faPatchField Class Reference

faPatchField<Type> abstract base class. This class gives 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. More...

Inheritance diagram for faPatchField:

Public Types
typedef faPatch	Patch
typedef calculatedFaPatchField< Type >	Calculated

Public Member Functions
	TypeName ("faPatchField")
	declareRunTimeSelectionTable (tmp, faPatchField, patch,(const faPatch &p, const DimensionedField< Type, areaMesh > &iF),(p, iF))
	declareRunTimeSelectionTable (tmp, faPatchField, patchMapper,(const faPatchField< Type > &ptf, const faPatch &p, const DimensionedField< Type, areaMesh > &iF, const faPatchFieldMapper &m),(dynamic_cast< const faPatchFieldType & >(ptf), p, iF, m))
	declareRunTimeSelectionTable (tmp, faPatchField, dictionary,(const faPatch &p, const DimensionedField< Type, areaMesh > &iF, const dictionary &dict),(p, iF, dict))
	faPatchField (const faPatch &, const DimensionedField< Type, areaMesh > &)
	faPatchField (const faPatch &, const DimensionedField< Type, areaMesh > &, const Field< Type > &)
	faPatchField (const faPatch &, const DimensionedField< Type, areaMesh > &, const dictionary &)
	faPatchField (const faPatchField< Type > &, const faPatch &, const DimensionedField< Type, areaMesh > &, const faPatchFieldMapper &)
	faPatchField (const faPatchField< Type > &)
virtual tmp< faPatchField< Type > >	clone () const
	faPatchField (const faPatchField< Type > &, const DimensionedField< Type, areaMesh > &)
virtual tmp< faPatchField< Type > >	clone (const DimensionedField< Type, areaMesh > &iF) const
virtual	~faPatchField ()=default
const objectRegistry &	db () const
const faPatch &	patch () const
const DimensionedField< Type, areaMesh > &	internalField () const
const Field< Type > &	primitiveField () const
const word &	patchType () const
word &	patchType ()
virtual bool	fixesValue () const
virtual bool	coupled () const
bool	updated () const
virtual void	autoMap (const faPatchFieldMapper &)
virtual void	rmap (const faPatchField< Type > &, const labelList &)
virtual tmp< Field< Type > >	snGrad () const
virtual void	updateCoeffs ()
virtual tmp< Field< Type > >	patchInternalField () const
virtual tmp< Field< Type > >	patchNeighbourField () const
virtual void	initEvaluate (const Pstream::commsTypes commsType=Pstream::commsTypes::blocking)
virtual void	evaluate (const Pstream::commsTypes commsType=Pstream::commsTypes::blocking)
virtual tmp< Field< Type > >	valueInternalCoeffs (const tmp< Field< scalar >> &) const
virtual tmp< Field< Type > >	valueBoundaryCoeffs (const tmp< Field< scalar >> &) const
virtual tmp< Field< Type > >	gradientInternalCoeffs () const
virtual tmp< Field< Type > >	gradientBoundaryCoeffs () const
virtual void	write (Ostream &) const
void	check (const faPatchField< Type > &) const
virtual void	operator= (const UList< Type > &)
virtual void	operator= (const faPatchField< Type > &)
virtual void	operator+= (const faPatchField< Type > &)
virtual void	operator-= (const faPatchField< Type > &)
virtual void	operator*= (const faPatchField< scalar > &)
virtual void	operator/= (const faPatchField< 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 faPatchField< Type > &)
virtual void	operator== (const Field< Type > &)
virtual void	operator== (const Type &)
template<class Type2 >
Foam::tmp< Foam::faPatchField< Type > >	NewCalculatedType (const faPatchField< Type2 > &pf)

Static Public Member Functions
static tmp< faPatchField< Type > >	New (const word &patchFieldType, const word &actualPatchType, const faPatch &, const DimensionedField< Type, areaMesh > &)
static tmp< faPatchField< Type > >	New (const word &patchFieldType, const faPatch &, const DimensionedField< Type, areaMesh > &)
static tmp< faPatchField< Type > >	New (const faPatchField< Type > &, const faPatch &, const DimensionedField< Type, areaMesh > &, const faPatchFieldMapper &)
static tmp< faPatchField< Type > >	New (const faPatch &, const DimensionedField< Type, areaMesh > &, const dictionary &)
template<class Type2 >
static tmp< faPatchField< Type > >	NewCalculatedType (const faPatchField< Type2 > &)
static const word &	calculatedType ()

Static Public Attributes
static int	disallowGenericFaPatchField

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

Detailed Description

faPatchField<Type> abstract base class. This class gives 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.

Author Zeljko Tukovic, FMENA Hrvoje Jasak, Wikki Ltd.

Source files

