parseDriver Class Reference

Driver for patch expressions. More...

Inheritance diagram for parseDriver:
[legend]
Collaboration diagram for parseDriver:
[legend]

Public Member Functions

 ClassName ("patchExpr::driver")
 
 parseDriver (const fvPatch &p)
 Construct for specified patch. More...
 
 parseDriver (const fvPatch &p, const dictionary &dict)
 Construct for specified patch with given dictionary. More...
 
 parseDriver (const fvPatch &p, const parseDriver &driver_)
 Construct for specified patch with copy of driver context. More...
 
 parseDriver (const word &patchName, const fvMesh &mesh)
 Construct with patchName for the given mesh. More...
 
 parseDriver (const dictionary &dict, const fvMesh &mesh)
 
virtual autoPtr< expressions::fvExprDriverclone () const
 Clone. More...
 
virtual ~parseDriver ()=default
 Destructor. More...
 
virtual const fvMeshmesh () const
 The mesh we are attached to. More...
 
virtual label size () const
 The underlying field size for the expression. More...
 
virtual label pointSize () const
 The underlying point field size for the expression. More...
 
label size (const FieldAssociation geoType) const
 Field size associated with different geometric field types. More...
 
virtual unsigned parse (const std::string &expr, size_t pos=0, size_t len=std::string::npos)
 Execute the parser. More...
 
template<class Type >
void setResult (Field< Type > *ptr, bool pointVal=false)
 Set result. More...
 
template<class Type >
tmp< Field< Type > > getVariableIfAvailable (const word &fldName) const
 Retrieve variable as field if possible. More...
 
template<class Type >
tmp< Field< Type > > getVolField (const word &fldName)
 Retrieve field (vol field) More...
 
template<class Type >
tmp< Field< Type > > getSurfaceField (const word &fldName)
 Retrieve field (surface field) More...
 
template<class Type >
tmp< Field< Type > > getPointField (const word &fldName)
 Retrieve field (point field) More...
 
template<class Type >
tmp< Field< Type > > getField (const word &fldName)
 Return named field. More...
 
template<class Type >
tmp< Field< Type > > faceToPoint (const Field< Type > &field) const
 Interpolate face to point. More...
 
template<class Type >
tmp< Field< Type > > pointToFace (const Field< Type > &field) const
 Interpolate point to face values. More...
 
template<class Type >
Type areaAverage (const Field< Type > &fld) const
 The area-weighted average of a field. More...
 
template<class Type >
Type areaSum (const Field< Type > &fld) const
 The area-weighted sum of a field. More...
 
tmp< scalarFieldfield_faceArea () const
 The face area magnitudes [magSf] - (swak = area) More...
 
tmp< vectorFieldfield_faceCentre () const
 The face centres - (swak = pos) More...
 
tmp< vectorFieldfield_areaNormal () const
 The face areas with their vector direction [Sf] - (swak = face) More...
 
tmp< vectorFieldfield_pointField () const
 The patch point locations - (swak = pts) More...
 
tmp< scalarFieldfield_rand (label seed=0, bool gaussian=false) const
 A uniform random field. More...
 
tmp< scalarFieldfield_randGaussian (label seed=0) const
 A Gaussian random field. More...
 
template<>
tmp< Field< bool > > getSurfaceField (const word &fldName)
 Retrieve field (surface field: bool) More...
 
template<>
tmp< Field< bool > > getPointField (const word &fldName)
 Retrieve field (point field: bool) More...
 
template<>
Foam::tmp< Foam::Field< bool > > getSurfaceField (const word &name)
 
template<>
Foam::tmp< Foam::Field< bool > > getPointField (const word &name)
 
template<class Type >
Foam::tmp< Foam::Field< Type > > getVariableIfAvailable (const word &name) const
 
template<class Type >
Foam::tmp< Foam::Field< Type > > getVolField (const word &name)
 
template<class Type >
Foam::tmp< Foam::Field< Type > > getSurfaceField (const word &name)
 
template<class Type >
Foam::tmp< Foam::Field< Type > > getPointField (const word &name)
 
template<class Type >
Foam::tmp< Foam::Field< Type > > getField (const word &name)
 
template<class Type >
Foam::tmp< Foam::Field< Type > > faceToPoint (const Field< Type > &field) const
 
