An abstract base class with a fat-interface to all derived classes covering all possible ways in which they might be used. More...

Inheritance diagram for fvsPatchField:

[legend]

Collaboration diagram for fvsPatchField:

[legend]

Public Types
typedef fvPatch	Patch

Public Member Functions
	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...

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

	fvsPatchField (const fvsPatchField< 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	~fvsPatchField ()
	Destructor. More...

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

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

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

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

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

virtual bool	coupled () const
	Return true if this patch field is coupled. 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 void	write (Ostream &) const
	Write. 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 Type >
tmp< fvsPatchField< Type > >	NewCalculatedType (const fvPatch &p)

Static Public Member Functions
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
static int	disallowGenericFvsPatchField
	Debug switch to disallow the use of genericFvsPatchField. More...

Private Attributes
const fvPatch &	patch_
	Reference to patch. More...

const DimensionedField< Type, surfaceMesh > &	internalField_
	Reference to internal field. More...

Friends
Ostream &	operator (Ostream &, const fvsPatchField< Type > &)

Detailed Description

An abstract base class with a fat-interface to all derived classes covering all possible ways in which they might be used.

The first level of derivation is to basic patchFields which cover zero-gradient, fixed-gradient, fixed-value and mixed conditions.

The next level of derivation covers all the specialised typed with specific evaluation proceedures, particularly with respect to specific fields.

Source files

Definition at line 65 of file fvsPatchField.H.

Member Typedef Documentation

◆ Patch

typedef fvPatch Patch

Definition at line 91 of file fvsPatchField.H.

Constructor & Destructor Documentation

◆ fvsPatchField() [1/6]

fvsPatchField	(	const fvPatch &	,
		const DimensionedField< Type, surfaceMesh > &
	)

Construct from patch and internal field.

◆ fvsPatchField() [2/6]

fvsPatchField	(	const fvPatch &	,
		const DimensionedField< Type, surfaceMesh > &	,
		const Field< Type > &
	)

Construct from patch and internal field and patch field.

◆ fvsPatchField() [3/6]

fvsPatchField	(	const fvPatch &	,
		const DimensionedField< Type, surfaceMesh > &	,
		const dictionary &
	)

Construct from patch, internal field and dictionary.

◆ fvsPatchField() [4/6]

fvsPatchField	(	const fvsPatchField< Type > &	,
		const fvPatch &	,
		const DimensionedField< Type, surfaceMesh > &	,
		const fvPatchFieldMapper &
	)

Construct by mapping the given fvsPatchField onto a new patch.

◆ fvsPatchField() [5/6]

fvsPatchField ( const fvsPatchField< Type > & )

Construct as copy.

◆ fvsPatchField() [6/6]

fvsPatchField	(	const fvsPatchField< Type > &	,
		const DimensionedField< Type, surfaceMesh > &
	)

Construct as copy setting internal field reference.

◆ ~fvsPatchField()

virtual ~fvsPatchField ( )

inlinevirtual

Destructor.

Definition at line 266 of file fvsPatchField.H.

Member Function Documentation

◆ TypeName()

TypeName ( "fvsPatchField" )

Runtime type information.

◆ declareRunTimeSelectionTable() [1/3]

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

◆ declareRunTimeSelectionTable() [2/3]

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() [3/3]

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

◆ clone() [1/2]

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

inlinevirtual

Construct and return a clone.

Definition at line 181 of file fvsPatchField.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.

Definition at line 195 of file fvsPatchField.H.

◆ New() [1/4]

static tmp<fvsPatchField<Type> > New	(	const word &	,
		const fvPatch &	,
		const DimensionedField< Type, surfaceMesh > &
	)

static

Return a pointer to a new patchField created on freestore given.

patch and internal field (does not set the patch field values)

◆ New() [2/4]

static tmp<fvsPatchField<Type> > New	(	const word &	,
		const word &	actualPatchType,
		const fvPatch &	,
		const DimensionedField< Type, surfaceMesh > &
	)

static

Return a pointer to a new patchField created on freestore given.

patch and internal field (does not set the patch field values) Allows override of constraint type

◆ New() [3/4]

static tmp<fvsPatchField<Type> > New	(	const fvsPatchField< Type > &	,
		const fvPatch &	,
		const DimensionedField< Type, surfaceMesh > &	,
		const fvPatchFieldMapper &
	)

static

Return a pointer to a new patchField created on freestore from.

a given fvsPatchField mapped onto a new patch

◆ New() [4/4]

static tmp<fvsPatchField<Type> > New	(	const fvPatch &	,
		const DimensionedField< Type, surfaceMesh > &	,
		const dictionary &
	)

static

Return a pointer to a new patchField created on freestore.

from dictionary

◆ NewCalculatedType() [1/3]

static tmp<fvsPatchField<Type> > NewCalculatedType ( const fvPatch & )

static

Return a pointer to a new calculatedFvsPatchField created on.

freestore without setting patchField values

◆ NewCalculatedType() [2/3]

tmp< fvsPatchField< Type > > NewCalculatedType ( const fvsPatchField< Type2 > & pf )

static

Return a pointer to a new calculatedFvsPatchField created on.

freestore without setting patchField values

Definition at line 133 of file calculatedFvsPatchField.C.

◆ db()

const objectRegistry & db ( ) const

Return local objectRegistry.

Definition at line 138 of file fvsPatchField.C.

◆ patch()

const fvPatch& patch ( ) const

inline

Return patch.

Definition at line 278 of file fvsPatchField.H.

Referenced by curvatureSeparation::calcCosAngle(), CentredFitData< Polynomial >::calcFit(), UpwindFitData< Polynomial >::calcFit(), CentredFitSnGradData< Polynomial >::calcFit(), leastSquaresVectors::calcLeastSquaresVectors(), skewCorrectionVectors::calcSkewCorrectionVectors(), Foam::fvc::cellReduce(), extendedFaceToCellStencil::collectData(), CoEulerDdtScheme< Type >::CorDeltaT(), inverseFaceDistanceDiffusivity::correct(), inversePointDistanceDiffusivity::correct(), surfaceInterpolation::makeNonOrthCorrectionVectors(), fvMeshDistribute::mapBoundaryFields(), fvMeshDistribute::mapExposedFaces(), fvsPatchField< Type >::NewCalculatedType(), parFvFieldReconstructor::reconstructFvSurfaceField(), dynamicRefineFvMesh::refine(), SLTSDdtScheme< Type >::relaxedDiag(), fvMeshDistribute::testField(), extendedUpwindCellToFaceStencil::weightedSum(), and extendedCellToFaceStencil::weightedSum().

Here is the caller graph for this function:

◆ dimensionedInternalField()

const DimensionedField<Type, surfaceMesh>& dimensionedInternalField ( ) const

inline

Return dimensioned internal field reference.

Definition at line 285 of file fvsPatchField.H.

◆ internalField()

const Field<Type>& internalField ( ) const

inline

Return internal field reference.

Definition at line 291 of file fvsPatchField.H.

◆ calculatedType()

const word & calculatedType ( )

static

Return the type of the calculated for of fvsPatchField.

Definition at line 35 of file calculatedFvsPatchField.C.

◆ fixesValue()

virtual bool fixesValue ( ) const

inlinevirtual

Return true if this patch field fixes a value.

Needed to check if a level has to be specified while solving Poissons equations.

Definition at line 302 of file fvsPatchField.H.

◆ coupled()

virtual bool coupled ( ) const

inlinevirtual

Return true if this patch field is coupled.

Definition at line 308 of file fvsPatchField.H.

Referenced by Foam::adjustPhi(), CentredFitData< Polynomial >::calcFit(), UpwindFitData< Polynomial >::calcFit(), CentredFitSnGradData< Polynomial >::calcFit(), skewCorrectionVectors::calcSkewCorrectionVectors(), pointLinear< Type >::correction(), linearUpwindV< Type >::correction(), linearUpwind< Type >::correction(), surfaceInterpolation::makeNonOrthCorrectionVectors(), extendedUpwindCellToFaceStencil::weightedSum(), and extendedCellToFaceStencil::weightedSum().

Here is the caller graph for this function:

◆ autoMap()

void autoMap ( const fvPatchFieldMapper & m )

virtual

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

Reimplemented in immersedBoundaryFvsPatchField< Type >, and emptyFvsPatchField< Type >.

Definition at line 159 of file fvsPatchField.C.

◆ rmap()

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

virtual

Reverse map the given fvsPatchField onto this fvsPatchField.

Reimplemented in emptyFvsPatchField< Type >.

Definition at line 170 of file fvsPatchField.C.

◆ write()

void write ( Ostream & os ) const

virtual

Write.

Reimplemented in immersedBoundaryFvsPatchField< Type >.

Definition at line 181 of file fvsPatchField.C.

Referenced by Foam::operator<<(), and immersedBoundaryFvsPatchField< Type >::write().

Here is the caller graph for this function:

◆ check()

void check ( const fvsPatchField< Type > & ptf ) const

Check fvsPatchField<Type> against given fvsPatchField<Type>

Definition at line 145 of file fvsPatchField.C.

◆ operator=() [1/3]

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

virtual

Reimplemented in fixedValueFvsPatchField< Type >, and slicedFvsPatchField< Type >.

◆ operator=() [2/3]

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

virtual

Reimplemented in fixedValueFvsPatchField< Type >, and slicedFvsPatchField< Type >.

◆ operator+=() [1/3]

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

virtual

Reimplemented in fixedValueFvsPatchField< Type >, and slicedFvsPatchField< Type >.

◆ operator-=() [1/3]

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

virtual

Reimplemented in fixedValueFvsPatchField< Type >, and slicedFvsPatchField< Type >.

◆ operator*=() [1/3]

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

virtual

Reimplemented in fixedValueFvsPatchField< Type >, and slicedFvsPatchField< Type >.

◆ operator/=() [1/3]

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

virtual

Reimplemented in fixedValueFvsPatchField< Type >, and slicedFvsPatchField< Type >.

◆ operator+=() [2/3]

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

virtual

Reimplemented in fixedValueFvsPatchField< Type >, and slicedFvsPatchField< Type >.

◆ operator-=() [2/3]

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

virtual

Reimplemented in fixedValueFvsPatchField< Type >, and slicedFvsPatchField< Type >.

◆ operator*=() [2/3]

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

virtual

Reimplemented in fixedValueFvsPatchField< Type >, and slicedFvsPatchField< Type >.

◆ operator/=() [2/3]

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

virtual

Reimplemented in fixedValueFvsPatchField< Type >, and slicedFvsPatchField< Type >.

◆ operator=() [3/3]

virtual void operator= ( const Type & )

virtual

Reimplemented in fixedValueFvsPatchField< Type >, and slicedFvsPatchField< Type >.

◆ operator+=() [3/3]

virtual void operator+= ( const Type & )

virtual

Reimplemented in fixedValueFvsPatchField< Type >, and slicedFvsPatchField< Type >.

◆ operator-=() [3/3]

virtual void operator-= ( const Type & )

virtual

Reimplemented in fixedValueFvsPatchField< Type >, and slicedFvsPatchField< Type >.

◆ operator*=() [3/3]

virtual void operator*= ( const scalar )

virtual

Reimplemented in fixedValueFvsPatchField< Type >, and slicedFvsPatchField< Type >.

◆ operator/=() [3/3]

virtual void operator/= ( const scalar )

virtual

Reimplemented in fixedValueFvsPatchField< Type >, and slicedFvsPatchField< Type >.

◆ operator==() [1/3]

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

virtual

◆ operator==() [2/3]

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

virtual

◆ operator==() [3/3]

virtual void operator== ( const Type & )

virtual

◆ NewCalculatedType() [3/3]

tmp<fvsPatchField<Type> > NewCalculatedType ( const fvPatch & p )

Definition at line 101 of file calculatedFvsPatchField.C.

Friends And Related Function Documentation

◆ operator

Ostream& operator	(	Ostream &	,
		const fvsPatchField< Type > &
	)

friend

Field Documentation

◆ patch_

const fvPatch& patch_

private

Reference to patch.

Definition at line 83 of file fvsPatchField.H.

Referenced by fvsPatchField< Type >::check(), and fvsPatchField< Type >::patch().

◆ internalField_

const DimensionedField<Type, surfaceMesh>& internalField_

private

Reference to internal field.

Definition at line 86 of file fvsPatchField.H.

Referenced by fvsPatchField< Type >::dimensionedInternalField(), and fvsPatchField< Type >::internalField().

◆ disallowGenericFvsPatchField

int disallowGenericFvsPatchField

static

Debug switch to disallow the use of genericFvsPatchField.

Definition at line 98 of file fvsPatchField.H.

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

src/finiteVolume/fields/fvsPatchFields/fvsPatchField/fvsPatchField.H
src/finiteVolume/fields/fvsPatchFields/basic/calculated/calculatedFvsPatchField.C
src/finiteVolume/fields/fvsPatchFields/fvsPatchField/fvsPatchField.C

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Private Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ Patch

Constructor & Destructor Documentation

◆ fvsPatchField() [1/6]

◆ fvsPatchField() [2/6]

◆ fvsPatchField() [3/6]

◆ fvsPatchField() [4/6]

◆ fvsPatchField() [5/6]

◆ fvsPatchField() [6/6]

◆ ~fvsPatchField()

Member Function Documentation

◆ TypeName()

◆ declareRunTimeSelectionTable() [1/3]

◆ declareRunTimeSelectionTable() [2/3]

◆ declareRunTimeSelectionTable() [3/3]

◆ clone() [1/2]

◆ clone() [2/2]

◆ New() [1/4]

◆ New() [2/4]

◆ New() [3/4]

◆ New() [4/4]

◆ NewCalculatedType() [1/3]

◆ NewCalculatedType() [2/3]

◆ db()

◆ patch()

◆ dimensionedInternalField()

◆ internalField()

◆ calculatedType()

◆ fixesValue()

◆ coupled()

◆ autoMap()

◆ rmap()

◆ write()

◆ check()

◆ operator=() [1/3]

◆ operator=() [2/3]

◆ operator+=() [1/3]

◆ operator-=() [1/3]

◆ operator*=() [1/3]

◆ operator/=() [1/3]

◆ operator+=() [2/3]

◆ operator-=() [2/3]

◆ operator*=() [2/3]

◆ operator/=() [2/3]

◆ operator=() [3/3]

◆ operator+=() [3/3]

◆ operator-=() [3/3]

◆ operator*=() [3/3]

◆ operator/=() [3/3]

◆ operator==() [1/3]

◆ operator==() [2/3]

◆ operator==() [3/3]

◆ NewCalculatedType() [3/3]

Friends And Related Function Documentation

◆ operator

Field Documentation

◆ patch_

◆ internalField_

◆ disallowGenericFvsPatchField