Base driver for parsing (field) values. More...

#include <exprDriver.H>

Inheritance diagram for exprDriver:

[legend]

Collaboration diagram for exprDriver:

[legend]

Public Types
enum	searchControls { NO_SEARCH = 0 , SEARCH_REGISTRY = 1 , SEARCH_FILES = 2 , CACHE_READ_FIELDS = 4 , DEFAULT_SEARCH = (SEARCH_REGISTRY) }
	Search/caching controls. More...
typedef HashTable< const regIOobject * >	contextObjectTableType
	Externally defined context fields.

Public Member Functions
	TypeName ("exprDriver")
	Runtime type information.
	exprDriver (const exprDriver &)=delete
	No copy construct.
void	operator= (const exprDriver &)=delete
	No copy assignment.
	exprDriver (enum searchControls search=searchControls::DEFAULT_SEARCH, const dictionary &dict=dictionary::null)
	Default construct, and default construct with search preferences.
	exprDriver (const exprDriver &rhs, const dictionary &dict)
	Copy construct with new dictionary reference.
	exprDriver (const dictionary &dict)
	Construct from a dictionary.
virtual	~exprDriver ()=default
	Destructor.
virtual label	size () const
	The natural field size for the expression.
virtual label	pointSize () const
	The point field size for the expression.
const TimeState *	timeState () const noexcept
	Reference to the current time-state (can be nullptr).
virtual scalar	timeValue () const
	The current time value.
virtual scalar	deltaT () const
	The current deltaT value.
const dictionary &	dict () const noexcept
	The dictionary with all input data/specification.
const exprResult &	result () const noexcept
	Const access to expression result.
exprResult &	result () noexcept
	Non-const access to expression result.
void	clearResult ()
	Clear the result.
template<class Type>
tmp< Field< Type > >	getResult (bool wantPointData=false)
	Return the expression result as a tmp field.
const word &	getResultType () const noexcept
	The result type as word - same as result().valueType().
void	resetDb (const objectRegistry *obrPtr=nullptr)
	Reset the objectRegistry (for functions).
void	resetDb (const objectRegistry &db)
	Reset the objectRegistry (for functions).
scalar	argValue () const noexcept
	Get special-purpose scalar reference argument.
int	stashedTokenId () const noexcept
	Get "look-behind" parsing context (internal bookkeeping).
int	resetStashedTokenId (int tokenId=0) const noexcept
	Reset "look-behind" parsing context (mutable operation).
void	setDebugging (bool scannerDebug, bool parserDebug)
	Set the scanner/parser debug.
void	setDebugging (const exprDriver &rhs)
	Set the scanner/parser debug to match the input.
bool	setCaching (bool on) noexcept
	Toggle CACHE_READ_FIELDS control.
void	setSearchBehaviour (enum searchControls search, const bool caching=false)
	Set search behaviour, with additional CACHE_READ_FIELDS toggle on.
void	setSearchBehaviour (const exprDriver &rhs)
	Set search behaviour to be identical to rhs.
bool	debugScanner () const noexcept
	Read access to scanner debug.
bool	debugParser () const noexcept
	Read access to parser debug.
bool	prevIterIsOldTime () const
virtual void	clearVariables ()
	Clear temporary variables, reset from expression strings.
void	setArgument (const scalar val) noexcept
	Set special-purpose scalar reference argument.
virtual bool	hasVariable (const word &name) const
	True if named variable exists.
virtual const exprResult &	variable (const word &name) const
	Return const-access to the named variable.
void	addVariables (const expressions::exprString &expr, bool clear=true)
	Add/set string expressions for variables.
void	addVariables (const UList< expressions::exprString > &list, bool clear=true)
	Add/set string expressions for variables.
template<class T>
void	addUniformVariable (const word &name, const T &val)
	Add a uniform variable from an outside caller.
bool	hasContextObjects () const
	True if any context fields are defined.
const regIOobject *	cfindContextIOobject (const word &name) const
	Find named context field, if it exists.
template<class ObjType>
const ObjType *	cfindContextObject (const word &name) const
	Find context field object of specified type.
void	addContextObject (const word &name, const regIOobject *)
	Add the object to the context.
void	addContextObject (const regIOobject *)
	Add the object to the context.
void	removeContextObject (const word &name)
	Remove the object from the context.
void	removeContextObject (const regIOobject *)
	Remove the object from the context.
const contextObjectTableType &	contextObjects () const noexcept
	Read access to the object context.
contextObjectTableType &	contextObjects () noexcept
	Write access to the object context.
template<class Type>
bool	isFunction (const word &name) const
	Named mapping with given type exists.
template<class Type>
Type	getFunctionValue (const word &name, const scalar x) const
	Evaluate named mapping for the given time/value. Zero for undefined/unknown.
template<class Type>
void	fillFunctionValues (Field< Type > &result, const word &name, const scalarField &input) const
	Fill result with values remapped according to the named Function1.
template<class T>
bool	isLocalVariable (const word &name, bool wantPointData=false, label expectedSize=-1) const
	Test existence of a local variable.
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.
virtual unsigned	parse (const std::string &expr, size_t pos=0, size_t len=std::string::npos)=0
	Execute the parser.
template<class Type>
tmp< Field< Type > >	evaluate (const expressions::exprString &expr, bool wantPointData=false)
	Evaluate the expression and return the field.
template<class Type>
Type	evaluateUniform (const expressions::exprString &expr, bool wantPointData=false)
	Evaluate the expression and return a single value.
void	evaluateVariable (const word &varName, const expressions::exprString &expr)
	Evaluate the expression and save as the specified named variable.
virtual void	evaluateVariableRemote (string remote, const word &varName, const expressions::exprString &expr)
	Evaluate an expression on a remote and save as the specified named variable.
