Inheritance diagram for exprResultStored:

Collaboration diagram for exprResultStored:

Public Member Functions
	TypeNameNoDebug ("exprResultStored")
	Runtime type information. More...

	exprResultStored ()
	Default construct. More...

	exprResultStored (const exprResultStored &rhs)
	Copy construct. More...

	exprResultStored (const dictionary &dict)
	Construct from a dictionary. More...

virtual autoPtr< exprResult >	clone () const
	Clone. More...

virtual	~exprResultStored ()=default
	Destructor. More...

const word &	name () const
	The name of the expression. More...

const expressions::exprString &	initialValueExpression () const
	The initial value expression. More...

void	writeDict (Ostream &os) const

void	operator= (const exprResultStored &rhs)
	Copy assignment. More...

void	operator= (const exprResult &rhs)
	Copy assignment. More...

bool	operator!= (const exprResultStored &rhs) const noexcept
	Compare for inequality (need by Ulist) More...

Public Member Functions inherited from exprResult
	TypeName ("exprResult")
	Runtime type information. More...

	declareRunTimeSelectionTable (autoPtr, exprResult, dictionary,(const dictionary &dict),(dict))

	declareRunTimeSelectionTable (autoPtr, exprResult, empty,(),())

	exprResult ()
	Default construct. More...

	exprResult (const exprResult &expr)
	Copy construct. More...

	exprResult (exprResult &&expr)
	Move construct. More...

	exprResult (const dictionary &dict, const bool singleValueOnly=false, const bool valueReqd=false)
	Construct from a dictionary. More...

	exprResult (Istream &is)
	Construct from Istream as dictionary content. More...

template<class Type >
	exprResult (const Field< Type > &fld)
	Construct by copying a field. More...

template<class Type >
	exprResult (Field< Type > &&fld)
	Construct by moving a field. More...

template<class Type >
	exprResult (autoPtr< Type > &&obj)
	Construct for an IOobject. More...

template<class Type >
	exprResult (const dimensioned< Type > &dt)
	Construct from a dimensioned value. More...

	exprResult (const bool &val)
	Construct from single value of bool. More...

	exprResult (const scalar &val)
	Construct from single value of scalar. More...

	exprResult (const vector &val)
	Construct from single value of vector. More...

	exprResult (const tensor &val)
	Construct from single value of tensor. More...

	exprResult (const symmTensor &val)
	Construct from single value of symmTensor. More...

	exprResult (const sphericalTensor &val)
	Construct from single value of sphericalTensor. More...

virtual	~exprResult ()
	Destructor. More...

bool	hasValue () const
	Has a value? More...

const word &	valueType () const noexcept
	Basic type for the field or single value. More...

bool	isPointData (const bool wantPointData=true) const
	True if representing point data, or test for same value as wantPointData argument. More...

bool	isUniform () const
	True if single, uniform value. More...

template<class Type >
bool	isType () const
	True if valueType corresponds to the given Type. More...

template<class Type >
Type	getValue () const
	Return a single value when isUniform() is true, or Zero when it is non-uniform or if the type mismatches, which means that it can generally be considered as failsafe. More...

template<class Type >
const Field< Type > *	getField () const
	Return a read pointer to the field data if the type matches, nullptr otherwise. Can generally be considered as failsafe. More...

bool	is_bool () const
	True if valueType is a bool. More...

label	size () const
	The field or object size. More...

const void *	dataAddress () const
	The address of the field data content. More...

void	clear ()
	Clear (zero) the result. More...

void	noReset () noexcept
	Change reset behaviour. More...

void	allowReset () noexcept
	Change reset behaviour. More...

void	testIfSingleValue (const bool parRun=Pstream::parRun())
	Test if field corresponds to a single-value and thus uniform. More...

template<class Type >
void	setResult (Field< Type > *, bool wantPointData=false)
	Set result field, taking ownership of the pointer. More...

template<class Type >
void	setResult (const Field< Type > &, bool wantPointData=false)
	Set result field, taking copy of the field contents. More...

template<class Type >
void	setResult (Field< Type > &&, bool wantPointData=false)
	Set result field, moving field contents. More...

template<class Type >
void	setResult (const Type &val, const label size)
	Set uniform result field of given size. More...

template<class Type >
void	setSingleValue (const Type &val)
	Set single-value uniform result. More...

template<class Type >
const Field< Type > &	cref () const
	Return const reference to the field. More...

template<class Type >
Field< Type > &	ref ()
	Return non-const reference to the field. More...

template<class Type >
Field< Type > &	constCast () const
	Return non-const reference to the field, casting away constness. More...

template<class Type >
tmp< Field< Type > >	getResult (bool cacheCopy=false)
	Return tmp field of the contents, optionally keeping a copy in cache. More...

exprResult	getUniform (const label size, const bool noWarn, const bool parRun=Pstream::parRun()) const
	Construct a uniform field from the current results. More...

