Loading...
Searching...
No Matches
Foam::fieldTypes Namespace Reference

Collection of common field types. More...

Functions

bool is_area (const word &clsName)
 Test if the class name appears to be an area field.
bool is_area_internal (const word &clsName)
 Test if the class name appears to be an area internal field.
bool is_surface (const word &clsName)
 Test if the class name appears to be a surface field.
bool is_internal (const word &clsName)
 Test if the class name appears to be a volume internal field.
bool is_volume (const word &clsName)
 Test if the class name appears to be a volume field.
bool is_basic (const word &clsName)
 Test if the class name appears to be a basic field.
const char * emptyTypeName_ () noexcept
 An empty patch field type.
const char * calculatedTypeName_ () noexcept
 A calculated patch field type.
const char * extrapolatedCalculatedTypeName_ () noexcept
 A combined zero-gradient and calculated patch field type.
const char * processorTypeName_ () noexcept
 A processor patch field type.
const char * zeroGradientTypeName_ () noexcept
 A zeroGradient patch field type.
const char * zeroValueTypeName_ () noexcept
 A zeroValue patch field type.
bool is_point (const word &clsName)
 Test if the class name appears to be a point field.

Variables

const wordList area
 Standard area field types (scalar, vector, tensor, etc).
const wordList area_internal
 Standard area internal field types (scalar, vector, tensor, etc).
const wordList surface
 Standard surface field types (scalar, vector, tensor, etc).
const wordList internal
 Standard volume internal field types (scalar, vector, tensor, etc).
const wordList volume
 Standard volume field types (scalar, vector, tensor, etc).
const wordList basic
 Standard basic field types (label, scalar, vector, tensor, etc).
const word emptyType
 An empty patch field type.
const word calculatedType
 A calculated patch field type.
const word extrapolatedCalculatedType
 A combined zero-gradient and calculated patch field type.
const word processorType
 A processor patch field type.
const word zeroGradientType
 A zeroGradient patch field type.
const word zeroValueType
 A zeroValue patch field type.
const wordList point
 Standard point field types (scalar, vector, tensor, etc).

Detailed Description

Collection of common field types.

Note
The fieldTypes header contains macros for primitive types that Fields are instantiated for.

Function Documentation

◆ is_area()

bool is_area ( const word & clsName)

Test if the class name appears to be an area field.

Definition at line 154 of file areaFields.C.

References area, string::ends_with(), and string::starts_with().

Referenced by if().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ is_area_internal()

bool is_area_internal ( const word & clsName)

Test if the class name appears to be an area internal field.

Definition at line 164 of file areaFields.C.

References area_internal, string::ends_with(), and string::starts_with().

Here is the call graph for this function:

◆ is_surface()

bool is_surface ( const word & clsName)

Test if the class name appears to be a surface field.

Definition at line 92 of file surfaceFields.C.

References string::ends_with(), string::starts_with(), and surface.

Here is the call graph for this function:

◆ is_internal()

bool is_internal ( const word & clsName)

Test if the class name appears to be a volume internal field.

Definition at line 155 of file volFields.C.

References string::ends_with(), internal, and string::starts_with().

Here is the call graph for this function:

◆ is_volume()

bool is_volume ( const word & clsName)

Test if the class name appears to be a volume field.

Definition at line 165 of file volFields.C.

References string::ends_with(), string::starts_with(), and volume.

Here is the call graph for this function:

◆ is_basic()

bool is_basic ( const word & clsName)

Test if the class name appears to be a basic field.

Definition at line 73 of file fieldTypes.C.

References basic, and string::ends_with().

Referenced by if().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ emptyTypeName_()

const char * emptyTypeName_ ( )
inlinenoexcept

An empty patch field type.

Definition at line 92 of file fieldTypes.H.

References Foam::noexcept.

◆ calculatedTypeName_()

const char * calculatedTypeName_ ( )
inlinenoexcept

