PatchFunction1 to lookup volField/surfaceField or pointField from an objectregistry and return its value on the patch. More...

#include <LookupField.H>

Inheritance diagram for LookupField< Type >:

[legend]

Collaboration diagram for LookupField< Type >:

[legend]

Public Member Functions
	TypeName ("lookup")
void	operator= (const LookupField< Type > &)=delete
	No copy assignment.
	LookupField (const polyPatch &pp, const word &redirectType, const word &entryName, const dictionary &dict, const bool faceValues=true)
	Construct from entry name, dictionary and optional registry.
	LookupField (const LookupField< Type > &rhs, const polyPatch &pp)
	Copy construct, setting patch.
	LookupField (const LookupField< Type > &rhs)
	Copy construct.
virtual tmp< PatchFunction1< Type > >	clone () const
	Construct and return a clone.
virtual tmp< PatchFunction1< Type > >	clone (const polyPatch &pp) const
	Return a clone, setting the patch.
virtual	~LookupField ()=default
	Destructor.
virtual bool	uniform () const
	Is value uniform (i.e. independent of coordinate).
virtual tmp< Field< Type > >	value (const scalar x) const
	Return Lookup value.
virtual tmp< Field< Type > >	integrate (const scalar x1, const scalar x2) const
	Integrate between two values.
virtual void	writeData (Ostream &os) const
	Write in dictionary format.