template<template< class > class BinaryOp, class Type >
Type	getReduced (const BinaryOp< Type > &bop, const Type &initial=pTraits< Type >::zero)
	Get a reduced result. More...

void	writeEntry (const word &keyword, Ostream &os) const
	Forwarding to Field::writeEntry. More...

void	writeDict (Ostream &os, const bool subDict=true) const
	Write entry as dictionary contents. More...

void	writeField (Ostream &os, const word &keyword="") const
	Write the field, optionally as an entry. More...

void	writeValue (Ostream &os) const
	Write the single value, or the first value from field. More...

virtual void	operator= (exprResult &&rhs)
	Move assignment. More...

exprResult &	operator*= (const scalar &b)
	Scalar multiplication. More...

exprResult &	operator+= (const exprResult &b)
	Addition of results. More...

template<class Type >
const Foam::Field< Type > *	getField () const

template<class Type >
Foam::tmp< Foam::Field< Type > >	getResult (bool cacheCopy)

template<class Type >
const Foam::Field< Type > &	cref () const

template<class Type >
Foam::Field< Type > &	ref ()

template<class Type >
Foam::Field< Type > &	constCast () const

Protected Member Functions
virtual void	resetImpl ()
	Reset at new timestep - disabling locally. More...

Protected Member Functions inherited from exprResult
virtual expressions::exprResult &	target ()
	Simulate virtual templated methods. More...

bool	reset (bool force=false)
	Reset at new timestep according to type. More...

void	needsReset (bool val)
	Adjusts the internal needsReset value. More...

Additional Inherited Members
Static Public Member Functions inherited from exprResult
static autoPtr< exprResult >	New (const dictionary &dict)
	Return a reference to the selected value driver. More...

static autoPtr< exprResult >	New (Istream &is)
	Construct from Istream as dictionary content. More...

Static Public Attributes inherited from exprResult
static const exprResult	null
	An empty result. More...

Detailed Description

An exprResult with persistence.

Dictionary parameters

Property	Description	Required
`name`	The result name	yes
`initialValue`	The initial value	yes
`value`	The expression result (dictionary)	no

Source files

Definition at line 78 of file exprResultStored.H.

Constructor & Destructor Documentation

◆ exprResultStored() [1/3]

exprResultStored ( )

Default construct.

Definition at line 52 of file exprResultStored.C.

Referenced by exprResultStored::clone().

Here is the caller graph for this function:

◆ exprResultStored() [2/3]

exprResultStored ( const exprResultStored & rhs )

Copy construct.

Definition at line 61 of file exprResultStored.C.

◆ exprResultStored() [3/3]

exprResultStored ( const dictionary & dict )

explicit

Construct from a dictionary.

Definition at line 72 of file exprResultStored.C.

◆ ~exprResultStored()

virtual ~exprResultStored ( )

virtualdefault

Destructor.

Member Function Documentation

◆ resetImpl()

virtual void resetImpl ( )

inlineprotectedvirtual

Reset at new timestep - disabling locally.

Reimplemented from exprResult.

Definition at line 102 of file exprResultStored.H.

◆ TypeNameNoDebug()

TypeNameNoDebug ( "exprResultStored" )

Runtime type information.

◆ clone()

virtual autoPtr<exprResult> clone ( ) const

inlinevirtual

Clone.

Reimplemented from exprResult.

Definition at line 133 of file exprResultStored.H.

References exprResultStored::exprResultStored().

Here is the call graph for this function:

◆ name()

const word& name ( ) const

inline

The name of the expression.

Definition at line 153 of file exprResultStored.H.

◆ initialValueExpression()

const expressions::exprString& initialValueExpression ( ) const

inline

The initial value expression.

Definition at line 161 of file exprResultStored.H.

◆ writeDict()

void writeDict ( Ostream & os ) const

Definition at line 84 of file exprResultStored.C.

References os().

Here is the call graph for this function:

◆ operator=() [1/2]

void operator= ( const exprResultStored & rhs )

Copy assignment.

Definition at line 101 of file exprResultStored.C.

References exprResult::operator=().

Here is the call graph for this function:

◆ operator=() [2/2]

void operator= ( const exprResult & rhs )

virtual

Copy assignment.

Reimplemented from exprResult.

Definition at line 118 of file exprResultStored.C.

References exprResult::operator=().

Here is the call graph for this function:

◆ operator!=()

bool operator!= ( const exprResultStored & rhs ) const

inlinenoexcept

Compare for inequality (need by Ulist)

Definition at line 185 of file exprResultStored.H.

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

src/OpenFOAM/expressions/exprResult/exprResultStored.H
src/OpenFOAM/expressions/exprResult/exprResultStored.C

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ exprResultStored() [1/3]

◆ exprResultStored() [2/3]

◆ exprResultStored() [3/3]

◆ ~exprResultStored()

Member Function Documentation

◆ resetImpl()

◆ TypeNameNoDebug()

◆ clone()

◆ name()

◆ initialValueExpression()

◆ writeDict()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator!=()