A generic version of calculatedPointPatchField, useful as a fallback for handling unknown patch types. More...

Inheritance diagram for genericPointPatchField< Type >:

Collaboration diagram for genericPointPatchField< Type >:

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

	genericPointPatchField (const pointPatch &, const DimensionedField< Type, pointMesh > &)
	Construct from patch and internal field. More...

	genericPointPatchField (const pointPatch &, const DimensionedField< Type, pointMesh > &, const dictionary &)
	Construct from patch, internal field and dictionary. More...

	genericPointPatchField (const genericPointPatchField< Type > &, const pointPatch &, const DimensionedField< Type, pointMesh > &, const pointPatchFieldMapper &)
	Construct by mapping given patch field onto a new patch. More...

virtual autoPtr< pointPatchField< Type > >	clone () const
	Construct and return a clone. More...

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

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

virtual autoPtr< pointPatchField< Type > >	clone (const DimensionedField< Type, pointMesh > &iF) const
	Construct and return a clone setting internal field reference. More...

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

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

virtual void	rmap (const pointPatchField< Type > &, const labelList &)
	Reverse map the given pointPatchField onto this pointPatchField. More...

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

	calculatedPointPatchField (const pointPatch &, const DimensionedField< Type, pointMesh > &)
	Construct from patch and internal field. More...

	calculatedPointPatchField (const pointPatch &, const DimensionedField< Type, pointMesh > &, const dictionary &)
	Construct from patch, internal field and dictionary. More...

	calculatedPointPatchField (const calculatedPointPatchField< Type > &, const pointPatch &, const DimensionedField< Type, pointMesh > &, const pointPatchFieldMapper &)
	Construct by mapping given patch field onto a new patch. More...

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

Public Member Functions inherited from pointPatchField< Type >
	declareRunTimeSelectionTable (autoPtr, pointPatchField, patch,(const pointPatch &p, const DimensionedField< Type, pointMesh > &iF),(p, iF))

	declareRunTimeSelectionTable (autoPtr, pointPatchField, patchMapper,(const pointPatchField< Type > &ptf, const pointPatch &p, const DimensionedField< Type, pointMesh > &iF, const pointPatchFieldMapper &m),(dynamic_cast< const pointPatchFieldType &>(ptf), p, iF, m))

	declareRunTimeSelectionTable (autoPtr, pointPatchField, dictionary,(const pointPatch &p, const DimensionedField< Type, pointMesh > &iF, const dictionary &dict),(p, iF, dict))

	pointPatchField (const pointPatch &, const DimensionedField< Type, pointMesh > &)
	Construct from patch and internal field. More...

	pointPatchField (const pointPatch &, const DimensionedField< Type, pointMesh > &, const dictionary &)
	Construct from patch, internal field and dictionary. More...

	pointPatchField (const pointPatchField< Type > &, const pointPatch &, const DimensionedField< Type, pointMesh > &, const pointPatchFieldMapper &)
	Construct by mapping given patch field onto a new patch. More...

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

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

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

label	size () const
	Return the patch size. More...

const DimensionedField< Type, pointMesh > &	internalField () const noexcept
	Return const-reference to the dimensioned internal field. More...

const Field< Type > &	primitiveField () const noexcept
	Return const-reference to the internal field values. More...

tmp< Field< Type > >	patchInternalField () const
	Return field created from appropriate internal field values. More...

template<class Type1 >
tmp< Field< Type1 > >	patchInternalField (const Field< Type1 > &iF) const
	Return field created from appropriate internal field values given internal field reference. More...

template<class Type1 >
tmp< Field< Type1 > >	patchInternalField (const Field< Type1 > &iF, const labelUList &meshPoints) const
	Return field created from selected internal field values given internal field reference. More...

template<class Type1 >
void	addToInternalField (Field< Type1 > &iF, const Field< Type1 > &pF) const
	Given the internal field and a patch field, add the patch field to the internal field. More...

template<class Type1 >
void	addToInternalField (Field< Type1 > &iF, const Field< Type1 > &pF, const labelUList &points) const
	Given the internal field and a patch field, add selected elements of the patch field to the internal field. More...

template<class Type1 >
void	setInInternalField (Field< Type1 > &iF, const Field< Type1 > &pF, const labelUList &meshPoints) const
	Given the internal field and a patch field, set the patch field in the internal field. More...

template<class Type1 >
void	setInInternalField (Field< Type1 > &iF, const Field< Type1 > &pF) const
	Given the internal field and a patch field, set the patch field in the internal field. More...

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

virtual void	initEvaluate (const Pstream::commsTypes commsType=Pstream::commsTypes::blocking)
	Initialise evaluation of the patch field (do nothing) More...