• faPatchField.H
• faPatchField.C
• newPatchField.C

Definition at line 46 of file areaFieldsFwd.H.

Member Typedef Documentation

Patch

typedef faPatch Patch

Definition at line 99 of file faPatchField.H.

Calculated

typedef calculatedFaPatchField<Type> Calculated

Definition at line 100 of file faPatchField.H.

Constructor & Destructor Documentation

faPatchField() [1/6]

faPatchField	(	const faPatch &	,
		const DimensionedField< Type, areaMesh > &
	)

faPatchField() [2/6]

faPatchField	(	const faPatch &	,
		const DimensionedField< Type, areaMesh > &	,
		const Field< Type > &
	)

faPatchField() [3/6]

faPatchField	(	const faPatch &	,
		const DimensionedField< Type, areaMesh > &	,
		const dictionary &
	)

faPatchField() [4/6]

faPatchField	(	const faPatchField< Type > &	,
		const faPatch &	,
		const DimensionedField< Type, areaMesh > &	,
		const faPatchFieldMapper &
	)

faPatchField() [5/6]

faPatchField

(

const faPatchField< Type > &

)

faPatchField() [6/6]

faPatchField	(	const faPatchField< Type > &	,
		const DimensionedField< Type, areaMesh > &
	)

~faPatchField()

virtual ~faPatchField ( )

virtualdefault

Member Function Documentation

TypeName()

TypeName

(

"faPatchField"

)

declareRunTimeSelectionTable() [1/3]

declareRunTimeSelectionTable	(	tmp	,
		faPatchField	,
		patch	,
		(const faPatch &p, const DimensionedField< Type, areaMesh > &iF)	,
		(p, iF)
	)

declareRunTimeSelectionTable() [2/3]

declareRunTimeSelectionTable	(	tmp	,
		faPatchField	,
		patchMapper	,
		(const faPatchField< Type > &ptf, const faPatch &p, const DimensionedField< Type, areaMesh > &iF, const faPatchFieldMapper &m)	,
		(dynamic_cast< const faPatchFieldType & >(ptf), p, iF, m)
	)

declareRunTimeSelectionTable() [3/3]

declareRunTimeSelectionTable	(	tmp	,
		faPatchField	,
		dictionary	,
		(const faPatch &p, const DimensionedField< Type, areaMesh > &iF, const dictionary &dict)	,
		(p, iF, dict)
	)

clone() [1/2]

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

inlinevirtual

Definition at line 190 of file faPatchField.H.

clone() [2/2]

virtual tmp<faPatchField<Type> > clone ( const DimensionedField< Type, areaMesh > &  iF ) const

inlinevirtual

Reimplemented in timeVaryingUniformFixedValueFaPatchField< Type >, clampedPlateFaPatchField< Type >, cyclicFaPatchField< Type >, processorFaPatchField< Type >, mixedFaPatchField< Type >, inletOutletFaPatchField< Type >, fixedGradientFaPatchField< Type >, genericFaPatchField< Type >, zeroGradientFaPatchField< Type >, emptyFaPatchField< Type >, symmetryFaPatchField< Type >, slipFaPatchField< Type >, fixedValueFaPatchField< Type >, fixedValueOutflowFaPatchField< Type >, calculatedFaPatchField< Type >, basicSymmetryFaPatchField< Type >, wedgeFaPatchField< Type >, coupledFaPatchField< Type >, and transformFaPatchField< Type >.

Definition at line 204 of file faPatchField.H.

New() [1/4]

static tmp<faPatchField<Type> > New ( const word &  patchFieldType, const word &  actualPatchType, const faPatch &  , const DimensionedField< Type, areaMesh > &    )

static

New() [2/4]

static tmp<faPatchField<Type> > New ( const word &  patchFieldType, const faPatch &  , const DimensionedField< Type, areaMesh > &    )

static

New() [3/4]

static tmp<faPatchField<Type> > New ( const faPatchField< Type > &  , const faPatch &  , const DimensionedField< Type, areaMesh > &  , const faPatchFieldMapper &    )

static

New() [4/4]

static tmp<faPatchField<Type> > New ( const faPatch &  , const DimensionedField< Type, areaMesh > &  , const dictionary &    )

static

NewCalculatedType() [1/2]

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

static

db()

const Foam::objectRegistry & db

(

)

const

Definition at line 135 of file faPatchField.C.

patch()

const faPatch& patch ( ) const

inline

Definition at line 275 of file faPatchField.H.

Referenced by contactAngleForce::correct(), and faPatchField< Type >::NewCalculatedType().

Here is the caller graph for this function:

internalField()

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

inline

Definition at line 281 of file faPatchField.H.

primitiveField()

const Field<Type>& primitiveField ( ) const

inline

Definition at line 287 of file faPatchField.H.