template<class Type >
Foam::tmp< Foam::Field< Type > > pointToFace (const Field< Type > &field) const
 
template<class Type >
Foam::tmp< Foam::GeometricField< Type, Foam::fvPatchField, Foam::volMesh > > getVolField (const word &fldName, bool getOldTime)
 
template<class Type >
Foam::tmp< Foam::GeometricField< Type, Foam::fvsPatchField, Foam::surfaceMesh > > getSurfaceField (const word &fldName, bool getOldTime)
 
template<class Type >
Foam::tmp< Foam::GeometricField< Type, Foam::pointPatchField, Foam::pointMesh > > getPointField (const word &fldName, bool getOldTime)
 
template<class Type >
Foam::tmp< Foam::Field< Type > > getField (const word &name) const
 
- Public Member Functions inherited from genericRagelLemonDriver
 genericRagelLemonDriver ()
 Construct null. More...
 
 genericRagelLemonDriver (const genericRagelLemonDriver &rhs)=default
 Copy construct. More...
 
 genericRagelLemonDriver (genericRagelLemonDriver &&rhs)=default
 Move construct. More...
 
virtual ~genericRagelLemonDriver ()=default
 Destructor. More...
 
void clear ()
 Reset references. More...
 
const std::string & content () const
 Get reference to the input buffer content. More...
 
void content (const std::string &s, size_t pos=0, size_t len=std::string::npos)
 
std::string::const_iterator cbegin () const
 Iterator to begin of content (sub)string. More...
 
std::string::const_iterator cend () const
 Iterator to end of content (sub)string. More...
 
size_t parsePosition () const
 The relative parse position with the content (sub)string. More...
 
size_t & parsePosition ()
 The relative parse position with the content (sub)string. More...
 
OstreamprintBuffer (Ostream &os) const
 Output the input buffer string content. More...
 
void reportFatal (const std::string &msg) const
 Report FatalError. More...
 
void reportFatal (const std::string &msg, size_t pos) const
 Report FatalError at parser position. More...
 
- Public Member Functions inherited from fvExprDriver
 TypeName ("fvExprDriver")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, fvExprDriver, dictionary,(const dictionary &dict, const fvMesh &mesh),(dict, mesh))
 
 declareRunTimeSelectionTable (autoPtr, fvExprDriver, idName,(const word &ident, const fvMesh &mesh),(ident, mesh))
 
 fvExprDriver (bool cacheReadFields=false, bool searchInMemory=true, bool searchFiles=false, const dictionary &dict=dictionary::null)
 Null constructor, and null construct with search preferences. More...
 
 fvExprDriver (const fvExprDriver &)
 Copy construct. More...
 
 fvExprDriver (const dictionary &dict)
 Construct from a dictionary. More...
 
virtual ~fvExprDriver ()
 Destructor. More...
 
const TimerunTime () const
 The Time associated with the mesh. More...
 
virtual word timeName () const
 The current time name. More...
 
virtual scalar timeValue () const
 The current time value. More...
 
bool cacheSets () const
 Status of cache-sets (static variable) More...
 
virtual void clearVariables ()
 Clear temporary variables and resets from expression strings. More...
 
virtual bool hasVariable (const word &name) const
 True if named variable exists. More...
 
virtual const exprResultvariable (const word &name) const
 Return const-access to the named variable. More...
 
template<class Type >
bool isVariableOrField (const word &name, bool isPointVal=false, label expectSize=-1) const
 Test for existence of a local/global variable or a field. More...
 
template<class Type >
tmp< Field< Type > > getVariable (const word &name, label expectSize, const bool mandatory=true) const
 Retrieve local/global variable as a tmp field. More...
 
word getFieldClassName (const word &name) const
 Lookup the field class name (memory or read from disk) More...
 
topoSetSource::sourceType topoSetType (const word &name) const
 Return cell/face/point set type or unknown. More...
 
topoSetSource::sourceType topoZoneType (const word &name) const
 Return cell/face/point zone type or unknown. More...
 
topoSetSource::sourceType topoSourceType (const word &name) const
 Return cell/face/point zone/set type or unknown. More...
 
labelList getTopoSetLabels (const word &name, enum topoSetSource::sourceType setType) const
 Read and return labels associated with the topo set. More...
 
