grid/gridFunctions.h File Reference

Contains definitions of the variables that are tracked on a grid point. More...

#include <vector>

Include dependency graph for gridFunctions.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	fld::EvolvedBy
	A pair of two grid functions where the first is evolved in time by the other. More...
Namespaces
namespace	fld
	Definitions of grid functions are here.
Defines
#define	GFCNT   fld::sysLast
	Used as the size marker.
Enumerations
enum	fld::sysIndex { fld::t = 0, fld::r }
	Identifiers of all known grid functions (the variables or fields on a grid). More...

---

Detailed Description

Contains definitions of the variables that are tracked on a grid point.

Author:

Mikica Kocic

Copyright:

GNU General Public License (GPLv3).

Here we configure the grid functions we are dealing with on a grid point. The customization should be done in the fld namespace below.

A grid function is a discretization of a variable (a "field") which is defined on every point of a given grid. Examples are the components of the metric tensor in GR, or the rest-mass density of a fluid which is defined in all cells within a given domain.

Instructions to add a new grid function for the field gf

• add the identifier gf to an enumeration in the fld namespace

• (optionally) add gf to a list passed to GridInitialData::gridFunction()

• (optionally) add gf to a list passed to GridOutputWriter::gridFunction()

• (optionally) add gf to a list passed to MoLIntegrator::keepConstant() or to MoLIntegrator::keepEvolved()

• to be able to access gf's values using gf(m,n), add emitField(gf) inside the declaration.

You will also need to:

• (optionally) add emitDerivative_r(gf) and/or emitDerivative_rr(gf) (in case you need the spatial derivatives of the field).

• (optionally) define the RHS of the evolution equation Real eq_gf_t( Int m, Int n ) and then assign the RHS to gf_t in BimetricEvolve::integStep_Prepare.

• setup the behavior of 'gf' at boundaries in the IntegFace interface methods IntegFace::applyLeftBoundaryCondition and IntegFace::applyRightBoundaryCondition.

Definition in file gridFunctions.h.

---

Define Documentation

#define GFCNT   fld::sysLast

Used as the size marker.

Definition at line 69 of file gridFunctions.h.