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

[legend]

Collaboration diagram for genericFvsPatchField< Type >:

[legend]

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

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

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

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

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

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

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

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

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

virtual void	rmap (const fvsPatchField< Type > &, const labelList &)
	Reverse map the given fvsPatchField onto this fvsPatchField. 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 calculatedFvsPatchField< Type >
	TypeName ("calculated")
	Runtime type information. More...

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

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

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

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

	calculatedFvsPatchField (const calculatedFvsPatchField< Type > &, const DimensionedField< Type, surfaceMesh > &)
	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 fvsPatchField< Type >
	TypeName ("fvsPatchField")
	Runtime type information. More...

	declareRunTimeSelectionTable (tmp, fvsPatchField, patch,(const fvPatch &p, const DimensionedField< Type, surfaceMesh > &iF),(p, iF))

	declareRunTimeSelectionTable (tmp, fvsPatchField, patchMapper,(const fvsPatchField< Type > &ptf, const fvPatch &p, const DimensionedField< Type, surfaceMesh > &iF, const fvPatchFieldMapper &m),(dynamic_cast< const fvsPatchFieldType & >(ptf), p, iF, m))

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

virtual void	operator== (const Type &)

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

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

typedef calculatedFvsPatchField< Type >	Calculated

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

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

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

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

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

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

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

Static Public Attributes inherited from fvsPatchField< Type >
static int	disallowGenericFvsPatchField
	Debug switch to disallow the use of genericFvsPatchField. More...

Detailed Description

template<class Type>
class Foam::genericFvsPatchField< 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::calculatedFvsPatchField

Source files

Definition at line 57 of file genericFvsPatchField.H.

Constructor & Destructor Documentation

◆ genericFvsPatchField() [1/5]

genericFvsPatchField	(	const fvPatch &	p,
		const DimensionedField< Type, surfaceMesh > &	iF
	)

Construct from patch and internal field.

Definition at line 35 of file genericFvsPatchField.C.

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

Here is the call graph for this function:

◆ genericFvsPatchField() [2/5]

genericFvsPatchField	(	const fvPatch &	p,
		const DimensionedField< Type, surfaceMesh > &	iF,
		const dictionary &	dict
	)

Construct from patch, internal field and dictionary.

Definition at line 52 of file genericFvsPatchField.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:

◆ genericFvsPatchField() [3/5]

genericFvsPatchField	(	const genericFvsPatchField< Type > &	ptf,
		const fvPatch &	p,
		const DimensionedField< Type, surfaceMesh > &	iF,
		const fvPatchFieldMapper &	mapper
	)

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

Definition at line 415 of file genericFvsPatchField.C.

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

Here is the call graph for this function:

◆ genericFvsPatchField() [4/5]

genericFvsPatchField ( const genericFvsPatchField< Type > & ptf )

Construct as copy.

Definition at line 475 of file genericFvsPatchField.C.

◆ genericFvsPatchField() [5/5]

genericFvsPatchField	(	const genericFvsPatchField< Type > &	ptf,
		const DimensionedField< Type, surfaceMesh > &	iF
	)

Construct as copy setting internal field reference.

Definition at line 492 of file genericFvsPatchField.C.

Member Function Documentation

◆ TypeName()

TypeName ( "generic" )

Runtime type information.

◆ clone() [1/2]

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

inlinevirtual

Construct and return a clone.

Reimplemented from calculatedFvsPatchField< Type >.

Definition at line 113 of file genericFvsPatchField.H.

◆ clone() [2/2]

virtual tmp<fvsPatchField<Type> > clone ( const DimensionedField< Type, surfaceMesh > & iF ) const

inlinevirtual

Construct and return a clone setting internal field reference.

Reimplemented from calculatedFvsPatchField< Type >.

Definition at line 130 of file genericFvsPatchField.H.

◆ autoMap()

void autoMap ( const fvPatchFieldMapper & m )

virtual

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

Reimplemented from fvsPatchField< Type >.

Definition at line 512 of file genericFvsPatchField.C.

References forAllIters.

◆ rmap()

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

virtual

Reverse map the given fvsPatchField onto this fvsPatchField.

Reimplemented from fvsPatchField< Type >.

Definition at line 547 of file genericFvsPatchField.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

Definition at line 612 of file genericFvsPatchField.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

Definition at line 633 of file genericFvsPatchField.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

Return the matrix diagonal coefficients corresponding to the.

evaluation of the gradient of this patchField

Definition at line 653 of file genericFvsPatchField.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

Return the matrix source coefficients corresponding to the.

evaluation of the gradient of this patchField

Definition at line 670 of file genericFvsPatchField.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 687 of file genericFvsPatchField.C.

◆ write()

void write ( Ostream & os ) const

virtual

Write.

Reimplemented from fvsPatchField< Type >.

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

Public Member Functions

Additional Inherited Members

Detailed Description

template<class Type> class Foam::genericFvsPatchField< Type >

Constructor & Destructor Documentation

◆ genericFvsPatchField() [1/5]

◆ genericFvsPatchField() [2/5]

◆ genericFvsPatchField() [3/5]

◆ genericFvsPatchField() [4/5]

◆ genericFvsPatchField() [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::genericFvsPatchField< Type >