Constructs on-the-fly a new boundary condition (derived from fixedValuePointPatchField) which is then used to evaluate. More...

Inheritance diagram for codedFixedValuePointPatchField< Type >:

[legend]

Collaboration diagram for codedFixedValuePointPatchField< Type >:

[legend]

Public Member Functions
	TypeName ("codedFixedValue")
	Runtime type information. More...

	codedFixedValuePointPatchField (const pointPatch &, const DimensionedField< Type, pointMesh > &)
	Construct from patch and internal field. More...

	codedFixedValuePointPatchField (const pointPatch &, const DimensionedField< Type, pointMesh > &, const dictionary &, const bool valueRequired=true)
	Construct from patch, internal field and dictionary. More...

	codedFixedValuePointPatchField (const codedFixedValuePointPatchField< Type > &, const pointPatch &, const DimensionedField< Type, pointMesh > &, const pointPatchFieldMapper &)
	Construct by mapping given codedFixedValuePointPatchField. More...

	codedFixedValuePointPatchField (const codedFixedValuePointPatchField< Type > &)
	Construct as copy. More...

virtual autoPtr< pointPatchField< Type > >	clone () const
	Construct and return a clone. More...

	codedFixedValuePointPatchField (const codedFixedValuePointPatchField< Type > &, const DimensionedField< Type, pointMesh > &)
	Construct as copy setting internal field reference. More...

virtual autoPtr< pointPatchField< Type > >	clone (const DimensionedField< Type, pointMesh > &iF) const
	Construct and return a clone setting internal field reference. More...

const pointPatchField< Type > &	redirectPatchField () const
	Get reference to the underlying patch. More...

virtual void	updateCoeffs ()
	Update the coefficients associated with the patch field. More...

virtual void	evaluate (const Pstream::commsTypes commsType=Pstream::commsTypes::blocking)
	Evaluate the patch field, sets Updated to false. More...

virtual void	write (Ostream &) const
	Write. More...

Public Member Functions inherited from fixedValuePointPatchField< Type >
	TypeName ("fixedValue")
	Runtime type information. More...

	fixedValuePointPatchField (const pointPatch &, const DimensionedField< Type, pointMesh > &)
	Construct from patch and internal field. More...

	fixedValuePointPatchField (const pointPatch &, const DimensionedField< Type, pointMesh > &, const dictionary &, const bool valueRequired=true)
	Construct from patch, internal field and dictionary. More...

	fixedValuePointPatchField (const fixedValuePointPatchField< Type > &, const pointPatch &, const DimensionedField< Type, pointMesh > &, const pointPatchFieldMapper &)
	Construct by mapping given patchField<Type> onto a new patch. More...

	fixedValuePointPatchField (const fixedValuePointPatchField< Type > &, const DimensionedField< Type, pointMesh > &)
	Construct as copy setting internal field reference. More...

virtual bool	fixesValue () const
	Return true if this patch field fixes a value. More...

virtual void	operator= (const Field< Type > &)

virtual void	operator= (const Type &)

Public Member Functions inherited from valuePointPatchField< Type >
	TypeName ("value")
	Declare type-name, virtual type (with debug switch) More...

	valuePointPatchField (const valuePointPatchField &)=default
	Copy construct. More...

	valuePointPatchField (const pointPatch &, const DimensionedField< Type, pointMesh > &)
	Construct from patch and internal field. More...

	valuePointPatchField (const pointPatch &, const DimensionedField< Type, pointMesh > &, const dictionary &, const bool valueRequired=true)
	Construct from patch, internal field and dictionary. More...

	valuePointPatchField (const valuePointPatchField< Type > &, const pointPatch &, const DimensionedField< Type, pointMesh > &, const pointPatchFieldMapper &)
	Construct by mapping given patchField<Type> onto a new patch. More...

	valuePointPatchField (const valuePointPatchField< Type > &, const DimensionedField< Type, pointMesh > &)
	Construct as copy setting internal field reference. More...

label	size () const
	Return size. More...

virtual void	autoMap (const pointPatchFieldMapper &)
	Map (and resize as needed) from self given a mapping object. More...