template<class Type>
tmp< Field< Type > >	newField (const Type &val=pTraits< Type >::zero) const
	Return a new field with the size().
template<class Type>
tmp< Field< Type > >	newPointField (const Type &val=pTraits< Type >::zero) const
	Return a new field with the pointSize().
expressions::exprString	readExpression (const word &name)
	Read an expression string (with the current dictionary) and do substitutions.
virtual bool	readDict (const dictionary &dict)
	Read variables, tables etc.
label	setVariableStrings (const dictionary &dict, bool mandatory=false)
	Read "variables" and assigns to the list of expression strings.
Ostream &	writeVariableStrings (Ostream &os, const word &keyword="") const
	Write "variables".
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 wantPointData)
template<class Type>
Foam::tmp< Foam::Field< Type > >	getResult (bool wantPointData)
template<class Type>
const Foam::Function1< Type > *	getFunction1Ptr (const word &name, const HashTable< refPtr< Function1< Type > > > &tbl, wordList *listFailure)
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

Static Public Member Functions
static expressions::exprString	readExpression (const word &name, const dictionary &dict)
	Read an expression string and do substitutions.
static List< expressions::exprString >	readVariableStrings (const dictionary &dict, const word &name="variables", bool mandatory=false)
	Read the list of variable strings.

Protected Member Functions
bool	searchRegistry () const noexcept
bool	searchFiles () const noexcept
bool	cacheReadFields () const noexcept
void	resetTimeReference (const TimeState *ts)
	Reset the time-state reference.
void	resetTimeReference (const TimeState &ts)
	Reset the time-state reference.
void	writeFunctions (Ostream &os) const
	Write scalar/vector Function1 entries in dictionary format.
virtual exprResult &	variable (const word &name)
	Non-const access to the named variable (sub-classes only).
void	fill_random (scalarField &field, label seed=0, const bool gaussian=false) const
	Fill a random field.
virtual bool	update ()
	Update things.
virtual void	updateSpecialVariables (bool force=false)
	Examine current variable values and update stored variables.
virtual exprResult	getRemoteResult (const exprDriver &other) const
	Get the result from another driver.

Static Protected Member Functions
static point	getPositionOfMinimum (const scalarField &vals, const pointField &locs)
	Return the location of the min value.
static point	getPositionOfMaximum (const scalarField &vals, const pointField &locs)
	Return the location of the max value.

Protected Attributes
const dictionary &	dict_
	The dictionary with all input data/specification.
exprResult	result_
	The result.
List< expressions::exprString >	variableStrings_
	Variable definitions, as read from a dictionary.
HashTable< exprResult >	variables_
	The variables table.
HashTable< refPtr< Function1< scalar > > >	scalarFuncs_
	Function1 mappings/timelines (scalar), evaluated at the simulation time or with arbitrary scalars.
HashTable< refPtr< Function1< vector > > >	vectorFuncs_
	Function1 mappings/timelines (vector), evaluated at the simulation time or with arbitrary scalars.
contextObjectTableType	contextObjects_
	Externally defined context fields.
scalar	arg1Value_
	Special-purpose scalar reference argument.
const TimeState *	timeStatePtr_
	Reference to the time-state.
const objectRegistry *	obrPtr_
	Pointer to an object registry (for functions etc).
int	stashedTokenId_
	Internal bookkeeping as "look-behind" parsing context.
bool	debugScanner_
	Request debugging for scanner.
bool	debugParser_
	Request debugging for parser.
bool	allowShadowing_
	Allow variable names to mask field names.
bool	prevIterIsOldTime_
	Use value of previous iteration when oldTime is requested.
searchControls	searchCtrl_
	Registry/disk/caching control.

Detailed Description

Base driver for parsing (field) values.

Largely based on code and ideas from swak4foam

Properties

Property	Description	Required	Default
`variables`	List of variables for expressions	no	()
`functions<scalar>`	Dictionary of scalar Function1	no	{}
`functions<vector>`	Dictionary of vector Function1	no	{}
`allowShadowing`	Allow variables to shadow field names	no	false

Debug Properties

Property	Description	Required	Default
`debug.driver`	Debug level (int) for base driver	no
`debug.scanner`	Add debug for scanner	no	false
`debug.parser`	Add debug for parser	no	false

The functions<scalar> and functions<vector> entries are dictionaries of Foam::Function1 definitions that can either be used to establish a time-varying quantity, to remap a field of scalar values, or both.

Source files

Definition at line 136 of file exprDriver.H.

Member Typedef Documentation

◆ contextObjectTableType

typedef HashTable<const regIOobject*> contextObjectTableType

Externally defined context fields.

Definition at line 158 of file exprDriver.H.

Member Enumeration Documentation

◆ searchControls

enum searchControls

Search/caching controls.

Enumerator
NO_SEARCH
SEARCH_REGISTRY	Search registry before disk.
SEARCH_FILES	Search disk (eg, standalone app).
CACHE_READ_FIELDS	Cache fields read from disk.
DEFAULT_SEARCH

Definition at line 145 of file exprDriver.H.

Constructor & Destructor Documentation

◆ exprDriver() [1/4]

exprDriver ( const exprDriver & )

delete

No copy construct.

References exprDriver().

Referenced by exprDriver(), exprDriver(), exprDriver(), fvExprDriver::fvExprDriver(), fvExprDriver::fvExprDriver(), fvExprDriver::fvExprDriver(), getRemoteResult(), operator=(), parseDriver::parseDriver(), parseDriver::parseDriver(), parseDriver::parseDriver(), setDebugging(), setSearchBehaviour(), and ~exprDriver().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ exprDriver() [2/4]

exprDriver	(	enum searchControls	search = searchControls::DEFAULT_SEARCH,
		const dictionary &	dict = dictionary::null )

explicit

Default construct, and default construct with search preferences.

