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

Metrics

The Metrics Module provides functions for uses to build spacetimes. The following functions are currently provided:

Function	Description
setMinkowski	Generates a flat spacetime as a 4x4 cell object.
setMinkowskiThreePlusOne	Generates the 3+1 components for flat spacetime..
threePlusOneBuilder	Generates the standard metric tensor from the 3+1 components.
threePlusOneDecomposer	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:

Standard Metric	Description
metricGet_Minkowski	Generic flat spacetime.
metricGet_Alcubierre	The Alcubierre solution. Includes comoving frame.
metricGet_Lentz	The Lentz soliton solution. Includes comoving frame.
metricGet_VanDenBroeck	The Van Den Broeck modification to Alcubierre. Includes comoving frame.
metricGet_ModifiedTime	Bobrick and Martire modified time version of the Alcubierre metric. Includes comoving frame.
metricGet_Schwarzschild	Standard black hole solution.

Supporting these main functions are several auxiliary functions that can be found within the utils folder in Metrics > utils.

Analyzer

Solver

Visualizer

Units