Public Member Functions inherited from PatchFunction1< Type >
	TypeName ("PatchFunction1") declareRunTimeSelectionTable(autoPtr
	Runtime type information.
	PatchFunction1 (const polyPatch &pp, const word &entryName, const bool faceValues=true)
	Construct from polyPatch and entry name.
	PatchFunction1 (const polyPatch &pp, const word &entryName, const dictionary &dict, const bool faceValues=true)
	Construct from polyPatch, dictionary and entry name.
	PatchFunction1 (const PatchFunction1< Type > &rhs, const polyPatch &pp)
	Copy construct setting patch.
	PatchFunction1 (const PatchFunction1< Type > &rhs)
	Copy construct.
virtual	~PatchFunction1 ()=default
	Destructor.
virtual bool	constant () const
	Is value constant (i.e. independent of x).
virtual bool	good () const
	Can function be evaluated?
virtual tmp< pointField >	localPosition (const pointField &globalPos) const
	Helper: optionally convert coordinates to local coordinates.
virtual tmp< Field< Type > >	transform (const Field< Type > &fld) const
	Apply optional transformation.
virtual tmp< Field< Type > >	transform (const tmp< Field< Type > > &tfld) const
	Apply optional transformation.
virtual void	autoMap (const FieldMapper &mapper)
	Map (and resize as needed) from self given a mapping object.
virtual void	rmap (const PatchFunction1< Type > &rhs, const labelList &addr)
	Reverse map the given PatchFunction1 onto this PatchFunction1.
Public Member Functions inherited from patchFunction1Base
	patchFunction1Base (const polyPatch &pp, const word &entryName, const bool faceValues=true)
	Construct from polyPatch and entry name.
	patchFunction1Base (const polyPatch &pp, const word &entryName, const dictionary &dict, const bool faceValues=true)
	Construct from polyPatch, dictionary and entry name.
	patchFunction1Base (const patchFunction1Base &rhs)
	Copy construct.
	patchFunction1Base (const patchFunction1Base &rhs, const polyPatch &pp)
	Copy construct setting patch.
virtual	~patchFunction1Base ()=default
	Destructor.
const word &	name () const noexcept
	The name of the entry.
const polyPatch &	patch () const noexcept
	Reference to the patch.
bool	faceValues () const noexcept
	Generate face or point values on patch?
label	size () const
	Number of faces or points on the patch.
const objectRegistry *	whichDb () const
	Return the associated registry (ie, the mesh).
const objectRegistry &	obr () const
	Return the object registry (ie, the mesh).
const Time &	time () const
	Return false: function not created with time database.
virtual void	userTimeToTime (const Time &t)
	Convert time.
Public Member Functions inherited from refCount
constexpr	refCount () noexcept
	Default construct, initializing count to 0.
int	use_count () const noexcept
	Return the current reference count.
bool	unique () const noexcept
	Return true if the reference count is zero.
void	operator++ () noexcept
	Increment the reference count.
void	operator++ (int) noexcept
	Increment the reference count.
void	operator-- () noexcept
	Decrement the reference count.
void	operator-- (int) noexcept
	Decrement the reference count.

Additional Inherited Members
Public Types inherited from PatchFunction1< Type >
typedef Field< Type >	returnType
	The return type is a field of values.
Static Public Member Functions inherited from PatchFunction1< Type >
template<class Derived>
static tmp< PatchFunction1< Type > >	Clone (const Derived &fun)
	Clone a PatchFunction1.
template<class Derived>
static tmp< PatchFunction1< Type > >	Clone (const Derived &fun, const polyPatch &pp)
	Clone a PatchFunction1 with a patch.
static autoPtr< PatchFunction1< Type > >	New (const polyPatch &pp, const word &entryName, const dictionary &dict, const bool faceValues=true, const bool mandatory=true)
	Selector.
static autoPtr< PatchFunction1< Type > >	NewCompat (const polyPatch &pp, const word &entryName, std::initializer_list< std::pair< const char *, int > > compat, const dictionary &dict, const bool faceValues=true, const bool mandatory=true)
	Compatibility selector.
static autoPtr< PatchFunction1< Type > >	NewIfPresent (const polyPatch &pp, const word &entryName, const dictionary &dict, const bool faceValues=true)
	An optional selector.
static refPtr< PatchFunction1< Type > >	New (HashPtrTable< PatchFunction1< Type > > &cache, const polyPatch &pp, const word &entryName, const dictionary &dict, enum keyType::option matchOpt=keyType::LITERAL, const bool faceValues=true, const bool mandatory=true)
	Selector with external storage. This also allows wildcard matches in a dictionary.
Public Attributes inherited from PatchFunction1< Type >
	PatchFunction1
	dictionary
const polyPatch &	pp
const polyPatch const word &	type
const polyPatch const word const word &	entryName
const polyPatch const word const word const dictionary &	dict
const polyPatch const word const word const dictionary const bool	faceValues
const polyPatch const word const word const dictionary const bool	pp
const polyPatch const word const word const dictionary const bool	type
const polyPatch const word const word const dictionary const bool	entryName
const polyPatch const word const word const dictionary const bool	dict
Protected Member Functions inherited from PatchFunction1< Type >
void	operator= (const PatchFunction1< Type > &)=delete
	No copy assignment.
Protected Member Functions inherited from patchFunction1Base
void	operator= (const patchFunction1Base &)=delete
	No copy assignment.
Protected Member Functions inherited from lookupBase
void	operator= (const lookupBase &)=delete
	No copy assignment.
	lookupBase (const dictionary &dict)
	Construct from dictionary.
	lookupBase (const lookupBase &rhs)
	Copy construct.
virtual	~lookupBase ()=default
	Destructor.
virtual void	writeEntries (Ostream &os) const
	Write coefficient entries in dictionary format.
Protected Attributes inherited from PatchFunction1< Type >
coordinateScaling< Type >	coordSys_
	Optional local coordinate system and scaling.
Protected Attributes inherited from patchFunction1Base
const word	name_
	Name of entry.
const polyPatch &	patch_
	Reference to the patch.
const bool	faceValues_
	Generate face or point values on patch.
Protected Attributes inherited from lookupBase
word	name_
	Key of object.

Detailed Description

template<class Type>
class Foam::PatchFunction1Types::LookupField< Type >

PatchFunction1 to lookup volField/surfaceField or pointField from an objectregistry and return its value on the patch.

The dictionary specification would typically resemble this:

entry
{
    type        lookup;
    name        myField;
}

where the entries mean:

Property	Description	Type	Reqd	Default
`type`	Function type: lookup	word	yes
`name`	name of volField/pointField	word	yes

Source files

Definition at line 85 of file LookupField.H.

Constructor & Destructor Documentation

◆ LookupField() [1/3]

template<class Type>

LookupField	(	const polyPatch &	pp,
		const word &	redirectType,
		const word &	entryName,
		const dictionary &	dict,
		const bool	faceValues = true )

Construct from entry name, dictionary and optional registry.

Definition at line 32 of file LookupField.C.

References PatchFunction1< Type >::dict, PatchFunction1< Type >::dictionary, PatchFunction1< Type >::entryName, PatchFunction1< Type >::faceValues, lookupBase::lookupBase(), PatchFunction1< Type >::PatchFunction1, and PatchFunction1< Type >::pp.

Referenced by clone(), LookupField(), LookupField(), and operator=().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ LookupField() [2/3]

template<class Type>

LookupField	(	const LookupField< Type > &	rhs,
		const polyPatch &	pp )

explicit

Copy construct, setting patch.

Definition at line 47 of file LookupField.C.

References lookupBase::lookupBase(), LookupField(), PatchFunction1< Type >::PatchFunction1, PatchFunction1< Type >::pp, and Foam::rhs().

Here is the call graph for this function:

◆ LookupField() [3/3]

template<class Type>

LookupField ( const LookupField< Type > & rhs )

explicit

Copy construct.

Definition at line 59 of file LookupField.C.

References LookupField(), patchFunction1Base::patch(), and Foam::rhs().

Here is the call graph for this function:

◆ ~LookupField()

template<class Type>

virtual ~LookupField ( )

virtualdefault

Destructor.

Member Function Documentation

◆ TypeName()

template<class Type>

TypeName ( "lookup" )

◆ operator=()

template<class Type>

void operator= ( const LookupField< Type > & )

delete

No copy assignment.

References PatchFunction1< Type >::dict, PatchFunction1< Type >::dictionary, PatchFunction1< Type >::entryName, PatchFunction1< Type >::faceValues, LookupField(), PatchFunction1< Type >::pp, and Foam::rhs().

Here is the call graph for this function:

◆ clone() [1/2]

template<class Type>

virtual tmp< PatchFunction1< Type > > clone ( ) const

inlinevirtual

Construct and return a clone.

Implements PatchFunction1< Type >.

Definition at line 137 of file LookupField.H.

References LookupField().

Here is the call graph for this function:

◆ clone() [2/2]

template<class Type>

virtual tmp< PatchFunction1< Type > > clone ( const polyPatch & pp ) const

inlinevirtual

Return a clone, setting the patch.

Implements PatchFunction1< Type >.

Definition at line 145 of file LookupField.H.

References PatchFunction1< Type >::Clone(), and PatchFunction1< Type >::pp.

Here is the call graph for this function:

◆ uniform()

template<class Type>

virtual bool uniform ( ) const

inlinevirtual

Is value uniform (i.e. independent of coordinate).

Implements PatchFunction1< Type >.

Definition at line 162 of file LookupField.H.

◆ value()

template<class Type>

Foam::tmp< Foam::Field< Type > > value ( const scalar x ) const

virtual

Return Lookup value.

Reimplemented from PatchFunction1< Type >.

Definition at line 72 of file LookupField.C.

References objectRegistry::cfindIOobject(), Foam::exit(), PatchFunction1< Type >::faceValues, Foam::FatalError, FatalErrorInFunction, patchIdentifier::index(), objectRegistry::lookupObject(), IOobject::name(), lookupBase::name_, objectRegistry::names(), Foam::nl, Field< Type >::null(), patchFunction1Base::obr(), objectRegistry::parent(), patchFunction1Base::patch(), patchFunction1Base::size(), and x.

Referenced by integrate().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ integrate()

template<class Type>

Foam::tmp< Foam::Field< Type > > integrate	(	const scalar	x1,
		const scalar	x2 ) const

virtual

Integrate between two values.

Reimplemented from PatchFunction1< Type >.

Definition at line 167 of file LookupField.C.

References value().

Here is the call graph for this function:

◆ writeData()

template<class Type>

void writeData ( Ostream & os ) const

virtual

Write in dictionary format.

Reimplemented from PatchFunction1< Type >.

Definition at line 178 of file LookupField.C.

References Ostream::beginBlock(), name, os(), Foam::type(), PatchFunction1< Type >::writeData(), and lookupBase::writeEntries().

Here is the call graph for this function:

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

src/finiteVolume/expressions/PatchFunction1/lookup/LookupField.H
src/finiteVolume/expressions/PatchFunction1/lookup/LookupField.C

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ LookupField() [1/3]

◆ LookupField() [2/3]

◆ LookupField() [3/3]

◆ ~LookupField()

Member Function Documentation

◆ TypeName()

◆ operator=()

◆ clone() [1/2]

◆ clone() [2/2]

◆ uniform()

◆ value()

◆ integrate()

◆ writeData()