faePatchField Class Reference

faePatchField<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 faePatchField:

Public Types
typedef faPatch	Patch
typedef calculatedFaePatchField< Type >	Calculated

Public Member Functions
	TypeName ("faePatchField")
	declareRunTimeSelectionTable (tmp, faePatchField, patch,(const faPatch &p, const DimensionedField< Type, edgeMesh > &iF),(p, iF))
	declareRunTimeSelectionTable (tmp, faePatchField, patchMapper,(const faePatchField< Type > &ptf, const faPatch &p, const DimensionedField< Type, edgeMesh > &iF, const faPatchFieldMapper &m),(dynamic_cast< const faePatchFieldType & >(ptf), p, iF, m))
	declareRunTimeSelectionTable (tmp, faePatchField, dictionary,(const faPatch &p, const DimensionedField< Type, edgeMesh > &iF, const dictionary &dict),(p, iF, dict))
	faePatchField (const faPatch &, const DimensionedField< Type, edgeMesh > &)
	faePatchField (const faPatch &, const DimensionedField< Type, edgeMesh > &, const Field< Type > &)
	faePatchField (const faPatch &, const DimensionedField< Type, edgeMesh > &, const dictionary &)
	faePatchField (const faePatchField< Type > &, const faPatch &, const DimensionedField< Type, edgeMesh > &, const faPatchFieldMapper &)
	faePatchField (const faePatchField< Type > &)
virtual tmp< faePatchField< Type > >	clone () const
	faePatchField (const faePatchField< Type > &, const DimensionedField< Type, edgeMesh > &)
virtual tmp< faePatchField< Type > >	clone (const DimensionedField< Type, edgeMesh > &iF) const
virtual	~faePatchField ()=default
const objectRegistry &	db () const
const faPatch &	patch () const
const DimensionedField< Type, edgeMesh > &	internalField () const
const Field< Type > &	primitiveField () const
virtual bool	fixesValue () const
virtual bool	coupled () const
virtual void	autoMap (const faPatchFieldMapper &)
virtual void	rmap (const faePatchField< Type > &, const labelList &)
virtual void	write (Ostream &) const
void	check (const faePatchField< Type > &) const
virtual void	operator= (const UList< Type > &)
virtual void	operator= (const faePatchField< Type > &)
virtual void	operator+= (const faePatchField< Type > &)
virtual void	operator-= (const faePatchField< Type > &)
virtual void	operator*= (const faePatchField< scalar > &)
virtual void	operator/= (const faePatchField< 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 faePatchField< Type > &)
virtual void	operator== (const Field< Type > &)
virtual void	operator== (const Type &)
template<class Type2 >
Foam::tmp< Foam::faePatchField< Type > >	NewCalculatedType (const faePatchField< Type2 > &pf)

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

Static Public Attributes
static int	disallowGenericFaePatchField

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

Detailed Description

faePatchField<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.

Finite area edge-based patch fields.

Author Zeljko Tukovic, FMENA Hrvoje Jasak, Wikki Ltd.

Source files

• faePatchField.H
• faePatchField.C
• newPatchField.C

Definition at line 43 of file edgeFieldsFwd.H.

Member Typedef Documentation

Patch

typedef faPatch Patch

Definition at line 91 of file faePatchField.H.

Calculated

typedef calculatedFaePatchField<Type> Calculated

Definition at line 92 of file faePatchField.H.

Constructor & Destructor Documentation

faePatchField() [1/6]

faePatchField	(	const faPatch &	,
		const DimensionedField< Type, edgeMesh > &
	)

faePatchField() [2/6]

faePatchField	(	const faPatch &	,
		const DimensionedField< Type, edgeMesh > &	,
		const Field< Type > &
	)

faePatchField() [3/6]

faePatchField	(	const faPatch &	,
		const DimensionedField< Type, edgeMesh > &	,
		const dictionary &
	)

faePatchField() [4/6]

faePatchField	(	const faePatchField< Type > &	,
		const faPatch &	,
		const DimensionedField< Type, edgeMesh > &	,
		const faPatchFieldMapper &
	)

faePatchField() [5/6]

faePatchField

(

const faePatchField< Type > &

)

faePatchField() [6/6]

faePatchField	(	const faePatchField< Type > &	,
		const DimensionedField< Type, edgeMesh > &
	)

~faePatchField()

virtual ~faePatchField ( )

virtualdefault

Member Function Documentation

TypeName()

TypeName

(

"faePatchField"

)

declareRunTimeSelectionTable() [1/3]

declareRunTimeSelectionTable	(	tmp	,
		faePatchField	,
		patch	,
		(const faPatch &p, const DimensionedField< Type, edgeMesh > &iF)	,
		(p, iF)
	)

declareRunTimeSelectionTable() [2/3]

declareRunTimeSelectionTable	(	tmp	,
		faePatchField	,
		patchMapper	,
		(const faePatchField< Type > &ptf, const faPatch &p, const DimensionedField< Type, edgeMesh > &iF, const faPatchFieldMapper &m)	,
		(dynamic_cast< const faePatchFieldType & >(ptf), p, iF, m)
	)

declareRunTimeSelectionTable() [3/3]

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

clone() [1/2]

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