bool isCellZone (const word &name) const
 Test if name is a known cellZone. More...
 
bool isFaceZone (const word &name) const
 Test if name is a known faceZone. More...
 
bool isPointZone (const word &name) const
 Test if name is a known pointZone. More...
 
bool isCellSet (const word &name) const
 Test if name is a known cellSet. More...
 
bool isFaceSet (const word &name) const
 Test if name is a known faceSet. More...
 
bool isPointSet (const word &name) const
 Test if name is a known pointSet. More...
 
virtual void evaluateVariable (const word &varName, const expressions::exprString &expr)
 
virtual void evaluateVariableRemote (string remote, const word &varName, const expressions::exprString &expr)
 
template<class Type >
bool isVariable (const word &name, bool isPointVal=false, label expectSize=-1) const
 Test existence of a local/global variable. More...
 
template<class Type >
bool foundField (const word &name) const
 Test if specified field can be found in memory or disk. More...
 
word getTypeOfField (const word &fieldName) const
 Read the IOobject for fieldName and return its headerClassName. More...
 
virtual bool readDict (const dictionary &dict)
 Read variables, tables etc. More...
 
OstreamwriteCommon (Ostream &os, bool debug=false) const
 
void createWriterAndRead (const word &name)
 Create a writer for this object. More...
 
void tryWrite () const
 
template<class GeomField >
Foam::tmp< GeomField > getOrReadField (const word &name, bool mandatory, bool getOldTime)
 
template<class GeomField >
Foam::tmp< GeomField > getOrReadPointField (const word &name, bool mandatory, bool getOldTime)
 
template<class GeomField , class Mesh >
Foam::tmp< GeomField > readAndRegister (const word &name, const Mesh &meshRef)
 
template<class Type >
Foam::tmp< Foam::Field< Type > > getVariable (const word &name, label expectedSize, const bool mandatory) const
 
template<class GeomField , class Mesh >
Foam::tmp< GeomField > getOrReadFieldImpl (const word &name, const Mesh &meshRef, bool mandatory, bool getOldTime)
 
template<class T >
Foam::autoPtr< TgetTopoSet (const fvMesh &mesh, const word &name, SetOrigin &origin) const
 
- Public Member Functions inherited from exprDriver
 TypeName ("exprDriver")
 Runtime type information. More...
 
 exprDriver (bool cacheReadFields=false, bool searchInMemory=true, bool searchFiles=false, const dictionary &dict=dictionary::null)
 Null constructor, and null construct with search preferences. More...
 
 exprDriver (const exprDriver &)
 Copy construct. More...
 
 exprDriver (const dictionary &dict)
 Construct from a dictionary. More...
 
virtual ~exprDriver ()=default
 Destructor. More...
 
const dictionarydict () const
 The dictionary with all input data/specification. More...
 
virtual const exprResultresult () const
 Const access to expression result. More...
 
virtual exprResultresult ()
 Non-const access to expression result. More...
 
void clearResult ()
 Clear the result. More...
 
template<class Type >
tmp< Field< Type > > getResult (bool isPointVal=false)
 Return the expression result as a tmp field. More...
 
virtual word getResultType () const
 The result type as word - same as result().valueType() More...
 
scalar argValue () const
 Set special-purpose scalar reference argument. More...
 
int stashedTokenId () const
 Get "look-behind" parsing context (internal bookkeeping) More...
 
int resetStashedTokenId (int tokenId=0) const
 Reset "look-behind" parsing context (mutable operation) More...
 
void setDebugging (bool scannerDebug, bool parserDebug)
 Set the scanner/parser debug. More...
 
void setDebugging (const exprDriver &rhs)
 Set the scanner/parser debug to match the input. More...
 
void setSearchBehaviour (bool cacheReadFields, bool searchInMemory, bool searchFiles)
 Set search behaviour. More...
 
void setSearchBehaviour (const exprDriver &rhs)
 Set search behaviour to be identical to rhs. More...
 
bool debugScanner () const
 Read access to scanner debug. More...
 
bool debugParser () const
 Read access to parser debug. More...
 
bool cacheReadFields () const
 
bool searchInMemory () const
 
bool searchFiles () const
 
