Foam::DimensionedFieldFunctions Namespace Reference

Classes

class  AtmosphericBoundaryLayerTurbulentEpsilon
 Runtime selectable DimensionedFieldFunction to set the turbulent dissipation rate, $\epsilon$, for an atmospheric boundary layer. More...
 
class  AtmosphericBoundaryLayerTurbulentKineticEnergy
 Runtime selectable DimensionedFieldFunction to set the turbulent kinetic energy, $k$, for an atmospheric boundary layer. More...
 
class  AtmosphericBoundaryLayerVelocity
 Runtime selectable DimensionedFieldFunction to set the velocity for an atmospheric boundary layer. More...
 
class  Coded
 Coded internal and patch field initialisation, evaluation and update with dimension checking. More...
 
class  DistanceFunction
 Distance function internal and patch field initialisation function. More...
 
class  FieldFunction
 Field function which looks up another field and uses it as the argument to evaluate a given Foam::Function1. The user must specify both the name of the looked-up field and the function1. More...
 
class  Surfaces
 Dimensioned field function which sets constant values inside a set of surfaces, and a default value elsewhere. Cutting is used to set fractional values in elements that intersect the surfaces. Foam::searchableSurface is used to define the surface geometry, so triangulated surface files can be used, as well as a list of simple predefined shapes (box, cylinder, ...). More...
 
class  TimeFunction
 Time dependent internal and patch field initialisation and update function. More...
 
class  Zonal
 Zonal internal and patch field initialisation function. More...
 
class  externalWallLayersHeatTransferCoefficient
 Runtime selectable DimensionedFieldFunction providing the heat transfer coefficient for a number of layers of conductive materials. More...
 
class  wallLayersHeatTransferCoefficient
 Runtime selectable DimensionedFieldFunction providing the heat transfer coefficient for a number of layers of conductive materials. More...
 
class  waveAlpha
 Initialises the phase fraction to that specified by a superposition of wave models. All the wave modelling parameters are obtained from a centrally registered waveSuperposition class. More...
 
class  waveVelocity
 Initialises the velocity to that specified by a superposition of wave models. All the wave modelling parameters are obtained from a centrally registered waveSuperposition class. More...
 
class  displacementGapHeatTransferCoefficient
 Runtime selectable DimensionedFieldFunction providing the heat transfer coefficient for a gap caused by surface displacement. More...
 

Typedefs

typedef DimensionedFieldFunction< DimensionedField< scalar, fvPatch > > DimensionedFieldFunctionScalarFvPatch
 
typedef DimensionedFieldFunction< DimensionedField< scalar, fvMesh > > DimensionedFieldFunctionScalarFvMesh
 
typedef DimensionedFieldFunction< DimensionedField< vector, fvMesh > > DimensionedFieldFunctionvectorFvMesh
 

Functions

 addDimensionedFieldFunction (AtmosphericBoundaryLayerVelocity, DimensionedFieldvectorfvMeshField)
 
 addDimensionedFieldFunction (AtmosphericBoundaryLayerTurbulentKineticEnergy, DimensionedFieldscalarfvMeshField)
 
 addDimensionedFieldFunction (AtmosphericBoundaryLayerTurbulentEpsilon, DimensionedFieldscalarfvMeshField)
 
 addDimensionedFieldFunction (AtmosphericBoundaryLayerVelocity, DimensionedFieldvectorfvPatchField)
 
 addDimensionedFieldFunction (AtmosphericBoundaryLayerTurbulentKineticEnergy, DimensionedFieldscalarfvPatchField)
 
 addDimensionedFieldFunction (AtmosphericBoundaryLayerTurbulentEpsilon, DimensionedFieldscalarfvPatchField)
 
template<class T >
void ignore (const T &)
 Dummy function to call on a variable to avoid "unused variable" warnings. More...
 
 addDimensionedFieldFunction (TimeFunction, DimensionedFieldlabelsurfaceMeshField)
 
 addDimensionedFieldFunction (Zonal, DimensionedFieldlabelsurfaceMeshField)
 
 defineTypeNameAndDebug (externalWallLayersHeatTransferCoefficient, 0)
 
 addToRunTimeSelectionTable (DimensionedFieldFunctionScalarFvPatch, externalWallLayersHeatTransferCoefficient, dictionary)
 
 defineTypeNameAndDebug (wallLayersHeatTransferCoefficient, 0)
 
 addToRunTimeSelectionTable (DimensionedFieldFunctionScalarFvPatch, wallLayersHeatTransferCoefficient, dictionary)
 
 defineTypeNameAndDebug (waveAlpha, 0)
 
 addToRunTimeSelectionTable (DimensionedFieldFunctionScalarFvMesh, waveAlpha, dictionary)
 
 defineTypeNameAndDebug (waveVelocity, 0)
 
 addToRunTimeSelectionTable (DimensionedFieldFunctionvectorFvMesh, waveVelocity, dictionary)
 
 defineTypeNameAndDebug (displacementGapHeatTransferCoefficient, 0)
 
 addToRunTimeSelectionTable (DimensionedFieldFunctionScalarFvPatch, displacementGapHeatTransferCoefficient, dictionary)
 

