Warp Factory
  • What is Warp Factory?
  • Overview
    • Installing Warp Factory
    • Workflow
    • Codebase Structure
    • Object Types
    • Frames
  • Examples
    • Metrics
      • M1 - First Metric
      • M2 - Default Metrics
      • M3 - Building a Metric
    • Energy Tensor
      • T1 - First Energy Tensor
      • T2 - Cartoon Methods
      • T3 - GPU Computation
      • T4 - Solver Order
      • T5 - Errors
    • Analysis
      • A1 - Energy Conditions
      • A2 - Metric Scalars
      • A3 - Eval Metric
      • A4 - Momentum Flow
    • Warp Shell
      • W1 Warp Shell Comoving
  • Modules
    • Metrics Module
      • Metric Library
        • metricGet_Minkowski
        • metricGet_Alcubierre
        • metricGet_Lentz
        • metricGet_VanDenBroeck
        • metricGet_WarpShellComoving
        • metricGet_ModifiedTime
        • metricGet_Schwarzschild
      • Metric Functions
        • setMinkowski
        • setMinkowskiThreePlusOne
        • threePlusOneBuilder
        • threePlusOneDecomposer
    • Analyzer Module
      • getMomentumFlowLines
      • doFrameTransfer
      • changeTensorIndex
      • getScalars
      • getEnergyConditions
      • evalMetric
    • Solver Module
      • getEnergyTensor
      • verifyTensor
    • Visualizer Module
      • plotThreePlusOne
      • plotTensor
      • Plot Functions
    • Units Module
  • General
    • Contributing
    • FAQ
    • Citing Warp Factory
Powered by GitBook
On this page
  • Description
  • Method
  • Syntax
  • Input Arguments
  • Output Arguments
  1. Modules
  2. Solver Module

verifyTensor

PreviousgetEnergyTensorNextVisualizer Module

Last updated 1 year ago

Description

Checks the data structure of the metric and stress-energy tensor objects to ensure the required data is provided. See 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.

Object Types