virtual void	evaluate (const Pstream::commsTypes commsType=Pstream::commsTypes::blocking)
	Evaluate the patch field, sets updated() to false. More...

virtual void	initEvaluateLocal (const Pstream::commsTypes commsType=Pstream::commsTypes::blocking)
	Initialise the evaluation of the patch field after a local. More...

virtual void	evaluateLocal (const Pstream::commsTypes commsType=Pstream::commsTypes::blocking)
	Evaluate the patch field after a local operation (e.g. *=) More...

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

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

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

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

virtual void	operator/= (const pointPatchField< scalar > &)

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

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

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

virtual void	operator== (const Type &)

bool	operator!= (const pointPatchField< Type > &) const =delete

bool	operator!= (const Field< Type > &) const =delete

bool	operator!= (const Type &) const =delete

void	negate ()
	Negate the field inplace. Dummy placeholder for FieldField. More...

void	normalise ()
	Normalise the field inplace. Dummy placeholder for FieldField. More...

template<class Type2 >
Foam::autoPtr< Foam::pointPatchField< Type > >	NewCalculatedType (const pointPatchField< Type2 > &pf)

template<class Type1 >
Foam::tmp< Foam::Field< Type1 > >	patchInternalField (const Field< Type1 > &iF, const labelUList &meshPoints) const

template<class Type1 >
Foam::tmp< Foam::Field< Type1 > >	patchInternalField (const Field< Type1 > &iF) const

Public Member Functions inherited from pointPatchFieldBase
	TypeName ("pointPatchField")
	Runtime type information. More...

	pointPatchFieldBase (const pointPatch &p)
	Construct from patch. More...

	pointPatchFieldBase (const pointPatch &p, const word &patchType)
	Construct from patch and patch type. More...

	pointPatchFieldBase (const pointPatch &p, const dictionary &dict)
	Construct from patch and dictionary. More...

	pointPatchFieldBase (const pointPatchFieldBase &, const pointPatch &p)
	Copy construct with new patch. More...

	pointPatchFieldBase (const pointPatchFieldBase &)
	Copy construct. More...

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

virtual bool	fixesValue () const
	True if the patch field fixes a value. More...

virtual bool	coupled () const
	True if the patch field is coupled. More...

virtual const word &	constraintType () const
	The constraint type the pointPatchField implements. More...

const objectRegistry &	db () const
	The associated objectRegistry. More...

const pointPatch &	patch () const noexcept
	Return the patch. More...

const word &	patchType () const noexcept
	The optional patch type. More...

word &	patchType () noexcept
	The optional patch type. More...

bool	updated () const noexcept
	True if the boundary condition has already been updated. More...

bool	manipulatedMatrix () const noexcept
	True if the matrix has already been manipulated. Currently ignored (always false) for pointPatchField. More...

void	checkPatch (const pointPatchFieldBase &rhs) const
	Check that patches are identical. More...

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 pointPatchField< Type >
typedef Type	value_type
	The Field value_type. More...

typedef DimensionedField< Type, pointMesh >	Internal
	The internal field type associated with the patch field. More...

typedef pointPatch	Patch
	The patch type for the patch field. More...

typedef calculatedPointPatchField< Type >	Calculated
	Type for a calculated patch. More...

Static Public Member Functions inherited from pointPatchField< Type >
static autoPtr< pointPatchField< Type > >	New (const word &patchFieldType, const pointPatch &p, const DimensionedField< Type, pointMesh > &iF)
	Return a pointer to a new patchField created on freestore given. More...

static autoPtr< pointPatchField< Type > >	New (const word &patchFieldType, const word &actualPatchType, const pointPatch &p, const DimensionedField< Type, pointMesh > &iF)
	Return a pointer to a new patchField created on freestore given. More...

static autoPtr< pointPatchField< Type > >	New (const pointPatchField< Type > &, const pointPatch &, const DimensionedField< Type, pointMesh > &, const pointPatchFieldMapper &)
	Return a pointer to a new patchField created on freestore from. More...

static autoPtr< pointPatchField< Type > >	New (const pointPatch &, const DimensionedField< Type, pointMesh > &, const dictionary &)
	Return a pointer to a new patchField created on freestore. More...

template<class Type2 >
static autoPtr< pointPatchField< Type > >	NewCalculatedType (const pointPatchField< Type2 > &)
	Return a pointer to a new calculatedPointPatchField created on. More...

Static Public Member Functions inherited from pointPatchFieldBase
static const word &	emptyType () noexcept
	The type name for `empty` patch fields. More...

static const word &	calculatedType () noexcept
	The type name for `calculated` patch fields. More...