A calculated patch field type.

Definition at line 102 of file fieldTypes.H.

References Foam::noexcept.

◆ extrapolatedCalculatedTypeName_()

const char * extrapolatedCalculatedTypeName_ ( )
inlinenoexcept

A combined zero-gradient and calculated patch field type.

Definition at line 112 of file fieldTypes.H.

References Foam::noexcept.

◆ processorTypeName_()

const char * processorTypeName_ ( )
inlinenoexcept

A processor patch field type.

Definition at line 125 of file fieldTypes.H.

References Foam::noexcept.

◆ zeroGradientTypeName_()

const char * zeroGradientTypeName_ ( )
inlinenoexcept

A zeroGradient patch field type.

Definition at line 135 of file fieldTypes.H.

References Foam::noexcept.

◆ zeroValueTypeName_()

const char * zeroValueTypeName_ ( )
inlinenoexcept

A zeroValue patch field type.

Definition at line 145 of file fieldTypes.H.

References Foam::noexcept.

◆ is_point()

bool is_point ( const word & clsName)

Test if the class name appears to be a point field.

Definition at line 94 of file pointFields.C.

References string::ends_with(), point, and string::starts_with().

Referenced by forAll().

Here is the call graph for this function:
Here is the caller graph for this function:

Variable Documentation

◆ area

const Foam::wordList area
extern

Standard area field types (scalar, vector, tensor, etc).

Referenced by is_area().

◆ area_internal

const Foam::wordList area_internal
extern

Standard area internal field types (scalar, vector, tensor, etc).

Referenced by is_area_internal().

◆ surface

const Foam::wordList surface
extern

Standard surface field types (scalar, vector, tensor, etc).

Referenced by is_surface().

◆ internal

const Foam::wordList internal
extern

Standard volume internal field types (scalar, vector, tensor, etc).

Referenced by is_internal().

◆ volume

const Foam::wordList volume
extern

Standard volume field types (scalar, vector, tensor, etc).

Referenced by is_volume().

◆ basic

const Foam::wordList basic
extern

Standard basic field types (label, scalar, vector, tensor, etc).

These also correspond to cloud output fields.

Referenced by is_basic().

◆ emptyType

const Foam::word emptyType
extern

An empty patch field type.

Referenced by faePatchFieldBase::emptyType(), faPatchFieldBase::emptyType(), fvPatchFieldBase::emptyType(), fvsPatchFieldBase::emptyType(), and pointPatchFieldBase::emptyType().

◆ calculatedType

const Foam::word calculatedType
extern

A calculated patch field type.

Referenced by faePatchFieldBase::calculatedType(), faPatchFieldBase::calculatedType(), fvPatchFieldBase::calculatedType(), fvsPatchFieldBase::calculatedType(), and pointPatchFieldBase::calculatedType().

◆ extrapolatedCalculatedType

const Foam::word extrapolatedCalculatedType
extern

A combined zero-gradient and calculated patch field type.

Referenced by faPatchFieldBase::extrapolatedCalculatedType(), and fvPatchFieldBase::extrapolatedCalculatedType().

◆ processorType

const Foam::word processorType
extern

A processor patch field type.

◆ zeroGradientType

const Foam::word zeroGradientType
extern

A zeroGradient patch field type.

Referenced by faPatchFieldBase::zeroGradientType(), fvPatchFieldBase::zeroGradientType(), and pointPatchFieldBase::zeroGradientType().

◆ zeroValueType

const Foam::word zeroValueType
extern

A zeroValue patch field type.

Referenced by faePatchFieldBase::zeroValueType(), faPatchFieldBase::zeroValueType(), fvPatchFieldBase::zeroValueType(), fvsPatchFieldBase::zeroValueType(), and pointPatchFieldBase::zeroValueType().

◆ point

const Foam::wordList point
extern

Standard point field types (scalar, vector, tensor, etc).

Referenced by is_point().