bool prevIterIsOldTime () const
 
virtual void setArgument (const scalar val)
 Set special-purpose scalar reference argument. More...
 
void addVariables (const expressions::exprString &expr, bool clear=true)
 Add/set string expressions for variables. More...
 
void addVariables (const UList< expressions::exprString > &list, bool clear=true)
 Add/set string expressions for variables. More...
 
template<class T >
void addUniformVariable (const word &name, const T &val)
 Add a uniform variable from an outside caller. More...
 
template<class T >
bool isLocalVariable (const word &name, bool isPointVal, label expectedSize=-1) const
 Test existence of a local variable. More...
 
template<class Type >
tmp< Field< Type > > getLocalVariable (const word &name, label expectSize, const bool mandatory=true) const
 Retrieve local/global variable as a tmp field. More...
 
template<class Type >
tmp< Field< Type > > evaluate (const expressions::exprString &expr, bool isPointVal=false)
 Evaluate the expression and return the field. More...
 
template<class Type >
Type evaluateUniform (const expressions::exprString &expr, bool isPointVal=false)
 Evaluate the expression and return a single value. More...
 
void evaluateVariable (const word &varName, const expressions::exprString &expr)
 
template<class Type >
tmp< Field< Type > > newField (const Type &val=pTraits< Type >::zero) const
 Return a new field with the size() More...
 
template<class Type >
tmp< Field< Type > > newPointField (const Type &val=pTraits< Type >::zero) const
 Return a new field with the pointSize() More...
 
expressions::exprString readExpression (const word &name)
 
label setVariableStrings (const dictionary &dict, bool mandatory=false)
 Read "variables" and assigns to the list of expression strings. More...
 
OstreamwriteVariableStrings (Ostream &os, const word &keyword="") const
 Write "variables". More...
 
template<class Type >
void addUniformVariable (const word &name, const Type &val)
 
template<class Type >
Foam::tmp< Foam::Field< Type > > evaluate (const expressions::exprString &expr, bool isPointVal)
 
template<class Type >
Foam::tmp< Foam::Field< Type > > getResult (bool isPointVal)
 
template<class Type >
Foam::tmp< Foam::Field< Type > > newField (const Type &val) const
 
template<class Type >
Foam::tmp< Foam::Field< Type > > newPointField (const Type &val) const
 

Protected Member Functions

 parseDriver (const parseDriver &)=delete
 
void operator= (const parseDriver &)=delete
 
- Protected Member Functions inherited from fvExprDriver
void setGlobalScopes (const wordUList &scopes)
 Define scopes for global variables. More...
 
virtual exprResultvariable (const word &name)
 Non-const access to the named variable (sub-classes only) More...
 
template<class T >
bool isGlobalVariable (const word &name, bool isPointVal, label expectedSize=-1) const
 Test existence of a global variable. More...
 
const exprResultlookupGlobal (const word &name) const
 Return the global variable if available or a null result. More...
 
template<class Type >
bool isField (const word &name, bool isPointVal=false, label expectSize=-1) const
 Test for the existence of a mesh field. More...
 
template<class GeomField >
tmp< GeomField > getOrReadField (const word &name, bool mandatory=true, bool getOldTime=false)
 Retrieve field from memory or disk. More...
 
template<class GeomField >
tmp< GeomField > getOrReadPointField (const word &name, bool mandatory=true, bool getOldTime=false)
 Retrieve point field from memory or disk. More...
 
template<class GeomField , class MeshRef >
tmp< GeomField > getOrReadFieldImpl (const word &name, const MeshRef &meshRef, bool mandatory=true, bool getOldTime=false)
 Retrieve field from memory or disk (implementation) More...
 
template<class GeomField , class MeshRef >
tmp< GeomField > readAndRegister (const word &name, const MeshRef &meshRef)
 Helper function for getOrReadField. More...
 
void fill_random (scalarField &field, label seed=0, const bool gaussian=false) const
 Create a random field. More...
 
template<class T >
autoPtr< TgetTopoSet (const fvMesh &mesh, const word &setName, SetOrigin &origin) const
 Get topoSet. More...
 
template<class T >
bool updateSet (autoPtr< T > &setPtr, const word &setName, SetOrigin origin) const
 Update topoSet. More...
 