inlinevirtual

Definition at line 182 of file faePatchField.H.

clone() [2/2]

virtual tmp<faePatchField<Type> > clone ( const DimensionedField< Type, edgeMesh > &  iF ) const

inlinevirtual

Reimplemented in processorFaePatchField< Type >, cyclicFaePatchField< Type >, symmetryFaePatchField< Type >, fixedValueFaePatchField< Type >, emptyFaePatchField< Type >, calculatedFaePatchField< Type >, wedgeFaePatchField< Type >, and coupledFaePatchField< Type >.

Definition at line 196 of file faePatchField.H.

New() [1/3]

static tmp<faePatchField<Type> > New ( const word &  , const faPatch &  , const DimensionedField< Type, edgeMesh > &    )

static

New() [2/3]

static tmp<faePatchField<Type> > New ( const faePatchField< Type > &  , const faPatch &  , const DimensionedField< Type, edgeMesh > &  , const faPatchFieldMapper &    )

static

New() [3/3]

static tmp<faePatchField<Type> > New ( const faPatch &  , const DimensionedField< Type, edgeMesh > &  , const dictionary &    )

static

NewCalculatedType() [1/2]

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

static

db()

const Foam::objectRegistry & db

(

)

const

Definition at line 122 of file faePatchField.C.

patch()

const faPatch& patch ( ) const

inline

Definition at line 259 of file faePatchField.H.

Referenced by faePatchField< Type >::NewCalculatedType().

Here is the caller graph for this function:

internalField()

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

inline

Definition at line 265 of file faePatchField.H.

primitiveField()

const Field<Type>& primitiveField ( ) const

inline

Definition at line 271 of file faePatchField.H.

calculatedType()

const Foam::word & calculatedType ( )

static

Definition at line 28 of file calculatedFaePatchField.C.

fixesValue()

virtual bool fixesValue ( ) const

inlinevirtual

Definition at line 282 of file faePatchField.H.

coupled()

virtual bool coupled ( ) const

inlinevirtual

Definition at line 288 of file faePatchField.H.

autoMap()

void autoMap ( const faPatchFieldMapper &  m )

virtual

Reimplemented in emptyFaePatchField< Type >.

Definition at line 143 of file faePatchField.C.

rmap()

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

virtual

Reimplemented in emptyFaePatchField< Type >.

Definition at line 153 of file faePatchField.C.

write()

void write ( Ostream &  os ) const

virtual

Reimplemented in fixedValueFaePatchField< Type >, calculatedFaePatchField< Type >, and coupledFaePatchField< Type >.

Definition at line 163 of file faePatchField.C.

check()

void check

(

const faePatchField< Type > &

ptf

)

const

Definition at line 130 of file faePatchField.C.

operator=() [1/3]

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

virtual

Reimplemented in fixedValueFaePatchField< Type >.

operator=() [2/3]

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

virtual

Reimplemented in fixedValueFaePatchField< Type >.

operator+=() [1/3]

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

virtual

Reimplemented in fixedValueFaePatchField< Type >.

operator-=() [1/3]

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

virtual

Reimplemented in fixedValueFaePatchField< Type >.

operator*=() [1/3]

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

virtual

Reimplemented in fixedValueFaePatchField< Type >.

operator/=() [1/3]

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

virtual

Reimplemented in fixedValueFaePatchField< Type >.

operator+=() [2/3]

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

virtual

Reimplemented in fixedValueFaePatchField< Type >.

operator-=() [2/3]

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

virtual

Reimplemented in fixedValueFaePatchField< Type >.

operator*=() [2/3]

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

virtual

Reimplemented in fixedValueFaePatchField< Type >.

operator/=() [2/3]

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

virtual

Reimplemented in fixedValueFaePatchField< Type >.

operator=() [3/3]

virtual void operator= ( const Type &  )

virtual

Reimplemented in fixedValueFaePatchField< Type >.

operator+=() [3/3]

virtual void operator+= ( const Type &  )

virtual

Reimplemented in fixedValueFaePatchField< Type >.

operator-=() [3/3]

virtual void operator-= ( const Type &  )

virtual

Reimplemented in fixedValueFaePatchField< Type >.

operator*=() [3/3]

virtual void operator*= ( const  scalar )

virtual

Reimplemented in fixedValueFaePatchField< Type >.

operator/=() [3/3]

virtual void operator/= ( const  scalar )

virtual

Reimplemented in fixedValueFaePatchField< Type >.

operator==() [1/3]

virtual void operator== ( const faePatchField< 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::faePatchField<Type> > NewCalculatedType

(

const faePatchField< Type2 > &

pf

)

Definition at line 96 of file calculatedFaePatchField.C.

Friends And Related Function Documentation

operator

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

friend

Member Data Documentation

disallowGenericFaePatchField

int disallowGenericFaePatchField

static

Definition at line 99 of file faePatchField.H.

---

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

• src/finiteArea/fields/edgeFields/edgeFieldsFwd.H
• src/finiteArea/fields/faePatchFields/faePatchField/faePatchField.H
• src/finiteArea/fields/faePatchFields/basic/calculated/calculatedFaePatchField.C
• src/finiteArea/fields/faePatchFields/faePatchField/faePatchField.C