This boundary condition provides a generic version of the calculated condition, useful as a fallback for handling unknown patch types. Not generally applicable as a user-specified condition. More...

Inheritance diagram for genericFaPatchField< Type >:

[legend]

Collaboration diagram for genericFaPatchField< Type >:

[legend]

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

	genericFaPatchField (const faPatch &, const DimensionedField< Type, areaMesh > &)
	Construct from patch and internal field. More...

	genericFaPatchField (const faPatch &, const DimensionedField< Type, areaMesh > &, const dictionary &)
	Construct from patch, internal field and dictionary. More...

	genericFaPatchField (const genericFaPatchField< Type > &, const faPatch &, const DimensionedField< Type, areaMesh > &, const faPatchFieldMapper &)
	Construct by mapping given patchField<Type> onto a new patch. More...

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

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

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

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

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

virtual void	rmap (const faPatchField< Type > &, const labelList &)
	Reverse map the given faPatchField onto this faPatchField. 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...

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

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

const word &	actualType () const
	Return the actual type. More...

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

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

	calculatedFaPatchField (const faPatch &, const DimensionedField< Type, areaMesh > &)
	Construct from patch and internal field. More...

	calculatedFaPatchField (const faPatch &, const DimensionedField< Type, areaMesh > &, const dictionary &)
	Construct from patch, internal field and dictionary. More...

	calculatedFaPatchField (const calculatedFaPatchField< Type > &, const faPatch &, const DimensionedField< Type, areaMesh > &, const faPatchFieldMapper &)
	Construct by mapping given patchField<Type> onto a new patch. More...

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

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

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

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

	declareRunTimeSelectionTable (tmp, faPatchField, patch,(const faPatch &p, const DimensionedField< Type, areaMesh > &iF),(p, iF))

	declareRunTimeSelectionTable (tmp, faPatchField, patchMapper,(const faPatchField< Type > &ptf, const faPatch &p, const DimensionedField< Type, areaMesh > &iF, const faPatchFieldMapper &m),(dynamic_cast< const faPatchFieldType & >(ptf), p, iF, m))

	declareRunTimeSelectionTable (tmp, faPatchField, dictionary,(const faPatch &p, const DimensionedField< Type, areaMesh > &iF, const dictionary &dict),(p, iF, dict))

	faPatchField (const faPatch &, const DimensionedField< Type, areaMesh > &)
	Construct from patch and internal field. More...

	faPatchField (const faPatch &, const DimensionedField< Type, areaMesh > &, const Field< Type > &)
	Construct from patch and internal field and patch field. More...

	faPatchField (const faPatch &, const DimensionedField< Type, areaMesh > &, const dictionary &)
	Construct from patch, internal field and dictionary. More...

	faPatchField (const faPatchField< Type > &, const faPatch &, const DimensionedField< Type, areaMesh > &, const faPatchFieldMapper &)
	Construct by mapping the given faPatchField onto a new patch. More...

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

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

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

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

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

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

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

virtual void	updateCoeffs ()
	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 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 void	evaluate (const Pstream::commsTypes commsType=Pstream::commsTypes::blocking)
	Evaluate the patch field, sets Updated to false. 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...

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

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

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

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

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

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

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

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

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

virtual void	operator== (const Type &)

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

Additional Inherited Members
Public Types inherited from faPatchField< Type >
typedef faPatch	Patch

typedef calculatedFaPatchField< Type >	Calculated

Static Public Member Functions inherited from faPatchField< Type >
static tmp< faPatchField< Type > >	New (const word &patchFieldType, const word &actualPatchType, const faPatch &, const DimensionedField< Type, areaMesh > &)
	Return a pointer to a new patchField created on freestore given. More...

static tmp< faPatchField< Type > >	New (const word &patchFieldType, const faPatch &, const DimensionedField< Type, areaMesh > &)
	Return a pointer to a new patchField created on freestore given. More...

static tmp< faPatchField< Type > >	New (const faPatchField< Type > &, const faPatch &, const DimensionedField< Type, areaMesh > &, const faPatchFieldMapper &)
	Return a pointer to a new patchField created on freestore from. More...

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

template<class Type2 >
static tmp< faPatchField< Type > >	NewCalculatedType (const faPatchField< Type2 > &)
	Return a pointer to a new calculatedFaPatchField created on. More...

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

Static Public Attributes inherited from faPatchField< Type >
static int	disallowGenericFaPatchField
	Debug switch to disallow the use of. More...

Detailed Description

template<class Type>
class Foam::genericFaPatchField< Type >

This boundary condition provides a generic version of the calculated condition, useful as a fallback for handling unknown patch types. Not generally applicable as a user-specified condition.

See also: Foam::calculatedFaPatchField

Source files

Definition at line 58 of file genericFaPatchField.H.

Constructor & Destructor Documentation

◆ genericFaPatchField() [1/5]

genericFaPatchField	(	const faPatch &	p,
		const DimensionedField< Type, areaMesh > &	iF
	)

Construct from patch and internal field.

Definition at line 36 of file genericFaPatchField.C.

References Foam::abort(), Foam::FatalError, FatalErrorInFunction, and Foam::foamVersion::patch.

Here is the call graph for this function:

◆ genericFaPatchField() [2/5]

genericFaPatchField	(	const faPatch &	p,
		const DimensionedField< Type, areaMesh > &	iF,
		const dictionary &	dict
	)

Construct from patch, internal field and dictionary.

Definition at line 53 of file genericFaPatchField.C.