virtual void	rmap (const pointPatchField< Type > &, const labelList &)
	Reverse map the given PointPatchField onto. More...

virtual void	operator= (const valuePointPatchField< Type > &)

virtual void	operator= (const pointPatchField< Type > &)

virtual void	operator== (const valuePointPatchField< Type > &)

virtual void	operator== (const pointPatchField< Type > &)

virtual void	operator== (const Field< Type > &)

virtual void	operator== (const Type &)

Public Member Functions inherited from pointPatchField< Type >
	TypeName ("pointPatchField")
	Runtime type information. More...

	declareRunTimeSelectionTable (autoPtr, pointPatchField, pointPatch,(const pointPatch &p, const DimensionedField< Type, pointMesh > &iF),(p, iF))

	declareRunTimeSelectionTable (autoPtr, pointPatchField, patchMapper,(const pointPatchField< Type > &ptf, const pointPatch &p, const DimensionedField< Type, pointMesh > &iF, const pointPatchFieldMapper &m),(dynamic_cast< const pointPatchFieldType & >(ptf), p, iF, m))

	declareRunTimeSelectionTable (autoPtr, pointPatchField, dictionary,(const pointPatch &p, const DimensionedField< Type, pointMesh > &iF, const dictionary &dict),(p, iF, dict))

	pointPatchField (const pointPatch &, const DimensionedField< Type, pointMesh > &)
	Construct from patch and internal field. More...

	pointPatchField (const pointPatch &, const DimensionedField< Type, pointMesh > &, const dictionary &)
	Construct from patch, internal field and dictionary. More...

	pointPatchField (const pointPatchField< Type > &, const pointPatch &, const DimensionedField< Type, pointMesh > &, const pointPatchFieldMapper &)
	Construct by mapping given patchField<Type> onto a new patch. More...

	pointPatchField (const pointPatchField< Type > &)
	Construct as copy. More...

	pointPatchField (const pointPatchField< Type > &, const DimensionedField< Type, pointMesh > &)
	Construct as copy setting internal field reference. More...

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

const objectRegistry &	db () const
	Return local objectRegistry. More...

label	size () const
	Return size. More...

const pointPatch &	patch () const
	Return patch. More...

const DimensionedField< Type, pointMesh > &	internalField () const
	Return dimensioned internal field reference. More...

const Field< Type > &	primitiveField () const
	Return internal field reference. More...

const word &	patchType () const
	Optional patch type. More...

word &	patchType ()
	Optional patch type. More...

virtual bool	coupled () const
	Return true if this patch field is coupled. More...

bool	updated () const
	Return true if the boundary condition has already been updated. More...

tmp< Field< Type > >	patchInternalField () const
	Return field created from appropriate internal field values. More...

template<class Type1 >
tmp< Field< Type1 > >	patchInternalField (const Field< Type1 > &iF) const
	Return field created from appropriate internal field values. More...

template<class Type1 >
tmp< Field< Type1 > >	patchInternalField (const Field< Type1 > &iF, const labelList &meshPoints) const
	Return field created from selected internal field values. More...

template<class Type1 >
void	addToInternalField (Field< Type1 > &iF, const Field< Type1 > &pF) const
	Given the internal field and a patch field,. More...

template<class Type1 >
void	addToInternalField (Field< Type1 > &iF, const Field< Type1 > &pF, const labelList &points) const
	Given the internal field and a patch field,. More...

template<class Type1 >
void	setInInternalField (Field< Type1 > &iF, const Field< Type1 > &pF, const labelList &meshPoints) const
	Given the internal field and a patch field,. More...

template<class Type1 >
void	setInInternalField (Field< Type1 > &iF, const Field< Type1 > &pF) const
	Given the internal field and a patch field,. More...

virtual const word &	constraintType () const
	Return the constraint type this pointPatchField implements. More...

virtual void	initEvaluate (const Pstream::commsTypes commsType=Pstream::commsTypes::blocking)
	Initialise evaluation of the patch field (do nothing) More...

virtual void	operator+= (const pointPatchField< Type > &)

virtual void	operator-= (const pointPatchField< Type > &)

virtual void	operator*= (const pointPatchField< scalar > &)

