File bout_types.hxx#

Defines

ENUMSTR(val)#

STRENUM(val)#

Typedefs

using BoutReal = double#: Size of real numbers.

using FuncPtr = BoutReal (*)(BoutReal t, BoutReal x, BoutReal y, BoutReal z)#: Boundary condition function.

Enums

enum CELL_LOC#

4 possible variable locations. Default is for passing to functions

Values:

enumerator deflt#

enumerator centre#

enumerator xlow#

enumerator ylow#

enumerator zlow#

enumerator vshift#

enum DIFF_METHOD#

Differential methods. Both central and upwind.

Values:

enumerator deflt#

enumerator u1#

enumerator u2#

enumerator c2#

enumerator w2#

enumerator w3#

enumerator c4#

enumerator u3#

enumerator fft#

enumerator split#

enumerator s2#

enum REGION#

Specify grid region for looping.

Values:

enumerator all#

enumerator nobndry#

enumerator nox#

enumerator noy#

enumerator noz#

enum DIRECTION#

To identify particular directions (in index space):

X, Y, Z are the coordinate directions
YAligned is a special case of Y, indicating a field-aligned grid, where the x- and z- axes are not necessarily orthogonal
YOrthogonal is a special case of Y, indicating a grid where the x and z axes are orthogonal but the y-direction is not necessarily field-aligned

Values:

enumerator X#

enumerator Y#

enumerator Z#

enumerator YAligned#

enumerator YOrthogonal#

enum YDirectionType#

Identify kind of a field’s y-direction

Standard is the default for the Mesh/Coordinates/ParallelTransform
Aligned indicates that the field has been transformed to field-aligned coordinates

Values:

enumerator Standard#

enumerator Aligned#

enum ZDirectionType#

Identify kind of a field’s z-direction

Standard is the default
Average indicates that the field represents an average over the z-direction, rather than having a particular z-position (i.e. is a Field2D)

Values:

enumerator Standard#

enumerator Average#

enum STAGGER#

To identify valid staggering combinations.

Values:

enumerator None#

enumerator C2L#

enumerator L2C#

enum DERIV#

To identify types of derivative method combinations.

Values:

enumerator Standard#

enumerator StandardSecond#

enumerator StandardFourth#

enumerator Upwind#

enumerator Flux#

Functions

std::string toString(CELL_LOC location)

CELL_LOC CELL_LOCFromString(const std::string &location_string)

std::string toString(DIFF_METHOD location)

std::string toString(REGION region)

std::string toString(DIRECTION direction)

std::string toString(YDirectionType d)

YDirectionType YDirectionTypeFromString(const std::string &y_direction_string)

std::string toString(ZDirectionType d)

ZDirectionType ZDirectionTypeFromString(const std::string &z_direction_string)

bool areDirectionsCompatible(const DirectionTypes &d1, const DirectionTypes &d2): Check whether direction types are compatible, so two fields with attributes d1 and d2 respectively can be added, subtracted, etc.