Typedef Documentation

◆ DimensionedFieldFunctionScalarFvPatch

◆ DimensionedFieldFunctionScalarFvMesh

◆ DimensionedFieldFunctionvectorFvMesh

Function Documentation

◆ addDimensionedFieldFunction() [1/8]

Foam::DimensionedFieldFunctions::addDimensionedFieldFunction ( AtmosphericBoundaryLayerVelocity  ,
DimensionedFieldvectorfvMeshField   
)

◆ addDimensionedFieldFunction() [2/8]

Foam::DimensionedFieldFunctions::addDimensionedFieldFunction ( AtmosphericBoundaryLayerTurbulentKineticEnergy  ,
DimensionedFieldscalarfvMeshField   
)

◆ addDimensionedFieldFunction() [3/8]

Foam::DimensionedFieldFunctions::addDimensionedFieldFunction ( AtmosphericBoundaryLayerTurbulentEpsilon  ,
DimensionedFieldscalarfvMeshField   
)

◆ addDimensionedFieldFunction() [4/8]

Foam::DimensionedFieldFunctions::addDimensionedFieldFunction ( AtmosphericBoundaryLayerVelocity  ,
DimensionedFieldvectorfvPatchField   
)

◆ addDimensionedFieldFunction() [5/8]

Foam::DimensionedFieldFunctions::addDimensionedFieldFunction ( AtmosphericBoundaryLayerTurbulentKineticEnergy  ,
DimensionedFieldscalarfvPatchField   
)

◆ addDimensionedFieldFunction() [6/8]

Foam::DimensionedFieldFunctions::addDimensionedFieldFunction ( AtmosphericBoundaryLayerTurbulentEpsilon  ,
DimensionedFieldscalarfvPatchField   
)

◆ ignore()

void Foam::DimensionedFieldFunctions::ignore ( const T )

Dummy function to call on a variable to avoid "unused variable" warnings.

Definition at line 179 of file DimensionedFieldFunction.H.

◆ addDimensionedFieldFunction() [7/8]

Foam::DimensionedFieldFunctions::addDimensionedFieldFunction ( TimeFunction  ,
DimensionedFieldlabelsurfaceMeshField   
)

◆ addDimensionedFieldFunction() [8/8]

Foam::DimensionedFieldFunctions::addDimensionedFieldFunction ( Zonal  ,
DimensionedFieldlabelsurfaceMeshField   
)

◆ defineTypeNameAndDebug() [1/5]

Foam::DimensionedFieldFunctions::defineTypeNameAndDebug ( externalWallLayersHeatTransferCoefficient  ,
 
)

◆ addToRunTimeSelectionTable() [1/5]

Foam::DimensionedFieldFunctions::addToRunTimeSelectionTable ( DimensionedFieldFunctionScalarFvPatch  ,
externalWallLayersHeatTransferCoefficient  ,
dictionary   
)

◆ defineTypeNameAndDebug() [2/5]

Foam::DimensionedFieldFunctions::defineTypeNameAndDebug ( wallLayersHeatTransferCoefficient  ,
 
)

◆ addToRunTimeSelectionTable() [2/5]

Foam::DimensionedFieldFunctions::addToRunTimeSelectionTable ( DimensionedFieldFunctionScalarFvPatch  ,
wallLayersHeatTransferCoefficient  ,
dictionary   
)

◆ defineTypeNameAndDebug() [3/5]

Foam::DimensionedFieldFunctions::defineTypeNameAndDebug ( waveAlpha  ,
 
)

◆ addToRunTimeSelectionTable() [3/5]

Foam::DimensionedFieldFunctions::addToRunTimeSelectionTable ( DimensionedFieldFunctionScalarFvMesh  ,
waveAlpha  ,
dictionary   
)

◆ defineTypeNameAndDebug() [4/5]

Foam::DimensionedFieldFunctions::defineTypeNameAndDebug ( waveVelocity  ,
 
)

◆ addToRunTimeSelectionTable() [4/5]

Foam::DimensionedFieldFunctions::addToRunTimeSelectionTable ( DimensionedFieldFunctionvectorFvMesh  ,
waveVelocity  ,
dictionary   
)

◆ defineTypeNameAndDebug() [5/5]

Foam::DimensionedFieldFunctions::defineTypeNameAndDebug ( displacementGapHeatTransferCoefficient  ,
 
)

◆ addToRunTimeSelectionTable() [5/5]

Foam::DimensionedFieldFunctions::addToRunTimeSelectionTable ( DimensionedFieldFunctionScalarFvPatch  ,
displacementGapHeatTransferCoefficient  ,
dictionary   
)