Definition at line 166 of file exprDriver.C.

References allowShadowing_, arg1Value_, contextObjects_, debugParser_, debugScanner_, dict(), dict_, obrPtr_, prevIterIsOldTime_, result_, scalarFuncs_, Foam::search(), searchCtrl_, stashedTokenId_, timeStatePtr_, variables_, variableStrings_, and vectorFuncs_.

Here is the call graph for this function:

◆ exprDriver() [3/4]

exprDriver	(	const exprDriver &	rhs,
		const dictionary &	dict )

Copy construct with new dictionary reference.

Definition at line 193 of file exprDriver.C.

References allowShadowing_, arg1Value_, contextObjects_, debugParser_, debugScanner_, dict(), dict_, exprDriver(), obrPtr_, prevIterIsOldTime_, result_, Foam::rhs(), scalarFuncs_, searchCtrl_, Foam::shallowCloneFunctions(), stashedTokenId_, timeStatePtr_, variables_, variableStrings_, and vectorFuncs_.

Here is the call graph for this function:

◆ exprDriver() [4/4]

exprDriver ( const dictionary & dict )

explicit

Construct from a dictionary.

Definition at line 230 of file exprDriver.C.

References dict(), exprDriver(), and readDict().

Here is the call graph for this function:

◆ ~exprDriver()

virtual ~exprDriver ( )

virtualdefault

Destructor.

References exprDriver().

Here is the call graph for this function:

Member Function Documentation

◆ searchRegistry()

bool searchRegistry ( ) const

inlineprotectednoexcept

Definition at line 137 of file exprDriverI.H.

References Foam::noexcept, SEARCH_REGISTRY, and searchCtrl_.

Referenced by fvExprDriver::foundField(), fvExprDriver::getFieldClassName(), fvExprDriver::getOrReadFieldImpl(), and setSearchBehaviour().

Here is the caller graph for this function:

◆ searchFiles()

bool searchFiles ( ) const

inlineprotectednoexcept

Definition at line 143 of file exprDriverI.H.

References Foam::noexcept, SEARCH_FILES, and searchCtrl_.

Referenced by fvExprDriver::foundField(), parseDriver::getField(), fvExprDriver::getFieldClassName(), fvExprDriver::getOrReadFieldImpl(), parseDriver::patchInternalField(), parseDriver::patchNeighbourField(), parseDriver::patchNormalField(), and setSearchBehaviour().

Here is the caller graph for this function:

◆ cacheReadFields()

bool cacheReadFields ( ) const

inlineprotectednoexcept

Definition at line 149 of file exprDriverI.H.

References CACHE_READ_FIELDS, Foam::noexcept, and searchCtrl_.

Referenced by fvExprDriver::readAndRegister(), and setSearchBehaviour().

Here is the caller graph for this function:

◆ resetTimeReference() [1/2]

void resetTimeReference ( const TimeState * ts )

protected

Reset the time-state reference.

Definition at line 123 of file exprDriver.C.

References timeStatePtr_.

Referenced by parseDriver::parseDriver(), parseDriver::parseDriver(), parseDriver::parseDriver(), parseDriver::parseDriver(), and parseDriver::parseDriver().

Here is the caller graph for this function:

◆ resetTimeReference() [2/2]

void resetTimeReference ( const TimeState & ts )

protected

Reset the time-state reference.

Definition at line 129 of file exprDriver.C.

References timeStatePtr_.

◆ writeFunctions()

void writeFunctions ( Ostream & os ) const

protected

Write scalar/vector Function1 entries in dictionary format.

Definition at line 215 of file exprDriverFunctions.C.

References dict_, os(), scalarFuncs_, vectorFuncs_, and Foam::writeFuncsImpl().

Referenced by fvExprDriver::writeCommon().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ variable() [1/2]

Foam::expressions::exprResult & variable ( const word & name )

inlineprotectedvirtual

Non-const access to the named variable (sub-classes only).

Reimplemented in fvExprDriver.

Definition at line 56 of file exprDriverI.H.

References Foam::name(), and variables_.

Referenced by parseDriver::getField(), and isLocalVariable().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fill_random()

void fill_random	(	scalarField &	field,
		label	seed = 0,
		const bool	gaussian = false ) const

protected

Fill a random field.

Parameters

field	the field to populate
seed	the seed value. If zero or negative, use as an offset to the current timeIndex (if a time-state is available)
gaussian	generate a Gaussian distribution

Definition at line 28 of file exprDriverFields.C.

References Foam::FieldOps::assign(), field(), TimeState::timeIndex(), and timeState().

Referenced by parseDriver::field_rand().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getPositionOfMinimum()

Foam::point getPositionOfMinimum	(	const scalarField &	vals,
		const pointField &	locs )

staticprotected

Return the location of the min value.

Definition at line 62 of file exprDriverFields.C.

References Foam::FieldOps::findMinData().

Here is the call graph for this function:

◆ getPositionOfMaximum()

Foam::point getPositionOfMaximum	(	const scalarField &	vals,
		const pointField &	locs )

staticprotected

Return the location of the max value.

Definition at line 72 of file exprDriverFields.C.

References Foam::FieldOps::findMaxData().

Here is the call graph for this function:

◆ update()

bool update ( )

protectedvirtual

Update things.

Definition at line 314 of file exprDriver.C.

◆ updateSpecialVariables()

void updateSpecialVariables ( bool force = false )

protectedvirtual

Examine current variable values and update stored variables.

Reimplemented in fvExprDriver.

Definition at line 320 of file exprDriver.C.

◆ getRemoteResult()

Foam::expressions::exprResult getRemoteResult ( const exprDriver & other ) const

protectedvirtual

Get the result from another driver.

Override to allow mapping

Definition at line 361 of file exprDriver.C.

