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

Inheritance diagram for codedMixedFvPatchField< Type >:

Collaboration diagram for codedMixedFvPatchField< Type >:

[legend]

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

	codedMixedFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &)
	Construct from patch and internal field. More...

	codedMixedFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const dictionary &)
	Construct from patch, internal field and dictionary. More...

	codedMixedFvPatchField (const codedMixedFvPatchField< Type > &, const fvPatch &, const DimensionedField< Type, volMesh > &, const fvPatchFieldMapper &)
	Construct by mapping given codedMixedFvPatchField. More...

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

virtual tmp< fvPatchField< Type > >	clone () const
	Construct and return a clone. More...

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

virtual tmp< fvPatchField< Type > >	clone (const DimensionedField< Type, volMesh > &iF) const
	Construct and return a clone setting internal field reference. More...

const mixedFvPatchField< Type > &	redirectPatchField () const
	Get reference to the underlying patchField. More...

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

virtual void	evaluate (const Pstream::commsTypes commsType=Pstream::blocking)
	Evaluate the patch field. More...

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

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

	mixedFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &)
	Construct from patch and internal field. More...

	mixedFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const dictionary &)
	Construct from patch, internal field and dictionary. More...

	mixedFvPatchField (const mixedFvPatchField< Type > &, const fvPatch &, const DimensionedField< Type, volMesh > &, const fvPatchFieldMapper &)
	Construct by mapping the given mixedFvPatchField onto a new patch. More...

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

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

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

virtual Field< Type > &	refValue ()

virtual const Field< Type > &	refValue () const

virtual Field< Type > &	refGrad ()

virtual const Field< Type > &	refGrad () const

virtual scalarField &	valueFraction ()

virtual const scalarField &	valueFraction () const

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

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

virtual tmp< Field< Type > >	snGrad () const
	Return gradient at boundary. More...

virtual tmp< Field< Type > >	valueInternalCoeffs (const tmp< scalarField > &) const
	Return the matrix diagonal coefficients corresponding to the. More...

virtual tmp< Field< Type > >	valueBoundaryCoeffs (const tmp< scalarField > &) const
	Return the matrix source coefficients corresponding to the. More...

virtual tmp< Field< Type > >	gradientInternalCoeffs () const
	Return the matrix diagonal coefficients corresponding to the. More...

virtual tmp< Field< Type > >	gradientBoundaryCoeffs () const
	Return the matrix source coefficients corresponding to the. More...

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

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

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

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

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

virtual void	operator/= (const fvPatchField< 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 Type &)

virtual void	operator*= (const scalar)

virtual void	operator/= (const scalar)

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

	declareRunTimeSelectionTable (tmp, fvPatchField, patch,(const fvPatch &p, const DimensionedField< Type, volMesh > &iF),(p, iF))

	declareRunTimeSelectionTable (tmp, fvPatchField, patchMapper,(const fvPatchField< Type > &ptf, const fvPatch &p, const DimensionedField< Type, volMesh > &iF, const fvPatchFieldMapper &m),(dynamic_cast< const fvPatchFieldType & >(ptf), p, iF, m))

	declareRunTimeSelectionTable (tmp, fvPatchField, dictionary,(const fvPatch &p, const DimensionedField< Type, volMesh > &iF, const dictionary &dict),(p, iF, dict))

	fvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &)
	Construct from patch and internal field. More...

	fvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const word &patchType)
	Construct from patch and internal field and patch type. More...

	fvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const Field< Type > &)
	Construct from patch and internal field and patch field. More...

	fvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const dictionary &, const bool valueRequired=false)
	Construct from patch, internal field and dictionary. More...

	fvPatchField (const fvPatchField< Type > &, const fvPatch &, const DimensionedField< Type, volMesh > &, const fvPatchFieldMapper &)
	Construct by mapping the given fvPatchField onto a new patch. More...

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

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

virtual tmp< fvPatchField< Type > >	clone () const
	Construct and return a clone. More...

Foam::tmp< Foam::fvPatchField< Type > >	NewCalculatedType (const fvPatch &p)

Foam::tmp< Foam::fvPatchField< Type > >	NewCalculatedType (const fvPatchField< Type2 > &pf)

virtual	~fvPatchField ()
	Destructor. More...

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

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

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

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

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

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

virtual bool	fixesValue () const
	Return true if this patch field fixes a value. 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...

