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

Variables

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

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 Foam::fieldTypes::is_area ( const word clsName)

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

Referenced by if().

Here is the caller graph for this function:

◆ is_area_internal()

bool Foam::fieldTypes::is_area_internal ( const word clsName)

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

◆ is_edge()

bool Foam::fieldTypes::is_edge ( const word clsName)

Test if the class name appears to be a (finite-area) edge field.

Referenced by if().

Here is the caller graph for this function:

◆ is_surface()

bool Foam::fieldTypes::is_surface ( const word clsName)

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

◆ is_internal()

bool Foam::fieldTypes::is_internal ( const word clsName)

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

◆ is_volume()

bool Foam::fieldTypes::is_volume ( const word clsName)

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

◆ 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, UList< T >::contains(), 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* Foam::fieldTypes::emptyTypeName_ ( )
inlinenoexcept

An empty patch field type.

Definition at line 92 of file fieldTypes.H.

◆ calculatedTypeName_()

const char* Foam::fieldTypes::calculatedTypeName_ ( )
inlinenoexcept

A calculated patch field type.

Definition at line 102 of file fieldTypes.H.

◆ extrapolatedCalculatedTypeName_()

const char* Foam::fieldTypes::extrapolatedCalculatedTypeName_ ( )
inlinenoexcept

A combined zero-gradient and calculated patch field type.

Definition at line 112 of file fieldTypes.H.

◆ processorTypeName_()

const char* Foam::fieldTypes::processorTypeName_ ( )
inlinenoexcept

A processor patch field type.

Definition at line 125 of file fieldTypes.H.

◆ zeroGradientTypeName_()

const char* Foam::fieldTypes::zeroGradientTypeName_ ( )
inlinenoexcept

A zeroGradient patch field type.

Definition at line 135 of file fieldTypes.H.

◆ zeroValueTypeName_()

const char* Foam::fieldTypes::zeroValueTypeName_ ( )
inlinenoexcept

A zeroValue patch field type.

Definition at line 145 of file fieldTypes.H.

◆ is_point()

bool Foam::fieldTypes::is_point ( const word clsName)

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

Referenced by forAll().

Here is the caller graph for this function:

Variable Documentation

◆ area

◆ area_internal

const wordList area_internal

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

◆ edge

◆ surface

◆ internal

const wordList internal

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

Referenced by if().

◆ volume

◆ basic

const Foam::wordList basic

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

These also correspond to cloud output fields.

Referenced by is_basic().

◆ emptyType

◆ calculatedType

◆ extrapolatedCalculatedType

◆ processorType

const Foam::word processorType

A processor patch field type.

◆ zeroGradientType

◆ zeroValueType

◆ point

const wordList point

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