References exprDriver(), exprResult::getUniform(), result(), and size().

Referenced by fvExprDriver::evaluateVariableRemote().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ TypeName()

TypeName ( "exprDriver" )

Runtime type information.

References TypeName().

Referenced by TypeName().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ operator=()

void operator= ( const exprDriver & )

delete

No copy assignment.

References DEFAULT_SEARCH, dict(), exprDriver(), Foam::rhs(), and Foam::search().

Here is the call graph for this function:

◆ size()

virtual label size ( ) const

inlinevirtual

The natural field size for the expression.

Reimplemented in parseDriver, fvExprDriver, parseDriver, and parseDriver.

Definition at line 423 of file exprDriver.H.

References size().

Referenced by getRemoteResult(), newField(), and size().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ pointSize()

virtual label pointSize ( ) const

inlinevirtual

The point field size for the expression.

Reimplemented in parseDriver, fvExprDriver, parseDriver, and parseDriver.

Definition at line 431 of file exprDriver.H.

Referenced by newPointField().

Here is the caller graph for this function:

◆ timeState()

const Foam::TimeState * timeState ( ) const

noexcept

Reference to the current time-state (can be nullptr).

Definition at line 247 of file exprDriver.C.

References Foam::noexcept, obrPtr_, and timeStatePtr_.

Referenced by fill_random().

Here is the caller graph for this function:

◆ timeValue()

Foam::scalar timeValue ( ) const

virtual

The current time value.

Definition at line 261 of file exprDriver.C.

References obrPtr_, and timeStatePtr_.

◆ deltaT()

Foam::scalar deltaT ( ) const

virtual

The current deltaT value.

Definition at line 275 of file exprDriver.C.

References obrPtr_, and timeStatePtr_.

◆ dict()

const dictionary & dict ( ) const

inlinenoexcept

The dictionary with all input data/specification.

Definition at line 455 of file exprDriver.H.

References dict(), dict_, and Foam::noexcept.

Referenced by fvExprDriver::declareRunTimeSelectionTable(), fvExprDriver::declareRunTimeSelectionTable(), dict(), exprDriver(), exprDriver(), exprDriver(), fvExprDriver::fvExprDriver(), fvExprDriver::fvExprDriver(), fvExprDriver::fvExprDriver(), fvExprDriver::getData(), fvExprDriver::getTopoSet(), fvExprDriver::getVariable(), fvExprDriver::New(), fvExprDriver::New(), newPointField(), operator=(), parseDriver::operator=(), parseDriver::parseDriver(), parseDriver::parseDriver(), parseDriver::parseDriver(), parseDriver::parseDriver(), parseDriver::parseDriver(), parseDriver::parseDriver(), parseDriver::parseDriver(), fvExprDriver::prepareData(), readDict(), fvExprDriver::readDict(), parseDriver::readDict(), readExpression(), readVariableStrings(), fvExprDriver::regionMesh(), and setVariableStrings().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ result() [1/2]

const exprResult & result ( ) const

inlinenoexcept

Const access to expression result.

Definition at line 463 of file exprDriver.H.

References Foam::noexcept, and result_.

Referenced by addUniformVariable(), addUniformVariable(), parseDriver::field_cellSelection(), parseDriver::field_faceSelection(), fillFunctionValues(), getRemoteResult(), fvExprDriver::isGlobalVariable(), parseDriver::pointToCell(), parseDriver::setInternalFieldResult(), and parseDriver::setResult().

Here is the caller graph for this function:

◆ result() [2/2]

exprResult & result ( )

inlinenoexcept

Non-const access to expression result.

Definition at line 471 of file exprDriver.H.

References Foam::noexcept, and result_.

◆ clearResult()

void clearResult ( )

Clear the result.

Definition at line 308 of file exprDriver.C.

References result_.

◆ getResult() [1/2]

template<class Type>

tmp< Field< Type > > getResult ( bool wantPointData = false )

Return the expression result as a tmp field.

This also clears the result and associated memory.

Referenced by evaluate().

Here is the caller graph for this function:

◆ getResultType()

const word & getResultType ( ) const

inlinenoexcept

The result type as word - same as result().valueType().

Definition at line 492 of file exprDriver.H.

References Foam::noexcept, and result_.

◆ resetDb() [1/2]

void resetDb ( const objectRegistry * obrPtr = nullptr )

Reset the objectRegistry (for functions).

Definition at line 135 of file exprDriver.C.

References forAllIters, obrPtr_, scalarFuncs_, and vectorFuncs_.

Referenced by parseDriver::parseDriver(), parseDriver::parseDriver(), parseDriver::parseDriver(), parseDriver::parseDriver(), parseDriver::parseDriver(), and resetDb().

Here is the caller graph for this function:

◆ resetDb() [2/2]

void resetDb ( const objectRegistry & db )

Reset the objectRegistry (for functions).

Definition at line 158 of file exprDriver.C.

References resetDb().

Here is the call graph for this function:

◆ argValue()

Foam::scalar argValue ( ) const

inlinenoexcept

Get special-purpose scalar reference argument.

Typically available as arg() in an expression and may correspond to table index, time value etc.

Definition at line 30 of file exprDriverI.H.

References arg1Value_, and Foam::noexcept.

◆ stashedTokenId()

int stashedTokenId ( ) const

inlinenoexcept

Get "look-behind" parsing context (internal bookkeeping).

Definition at line 108 of file exprDriverI.H.

References Foam::noexcept, and stashedTokenId_.

◆ resetStashedTokenId()

int resetStashedTokenId ( int tokenId = 0 ) const

inlinenoexcept

Reset "look-behind" parsing context (mutable operation).

Returns: the previous value

Definition at line 114 of file exprDriverI.H.

References stashedTokenId_.

◆ setDebugging() [1/2]