virtual void	operator/= (const pointPatchField< scalar > &)

virtual void	operator+= (const Field< Type > &)

virtual void	operator-= (const Field< Type > &)

virtual void	operator*= (const Field< scalar > &)

virtual void	operator/= (const Field< scalar > &)

virtual void	operator+= (const Type &)

virtual void	operator-= (const Type &)

virtual void	operator*= (const scalar)

virtual void	operator/= (const scalar)

void	negate ()
	Negate the field inplace. More...

template<class Type2 >
Foam::autoPtr< Foam::pointPatchField< Type > >	NewCalculatedType (const pointPatchField< Type2 > &pf)

template<class Type1 >
Foam::tmp< Foam::Field< Type1 > >	patchInternalField (const Field< Type1 > &iF, const labelList &meshPoints) const

template<class Type1 >
Foam::tmp< Foam::Field< Type1 > >	patchInternalField (const Field< Type1 > &iF) const

Public Member Functions inherited from Field< Type >
constexpr	Field () noexcept
	Construct null. More...

	Field (const label len)
	Construct given size. More...

	Field (const label len, const Type &val)
	Construct given size and initial value. More...

	Field (const label len, const zero)
	Construct given size and initial values of zero. More...

	Field (const Field< Type > &fld)
	Copy construct. More...

	Field (const UList< Type > &list)
	Copy construct from UList<Type> More...

template<class Addr >
	Field (const IndirectListBase< Type, Addr > &list)
	Copy construct from IndirectList. More...

	Field (Field< Type > &&fld)
	Move construct from Field. More...

	Field (List< Type > &&list)
	Move construct from List. More...

template<int SizeMin>
	Field (DynamicList< Type, SizeMin > &&list)
	Move construct from DynamicList. More...

	Field (const UList< Type > &mapF, const labelUList &mapAddressing)
	Construct by 1 to 1 mapping from the given field. More...

	Field (const tmp< Field< Type >> &tmapF, const labelUList &mapAddressing)
	Construct by 1 to 1 mapping from the given tmp field. More...

	Field (const UList< Type > &mapF, const labelListList &mapAddressing, const scalarListList &weights)
	Construct by interpolative mapping from the given field. More...

	Field (const tmp< Field< Type >> &tmapF, const labelListList &mapAddressing, const scalarListList &weights)
	Construct by interpolative mapping from the given tmp field. More...

	Field (const UList< Type > &mapF, const FieldMapper &map, const bool applyFlip=true)
	Construct by mapping from the given field. More...

	Field (const UList< Type > &mapF, const FieldMapper &map, const Type &defaultValue, const bool applyFlip=true)
	Construct by mapping from the given field. More...

	Field (const UList< Type > &mapF, const FieldMapper &map, const UList< Type > &defaultValues, const bool applyFlip=true)
	Construct by mapping from the given field. More...

	Field (const tmp< Field< Type >> &tmapF, const FieldMapper &map, const bool applyFlip=true)
	Construct by mapping from the given tmp field. More...

	Field (const tmp< Field< Type >> &tmapF, const FieldMapper &map, const Type &defaultValue, const bool applyFlip=true)

	Field (const tmp< Field< Type >> &tmapF, const FieldMapper &map, const UList< Type > &defaultValues, const bool applyFlip=true)

	Field (Field< Type > &fld, bool reuse)
	Copy construct or re-use as specified. More...

	Field (const tmp< Field< Type >> &tfld)
	Copy or move construct from tmp. More...

	Field (Istream &is)
	Construct from Istream. More...

	Field (const word &keyword, const dictionary &dict, const label len)
	Construct from a dictionary entry. More...

tmp< Field< Type > >	clone () const
	Clone. More...

void	map (const UList< Type > &mapF, const labelUList &mapAddressing)
	1 to 1 map from the given field More...

void	map (const tmp< Field< Type >> &tmapF, const labelUList &mapAddressing)
	1 to 1 map from the given tmp field More...

void	map (const UList< Type > &mapF, const labelListList &mapAddressing, const scalarListList &weights)
	Interpolative map from the given field. More...