static const word &	zeroGradientType () noexcept
	The type name for `zeroGradient` patch fields. More...

Static Public Attributes inherited from pointPatchFieldBase
static int	disallowGenericPatchField
	Debug switch to disallow the use of generic pointPatchField. More...

Protected Member Functions inherited from pointPatchFieldBase
virtual void	readDict (const dictionary &dict)
	Read dictionary entries. More...

void	setUpdated (bool state) noexcept
	Set updated state. More...

void	setManipulated (bool state) noexcept
	Set matrix manipulated state. Currently a no-op for pointPatchField. More...

Protected Member Functions inherited from genericPatchFieldBase
void	genericFatalSolveError (const word &patchName, const IOobject &io) const
	Add error message to FatalError about solving with generic condition. More...

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
	Write all generic entries from dictionary, optionally treating the "value" entry separately. More...

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)
	Implementation for reverse map given patch field onto this patch field. More...

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

Detailed Description

template<class Type>
class Foam::genericPointPatchField< Type >

A generic version of calculatedPointPatchField, useful as a fallback for handling unknown patch types.

Source files

Definition at line 50 of file genericPointPatchField.H.

Constructor & Destructor Documentation

◆ genericPointPatchField() [1/5]

genericPointPatchField	(	const pointPatch &	p,
		const DimensionedField< Type, pointMesh > &	iF
	)

Construct from patch and internal field.

Definition at line 29 of file genericPointPatchField.C.

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

Here is the call graph for this function:

◆ genericPointPatchField() [2/5]

genericPointPatchField	(	const pointPatch &	p,
		const DimensionedField< Type, pointMesh > &	iF,
		const dictionary &	dict
	)

Construct from patch, internal field and dictionary.

Definition at line 46 of file genericPointPatchField.C.

References io(), and Foam::foamVersion::patch.

Here is the call graph for this function:

◆ genericPointPatchField() [3/5]

genericPointPatchField	(	const genericPointPatchField< Type > &	rhs,
		const pointPatch &	p,
		const DimensionedField< Type, pointMesh > &	iF,
		const pointPatchFieldMapper &	mapper
	)

Construct by mapping given patch field onto a new patch.

Definition at line 66 of file genericPointPatchField.C.

◆ genericPointPatchField() [4/5]

genericPointPatchField ( const genericPointPatchField< Type > & )

default

Default copy construct.

◆ genericPointPatchField() [5/5]

genericPointPatchField	(	const genericPointPatchField< Type > &	rhs,
		const DimensionedField< Type, pointMesh > &	iF
	)

Construct as copy setting internal field reference.

Definition at line 82 of file genericPointPatchField.C.

Member Function Documentation

◆ TypeName()

TypeName ( "generic" )

Runtime type information.

◆ clone() [1/2]

virtual autoPtr<pointPatchField<Type> > clone ( ) const

inlinevirtual

Construct and return a clone.

Reimplemented from calculatedPointPatchField< Type >.

Definition at line 104 of file genericPointPatchField.H.

◆ clone() [2/2]

virtual autoPtr<pointPatchField<Type> > clone ( const DimensionedField< Type, pointMesh > & iF ) const

inlinevirtual

Construct and return a clone setting internal field reference.

Reimplemented from calculatedPointPatchField< Type >.

Definition at line 133 of file genericPointPatchField.H.

◆ write()

void write ( Ostream & os ) const

virtual

Write.

Reimplemented from pointPatchField< Type >.

Definition at line 95 of file genericPointPatchField.C.

References os().

Here is the call graph for this function:

◆ autoMap()

void autoMap ( const pointPatchFieldMapper & m )

virtual

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

Reimplemented from pointPatchField< Type >.

Definition at line 104 of file genericPointPatchField.C.

◆ rmap()

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

virtual

Reverse map the given pointPatchField onto this pointPatchField.

Reimplemented from pointPatchField< Type >.

Definition at line 114 of file genericPointPatchField.C.

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

src/genericPatchFields/genericPointPatchField/genericPointPatchField.H
src/genericPatchFields/genericPointPatchField/genericPointPatchField.C

Public Member Functions

Additional Inherited Members

Detailed Description

template<class Type> class Foam::genericPointPatchField< Type >

Constructor & Destructor Documentation

◆ genericPointPatchField() [1/5]

◆ genericPointPatchField() [2/5]

◆ genericPointPatchField() [3/5]

◆ genericPointPatchField() [4/5]

◆ genericPointPatchField() [5/5]

Member Function Documentation

◆ TypeName()

◆ clone() [1/2]

◆ clone() [2/2]

◆ write()

◆ autoMap()

◆ rmap()

template<class Type>
class Foam::genericPointPatchField< Type >