fvsPatchField Class Reference

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:

Public Types
typedef fvPatch	Patch
typedef calculatedFvsPatchField< Type >	Calculated

Public Member Functions
	TypeName ("fvsPatchField")
	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 > &)
	fvsPatchField (const fvPatch &, const DimensionedField< Type, surfaceMesh > &, const Field< Type > &)
	fvsPatchField (const fvPatch &, const DimensionedField< Type, surfaceMesh > &, const dictionary &)
	fvsPatchField (const fvsPatchField< Type > &, const fvPatch &, const DimensionedField< Type, surfaceMesh > &, const fvPatchFieldMapper &)
	fvsPatchField (const fvsPatchField< Type > &)
virtual tmp< fvsPatchField< Type > >	clone () const
	fvsPatchField (const fvsPatchField< Type > &, const DimensionedField< Type, surfaceMesh > &)
virtual tmp< fvsPatchField< Type > >	clone (const DimensionedField< Type, surfaceMesh > &iF) const
virtual	~fvsPatchField ()=default
const objectRegistry &	db () const
const fvPatch &	patch () const
const DimensionedField< Type, surfaceMesh > &	internalField () const
const Field< Type > &	primitiveField () const
virtual bool	fixesValue () const
virtual bool	coupled () const
virtual void	autoMap (const fvPatchFieldMapper &)
virtual void	rmap (const fvsPatchField< Type > &, const labelList &)
virtual void	write (Ostream &) const
void	check (const fvsPatchField< Type > &) const
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 >
Foam::tmp< Foam::fvsPatchField< Type > >	NewCalculatedType (const fvPatch &p)
template<class Type2 >
Foam::tmp< Foam::fvsPatchField< Type > >	NewCalculatedType (const fvsPatchField< Type2 > &pf)

Static Public Member Functions
static tmp< fvsPatchField< Type > >	New (const word &, const fvPatch &, const DimensionedField< Type, surfaceMesh > &)
static tmp< fvsPatchField< Type > >	New (const word &, const word &actualPatchType, const fvPatch &, const DimensionedField< Type, surfaceMesh > &)
static tmp< fvsPatchField< Type > >	New (const fvsPatchField< Type > &, const fvPatch &, const DimensionedField< Type, surfaceMesh > &, const fvPatchFieldMapper &)
static tmp< fvsPatchField< Type > >	New (const fvPatch &, const DimensionedField< Type, surfaceMesh > &, const dictionary &)
static tmp< fvsPatchField< Type > >	NewCalculatedType (const fvPatch &)
template<class Type2 >
static tmp< fvsPatchField< Type > >	NewCalculatedType (const fvsPatchField< Type2 > &)
static const word &	calculatedType ()

Static Public Attributes
static int	disallowGenericFvsPatchField

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 procedures, particularly with respect to specific fields.

Source files

• fvsPatchField.H
• fvsPatchField.C
• fvsPatchFieldNew.C

Definition at line 64 of file fvsPatchField.H.

Member Typedef Documentation

Patch

typedef fvPatch Patch

Definition at line 93 of file fvsPatchField.H.

Calculated

typedef calculatedFvsPatchField<Type> Calculated

Definition at line 94 of file fvsPatchField.H.

Constructor & Destructor Documentation

fvsPatchField() [1/6]

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

fvsPatchField() [2/6]

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

fvsPatchField() [3/6]

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

fvsPatchField() [4/6]

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

fvsPatchField() [5/6]

fvsPatchField

(

const fvsPatchField< Type > &

)

fvsPatchField() [6/6]

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

~fvsPatchField()

virtual ~fvsPatchField ( )

virtualdefault

Member Function Documentation

TypeName()

TypeName

(

"fvsPatchField"

)

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

Definition at line 184 of file fvsPatchField.H.

clone() [2/2]

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

inlinevirtual