patchType() [1/2]

const word& patchType ( ) const

inline

Definition at line 293 of file faPatchField.H.

patchType() [2/2]

word& patchType ( )

inline

Definition at line 299 of file faPatchField.H.

calculatedType()

const Foam::word & calculatedType ( )

static

Definition at line 28 of file calculatedFaPatchField.C.

fixesValue()

virtual bool fixesValue ( ) const

inlinevirtual

Definition at line 310 of file faPatchField.H.

coupled()

virtual bool coupled ( ) const

inlinevirtual

Definition at line 316 of file faPatchField.H.

Referenced by faMatrix< Type >::addBoundarySource(), and faMatrix< Type >::relax().

Here is the caller graph for this function:

updated()

bool updated ( ) const

inline

Definition at line 322 of file faPatchField.H.

autoMap()

void autoMap ( const faPatchFieldMapper &  m )

virtual

Reimplemented in mixedFaPatchField< Type >, fixedGradientFaPatchField< Type >, genericFaPatchField< Type >, and emptyFaPatchField< Type >.

Definition at line 170 of file faPatchField.C.

rmap()

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

virtual

Reimplemented in mixedFaPatchField< Type >, fixedGradientFaPatchField< Type >, emptyFaPatchField< Type >, and genericFaPatchField< Type >.

Definition at line 178 of file faPatchField.C.

snGrad()

Foam::tmp< Foam::Field< Type > > snGrad ( ) const

virtual

Definition at line 155 of file faPatchField.C.

updateCoeffs()

virtual void updateCoeffs ( )

inlinevirtual

Reimplemented in timeVaryingUniformFixedValueFaPatchField< Type >, emptyFaPatchField< Type >, and inletOutletFaPatchField< Type >.

Definition at line 351 of file faPatchField.H.

patchInternalField()

Foam::tmp< Foam::Field< Type > > patchInternalField ( ) const

virtual

Definition at line 163 of file faPatchField.C.

patchNeighbourField()

virtual tmp<Field<Type> > patchNeighbourField ( ) const

inlinevirtual

Definition at line 360 of file faPatchField.H.

Referenced by faMatrix< Type >::addBoundarySource().

Here is the caller graph for this function:

initEvaluate()

virtual void initEvaluate ( const Pstream::commsTypes  commsType = Pstream::commsTypes::blocking )

inlinevirtual

Reimplemented in processorFaPatchField< Type >, and coupledFaPatchField< Type >.

Definition at line 368 of file faPatchField.H.

evaluate()

void evaluate ( const Pstream::commsTypes  commsType = Pstream::commsTypes::blocking )

virtual

Reimplemented in clampedPlateFaPatchField< Type >, basicSymmetryFaPatchField< Type >, wedgeFaPatchField< Type >, mixedFaPatchField< Type >, clampedPlateFaPatchField< Type >, fixedGradientFaPatchField< Type >, zeroGradientFaPatchField< Type >, basicSymmetryFaPatchField< Type >, wedgeFaPatchField< Type >, processorFaPatchField< Type >, coupledFaPatchField< Type >, basicSymmetryFaPatchField< Type >, and wedgeFaPatchField< Type >.

Definition at line 188 of file faPatchField.C.

Referenced by clampedPlateFaPatchField< Type >::evaluate(), and zeroGradientFaPatchField< Type >::evaluate().

Here is the caller graph for this function:

valueInternalCoeffs()

virtual tmp<Field<Type> > valueInternalCoeffs ( const tmp< Field< scalar >> &  ) const

inlinevirtual

Definition at line 384 of file faPatchField.H.

Referenced by gaussConvectionScheme< Type >::famDiv().

Here is the caller graph for this function:

valueBoundaryCoeffs()

virtual tmp<Field<Type> > valueBoundaryCoeffs ( const tmp< Field< scalar >> &  ) const

inlinevirtual

Definition at line 395 of file faPatchField.H.

Referenced by gaussConvectionScheme< Type >::famDiv().

Here is the caller graph for this function:

gradientInternalCoeffs()

virtual tmp<Field<Type> > gradientInternalCoeffs ( ) const

inlinevirtual

Definition at line 405 of file faPatchField.H.

Referenced by gaussLaplacianScheme< Type >::famLaplacian().

Here is the caller graph for this function:

gradientBoundaryCoeffs()

virtual tmp<Field<Type> > gradientBoundaryCoeffs ( ) const

inlinevirtual

Definition at line 413 of file faPatchField.H.

Referenced by gaussLaplacianScheme< Type >::famLaplacian().

Here is the caller graph for this function:

write()

void write ( Ostream &  os ) const

virtual