void setDebugging	(	bool	scannerDebug,
		bool	parserDebug )

Set the scanner/parser debug.

Definition at line 484 of file exprDriver.C.

References debugParser_, and debugScanner_.

◆ setDebugging() [2/2]

void setDebugging ( const exprDriver & rhs )

Set the scanner/parser debug to match the input.

Definition at line 495 of file exprDriver.C.

References debugParser_, debugScanner_, exprDriver(), and Foam::rhs().

Here is the call graph for this function:

◆ setCaching()

bool setCaching ( bool on )

noexcept

Toggle CACHE_READ_FIELDS control.

Definition at line 505 of file exprDriver.C.

References CACHE_READ_FIELDS, SEARCH_FILES, SEARCH_REGISTRY, and searchCtrl_.

◆ setSearchBehaviour() [1/2]

void setSearchBehaviour	(	enum searchControls	search,
		const bool	caching = false )

Set search behaviour, with additional CACHE_READ_FIELDS toggle on.

Definition at line 533 of file exprDriver.C.

References CACHE_READ_FIELDS, cacheReadFields(), Foam::Info, Foam::nl, Foam::search(), SEARCH_FILES, SEARCH_REGISTRY, searchCtrl_, searchFiles(), and searchRegistry().

Here is the call graph for this function:

◆ setSearchBehaviour() [2/2]

void setSearchBehaviour ( const exprDriver & rhs )

Set search behaviour to be identical to rhs.

Definition at line 561 of file exprDriver.C.

References exprDriver(), Foam::rhs(), and searchCtrl_.

Here is the call graph for this function:

◆ debugScanner()

bool debugScanner ( ) const

inlinenoexcept

Read access to scanner debug.

Definition at line 125 of file exprDriverI.H.

References debugScanner_, and Foam::noexcept.

Referenced by parseDriver::parse().

Here is the caller graph for this function:

◆ debugParser()

bool debugParser ( ) const

inlinenoexcept

Read access to parser debug.

Definition at line 131 of file exprDriverI.H.

References debugParser_, and Foam::noexcept.

◆ prevIterIsOldTime()

bool prevIterIsOldTime ( ) const

inline

Definition at line 577 of file exprDriver.H.

References prevIterIsOldTime(), and prevIterIsOldTime_.

Referenced by prevIterIsOldTime().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ clearVariables()

void clearVariables ( )

virtual

Clear temporary variables, reset from expression strings.

Reimplemented in fvExprDriver.

Definition at line 324 of file exprDriver.C.

References addVariables(), variables_, and variableStrings_.

Referenced by addVariables(), and addVariables().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setArgument()

void setArgument ( const scalar val )

inlinenoexcept

Set special-purpose scalar reference argument.

Typically available as arg() in an expression and may corrspond to table index, time value etc.

Definition at line 24 of file exprDriverI.H.

References arg1Value_.

◆ hasVariable()

bool hasVariable ( const word & name ) const

inlinevirtual

True if named variable exists.

Reimplemented in fvExprDriver.

Definition at line 36 of file exprDriverI.H.

References Foam::name(), and variables_.

Referenced by parseDriver::getField(), and isLocalVariable().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ variable() [2/2]

const Foam::expressions::exprResult & variable ( const word & name ) const

inlinevirtual

Return const-access to the named variable.

Reimplemented in fvExprDriver.

Definition at line 46 of file exprDriverI.H.

References Foam::name(), and variables_.

Here is the call graph for this function:

◆ addVariables() [1/2]

void addVariables	(	const expressions::exprString &	expr,
		bool	clear = true )

Add/set string expressions for variables.

Can include multiple definitions inline

Parameters

clear Remove previously defined variables

Definition at line 371 of file exprDriver.C.