void	map (const tmp< Field< Type >> &tmapF, const labelListList &mapAddressing, const scalarListList &weights)
	Interpolative map from the given tmp field. More...

void	map (const UList< Type > &mapF, const FieldMapper &map, const bool applyFlip=true)
	Map from the given field. More...

void	map (const tmp< Field< Type >> &tmapF, const FieldMapper &map, const bool applyFlip=true)
	Map from the given tmp field. More...

void	autoMap (const FieldMapper &map, const bool applyFlip=true)
	Map from self. More...

void	rmap (const UList< Type > &mapF, const labelUList &mapAddressing)
	1 to 1 reverse-map from the given field More...

void	rmap (const tmp< Field< Type >> &tmapF, const labelUList &mapAddressing)
	1 to 1 reverse-map from the given tmp field More...

void	rmap (const UList< Type > &mapF, const labelUList &mapAddressing, const UList< scalar > &weights)
	Interpolative reverse map from the given field. More...

void	rmap (const tmp< Field< Type >> &tmapF, const labelUList &mapAddressing, const UList< scalar > &weights)
	Interpolative reverse map from the given tmp field. More...

void	negate ()
	Negate this field (negative). More...

tmp< Field< cmptType > >	component (const direction) const
	Return a component field of the field. More...

void	replace (const direction, const UList< cmptType > &)
	Replace a component field of the field. More...

void	replace (const direction, const tmp< Field< cmptType >> &)
	Replace a component field of the field. More...

void	replace (const direction, const cmptType &)
	Replace a component field of the field. More...

template<class VSForm >
VSForm	block (const label start) const

tmp< Field< Type > >	T () const
	Return the field transpose (only defined for second rank tensors) More...

void	writeEntry (const word &keyword, Ostream &os) const
	Write the field as a dictionary entry. More...

void	operator= (const Field< Type > &)
	Copy assignment. More...

void	operator= (const tmp< Field< Type >> &)

void	operator= (const UList< Type > &)

void	operator= (const SubField< Type > &)

void	operator= (Field< Type > &&rhs)
	Move assignment. More...

void	operator= (List< Type > &&rhs)

template<int SizeMin>
void	operator= (DynamicList< Type, SizeMin > &&rhs)

void	operator= (const Type &val)
	Value assignment. More...

void	operator= (const zero)

template<class Form , class Cmpt , direction nCmpt>
void	operator= (const VectorSpace< Form, Cmpt, nCmpt > &)

void	operator+= (const UList< Type > &)

void	operator+= (const tmp< Field< Type >> &)

void	operator-= (const UList< Type > &)

void	operator-= (const tmp< Field< Type >> &)

void	operator*= (const UList< scalar > &)

void	operator*= (const tmp< Field< scalar >> &)

void	operator/= (const UList< scalar > &)

void	operator/= (const tmp< Field< scalar >> &)

void	operator+= (const Type &)

void	operator-= (const Type &)

void	operator*= (const scalar &)

void	operator/= (const scalar &)

template<class Type>
void	operator= (const tmp< Field > &rhs)

Static Public Attributes
static constexpr const char *const	codeTemplateC = "fixedValuePointPatchFieldTemplate.C"
	Name of the C code template to be used. More...

static constexpr const char *const	codeTemplateH = "fixedValuePointPatchFieldTemplate.H"
	Name of the H code template to be used. More...

Static Public Attributes inherited from pointPatchField< Type >
static int	disallowGenericPointPatchField
	Debug switch to disallow the use of genericPointPatchField. More...

Additional Inherited Members
Public Types inherited from pointPatchField< Type >
typedef Type	value_type

typedef pointPatch	Patch

typedef calculatedPointPatchField< Type >	Calculated

Public Types inherited from Field< Type >
typedef pTraits< Type >::cmptType	cmptType
	Component type. More...

typedef SubField< Type >	subField
	Declare type of subField. More...

Static Public Member Functions inherited from pointPatchField< Type >
static autoPtr< pointPatchField< Type > >	New (const word &, const pointPatch &, const DimensionedField< Type, pointMesh > &)
	Return a pointer to a new patchField created on freestore given. More...

