verifyTensor

Description

Checks the data structure of the metric and stress-energy tensor objects to ensure the required data is provided. See Object Types for specifics on the required struct fields.

Method

Checks all required fields by object type.

This function is used throughout Warp Factory to ensure that data is present. The user can decide to use this to check their own metrics, but errors will be provided automatically in critical functions, such as in the frame transformations or in the solver.

Syntax

[verified] = verifyTensor(inputTensor, suppressMsgs)

Input Arguments

blue are required inputs.

orange are optional inputs with native default values.

Inputs	Format	Type	Description
inputTensor	struct	object	Input tensor object.
suppressMsgs	1x1 array	integer	Selects if error messages will be displayed. The default value is 0, which means true.

Output Arguments

Outputs	Format	Type	Description
verified	1x1 array	logical	Returns a 1 if the tensor is verified and 0 if not.