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 genericFvPatchField< Type >:

[legend]

Collaboration diagram for genericFvPatchField< Type >:

[legend]

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

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

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

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

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

	genericFvPatchField (const genericFvPatchField< Type > &)=default
	Default copy construct. More...

	genericFvPatchField (const genericFvPatchField< 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	write (Ostream &) const
	Write. More...

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 > >	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 calculatedFvPatchField< Type >
	TypeName ("calculated")
	Runtime type information. More...

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

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

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

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

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

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	assignable () const
	Return true if the value of the patch field. 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
	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 ()
	Update the coefficients associated with the patch field. 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 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...

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

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 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 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 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::genericFvPatchField< 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::calculatedFvPatchField

Source files

Definition at line 58 of file genericFvPatchField.H.

Constructor & Destructor Documentation

◆ genericFvPatchField() [1/5]

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

Construct from patch and internal field.

Definition at line 36 of file genericFvPatchField.C.

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

Here is the call graph for this function:

◆ genericFvPatchField() [2/5]

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

Construct from patch, internal field and dictionary.

Definition at line 53 of file genericFvPatchField.C.

References dict, and Foam::foamVersion::patch.

◆ genericFvPatchField() [3/5]

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

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

Definition at line 78 of file genericFvPatchField.C.

◆ genericFvPatchField() [4/5]

genericFvPatchField ( const genericFvPatchField< Type > & )

default

Default copy construct.

◆ genericFvPatchField() [5/5]

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

Construct as copy setting internal field reference.

Definition at line 94 of file genericFvPatchField.C.

Member Function Documentation

◆ TypeName()

TypeName ( "generic" )

Runtime type information.

◆ clone() [1/2]

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

inlinevirtual

Construct and return a clone.

Reimplemented from calculatedFvPatchField< Type >.

Definition at line 100 of file genericFvPatchField.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 calculatedFvPatchField< Type >.

Definition at line 120 of file genericFvPatchField.H.

◆ write()

void write ( Ostream & os ) const

virtual

Write.

Reimplemented from calculatedFvPatchField< Type >.

Definition at line 107 of file genericFvPatchField.C.

References os().

Here is the call graph for this function:

◆ autoMap()

void autoMap ( const fvPatchFieldMapper & m )

virtual

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

Reimplemented from fvPatchField< Type >.

Definition at line 117 of file genericFvPatchField.C.

◆ rmap()

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

virtual

Reverse map the given fvPatchField onto this fvPatchField.

Reimplemented from fvPatchField< Type >.

Definition at line 128 of file genericFvPatchField.C.

◆ valueInternalCoeffs()

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

virtual

Fatal.

Reimplemented from calculatedFvPatchField< Type >.

Definition at line 146 of file genericFvPatchField.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 calculatedFvPatchField< Type >.

Definition at line 167 of file genericFvPatchField.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 calculatedFvPatchField< Type >.

Definition at line 187 of file genericFvPatchField.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 calculatedFvPatchField< Type >.

Definition at line 204 of file genericFvPatchField.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/genericFvPatchField/genericFvPatchField.H
src/genericPatchFields/genericFvPatchField/genericFvPatchField.C

Public Member Functions

Additional Inherited Members

Detailed Description

template<class Type> class Foam::genericFvPatchField< Type >

Constructor & Destructor Documentation

◆ genericFvPatchField() [1/5]

◆ genericFvPatchField() [2/5]

◆ genericFvPatchField() [3/5]

◆ genericFvPatchField() [4/5]

◆ genericFvPatchField() [5/5]

Member Function Documentation

◆ TypeName()

◆ clone() [1/2]

◆ clone() [2/2]

◆ write()

◆ autoMap()

◆ rmap()

◆ valueInternalCoeffs()

◆ valueBoundaryCoeffs()

◆ gradientInternalCoeffs()

◆ gradientBoundaryCoeffs()

template<class Type>
class Foam::genericFvPatchField< Type >