evalMetric
Description
The function evaluates the common analysis functions of the metric tensor. It returns the stress-energy tensor in coordinate and Eulerian frame, the energy conditions, and the metric scalars.
Method
evalMetric runs several solver and analysis functions and packages the output into a struct for the user.
Syntax
[output] = evalMetric(metric, tryGPU, keepPositive, numAngularVec, numTimeVec)
Input Arguments
blue are required inputs.
orange are optional inputs with native default values.
metric
struct
object
Input metric tensor.
tryGPU
1x1 array
integer
Use the GPU for evaluations, input either 1 for true or 0 for false. The default value is 0.
keepPositive
1x1 array
integer
Selects if the energy condition output only returns positive violation values. Input either 1 for true or 0 for false, returning positive and negative values. The default value is 1.
numAngularVec
1x1 array
integer
The number of spatial vectors used for energy conditions. The default value is 100.
numTimeVec
1x1 array
integer
The number of time vectors used for energy conditions. The default value is 10.
Output Arguments
output
struct
object
Returns a struct with the following fields:
.metric: metric tensor
.energyTensor: stress-energy tensor in the coordinate frame
.energyTensorEulerian: stress-energy tensor in the Eulerian frame
.null: null energy condition
.weak: weak energy condition
.strong: strong energy condition
.dominant: dominant energy condition
.expansion: expansion scalar
.shear: shear scalar
.vorticity: vorticity scalar
Last updated