A mixed boundary condition with expressions. More...

Inheritance diagram for exprMixedFvPatchField< Type >:

Collaboration diagram for exprMixedFvPatchField< Type >:

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

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

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

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

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

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

	exprMixedFvPatchField (const exprMixedFvPatchField< 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...

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

virtual void	write (Ostream &os) 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 bool	assignable () const
	Return false: this patch field is not altered by assignment. 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 Field< Type > &	source ()

virtual const Field< Type > &	source () 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 void	evaluate (const Pstream::commsTypes commsType=Pstream::commsTypes::blocking)
	Evaluate the patch field. 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 Type &value)
	Construct from patch, internal field and value. 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=true)
	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	~fvPatchField ()=default
	Destructor. More...

bool	useImplicit () const noexcept
	Use implicit formulation for coupled patches only. More...

bool	useImplicit (bool on) noexcept
	Set useImplicit on/off. More...

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

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

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

const DimensionedField< Type, volMesh > &	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...

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 scalarField &deltaCoeffs) const
	Return patch-normal gradient for coupled-patches. More...

virtual void	updateWeightedCoeffs (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::commsTypes::blocking)
	Initialise the evaluation of the patch field. More...

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

virtual tmp< Field< Type > >	valueBoundaryCoeffs (const tmp< Field< scalar >> &) const
	Return the matrix source 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 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...

virtual void	manipulateMatrix (fvMatrix< Type > &matrix, const label iMatrix, const direction cmp)
	Manipulate fvMatrix. 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 &)

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

Public Member Functions inherited from patchExprFieldBase
	patchExprFieldBase ()
	Default construct. More...

	patchExprFieldBase (const dictionary &dict, enum expectedTypes expectedType=expectedTypes::VALUE_TYPE, bool wantPointData=false)
	Construct from dictionary. More...

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

Protected Member Functions
void	setDebug ()
	Set debug ON if "debug" is enabled. More...

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

expressions::patchExpr::parseDriver	driver_
	The expression driver. More...

Protected Attributes inherited from patchExprFieldBase
bool	debug_
	Add debugging. More...

bool	evalOnConstruct_
	Slightly dodgy concept here. More...

expressions::exprString	valueExpr_

expressions::exprString	gradExpr_

expressions::exprString	fracExpr_

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

typedef calculatedFvPatchField< Type >	Calculated

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

template<class Type2 >
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...

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

Protected Types inherited from patchExprFieldBase
enum	expectedTypes { VALUE_TYPE = 1, GRADIENT_TYPE = 2, MIXED_TYPE = 3 }
	Enumeration of expected expressions. More...

Detailed Description

template<class Type>
class Foam::exprMixedFvPatchField< Type >

A mixed boundary condition with expressions.

Usage

Property	Description	Required	Default
`valueExpr`	expression for uniformValue	partly	0
`gradientExpr`	expression for uniformGradient	partly	0
`fractionExpr`	expression for valueFraction	partly	depends

Note: For fixed-value boundary conditions, can also just use uniformFixedValueFvPatchField with an expression for the PatchFunction1, or a exprMixedFvPatchField.

For gradient boundary conditions, can also just use uniformFixedGradientFvPatchField with an expression for the PatchFunction1.

Source files

Definition at line 90 of file exprMixedFvPatchField.H.

Constructor & Destructor Documentation

◆ exprMixedFvPatchField() [1/5]

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

Construct from patch and internal field.

Definition at line 47 of file exprMixedFvPatchField.C.

References Foam::Zero.

◆ exprMixedFvPatchField() [2/5]

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

Construct from patch, internal field and dictionary.

Definition at line 84 of file exprMixedFvPatchField.C.

◆ exprMixedFvPatchField() [3/5]

exprMixedFvPatchField	(	const exprMixedFvPatchField< Type > &	rhs,
		const fvPatch &	p,
		const DimensionedField< Type, volMesh > &	iF,
		const fvPatchFieldMapper &	mapper
	)

Construct by mapping onto a new patch.

Definition at line 65 of file exprMixedFvPatchField.C.

References DebugInFunction, and Foam::nl.

◆ exprMixedFvPatchField() [4/5]

exprMixedFvPatchField ( const exprMixedFvPatchField< Type > & rhs )

Construct as copy.

Definition at line 258 of file exprMixedFvPatchField.C.

References DebugInFunction, and Foam::nl.

◆ exprMixedFvPatchField() [5/5]

exprMixedFvPatchField	(	const exprMixedFvPatchField< Type > &	rhs,
		const DimensionedField< Type, volMesh > &	iF
	)

Construct as copy setting internal field reference.

Definition at line 274 of file exprMixedFvPatchField.C.

References DebugInFunction, and Foam::nl.

Member Function Documentation

◆ setDebug()

void setDebug ( )

protected

Set debug ON if "debug" is enabled.

Definition at line 34 of file exprMixedFvPatchField.C.

References Foam::expressions::patchExpr::debug.

◆ TypeName()

TypeName ( "exprMixed" )

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 155 of file exprMixedFvPatchField.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 172 of file exprMixedFvPatchField.H.

◆ updateCoeffs()

void updateCoeffs ( )

virtual

Update the coefficients associated with the patch field.

Reimplemented from fvPatchField< Type >.

Definition at line 292 of file exprMixedFvPatchField.C.

References Foam::expressions::patchExpr::debug, Foam::endl(), Foam::Info, InfoInFunction, Foam::nl, and Foam::Zero.

Here is the call graph for this function:

◆ write()

void write ( Ostream & os ) const

virtual

Write.

Reimplemented from mixedFvPatchField< Type >.

Definition at line 393 of file exprMixedFvPatchField.C.

References Foam::expressions::patchExpr::debug, os(), and Foam::vtk::write().

Here is the call graph for this function:

Member Data Documentation

◆ dict_

dictionary dict_

protected

Dictionary contents for the boundary condition.

Definition at line 104 of file exprMixedFvPatchField.H.

◆ driver_

expressions::patchExpr::parseDriver driver_

protected

The expression driver.

Definition at line 107 of file exprMixedFvPatchField.H.

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

src/finiteVolume/expressions/fields/fvPatchFields/exprMixedFvPatchField.H
src/finiteVolume/expressions/fields/fvPatchFields/exprMixedFvPatchField.C

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

template<class Type> class Foam::exprMixedFvPatchField< Type >

Constructor & Destructor Documentation

◆ exprMixedFvPatchField() [1/5]

◆ exprMixedFvPatchField() [2/5]

◆ exprMixedFvPatchField() [3/5]

◆ exprMixedFvPatchField() [4/5]

◆ exprMixedFvPatchField() [5/5]

Member Function Documentation

◆ setDebug()

◆ TypeName()

◆ clone() [1/2]

◆ clone() [2/2]

◆ updateCoeffs()

◆ write()

Member Data Documentation

◆ dict_

◆ driver_

template<class Type>
class Foam::exprMixedFvPatchField< Type >