virtual void updateSpecialVariables (bool force=false)
 Examine current variable values and update stored variables. More...
 
virtual bool hasDataToWrite () const
 Do we need a data file to be written. More...
 
virtual void prepareData (dictionary &dict) const
 
virtual void getData (const dictionary &dict)
 Read data from dictionary, normally via the reader/writer. More...
 
- Protected Member Functions inherited from exprDriver
void fill_random (scalarField &field, label seed=0, const bool gaussian=false) const
 Fill a random field. More...
 
virtual bool update ()
 Update things. More...
 
virtual exprResult getRemoteResult (const exprDriver &other) const
 Get the result from another driver. More...
 
void operator= (const exprDriver &)=delete
 No copy assignment. More...
 

Protected Attributes

const fvPatchpatch_
 The referenced patch. More...
 
- Protected Attributes inherited from genericRagelLemonDriver
std::reference_wrapper< const std::string > content_
 Reference to the input string. More...
 
size_t start_
 Start position within input string. More...
 
size_t length_
 Length of input (sub)string. More...
 
size_t position_
 The last known parser position. More...
 
- Protected Attributes inherited from exprDriver
const dictionarydict_
 The dictionary with all input data/specification. More...
 
exprResult result_
 The result. More...
 
List< expressions::exprStringvariableStrings_
 Variable definitions, as read from a dictionary. More...
 
HashTable< exprResultvariables_
 The variables table. More...
 
scalar arg1Value_
 Special-purpose scalar reference argument. More...
 
int stashedTokenId_
 Internal bookkeeping as "look-behind" parsing context. More...
 
bool debugScanner_
 Request debugging for scanner. More...
 
bool debugParser_
 Request debugging for parser. More...
 
bool allowShadowing_
 Allow variable names to mask field names. More...
 
bool prevIterIsOldTime_
 Use value of previous iteration when oldTime is requested. More...
 
bool cacheReadFields_
 Keep fields read from disc in memory. More...
 
bool searchInMemory_
 Search in registry before looking on disk. More...
 
bool searchFiles_
 Search on disk (eg, for a standalone application) More...
 

Additional Inherited Members

- Public Types inherited from genericRagelLemonDriver
typedef size_t location_type
 Type for linear addressing within parse content. More...
 
- Static Public Member Functions inherited from fvExprDriver
static const fvMeshdefaultMesh ()
 Get the default mesh, if one is defined. More...
 
static const fvMeshresetDefaultMesh (const fvMesh &mesh, const bool force=false)
 Set the default mesh (if not already set) More...
 
static autoPtr< fvExprDriverNew (const dictionary &dict, const fvMesh &mesh)
 Return a reference to the selected value driver. More...
 
static autoPtr< fvExprDriverNew (const dictionary &dict)
 Return a reference to the selected value driver. More...
 
static autoPtr< fvExprDriverNew (const word &type, const word &id, const fvMesh &mesh)
 Return a reference to the selected value driver. More...
 
- Static Public Member Functions inherited from exprDriver
static expressions::exprString readExpression (const word &name, const dictionary &dict)
 Read an expression string and do substitutions. More...
 
static List< expressions::exprStringreadVariableStrings (const dictionary &dict, const word &name="variables", bool mandatory=false)
 Read the list of variable strings. More...
 
- Protected Types inherited from fvExprDriver
enum  SetOrigin {
  INVALID = 0, NEW, FILE, MEMORY,
  CACHE
}
 The origin of the topoSet. More...
 
- Static Protected Member Functions inherited from fvExprDriver
static const fvMeshregionMesh (const dictionary &dict, const fvMesh &mesh, bool readIfNecessary)
 
template<class T >
static word defaultBoundaryType (const T &)
 Default boundary type is calculated. More...
 
template<class Type >
static word defaultBoundaryType (const GeometricField< Type, fvPatchField, volMesh > &)
 Default boundary type for volume fields is zeroGradient. More...
 
template<class T >
static void correctField (T &)
 Apply correctBoundaryConditions (volume fields only) More...
 
template<class Type >
static void correctField (GeometricField< Type, fvPatchField, volMesh > &fld)
 