Reimplemented in processorCyclicFvsPatchField< Type >, processorFvsPatchField< Type >, genericFvsPatchField< Type >, slicedFvsPatchField< Type >, cyclicFvsPatchField< Type >, cyclicACMIFvsPatchField< Type >, cyclicAMIFvsPatchField< Type >, nonuniformTransformCyclicFvsPatchField< Type >, symmetryPlaneFvsPatchField< Type >, fixedValueFvsPatchField< Type >, cyclicSlipFvsPatchField< Type >, emptyFvsPatchField< Type >, symmetryFvsPatchField< Type >, wedgeFvsPatchField< Type >, calculatedFvsPatchField< Type >, and coupledFvsPatchField< Type >.

Definition at line 198 of file fvsPatchField.H.

New() [1/4]

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

static

Referenced by fvsPatchField< Type >::clone().

Here is the caller graph for this function:

New() [2/4]

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

static

New() [3/4]

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

static

New() [4/4]

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

static

NewCalculatedType() [1/4]

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

static

NewCalculatedType() [2/4]

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

static

db()

const Foam::objectRegistry & db

(

)

const

Definition at line 125 of file fvsPatchField.C.

patch()

const fvPatch& patch ( ) const

inline

Definition at line 277 of file fvsPatchField.H.

Referenced by curvatureSeparation::calcCosAngle(), CentredFitSnGradData< Polynomial >::calcFit(), extendedFaceToCellStencil::collectData(), inverseFaceDistanceDiffusivity::correct(), inversePointDistanceDiffusivity::correct(), dynamicRefineFvMesh::mapFields(), fvMeshAdder::MapSurfaceField(), fvsPatchField< Type >::NewCalculatedType(), basicFvGeometryScheme::nonOrthCorrectionVectors(), basicFvGeometryScheme::nonOrthDeltaCoeffs(), fvMeshDistribute::testField(), extendedUpwindCellToFaceStencil::weightedSum(), and extendedCellToFaceStencil::weightedSum().

Here is the caller graph for this function:

internalField()

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

inline

Definition at line 283 of file fvsPatchField.H.

primitiveField()

const Field<Type>& primitiveField ( ) const

inline

Definition at line 289 of file fvsPatchField.H.

calculatedType()

const Foam::word & calculatedType ( )

static

Definition at line 28 of file calculatedFvsPatchField.C.

fixesValue()

virtual bool fixesValue ( ) const

inlinevirtual

Definition at line 300 of file fvsPatchField.H.

coupled()

virtual bool coupled ( ) const

inlinevirtual

Definition at line 306 of file fvsPatchField.H.

Referenced by Foam::adjustPhi(), CentredFitSnGradData< Polynomial >::calcFit(), phaseModel::correctInflowOutflow(), pointLinear< Type >::correction(), linearUpwind< Type >::correction(), linearUpwindV< Type >::correction(), linearUpwindNormal< Type >::correction(), weightedFlux< Type >::interpolate(), Foam::MULES::limit(), basicFvGeometryScheme::nonOrthCorrectionVectors(), MultiComponentPhaseModel< BasePhaseModel, phaseThermo >::solveYi(), extendedUpwindCellToFaceStencil::weightedSum(), and extendedCellToFaceStencil::weightedSum().

Here is the caller graph for this function:

autoMap()

void autoMap ( const fvPatchFieldMapper &  m )

virtual

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

Definition at line 144 of file fvsPatchField.C.

rmap()

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

virtual

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

Definition at line 153 of file fvsPatchField.C.

write()

void write ( Ostream &  os ) const

virtual

Reimplemented in genericFvsPatchField< Type >.

Definition at line 163 of file fvsPatchField.C.

check()

void check

(

const fvsPatchField< Type > &

ptf

)

const

Definition at line 132 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/4]

Foam::tmp<Foam::fvsPatchField<Type> > NewCalculatedType

(

const fvPatch &

p

)

Definition at line 95 of file calculatedFvsPatchField.C.

NewCalculatedType() [4/4]

Foam::tmp<Foam::fvsPatchField<Type> > NewCalculatedType

(

const fvsPatchField< Type2 > &

pf

)

Definition at line 127 of file calculatedFvsPatchField.C.

Friends And Related Function Documentation

operator

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

friend

Member Data Documentation

disallowGenericFvsPatchField

int disallowGenericFvsPatchField

static

Definition at line 101 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