bool	manipulatedMatrix () const
	Return true if the matrix has already been manipulated. More...

virtual tmp< Field< Type > >	snGrad () const
	Return patch-normal gradient. More...

virtual tmp< Field< Type > >	snGrad (const scalarField &deltaCoeffs) const
	Return patch-normal gradient for coupled-patches. More...

virtual void	updateCoeffs (const scalarField &weights)
	Update the coefficients associated with the patch field. More...

virtual tmp< Field< Type > >	patchInternalField () const
	Return internal field next to patch as patch field. More...

virtual void	patchInternalField (Field< Type > &) const
	Return internal field next to patch as patch field. More...

virtual tmp< Field< Type > >	patchNeighbourField () const
	Return patchField on the opposite patch of a coupled patch. More...

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

virtual tmp< Field< Type > >	gradientInternalCoeffs () const
	Return the matrix diagonal coefficients corresponding to the. More...

virtual tmp< Field< Type > >	gradientInternalCoeffs (const scalarField &deltaCoeffs) const
	Return the matrix diagonal coefficients corresponding to the. More...

virtual tmp< Field< Type > >	gradientBoundaryCoeffs () const
	Return the matrix source coefficients corresponding to the. More...

virtual tmp< Field< Type > >	gradientBoundaryCoeffs (const scalarField &deltaCoeffs) const
	Return the matrix source coefficients corresponding to the. More...

virtual void	manipulateMatrix (fvMatrix< Type > &matrix)
	Manipulate matrix. More...

virtual void	manipulateMatrix (fvMatrix< Type > &matrix, const scalarField &weights)
	Manipulate matrix with given weights. More...

void	writeEntryIfDifferent (Ostream &os, const word &entryName, const EntryType &value1, const EntryType &value2) const
	Helper function to write the keyword and entry only if the. More...

void	check (const fvPatchField< Type > &) const
	Check fvPatchField<Type> against given fvPatchField<Type> More...

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

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

virtual void	operator== (const Type &)

Public Member Functions inherited from codedBase
	ClassName ("codedBase")
	Runtime type information. More...

	codedBase ()
	Construct null. More...

virtual	~codedBase ()
	Destructor. More...

Static Public Attributes
static const word	codeTemplateC = "mixedFvPatchFieldTemplate.C"
	Name of the C code template to be used. More...

static const word	codeTemplateH = "mixedFvPatchFieldTemplate.H"
	Name of the H code template to be used. More...

Static Public Attributes inherited from fvPatchField< Type >
static int	disallowGenericFvPatchField
	Debug switch to disallow the use of genericFvPatchField. More...

Private Member Functions
const IOdictionary &	dict () const

virtual dlLibraryTable &	libs () const
	Get the loaded dynamic libraries. More...

virtual void	prepare (dynamicCode &, const dynamicCodeContext &) const
	Adapt the context for the current object. More...

virtual string	description () const

virtual void	clearRedirect () const

virtual const dictionary &	codeDict () const

Static Private Member Functions
static void	setFieldTemplates (dynamicCode &dynCode)
	Set the rewrite vars controlling the Type. More...

Private Attributes
dictionary	dict_
	Dictionary contents for the boundary condition. More...

const word	redirectType_

autoPtr< mixedFvPatchField< Type > >	redirectPatchFieldPtr_

Additional Inherited Members
Public Types inherited from fvPatchField< Type >
typedef fvPatch	Patch

Static Public Member Functions inherited from fvPatchField< Type >
static tmp< fvPatchField< Type > >	New (const word &, const fvPatch &, const DimensionedField< Type, volMesh > &)
	Return a pointer to a new patchField created on freestore given. More...

static tmp< fvPatchField< Type > >	New (const word &, const word &actualPatchType, const fvPatch &, const DimensionedField< Type, volMesh > &)
	Return a pointer to a new patchField created on freestore given. More...

static tmp< fvPatchField< Type > >	New (const fvPatchField< Type > &, const fvPatch &, const DimensionedField< Type, volMesh > &, const fvPatchFieldMapper &)
	Return a pointer to a new patchField created on freestore from. More...

static tmp< fvPatchField< Type > >	New (const fvPatch &, const DimensionedField< Type, volMesh > &, const dictionary &)
	Return a pointer to a new patchField created on freestore. More...

static tmp< fvPatchField< Type > >	NewCalculatedType (const fvPatch &)
	Return a pointer to a new calculatedFvPatchField created on. More...

