Codebase Structure
Description of the general organization and core functions within Warp Factory
Warp Factory is a package of functions written in MATLAB. It is organized around several modules containing functions that can be called to build and evaluate metrics. Each of these modules will be described here at a high level.
Module Descriptions
The Metrics Module provides functions for uses to build spacetimes. The following functions are currently provided:
Generates a flat spacetime as a 4x4 cell object.
Generates the 3+1 components for flat spacetime..
Generates the standard metric tensor from the 3+1 components.
Generates the 3+1 components from a standard metric tensor.
In addition, a standard Metric Library is provided which contains some of the standard and famous warp metrics found over the last few decades. These include:
Generic flat spacetime.
The Alcubierre solution. Includes comoving frame.
The Lentz soliton solution. Includes comoving frame.
The Van Den Broeck modification to Alcubierre. Includes comoving frame.
Bobrick and Martire modified time version of the Alcubierre metric. Includes comoving frame.
Standard black hole solution.
Supporting these main functions are several auxiliary functions that can be found within the utils folder in Metrics > utils.
The Analyzer Module performs all of the analysis products provided in Warp Factory. This includes things like finding the energy conditions from a stress-energy tensor or determining the metric scalars. The following functions are currently provided:
Generates momentum flowlines from the stress-energy tensor.
Performs transformations to tensors. Currently only does a local Eulerian transformation.
Performs raising or lowering operations on tensors
Finds metric scalars
Finds the energy conditions of the stress-energy tensor
Evaluates the metric and returns the stress-energy, scalars, and energy conditions
Supporting these main functions are several auxiliary functions that can be found within the utils folder in Analyzer > utils.
The Solver Module evaluates the field equation to find the stress-energy tensor. The following functions are currently provided:
Finds the stress-energy tensor from the metric tensor
Checks the data fields of tensor objects for completeness.
Supporting this main function are several auxiliary functions that can be found within the utils folder in Solver > utils.
The Visualizer Module has several functions which aid users in displaying the tensors and analysis products. This currently includes the following:
Plots the metric in terms of its 3+1 foliation components
Plots the components of the tensor objects
Supporting these main functions are several auxiliary functions that can be found within the utils folder in Visualizer > utils. described in Plot Functions
The Units Module contains a list of reserved function names that act as unit specifications for use in Warp Factory.
Last updated