Reimplemented in mixedFaPatchField< Type >, coupledFaPatchField< Type >, timeVaryingUniformFixedValueFaPatchField< Type >, clampedPlateFaPatchField< Type >, fixedGradientFaPatchField< Type >, fixedValueFaPatchField< Type >, fixedValueOutflowFaPatchField< Type >, calculatedFaPatchField< Type >, inletOutletFaPatchField< Type >, and genericFaPatchField< Type >.

Definition at line 200 of file faPatchField.C.

Referenced by clampedPlateFaPatchField< Type >::write().

Here is the caller graph for this function:

check()

void check

(

const faPatchField< Type > &

ptf

)

const

Definition at line 143 of file faPatchField.C.

operator=() [1/3]

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

virtual

Reimplemented in mixedFaPatchField< Type >, fixedValueFaPatchField< Type >, and fixedValueOutflowFaPatchField< Type >.

Referenced by clampedPlateFaPatchField< Type >::clampedPlateFaPatchField().

Here is the caller graph for this function:

operator=() [2/3]

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

virtual

Reimplemented in mixedFaPatchField< Type >, fixedValueFaPatchField< Type >, fixedValueOutflowFaPatchField< Type >, and transformFaPatchField< Type >.

operator+=() [1/3]

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

virtual

Reimplemented in mixedFaPatchField< Type >, fixedValueFaPatchField< Type >, and fixedValueOutflowFaPatchField< Type >.

operator-=() [1/3]

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

virtual

Reimplemented in mixedFaPatchField< Type >, fixedValueFaPatchField< Type >, and fixedValueOutflowFaPatchField< Type >.

operator*=() [1/3]

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

virtual

Reimplemented in mixedFaPatchField< Type >, fixedValueFaPatchField< Type >, and fixedValueOutflowFaPatchField< Type >.

operator/=() [1/3]

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

virtual

Reimplemented in mixedFaPatchField< Type >, fixedValueFaPatchField< Type >, and fixedValueOutflowFaPatchField< Type >.

operator+=() [2/3]

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

virtual

Reimplemented in mixedFaPatchField< Type >, fixedValueFaPatchField< Type >, and fixedValueOutflowFaPatchField< Type >.

operator-=() [2/3]

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

virtual

Reimplemented in mixedFaPatchField< Type >, fixedValueFaPatchField< Type >, and fixedValueOutflowFaPatchField< Type >.

operator*=() [2/3]

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

virtual

Reimplemented in mixedFaPatchField< Type >, fixedValueFaPatchField< Type >, and fixedValueOutflowFaPatchField< Type >.

operator/=() [2/3]

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

virtual

Reimplemented in mixedFaPatchField< Type >, fixedValueFaPatchField< Type >, and fixedValueOutflowFaPatchField< Type >.

operator=() [3/3]

virtual void operator= ( const Type &  )

virtual

Reimplemented in mixedFaPatchField< Type >, fixedValueFaPatchField< Type >, and fixedValueOutflowFaPatchField< Type >.

operator+=() [3/3]

virtual void operator+= ( const Type &  )

virtual

Reimplemented in mixedFaPatchField< Type >, fixedValueFaPatchField< Type >, and fixedValueOutflowFaPatchField< Type >.

operator-=() [3/3]

virtual void operator-= ( const Type &  )

virtual

Reimplemented in mixedFaPatchField< Type >, fixedValueFaPatchField< Type >, and fixedValueOutflowFaPatchField< Type >.

operator*=() [3/3]

virtual void operator*= ( const  scalar )

virtual

Reimplemented in mixedFaPatchField< Type >, fixedValueFaPatchField< Type >, and fixedValueOutflowFaPatchField< Type >.

operator/=() [3/3]

virtual void operator/= ( const  scalar )

virtual

Reimplemented in mixedFaPatchField< Type >, fixedValueFaPatchField< Type >, and fixedValueOutflowFaPatchField< Type >.

operator==() [1/3]

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

virtual

operator==() [2/3]

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

virtual

operator==() [3/3]

virtual void operator== ( const Type &  )

virtual

NewCalculatedType() [2/2]

Foam::tmp<Foam::faPatchField<Type> > NewCalculatedType

(

const faPatchField< Type2 > &

pf

)

Definition at line 96 of file calculatedFaPatchField.C.

Friends And Related Function Documentation

operator

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

friend

Member Data Documentation

disallowGenericFaPatchField

int disallowGenericFaPatchField

static

Definition at line 107 of file faPatchField.H.

---

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

• src/finiteArea/fields/areaFields/areaFieldsFwd.H
• src/finiteArea/fields/faPatchFields/faPatchField/faPatchField.H
• src/finiteArea/fields/faPatchFields/basic/calculated/calculatedFaPatchField.C
• src/finiteArea/fields/faPatchFields/faPatchField/faPatchField.C