static autoPtr< pointPatchField< Type > >	New (const word &, const word &actualPatchType, const pointPatch &, const DimensionedField< Type, pointMesh > &)
	Return a pointer to a new patchField created on freestore given. More...

static autoPtr< pointPatchField< Type > >	New (const pointPatchField< Type > &, const pointPatch &, const DimensionedField< Type, pointMesh > &, const pointPatchFieldMapper &)
	Return a pointer to a new patchField created on freestore from. More...

static autoPtr< pointPatchField< Type > >	New (const pointPatch &, const DimensionedField< Type, pointMesh > &, const dictionary &)
	Return a pointer to a new patchField created on freestore. More...

template<class Type2 >
static autoPtr< pointPatchField< Type > >	NewCalculatedType (const pointPatchField< Type2 > &)
	Return a pointer to a new calculatedPointPatchField created on. More...

static const word &	calculatedType ()
	Return the type of the calculated form of pointPatchField. More...

Static Public Member Functions inherited from Field< Type >
static const Field< Type > &	null ()
	Return nullObject reference field. More...

static autoPtr< Field< Type > >	New (Istream &is)
	Return a pointer to a new Field created on freestore. More...

template<class Type2 >
static tmp< Field< Type > >	NewCalculatedType (const Field< Type2 > &f)

Protected Member Functions inherited from codedBase
void	setCodeContext (const dictionary &dict)
	Set code context from a dictionary. More...

void	append (const std::string &str)
	Add content to SHA1 hashing. More...

void	updateLibrary (const word &name, const dynamicCodeContext &context) const
	Update library as required, using the given context. More...

void	updateLibrary (const word &name, const dictionary &dict) const

void	updateLibrary (const word &name) const

	ClassName ("codedBase")
	Runtime type information. More...

	codedBase ()=default
	Construct null. More...

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

Static Protected Member Functions inherited from codedBase
static void	writeCodeDict (Ostream &os, const dictionary &dict)
	Write code-dictionary contents. More...

Detailed Description

template<class Type>
class Foam::codedFixedValuePointPatchField< Type >

Constructs on-the-fly a new boundary condition (derived from fixedValuePointPatchField) which is then used to evaluate.

Example:

movingWall
{
    type            codedFixedValue;
    value           uniform 0;
    name    rampedFixedValue;   // name of generated bc

    code
    #{
        operator==
        (
            vector(0,0,1)
            *min(10, 0.1*this->db().time().value())
        );
    #};

    //codeInclude
    //#{
    //    #include "fvCFD.H"
    //#};

    //codeOptions
    //#{
    //    -I$(LIB_SRC)/finiteVolume/lnInclude
    //#};
}

A special form is if the code section is not supplied. In this case the code gets read from a (runTimeModifiable!) dictionary system/codeDict which would have a corresponding entry

rampedFixedValue
{
    code
    #{
        operator==(min(10, 0.1*this->db().time().value()));
    #};
}

See also: codedFixedValueFvPatchField

Source files

Definition at line 103 of file codedFixedValuePointPatchField.H.

Constructor & Destructor Documentation

◆ codedFixedValuePointPatchField() [1/5]

codedFixedValuePointPatchField	(	const pointPatch &	p,
		const DimensionedField< Type, pointMesh > &	iF
	)

Construct from patch and internal field.

Definition at line 149 of file codedFixedValuePointPatchField.C.

◆ codedFixedValuePointPatchField() [2/5]

codedFixedValuePointPatchField	(	const pointPatch &	p,
		const DimensionedField< Type, pointMesh > &	iF,
		const dictionary &	dict,
		const bool	valueRequired = `true`
	)

Construct from patch, internal field and dictionary.

Definition at line 179 of file codedFixedValuePointPatchField.C.

◆ codedFixedValuePointPatchField() [3/5]

codedFixedValuePointPatchField	(	const codedFixedValuePointPatchField< Type > &	ptf,
		const pointPatch &	p,
		const DimensionedField< Type, pointMesh > &	iF,
		const pointPatchFieldMapper &	mapper
	)

Construct by mapping given codedFixedValuePointPatchField.

onto a new patch

Definition at line 162 of file codedFixedValuePointPatchField.C.

