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

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

	genericFaPatchField (const genericFaPatchField< Type > &)=default
	Default construct. 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	write (Ostream &) const
	Write. 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
	Fatal. More...

virtual tmp< Field< Type > >	valueBoundaryCoeffs (const tmp< scalarField > &) const
	Fatal. More...

tmp< Field< Type > >	gradientInternalCoeffs () const
	Fatal. More...

tmp< Field< Type > >	gradientBoundaryCoeffs () const
	Fatal. 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

virtual tmp< Field< Type > >	valueBoundaryCoeffs (const tmp< Field< scalar >> &) const

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)

Public Member Functions inherited from genericPatchFieldBase
	genericPatchFieldBase ()=default
	Default construct, generally not useful. More...

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

	genericPatchFieldBase (genericPatchFieldBase &&)=default
	Move construct. More...

	genericPatchFieldBase (const dictionary &dict)
	Initialize from dictionary. More...

const word &	actualType () const noexcept
	The actual patch type. More...

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 > &)

static tmp< faPatchField< Type > >	New (const word &patchFieldType, const faPatch &, const DimensionedField< Type, areaMesh > &)

static tmp< faPatchField< Type > >	New (const faPatchField< Type > &, const faPatch &, const DimensionedField< Type, areaMesh > &, const faPatchFieldMapper &)

static tmp< faPatchField< Type > >	New (const faPatch &, const DimensionedField< Type, areaMesh > &, const dictionary &)

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

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

Protected Member Functions inherited from genericPatchFieldBase
void	genericFatalSolveError (const word &patchName, const IOobject &io) const

void	reportMissingEntry (const word &entryName, const word &patchName, const IOobject &io) const
	FatalError for missing entry. More...

void	processGeneric (const label patchSize, const word &patchName, const IOobject &io, const bool separateValue)

bool	processEntry (const entry &dEntry, const label patchSize, const word &patchName, const IOobject &io)

void	putEntry (const entry &e, Ostream &os) const
	Write a single entry, with lookup of hashed values. More...

void	writeGeneric (Ostream &os, const bool separateValue) const

template<class MapperType >
void	mapGeneric (const genericPatchFieldBase &rhs, const MapperType &mapper)
	Implementation for construct with mapper. More...

template<class MapperType >
void	autoMapGeneric (const MapperType &mapper)
	Implementation for autoMap of self given a mapping object. More...

void	rmapGeneric (const genericPatchFieldBase &rhs, const labelList &addr)

	genericPatchFieldBase (const Foam::zero, const genericPatchFieldBase &)
	Partial copy construct. Only copy type and dictionary. More...

Protected Attributes inherited from genericPatchFieldBase
word	actualTypeName_
	The non-generic patch name. More...

dictionary	dict_

HashPtrTable< scalarField >	scalarFields_

HashPtrTable< vectorField >	vectorFields_

HashPtrTable< sphericalTensorField >	sphTensorFields_

HashPtrTable< symmTensorField >	symmTensorFields_

HashPtrTable< tensorField >	tensorFields_

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, Foam::nl, 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 dict, and Foam::foamVersion::patch.

◆ genericFaPatchField() [3/5]

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

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

Definition at line 78 of file genericFaPatchField.C.

◆ genericFaPatchField() [4/5]

genericFaPatchField ( const genericFaPatchField< Type > & )

default

Default construct.

◆ genericFaPatchField() [5/5]

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

Construct as copy setting internal field reference.

Definition at line 94 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 100 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 120 of file genericFaPatchField.H.

◆ write()

void write ( Ostream & os ) const

virtual

Write.

Reimplemented from calculatedFaPatchField< Type >.

Definition at line 107 of file genericFaPatchField.C.

References os().

Here is the call graph for this function:

◆ 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 117 of file genericFaPatchField.C.

◆ rmap()

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

virtual

Reverse map the given faPatchField onto this faPatchField.

Reimplemented from faPatchField< Type >.

Definition at line 128 of file genericFaPatchField.C.

◆ valueInternalCoeffs()

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

virtual

Fatal.

Reimplemented from calculatedFaPatchField< Type >.

Definition at line 146 of file genericFaPatchField.C.

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

Here is the call graph for this function:

◆ valueBoundaryCoeffs()

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

virtual

Fatal.

Reimplemented from calculatedFaPatchField< Type >.

Definition at line 167 of file genericFaPatchField.C.

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

Here is the call graph for this function:

◆ gradientInternalCoeffs()

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

virtual

Fatal.

Reimplemented from calculatedFaPatchField< Type >.

Definition at line 187 of file genericFaPatchField.C.

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

Here is the call graph for this function:

◆ gradientBoundaryCoeffs()

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

virtual

Fatal.

Reimplemented from calculatedFaPatchField< Type >.

Definition at line 205 of file genericFaPatchField.C.

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

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]

◆ write()

◆ autoMap()

◆ rmap()

◆ valueInternalCoeffs()

◆ valueBoundaryCoeffs()

◆ gradientInternalCoeffs()

◆ gradientBoundaryCoeffs()

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