static tmp< fvPatchField< Type > >	NewCalculatedType (const fvPatchField< Type2 > &)
	Return a pointer to a new calculatedFvPatchField created on. More...

static const word &	calculatedType ()
	Return the type of the calculated for of fvPatchField. More...

Protected Member Functions inherited from codedBase
void	updateLibrary (const word &redirectType) const
	Update library as required. More...

Detailed Description

template<class Type>
class Foam::codedMixedFvPatchField< Type >

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

Patch usage

Example:

myPatch
{
    type            codedMixed;

    refValue        uniform (0 0 0);
    refGradient     uniform (0 0 0);
    valueFraction   uniform 1;

    redirectType    rampedMixed;   // name of generated BC

    code
    #{
        this->refValue() =
            vector(1, 0, 0)
           *min(10, 0.1*this->db().time().value());
        this->refGrad() = vector::zero;
        this->valueFraction() = 1.0;
    #};

    //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

myPatch
{
    code
    #{
        this->refValue() = min(10, 0.1*this->db().time().value());
        this->refGrad() = vector::zero;
        this->valueFraction() = 1.0;
    #};
}

See also: Foam::dynamicCode Foam::functionEntries::codeStream

Source files

Definition at line 114 of file codedMixedFvPatchField.H.

Constructor & Destructor Documentation

◆ codedMixedFvPatchField() [1/5]

codedMixedFvPatchField	(	const fvPatch &	p,
		const DimensionedField< Type, volMesh > &	iF
	)

Construct from patch and internal field.

Definition at line 179 of file codedMixedFvPatchField.C.

◆ codedMixedFvPatchField() [2/5]

codedMixedFvPatchField	(	const fvPatch &	p,
		const DimensionedField< Type, volMesh > &	iF,
		const dictionary &	dict
	)

Construct from patch, internal field and dictionary.

Definition at line 209 of file codedMixedFvPatchField.C.

◆ codedMixedFvPatchField() [3/5]

codedMixedFvPatchField	(	const codedMixedFvPatchField< Type > &	ptf,
		const fvPatch &	p,
		const DimensionedField< Type, volMesh > &	iF,
		const fvPatchFieldMapper &	mapper
	)

Construct by mapping given codedMixedFvPatchField.

onto a new patch

Definition at line 192 of file codedMixedFvPatchField.C.

◆ codedMixedFvPatchField() [4/5]

codedMixedFvPatchField ( const codedMixedFvPatchField< Type > & ptf )

Construct as copy.

Definition at line 227 of file codedMixedFvPatchField.C.

◆ codedMixedFvPatchField() [5/5]

codedMixedFvPatchField	(	const codedMixedFvPatchField< Type > &	ptf,
		const DimensionedField< Type, volMesh > &	iF
	)

Construct as copy setting internal field reference.

Definition at line 241 of file codedMixedFvPatchField.C.

Member Function Documentation

◆ dict()

const Foam::IOdictionary & dict

private

Definition at line 67 of file codedMixedFvPatchField.C.

References objectRegistry::foundObject(), objectRegistry::lookupObject(), regIOobject::store(), and Foam::system().

Here is the call graph for this function:

◆ setFieldTemplates()

void setFieldTemplates ( dynamicCode & dynCode )

staticprivate

Set the rewrite vars controlling the Type.

Definition at line 49 of file codedMixedFvPatchField.C.

References dynamicCode::setFilterVariable().

Here is the call graph for this function:

◆ libs()

Foam::dlLibraryTable & libs

privatevirtual

Get the loaded dynamic libraries.

Implements codedBase.

Definition at line 96 of file codedMixedFvPatchField.C.

◆ prepare()

void prepare	(	dynamicCode &	dynCode,
		const dynamicCodeContext &	context
	)		const

privatevirtual

Adapt the context for the current object.

Implements codedBase.

Definition at line 104 of file codedMixedFvPatchField.C.

References dynamicCode::addCompileFile(), dynamicCode::addCopyFile(), dynamicCodeContext::libs(), dynamicCodeContext::options(), dynamicCode::setFilterVariable(), and dynamicCode::setMakeOptions().

Here is the call graph for this function:

◆ description()

Foam::string description

privatevirtual

Implements codedBase.

Definition at line 157 of file codedMixedFvPatchField.C.

References dimensionedInternalField().

Here is the call graph for this function:

◆ clearRedirect()

void clearRedirect

privatevirtual

Implements codedBase.

Definition at line 168 of file codedMixedFvPatchField.C.

◆ codeDict()

const Foam::dictionary & codeDict

privatevirtual

Implements codedBase.

Definition at line 143 of file codedMixedFvPatchField.C.

◆ TypeName()

TypeName ( "codedMixed" )

Runtime type information.

◆ clone() [1/2]

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

inlinevirtual

Construct and return a clone.

Reimplemented from mixedFvPatchField< Type >.

Definition at line 201 of file codedMixedFvPatchField.H.

◆ clone() [2/2]

virtual tmp<fvPatchField<Type> > clone ( const DimensionedField< Type, volMesh > & iF ) const

inlinevirtual

Construct and return a clone setting internal field reference.

Reimplemented from mixedFvPatchField< Type >.

Definition at line 218 of file codedMixedFvPatchField.H.

◆ redirectPatchField()

const Foam::mixedFvPatchField< Type > & redirectPatchField

Get reference to the underlying patchField.

Definition at line 258 of file codedMixedFvPatchField.C.

References dict, dimensionedInternalField(), OStringStream::str(), and write().

Here is the call graph for this function:

◆ updateCoeffs()

void updateCoeffs

virtual

Update the coefficients associated with the patch field.

Reimplemented from fvPatchField< Type >.

Definition at line 294 of file codedMixedFvPatchField.C.

References mixedFvPatchField< Type >::refGrad(), mixedFvPatchField< Type >::refValue(), and mixedFvPatchField< Type >::valueFraction().

Here is the call graph for this function:

◆ evaluate()

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

virtual

Evaluate the patch field.

This is only needed to set the updated() flag of the redirectType to false.

Reimplemented from mixedFvPatchField< Type >.

Definition at line 319 of file codedMixedFvPatchField.C.

◆ write()

void write ( Ostream & os ) const

virtual

Write.

Reimplemented from mixedFvPatchField< Type >.

Definition at line 338 of file codedMixedFvPatchField.C.

References Foam::nl, write(), Ostream::writeKeyword(), and Ostream::writeQuoted().

Here is the call graph for this function:

Field Documentation

◆ dict_

dictionary dict_

mutableprivate

Dictionary contents for the boundary condition.

Definition at line 122 of file codedMixedFvPatchField.H.

◆ redirectType_

const word redirectType_

private

Definition at line 124 of file codedMixedFvPatchField.H.

◆ redirectPatchFieldPtr_

autoPtr<mixedFvPatchField<Type> > redirectPatchFieldPtr_

mutableprivate

Definition at line 126 of file codedMixedFvPatchField.H.

◆ codeTemplateC

const Foam::word codeTemplateC = "mixedFvPatchFieldTemplate.C"

static

Name of the C code template to be used.

Definition at line 157 of file codedMixedFvPatchField.H.

◆ codeTemplateH

const Foam::word codeTemplateH = "mixedFvPatchFieldTemplate.H"

static

Name of the H code template to be used.

Definition at line 160 of file codedMixedFvPatchField.H.

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

src/finiteVolume/fields/fvPatchFields/derived/codedMixed/codedMixedFvPatchField.H
src/finiteVolume/fields/fvPatchFields/derived/codedMixed/codedMixedFvPatchField.C

Public Member Functions

Static Public Attributes

Private Member Functions

Static Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

template<class Type> class Foam::codedMixedFvPatchField< Type >

Constructor & Destructor Documentation

◆ codedMixedFvPatchField() [1/5]

◆ codedMixedFvPatchField() [2/5]

◆ codedMixedFvPatchField() [3/5]

◆ codedMixedFvPatchField() [4/5]

◆ codedMixedFvPatchField() [5/5]

Member Function Documentation

◆ dict()

◆ setFieldTemplates()

◆ libs()

◆ prepare()

◆ description()

◆ clearRedirect()

◆ codeDict()

◆ TypeName()

◆ clone() [1/2]

◆ clone() [2/2]

◆ redirectPatchField()

◆ updateCoeffs()

◆ evaluate()

◆ write()

Field Documentation

◆ dict_

◆ redirectType_

◆ redirectPatchFieldPtr_

◆ codeTemplateC

◆ codeTemplateH

template<class Type>
class Foam::codedMixedFvPatchField< Type >