References clear(), clearVariables(), dict_, evaluateVariable(), evaluateVariableRemote(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::FatalIOError, FatalIOErrorInFunction, Foam::stringOps::inplaceTrim(), Foam::nl, Foam::stringOps::split(), exprString::toExpr(), Foam::stringOps::trim(), and word::validate().

Referenced by addVariables(), clearVariables(), and fvExprDriver::clearVariables().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addVariables() [2/2]

void addVariables	(	const UList< expressions::exprString > &	list,
		bool	clear = true )

Add/set string expressions for variables.

Can include multiple definitions inline

Parameters

clear Remove previously defined variables

Definition at line 466 of file exprDriver.C.

References addVariables(), clear(), and clearVariables().

Here is the call graph for this function:

◆ addUniformVariable() [1/2]

template<class T>

void addUniformVariable	(	const word &	name,
		const T &	val )

inline

Add a uniform variable from an outside caller.

References contextObjects(), fillFunctionValues(), getFunctionValue(), isFunction(), isLocalVariable(), Foam::name(), Foam::noexcept, result(), Foam::T(), and x.

Here is the call graph for this function:

◆ hasContextObjects()

bool hasContextObjects ( ) const

inline

True if any context fields are defined.

Definition at line 23 of file exprDriverContextI.H.

References contextObjects_.

◆ cfindContextIOobject()

const Foam::regIOobject * cfindContextIOobject ( const word & name ) const

inline

Find named context field, if it exists.

Definition at line 30 of file exprDriverContextI.H.

References contextObjects_, and Foam::name().

Referenced by cfindContextObject(), fvExprDriver::foundField(), parseDriver::getField(), parseDriver::patchInternalField(), parseDriver::patchNeighbourField(), and parseDriver::patchNormalField().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ cfindContextObject()

template<class ObjType>

const ObjType * cfindContextObject ( const word & name ) const

Find context field object of specified type.

Returns: nullptr if not found

Definition at line 106 of file exprDriverContextI.H.

References cfindContextIOobject(), and Foam::name().

Referenced by fvExprDriver::getOrReadFieldImpl().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addContextObject() [1/2]

void addContextObject	(	const word &	name,
		const regIOobject *	objptr )

inline

Add the object to the context.

Definition at line 40 of file exprDriverContextI.H.

References contextObjects_, and Foam::name().

Referenced by addContextObject().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addContextObject() [2/2]

void addContextObject ( const regIOobject * objptr )

inline

Add the object to the context.

Definition at line 57 of file exprDriverContextI.H.

References addContextObject(), and IOobject::name().

Here is the call graph for this function:

◆ removeContextObject() [1/2]

void removeContextObject ( const word & name )

inline

Remove the object from the context.

Definition at line 69 of file exprDriverContextI.H.

References contextObjects_, and Foam::name().

Here is the call graph for this function:

◆ removeContextObject() [2/2]

void removeContextObject ( const regIOobject * objptr )

inline

Remove the object from the context.

Definition at line 78 of file exprDriverContextI.H.

References contextObjects_, and IOobject::name().

Here is the call graph for this function:

◆ contextObjects() [1/2]

const Foam::HashTable< const Foam::regIOobject * > & contextObjects ( ) const

inlinenoexcept

Read access to the object context.

Definition at line 91 of file exprDriverContextI.H.

References contextObjects_, and Foam::noexcept.

Referenced by addUniformVariable().

Here is the caller graph for this function:

◆ contextObjects() [2/2]

Foam::HashTable< const Foam::regIOobject * > & contextObjects ( )

inlinenoexcept

Write access to the object context.

Definition at line 98 of file exprDriverContextI.H.

References contextObjects_, and Foam::noexcept.

◆ isFunction()

template<class Type>

bool isFunction ( const word & name ) const

Named mapping with given type exists.

Definition at line 72 of file exprDriverTemplates.C.

References doLocalCode, Foam::name(), scalarFuncs_, and vectorFuncs_.

Referenced by addUniformVariable().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getFunctionValue()

template<class Type>

Type getFunctionValue	(	const word &	name,
		const scalar	x ) const

Evaluate named mapping for the given time/value. Zero for undefined/unknown.

Definition at line 97 of file exprDriverTemplates.C.

References doLocalCode, UList< T >::empty(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::flatOutput(), Foam::name(), Foam::nl, scalarFuncs_, Function1< Type >::value(), vectorFuncs_, and x.

Referenced by addUniformVariable().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fillFunctionValues()

template<class Type>

void fillFunctionValues	(	Field< Type > &	result,
		const word &	name,
		const scalarField &	input ) const

Fill result with values remapped according to the named Function1.

Definition at line 150 of file exprDriverTemplates.C.

References doLocalCode, UList< T >::empty(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::flatOutput(), Foam::min(), Foam::name(), Foam::nl, result(), scalarFuncs_, UList< T >::size(), Function1< Type >::value(), vectorFuncs_, and Foam::Zero.

Referenced by addUniformVariable().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isLocalVariable()

template<class Type>

bool isLocalVariable	(	const word &	name,
		bool	wantPointData = false,
		label	expectedSize = -1 ) const

Test existence of a local variable.

Definition at line 221 of file exprDriverTemplates.C.

References DebugInfo, Foam::endl(), hasVariable(), Foam::Info, exprResult::isPointData(), exprResult::isType(), Foam::name(), Foam::returnReduceAnd(), exprResult::size(), exprResult::valueType(), and variable().

Referenced by addUniformVariable(), and fvExprDriver::isVariable().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getLocalVariable()

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.

Parameters

name	The name of the local/global field
expectSize	The size check on the variable, -1 to ignore
mandatory	A missing variable is Fatal, or return an invalid tmp

References getLocalVariable(), and Foam::name().

Referenced by getLocalVariable().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ parse()

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

pure virtual

Execute the parser.

The return value currently has no meaning.

Implemented in parseDriver, parseDriver, and parseDriver.

References parse(), and Foam::pos().

Referenced by evaluate(), evaluateUniform(), evaluateVariable(), fvExprDriver::evaluateVariable(), parse(), and fvExprDriver::updateSpecialVariables().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ evaluate() [1/2]

template<class Type>

tmp< Field< Type > > evaluate	(	const expressions::exprString &	expr,
		bool	wantPointData = false )

inline

Evaluate the expression and return the field.

This also clears the result and associated memory.

References evaluate(), evaluateUniform(), evaluateVariable(), and evaluateVariableRemote().

Referenced by evaluate().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ evaluateUniform()

template<class Type>

Type evaluateUniform	(	const expressions::exprString &	expr,
		bool	wantPointData = false )

inline

Evaluate the expression and return a single value.

Does not clear the result.

Definition at line 93 of file exprDriverI.H.

References parse(), and result_.

Referenced by evaluate().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ evaluateVariable()

void evaluateVariable	(	const word &	varName,
		const expressions::exprString &	expr )

Evaluate the expression and save as the specified named variable.

Definition at line 331 of file exprDriver.C.

References DebugInfo, Foam::endl(), parse(), result_, and variables_.

Referenced by addVariables(), and evaluate().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ evaluateVariableRemote()

void evaluateVariableRemote	(	string	remote,
		const word &	varName,
		const expressions::exprString &	expr )

virtual

Evaluate an expression on a remote and save as the specified named variable.

Reimplemented in fvExprDriver.

Definition at line 349 of file exprDriver.C.

References NotImplemented.

Referenced by addVariables(), and evaluate().

Here is the caller graph for this function:

◆ newField() [1/2]

template<class Type>

tmp< Field< Type > > newField ( const Type & val = pTraits< Type >::zero ) const

Return a new field with the size().

References newField().

Referenced by newField().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ newPointField() [1/2]

template<class Type>

tmp< Field< Type > > newPointField ( const Type & val = pTraits< Type >::zero ) const

Return a new field with the pointSize().

References dict(), Foam::name(), newPointField(), os(), readDict(), readExpression(), readVariableStrings(), setVariableStrings(), and writeVariableStrings().

Referenced by newPointField().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ readExpression() [1/2]

Foam::expressions::exprString readExpression	(	const word &	name,
		const dictionary &	dict )

static

Read an expression string and do substitutions.

Definition at line 67 of file exprDriverIO.C.

References dict(), and Foam::name().

Referenced by newPointField().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ readVariableStrings()

Foam::List< Foam::expressions::exprString > readVariableStrings	(	const dictionary &	dict,
		const word &	name = "variables",
		bool	mandatory = false )

static

Read the list of variable strings.

(or initialize with a single string)

Definition at line 88 of file exprDriverIO.C.

References dict(), and Foam::exprTools::getList().

Referenced by newPointField(), readDict(), and setVariableStrings().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ readExpression() [2/2]

Foam::expressions::exprString readExpression ( const word & name )

Read an expression string (with the current dictionary) and do substitutions.

Definition at line 78 of file exprDriverIO.C.

References dict, and Foam::name().

Here is the call graph for this function:

◆ readDict()

bool readDict ( const dictionary & dict )

virtual

Read variables, tables etc.

Also usable for objects not constructed from a dictionary.

Reimplemented in fvExprDriver, and parseDriver.

Definition at line 289 of file exprDriver.C.

References dict(), readVariableStrings(), and variableStrings_.

Referenced by exprDriver(), newPointField(), and fvExprDriver::readDict().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setVariableStrings()

Foam::label setVariableStrings	(	const dictionary &	dict,
		bool	mandatory = false )

Read "variables" and assigns to the list of expression strings.

Returns: the number variable strings read.

Definition at line 99 of file exprDriverIO.C.

References dict(), readVariableStrings(), and variableStrings_.

Referenced by newPointField().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ writeVariableStrings()

Foam::Ostream & writeVariableStrings	(	Ostream &	os,
		const word &	keyword = "" ) const

Write "variables".

Definition at line 111 of file exprDriverIO.C.

References os(), and variableStrings_.

Referenced by newPointField(), and fvExprDriver::writeCommon().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addUniformVariable() [2/2]

template<class Type>

void addUniformVariable	(	const word &	name,
		const Type &	val )

inline

Definition at line 66 of file exprDriverI.H.

References Foam::name(), result(), and variables_.

Here is the call graph for this function:

◆ evaluate() [2/2]

template<class Type>

Foam::tmp< Foam::Field< Type > > evaluate	(	const expressions::exprString &	expr,
		bool	wantPointData )

Definition at line 79 of file exprDriverI.H.

References getResult(), and parse().

Here is the call graph for this function:

◆ getResult() [2/2]

template<class Type>

Foam::tmp< Foam::Field< Type > > getResult ( bool wantPointData )

Definition at line 28 of file exprDriverTemplates.C.

References Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::nl, and result_.

Here is the call graph for this function:

◆ getFunction1Ptr()

template<class Type>

const Foam::Function1< Type > * getFunction1Ptr	(	const word &	name,
		const HashTable< refPtr< Function1< Type > > > &	tbl,
		wordList *	listFailure )

Definition at line 46 of file exprDriverTemplates.C.

References Foam::name().

Here is the call graph for this function:

◆ newField() [2/2]

template<class Type>

Foam::tmp< Foam::Field< Type > > newField ( const Type & val ) const

Definition at line 266 of file exprDriverTemplates.C.

References Foam::New(), and size().

Here is the call graph for this function:

◆ newPointField() [2/2]

template<class Type>

Foam::tmp< Foam::Field< Type > > newPointField ( const Type & val ) const

Definition at line 277 of file exprDriverTemplates.C.

References Foam::New(), and pointSize().

Here is the call graph for this function:

Member Data Documentation

◆ dict_

const dictionary& dict_

protected

The dictionary with all input data/specification.

Definition at line 196 of file exprDriver.H.

Referenced by addVariables(), dict(), exprDriver(), exprDriver(), and writeFunctions().

◆ result_

exprResult result_

protected

The result.

Definition at line 201 of file exprDriver.H.

Referenced by clearResult(), evaluateUniform(), evaluateVariable(), fvExprDriver::evaluateVariable(), exprDriver(), exprDriver(), getResult(), getResultType(), result(), result(), and fvExprDriver::updateSpecialVariables().

◆ variableStrings_

List<expressions::exprString> variableStrings_

protected

Variable definitions, as read from a dictionary.

Definition at line 206 of file exprDriver.H.

Referenced by clearVariables(), fvExprDriver::clearVariables(), exprDriver(), exprDriver(), readDict(), setVariableStrings(), and writeVariableStrings().

◆ variables_

HashTable<exprResult> variables_

protected

The variables table.

Definition at line 211 of file exprDriver.H.

Referenced by addUniformVariable(), clearVariables(), fvExprDriver::clearVariables(), evaluateVariable(), fvExprDriver::evaluateVariable(), fvExprDriver::evaluateVariableRemote(), exprDriver(), exprDriver(), hasVariable(), fvExprDriver::hasVariable(), fvExprDriver::updateSpecialVariables(), variable(), variable(), fvExprDriver::variable(), fvExprDriver::variable(), and fvExprDriver::writeCommon().

◆ scalarFuncs_

HashTable<refPtr<Function1<scalar> > > scalarFuncs_

protected

Function1 mappings/timelines (scalar), evaluated at the simulation time or with arbitrary scalars.

Definition at line 217 of file exprDriver.H.

Referenced by exprDriver(), exprDriver(), fillFunctionValues(), getFunctionValue(), isFunction(), resetDb(), and writeFunctions().

◆ vectorFuncs_

HashTable<refPtr<Function1<vector> > > vectorFuncs_

protected

Function1 mappings/timelines (vector), evaluated at the simulation time or with arbitrary scalars.

Definition at line 223 of file exprDriver.H.

Referenced by exprDriver(), exprDriver(), fillFunctionValues(), getFunctionValue(), isFunction(), resetDb(), and writeFunctions().

◆ contextObjects_

contextObjectTableType contextObjects_

protected

Externally defined context fields.

Definition at line 228 of file exprDriver.H.

Referenced by addContextObject(), cfindContextIOobject(), contextObjects(), contextObjects(), exprDriver(), exprDriver(), hasContextObjects(), removeContextObject(), and removeContextObject().

◆ arg1Value_

scalar arg1Value_

protected

Special-purpose scalar reference argument.

Definition at line 233 of file exprDriver.H.

Referenced by argValue(), exprDriver(), exprDriver(), and setArgument().

◆ timeStatePtr_

const TimeState* timeStatePtr_

mutableprotected

Reference to the time-state.

Definition at line 238 of file exprDriver.H.

Referenced by deltaT(), exprDriver(), exprDriver(), resetTimeReference(), resetTimeReference(), timeState(), and timeValue().

◆ obrPtr_

const objectRegistry* obrPtr_

protected

Pointer to an object registry (for functions etc).

Definition at line 243 of file exprDriver.H.

Referenced by deltaT(), exprDriver(), exprDriver(), resetDb(), timeState(), and timeValue().

◆ stashedTokenId_

int stashedTokenId_

mutableprotected

Internal bookkeeping as "look-behind" parsing context.

Definition at line 251 of file exprDriver.H.

Referenced by exprDriver(), exprDriver(), resetStashedTokenId(), and stashedTokenId().

◆ debugScanner_

bool debugScanner_

protected

Request debugging for scanner.

Definition at line 256 of file exprDriver.H.

Referenced by debugScanner(), exprDriver(), exprDriver(), setDebugging(), and setDebugging().

◆ debugParser_

bool debugParser_

protected

Request debugging for parser.

Definition at line 261 of file exprDriver.H.

Referenced by debugParser(), exprDriver(), exprDriver(), setDebugging(), and setDebugging().

◆ allowShadowing_

bool allowShadowing_

protected

Allow variable names to mask field names.

Definition at line 266 of file exprDriver.H.

Referenced by fvExprDriver::evaluateVariable(), exprDriver(), and exprDriver().

◆ prevIterIsOldTime_

bool prevIterIsOldTime_

protected

Use value of previous iteration when oldTime is requested.

Definition at line 271 of file exprDriver.H.

Referenced by exprDriver(), exprDriver(), and prevIterIsOldTime().

◆ searchCtrl_

searchControls searchCtrl_

protected

Registry/disk/caching control.

Definition at line 276 of file exprDriver.H.

Referenced by cacheReadFields(), exprDriver(), exprDriver(), searchFiles(), searchRegistry(), setCaching(), setSearchBehaviour(), and setSearchBehaviour().

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

src/OpenFOAM/expressions/exprDriver/exprDriver.H
src/OpenFOAM/expressions/exprDriver/exprDriver.C
src/OpenFOAM/expressions/exprDriver/exprDriverContextI.H
src/OpenFOAM/expressions/exprDriver/exprDriverFields.C
src/OpenFOAM/expressions/exprDriver/exprDriverFunctions.C
src/OpenFOAM/expressions/exprDriver/exprDriverI.H
src/OpenFOAM/expressions/exprDriver/exprDriverIO.C
src/OpenFOAM/expressions/exprDriver/exprDriverTemplates.C

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ contextObjectTableType

Member Enumeration Documentation

◆ searchControls

Constructor & Destructor Documentation

◆ exprDriver() [1/4]

◆ exprDriver() [2/4]

◆ exprDriver() [3/4]

◆ exprDriver() [4/4]

◆ ~exprDriver()

Member Function Documentation

◆ searchRegistry()

◆ searchFiles()

◆ cacheReadFields()

◆ resetTimeReference() [1/2]

◆ resetTimeReference() [2/2]

◆ writeFunctions()

◆ variable() [1/2]

◆ fill_random()

◆ getPositionOfMinimum()

◆ getPositionOfMaximum()

◆ update()

◆ updateSpecialVariables()

◆ getRemoteResult()

◆ TypeName()

◆ operator=()

◆ size()

◆ pointSize()

◆ timeState()

◆ timeValue()

◆ deltaT()

◆ dict()

◆ result() [1/2]

◆ result() [2/2]

◆ clearResult()

◆ getResult() [1/2]

◆ getResultType()

◆ resetDb() [1/2]

◆ resetDb() [2/2]

◆ argValue()

◆ stashedTokenId()

◆ resetStashedTokenId()

◆ setDebugging() [1/2]

◆ setDebugging() [2/2]

◆ setCaching()

◆ setSearchBehaviour() [1/2]

◆ setSearchBehaviour() [2/2]

◆ debugScanner()

◆ debugParser()

◆ prevIterIsOldTime()

◆ clearVariables()

◆ setArgument()

◆ hasVariable()

◆ variable() [2/2]

◆ addVariables() [1/2]

◆ addVariables() [2/2]

◆ addUniformVariable() [1/2]

◆ hasContextObjects()

◆ cfindContextIOobject()

◆ cfindContextObject()

◆ addContextObject() [1/2]

◆ addContextObject() [2/2]

◆ removeContextObject() [1/2]

◆ removeContextObject() [2/2]

◆ contextObjects() [1/2]

◆ contextObjects() [2/2]

◆ isFunction()

◆ getFunctionValue()

◆ fillFunctionValues()

◆ isLocalVariable()

◆ getLocalVariable()

◆ parse()

◆ evaluate() [1/2]