◆ codedFixedValuePointPatchField() [4/5]

codedFixedValuePointPatchField ( const codedFixedValuePointPatchField< Type > & ptf )

Construct as copy.

Definition at line 198 of file codedFixedValuePointPatchField.C.

◆ codedFixedValuePointPatchField() [5/5]

codedFixedValuePointPatchField	(	const codedFixedValuePointPatchField< Type > &	ptf,
		const DimensionedField< Type, pointMesh > &	iF
	)

Construct as copy setting internal field reference.

Definition at line 212 of file codedFixedValuePointPatchField.C.

Member Function Documentation

◆ TypeName()

TypeName ( "codedFixedValue" )

Runtime type information.

◆ clone() [1/2]

virtual autoPtr<pointPatchField<Type> > clone ( ) const

inlinevirtual

Construct and return a clone.

Reimplemented from fixedValuePointPatchField< Type >.

Definition at line 190 of file codedFixedValuePointPatchField.H.

◆ clone() [2/2]

virtual autoPtr<pointPatchField<Type> > clone ( const DimensionedField< Type, pointMesh > & iF ) const

inlinevirtual

Construct and return a clone setting internal field reference.

Reimplemented from fixedValuePointPatchField< Type >.

Definition at line 207 of file codedFixedValuePointPatchField.H.

◆ redirectPatchField()

const Foam::pointPatchField< Type > & redirectPatchField ( ) const

Get reference to the underlying patch.

Definition at line 229 of file codedFixedValuePointPatchField.C.

References dict, Foam::foamVersion::patch, StringStreamAllocator< StreamType >::str(), Ostream::writeEntry(), and Field< Type >::writeEntry().

Here is the call graph for this function:

◆ updateCoeffs()

void updateCoeffs ( )

virtual

Update the coefficients associated with the patch field.

Reimplemented from valuePointPatchField< Type >.

Definition at line 257 of file codedFixedValuePointPatchField.C.

References Foam::operator==().

Here is the call graph for this function:

◆ evaluate()

void evaluate ( const Pstream::commsTypes commsType = Pstream::commsTypes::blocking )

virtual

Evaluate the patch field, sets Updated to false.

Reimplemented from valuePointPatchField< Type >.

Definition at line 280 of file codedFixedValuePointPatchField.C.

References Foam::stringOps::evaluate().

Here is the call graph for this function:

◆ write()

void write ( Ostream & os ) const

virtual

Write.

Reimplemented from valuePointPatchField< Type >.

Definition at line 296 of file codedFixedValuePointPatchField.C.

References Foam::vtk::write(), and Ostream::writeEntry().

Here is the call graph for this function:

Member Data Documentation

◆ codeTemplateC

constexpr const char* const codeTemplateC = "fixedValuePointPatchFieldTemplate.C"

staticconstexpr

Name of the C code template to be used.

Definition at line 144 of file codedFixedValuePointPatchField.H.

◆ codeTemplateH

constexpr const char* const codeTemplateH = "fixedValuePointPatchFieldTemplate.H"

staticconstexpr

Name of the H code template to be used.

Definition at line 148 of file codedFixedValuePointPatchField.H.

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

src/OpenFOAM/fields/pointPatchFields/derived/codedFixedValue/codedFixedValuePointPatchField.H
src/OpenFOAM/fields/pointPatchFields/derived/codedFixedValue/codedFixedValuePointPatchField.C

Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

template<class Type> class Foam::codedFixedValuePointPatchField< Type >

Constructor & Destructor Documentation

◆ codedFixedValuePointPatchField() [1/5]

◆ codedFixedValuePointPatchField() [2/5]

◆ codedFixedValuePointPatchField() [3/5]

◆ codedFixedValuePointPatchField() [4/5]

◆ codedFixedValuePointPatchField() [5/5]

Member Function Documentation

◆ TypeName()

◆ clone() [1/2]

◆ clone() [2/2]

◆ redirectPatchField()

◆ updateCoeffs()

◆ evaluate()

◆ write()

Member Data Documentation

◆ codeTemplateC

◆ codeTemplateH

template<class Type>
class Foam::codedFixedValuePointPatchField< Type >