- Static Protected Member Functions inherited from exprDriver
template<typename TableType >
static bool readTable (const word &name, const dictionary &dict, HashTable< TableType > &tbl, bool clear=true)
 Read an interpolation table. More...
 
template<class TableType >
static void writeTable (Ostream &os, const word &name, const HashTable< TableType > &tbl)
 Write an interpolation table. More...
 
template<class Type >
static Type weightedAverage (const scalarField &weights, const Field< Type > &fld)
 The (global) weighted average of a field, with stabilisation. More...
 
template<class Type >
static Type weightedSum (const scalarField &weights, const Field< Type > &fld)
 The (global) weighted sum (integral) of a field. More...
 
static point getPositionOfMinimum (const scalarField &vals, const pointField &locs)
 Return the location of the min value. More...
 
static point getPositionOfMaximum (const scalarField &vals, const pointField &locs)
 Return the location of the max value. More...
 

Detailed Description

Driver for patch expressions.

In addition to the standard mathematical functions, operations and logical and relational operations, the patch expressions support the following driver-specific functions:

Functions

Function Description Number of arguments
pos The face centres 0
pts The face points 0
area The face area magnitudes 0
weightAverage Area weighted average 1
weightSum Area weighted sum 1
face The face areaNormal vectors 0
point A point-field point value 1
faceToPoint Interpolate face values onto points 1
pointToFace Interpolate point values onto faces 1
rand Random field 0/1
Note
Use namespace debug switch patchExpr for scanner (2), parser (4) or dictionary controls as per Foam::expressions::exprDriver.
Source files

Definition at line 140 of file patchExprDriver.H.

Constructor & Destructor Documentation

◆ parseDriver() [1/6]

parseDriver ( const parseDriver )
protecteddelete

Referenced by parseDriver::clone().

Here is the caller graph for this function:

◆ parseDriver() [2/6]

parseDriver ( const fvPatch p)
explicit

Construct for specified patch.

Definition at line 102 of file patchExprDriver.C.

◆ parseDriver() [3/6]

parseDriver ( const fvPatch p,
const dictionary dict 
)

Construct for specified patch with given dictionary.

Definition at line 111 of file patchExprDriver.C.

◆ parseDriver() [4/6]

parseDriver ( const fvPatch p,
const parseDriver driver_ 
)

Construct for specified patch with copy of driver context.

Definition at line 123 of file patchExprDriver.C.

◆ parseDriver() [5/6]

parseDriver ( const word patchName,
const fvMesh mesh 
)

Construct with patchName for the given mesh.

Definition at line 135 of file patchExprDriver.C.

◆ parseDriver() [6/6]

parseDriver ( const dictionary dict,
const fvMesh mesh 
)

Construct with "patch" (mandatory) and "region" (optional) specified in dictionary

Definition at line 145 of file patchExprDriver.C.

◆ ~parseDriver()

virtual ~parseDriver ( )
virtualdefault

Destructor.

Member Function Documentation

◆ operator=()

void operator= ( const parseDriver )
protecteddelete

◆ ClassName()

ClassName ( "patchExpr::driver"  )

◆ clone()

virtual autoPtr<expressions::fvExprDriver> clone ( ) const
inlinevirtual

Clone.

Implements fvExprDriver.

Definition at line 194 of file patchExprDriver.H.

References parseDriver::parseDriver().

Here is the call graph for this function:

◆ mesh()

virtual const fvMesh& mesh ( ) const
inlinevirtual

The mesh we are attached to.

Implements fvExprDriver.

Definition at line 210 of file patchExprDriver.H.

References fvPatch::boundaryMesh(), fvBoundaryMesh::mesh(), and parseDriver::patch_.

Here is the call graph for this function:

◆ size() [1/2]

virtual label size ( ) const
inlinevirtual

The underlying field size for the expression.

Implements fvExprDriver.

Definition at line 216 of file patchExprDriver.H.

References fvPatch::patch(), and parseDriver::patch_.

Here is the call graph for this function:

◆ pointSize()

virtual label pointSize ( ) const
inlinevirtual

The underlying point field size for the expression.

Implements fvExprDriver.

Definition at line 222 of file patchExprDriver.H.

References PrimitivePatch< FaceList, PointField >::nPoints(), fvPatch::patch(), and parseDriver::patch_.

Here is the call graph for this function:

◆ size() [2/2]

Foam::label size ( const FieldAssociation  geoType) const
inline

Field size associated with different geometric field types.

Definition at line 31 of file patchExprDriverI.H.

References Foam::expressions::patchExpr::POINT_DATA, and Foam::expressions::patchExpr::SURFACE_DATA.

◆ parse()

unsigned parse ( const std::string &  expr,
size_t  pos = 0,
size_t  len = std::string::npos 
)
virtual

Execute the parser.

The return value currently has no meaning.

Implements exprDriver.

Definition at line 157 of file patchExprDriver.C.

References Foam::pos(), and scanner::process().

Here is the call graph for this function:

◆ setResult()

void setResult ( Field< Type > *  ptr,
bool  pointVal = false 
)
inline

Set result.

Definition at line 252 of file patchExprDriver.H.

References exprDriver::result(), and exprResult::setResult().

Here is the call graph for this function:

◆ getVariableIfAvailable() [1/2]

tmp<Field<Type> > getVariableIfAvailable ( const word fldName) const

Retrieve variable as field if possible.

Test tmp for validity to determine success of the operation.

◆ getVolField() [1/3]

tmp<Field<Type> > getVolField ( const word fldName)

Retrieve field (vol field)

◆ getSurfaceField() [1/5]

tmp<Field<Type> > getSurfaceField ( const word fldName)

Retrieve field (surface field)

◆ getPointField() [1/5]

tmp<Field<Type> > getPointField ( const word fldName)

Retrieve field (point field)

◆ getField() [1/3]

tmp<Field<Type> > getField ( const word fldName)

Return named field.

◆ faceToPoint() [1/2]

tmp<Field<Type> > faceToPoint ( const Field< Type > &  field) const

Interpolate face to point.

◆ pointToFace() [1/2]

tmp<Field<Type> > pointToFace ( const Field< Type > &  field) const

Interpolate point to face values.

◆ areaAverage()

Type areaAverage ( const Field< Type > &  fld) const
inline

The area-weighted average of a field.

Definition at line 298 of file patchExprDriver.H.

References fld, fvPatch::magSf(), parseDriver::patch_, and exprDriver::weightedAverage().

Here is the call graph for this function:

◆ areaSum()

Type areaSum ( const Field< Type > &  fld) const
inline

The area-weighted sum of a field.

Definition at line 305 of file patchExprDriver.H.

References fld, fvPatch::magSf(), parseDriver::patch_, and exprDriver::weightedSum().

Here is the call graph for this function:

◆ field_faceArea()

Foam::tmp< Foam::scalarField > field_faceArea ( ) const

The face area magnitudes [magSf] - (swak = area)

Definition at line 59 of file patchExprDriverFields.C.

References fvPatch::magSf(), and parseDriver::patch_.

Here is the call graph for this function:

◆ field_faceCentre()

Foam::tmp< Foam::vectorField > field_faceCentre ( ) const

The face centres - (swak = pos)

Definition at line 66 of file patchExprDriverFields.C.

◆ field_areaNormal()

Foam::tmp< Foam::vectorField > field_areaNormal ( ) const

The face areas with their vector direction [Sf] - (swak = face)

Definition at line 73 of file patchExprDriverFields.C.

◆ field_pointField()

Foam::tmp< Foam::vectorField > field_pointField ( ) const

The patch point locations - (swak = pts)

Definition at line 80 of file patchExprDriverFields.C.

◆ field_rand()

Foam::tmp< Foam::scalarField > field_rand ( label  seed = 0,
bool  gaussian = false 
) const

A uniform random field.

Definition at line 88 of file patchExprDriverFields.C.

References tmp< T >::New().

Referenced by parseDriver::field_randGaussian().

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

◆ field_randGaussian()

tmp<scalarField> field_randGaussian ( label  seed = 0) const
inline

A Gaussian random field.

Definition at line 326 of file patchExprDriver.H.

References parseDriver::field_rand().

Here is the call graph for this function:

◆ getSurfaceField() [2/5]

tmp<Field<bool> > getSurfaceField ( const word fldName)

Retrieve field (surface field: bool)

◆ getPointField() [2/5]

tmp<Field<bool> > getPointField ( const word fldName)

Retrieve field (point field: bool)