References token::compoundToken(), dict, Foam::dynamicCast(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, token::isCompound(), token::isLabel(), token::isPunctuation(), token::isWord(), token::labelToken(), Foam::New(), Foam::nl, token::number(), Foam::foamVersion::patch, Istream::putBack(), token::transferCompoundToken(), and token::wordToken().

Here is the call graph for this function:

◆ genericFaPatchField() [3/5]

genericFaPatchField	(	const genericFaPatchField< Type > &	ptf,
		const faPatch &	p,
		const DimensionedField< Type, areaMesh > &	iF,
		const faPatchFieldMapper &	mapper
	)

Construct by mapping given patchField<Type> onto a new patch.

Definition at line 416 of file genericFaPatchField.C.

References forAllConstIters(), and Foam::New().

Here is the call graph for this function:

◆ genericFaPatchField() [4/5]

genericFaPatchField ( const genericFaPatchField< Type > & ptf )

Construct as copy.

Definition at line 476 of file genericFaPatchField.C.

◆ genericFaPatchField() [5/5]

genericFaPatchField	(	const genericFaPatchField< Type > &	ptf,
		const DimensionedField< Type, areaMesh > &	iF
	)

Construct as copy setting internal field reference.

Definition at line 493 of file genericFaPatchField.C.

Member Function Documentation

◆ TypeName()

TypeName ( "generic" )

Runtime type information.

◆ clone() [1/2]

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

inlinevirtual

Construct and return a clone.

Reimplemented from calculatedFaPatchField< Type >.

Definition at line 114 of file genericFaPatchField.H.

◆ clone() [2/2]

virtual tmp<faPatchField<Type> > clone ( const DimensionedField< Type, areaMesh > & iF ) const

inlinevirtual

Construct and return a clone setting internal field reference.

Reimplemented from calculatedFaPatchField< Type >.

Definition at line 131 of file genericFaPatchField.H.

◆ autoMap()

void autoMap ( const faPatchFieldMapper & m )

virtual

Map (and resize as needed) from self given a mapping object.

Reimplemented from faPatchField< Type >.

Definition at line 513 of file genericFaPatchField.C.

References forAllIters.

◆ rmap()

void rmap	(	const faPatchField< Type > &	ptf,
		const labelList &	addr
	)

virtual

Reverse map the given faPatchField onto this faPatchField.

Reimplemented from faPatchField< Type >.

Definition at line 548 of file genericFaPatchField.C.

References forAllIters.

◆ valueInternalCoeffs()

Foam::tmp< Foam::Field< Type > > valueInternalCoeffs ( const tmp< scalarField > & ) const

virtual

Return the matrix diagonal coefficients corresponding to the.

evaluation of the value of this patchField with given weights

Reimplemented from calculatedFaPatchField< Type >.

Definition at line 613 of file genericFaPatchField.C.

References Foam::abort(), Foam::FatalError, FatalErrorInFunction, and Foam::foamVersion::patch.

Here is the call graph for this function:

◆ valueBoundaryCoeffs()

Foam::tmp< Foam::Field< Type > > valueBoundaryCoeffs ( const tmp< scalarField > & ) const

virtual

Return the matrix source coefficients corresponding to the.

evaluation of the value of this patchField with given weights

Reimplemented from calculatedFaPatchField< Type >.

Definition at line 634 of file genericFaPatchField.C.

References Foam::abort(), Foam::FatalError, FatalErrorInFunction, and Foam::foamVersion::patch.

Here is the call graph for this function:

◆ gradientInternalCoeffs()

Foam::tmp< Foam::Field< Type > > gradientInternalCoeffs ( ) const

virtual

Return the matrix diagonal coefficients corresponding to the.

evaluation of the gradient of this patchField

Reimplemented from calculatedFaPatchField< Type >.

Definition at line 654 of file genericFaPatchField.C.

References Foam::abort(), Foam::FatalError, FatalErrorInFunction, and Foam::foamVersion::patch.

Here is the call graph for this function:

◆ gradientBoundaryCoeffs()

Foam::tmp< Foam::Field< Type > > gradientBoundaryCoeffs ( ) const

virtual

Return the matrix source coefficients corresponding to the.

evaluation of the gradient of this patchField

Reimplemented from calculatedFaPatchField< Type >.

Definition at line 671 of file genericFaPatchField.C.

References Foam::abort(), Foam::FatalError, FatalErrorInFunction, and Foam::foamVersion::patch.

Here is the call graph for this function:

◆ actualType()

const Foam::word & actualType ( ) const

Return the actual type.

Definition at line 688 of file genericFaPatchField.C.

◆ write()

void write ( Ostream & os ) const

virtual

Write.

Reimplemented from calculatedFaPatchField< Type >.

Definition at line 695 of file genericFaPatchField.C.

References Ostream::writeEntry().

Here is the call graph for this function:

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

src/genericPatchFields/genericFaPatchField/genericFaPatchField.H
src/genericPatchFields/genericFaPatchField/genericFaPatchField.C

Public Member Functions

Additional Inherited Members

Detailed Description

template<class Type> class Foam::genericFaPatchField< Type >

Constructor & Destructor Documentation

◆ genericFaPatchField() [1/5]

◆ genericFaPatchField() [2/5]

◆ genericFaPatchField() [3/5]

◆ genericFaPatchField() [4/5]

◆ genericFaPatchField() [5/5]

Member Function Documentation

◆ TypeName()

◆ clone() [1/2]

◆ clone() [2/2]

◆ autoMap()

◆ rmap()

◆ valueInternalCoeffs()

◆ valueBoundaryCoeffs()

◆ gradientInternalCoeffs()

◆ gradientBoundaryCoeffs()

◆ actualType()

◆ write()

template<class Type>
class Foam::genericFaPatchField< Type >