◆ getSurfaceField() [3/5]

Foam::tmp<Foam::Field<bool> > getSurfaceField ( const word name)

Definition at line 37 of file patchExprDriverFields.C.

References Foam::name().

Here is the call graph for this function:

◆ getPointField() [3/5]

Foam::tmp<Foam::Field<bool> > getPointField ( const word name)

Definition at line 48 of file patchExprDriverFields.C.

References Foam::name().

Here is the call graph for this function:

◆ getVariableIfAvailable() [2/2]

Foam::tmp<Foam::Field<Type> > getVariableIfAvailable ( const word name) const

Definition at line 35 of file patchExprDriverTemplates.C.

References exprResult::cref(), Foam::endl(), Foam::gAverage(), exprResult::isPointValue(), exprResult::isUniform(), Foam::name(), Foam::New(), Foam::nl, Foam::returnReduce(), tmp< T >::valid(), and WarningInFunction.

Here is the call graph for this function:

◆ getVolField() [2/3]

Foam::tmp<Foam::Field<Type> > getVolField ( const word name)

Definition at line 89 of file patchExprDriverTemplates.C.

References Foam::name().

Here is the call graph for this function:

◆ getSurfaceField() [4/5]

Foam::tmp<Foam::Field<Type> > getSurfaceField ( const word name)

Definition at line 97 of file patchExprDriverTemplates.C.

References Foam::name().

Here is the call graph for this function:

◆ getPointField() [4/5]

Foam::tmp<Foam::Field<Type> > getPointField ( const word name)

Definition at line 105 of file patchExprDriverTemplates.C.

References Foam::name().

Here is the call graph for this function:

◆ getField() [2/3]

Foam::tmp<Foam::Field<Type> > getField ( const word name)

Definition at line 113 of file patchExprDriverTemplates.C.

References Foam::exit(), Foam::FatalError, FatalErrorInFunction, objectRegistry::findObject(), Foam::flatOutput(), tmp< T >::get(), mesh, Foam::name(), Foam::New(), MeshObject< polyMesh, UpdateableMeshObject, pointMesh >::New(), Foam::nl, objectRegistry::sortedNames(), and tmp< T >::valid().

Here is the call graph for this function:

◆ faceToPoint() [2/2]

Foam::tmp<Foam::Field<Type> > faceToPoint ( const Field< Type > &  field) const

Definition at line 205 of file patchExprDriverTemplates.C.

References field(), and PrimitivePatchInterpolation< Patch >::pointToFaceInterpolate().

Here is the call graph for this function:

◆ pointToFace() [2/2]

Foam::tmp<Foam::Field<Type> > pointToFace ( const Field< Type > &  field) const

Definition at line 218 of file patchExprDriverTemplates.C.

References PrimitivePatchInterpolation< Patch >::faceToPointInterpolate(), and field().

Here is the call graph for this function:

◆ getVolField() [3/3]

Foam::tmp<Foam::GeometricField<Type, Foam::fvPatchField, Foam::volMesh> > getVolField ( const word fldName,
bool  getOldTime 
)

Definition at line 187 of file volumeExprDriverTemplates.C.

◆ getSurfaceField() [5/5]

Foam::tmp<Foam::GeometricField<Type, Foam::fvsPatchField, Foam::surfaceMesh> > getSurfaceField ( const word fldName,
bool  getOldTime 
)

Definition at line 206 of file volumeExprDriverTemplates.C.

◆ getPointField() [5/5]

Foam::tmp<Foam::GeometricField<Type, Foam::pointPatchField, Foam::pointMesh> > getPointField ( const word fldName,
bool  getOldTime 
)

Definition at line 225 of file volumeExprDriverTemplates.C.

◆ getField() [3/3]

Foam::tmp<Foam::Field<Type> > getField ( const word name) const

Definition at line 33 of file fieldExprDriverTemplates.C.

References exprResult::cref(), Foam::endl(), Foam::gAverage(), exprResult::isPointValue(), exprResult::isUniform(), Foam::name(), Foam::New(), Foam::nl, Foam::returnReduce(), tmp< T >::valid(), and WarningInFunction.

Here is the call graph for this function:

Member Data Documentation

◆ patch_


The documentation for this class was generated from the following files: