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

[legend]

Public Types
typedef faPatch	Patch

typedef calculatedFaePatchField< Type >	Calculated

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

	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 > &)
	Construct from patch and internal field. More...

	faePatchField (const faPatch &, const DimensionedField< Type, edgeMesh > &, const Field< Type > &)
	Construct from patch and internal field and patch field. More...

	faePatchField (const faPatch &, const DimensionedField< Type, edgeMesh > &, const dictionary &)
	Construct from patch, internal field and dictionary. More...

	faePatchField (const faePatchField< Type > &, const faPatch &, const DimensionedField< Type, edgeMesh > &, const faPatchFieldMapper &)
	Construct by mapping the given faePatchField onto a new patch. More...

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

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

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

virtual tmp< faePatchField< Type > >	clone (const DimensionedField< Type, edgeMesh > &iF) const
	Construct and return a clone setting internal field reference. More...

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

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

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

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

const Field< Type > &	primitiveField () 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 faPatchFieldMapper &)
	Map (and resize as needed) from self given a mapping object. More...

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

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

void	check (const faePatchField< Type > &) const
	Check faePatchField<Type> against given faePatchField<Type> More...

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 > &)
	Return a pointer to a new patchField created on freestore given. More...

static tmp< faePatchField< Type > >	New (const faePatchField< Type > &, const faPatch &, const DimensionedField< Type, edgeMesh > &, const faPatchFieldMapper &)
	Return a pointer to a new patchField created on freestore from. More...

static tmp< faePatchField< Type > >	New (const faPatch &, const DimensionedField< Type, edgeMesh > &, const dictionary &)
	Return a pointer to a new patchField created on freestore. More...

template<class Type2 >
static tmp< faePatchField< Type > >	NewCalculatedType (const faePatchField< Type2 > &)
	Return a pointer to a new calculatedFaePatchField created on. More...

static const word &	calculatedType ()
	Return the type of the calculated for of faePatchField. More...

Static Public Attributes
static int	disallowGenericFaePatchField
	Debug switch to disallow the use of. More...

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

Detailed Description

template<class Type>
class Foam::faePatchField< Type >

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

Definition at line 49 of file edgeFieldsFwd.H.

Member Typedef Documentation

◆ Patch

typedef faPatch Patch

Definition at line 95 of file faePatchField.H.

◆ Calculated

typedef calculatedFaePatchField<Type> Calculated

Definition at line 96 of file faePatchField.H.

Constructor & Destructor Documentation

◆ faePatchField() [1/6]

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

Construct from patch and internal field.

Definition at line 35 of file faePatchField.C.

◆ faePatchField() [2/6]

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

Construct from patch and internal field and patch field.

Definition at line 48 of file faePatchField.C.

◆ faePatchField() [3/6]

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

Construct from patch, internal field and dictionary.

Definition at line 77 of file faePatchField.C.

References dict, and p.

◆ faePatchField() [4/6]

faePatchField	(	const faePatchField< Type > &	ptf,
		const faPatch &	p,
		const DimensionedField< Type, edgeMesh > &	iF,
		const faPatchFieldMapper &	mapper
	)

Construct by mapping the given faePatchField onto a new patch.

Definition at line 62 of file faePatchField.C.

◆ faePatchField() [5/6]

faePatchField ( const faePatchField< Type > & ptf )

Construct as copy.

Definition at line 103 of file faePatchField.C.

◆ faePatchField() [6/6]

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

Construct as copy setting internal field reference.

Definition at line 115 of file faePatchField.C.

◆ ~faePatchField()

virtual ~faePatchField ( )

virtualdefault

Destructor.

Member Function Documentation

◆ TypeName()

TypeName ( "faePatchField< Type >" )

Runtime type information.

◆ declareRunTimeSelectionTable() [1/3]

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

◆ declareRunTimeSelectionTable() [2/3]

declareRunTimeSelectionTable	(	tmp	,
		faePatchField< Type >	,
		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< Type >	,
		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

Construct and return a clone.

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

Definition at line 186 of file faePatchField.H.

◆ clone() [2/2]

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

inlinevirtual

Construct and return a clone setting internal field reference.

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

Definition at line 200 of file faePatchField.H.

◆ New() [1/3]

Foam::tmp< Foam::faePatchField< Type > > New	(	const word &	patchFieldType,
		const faPatch &	p,
		const DimensionedField< Type, edgeMesh > &	iF
	)

static

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

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

Definition at line 33 of file faePatchFieldNew.C.

References DebugInFunction, Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInLookup, and p.

Here is the call graph for this function:

◆ New() [2/3]

Foam::tmp< Foam::faePatchField< Type > > New	(	const faePatchField< Type > &	ptf,
		const faPatch &	p,
		const DimensionedField< Type, edgeMesh > &	iF,
		const faPatchFieldMapper &	pfMapper
	)

static

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

a given faePatchField mapped onto a new patch

Definition at line 115 of file faePatchFieldNew.C.

References DebugInFunction, Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInLookup, and p.

Here is the call graph for this function:

◆ New() [3/3]

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

static

Return a pointer to a new patchField created on freestore.

from dictionary

Definition at line 68 of file faePatchFieldNew.C.

References DebugInFunction, dict, Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, Foam::nl, and p.

Here is the call graph for this function:

◆ NewCalculatedType() [1/2]

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

static

Return a pointer to a new calculatedFaePatchField created on.

freestore without setting patchField values

◆ db()

const Foam::objectRegistry & db ( ) const

Return local objectRegistry.

Definition at line 129 of file faePatchField.C.

References IOobject::db().

Here is the call graph for this function:

◆ patch()

const faPatch& patch ( ) const

inline

Return patch.

Definition at line 263 of file faePatchField.H.

Referenced by faePatchField< Type >::NewCalculatedType(), faePatchField< Type >::operator*=(), and faePatchField< Type >::operator/=().

Here is the caller graph for this function:

◆ internalField()

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

inline

Return dimensioned internal field reference.

Definition at line 269 of file faePatchField.H.

◆ primitiveField()

const Field<Type>& primitiveField ( ) const

inline

Return internal field reference.

Definition at line 275 of file faePatchField.H.

◆ calculatedType()

const Foam::word & calculatedType ( )

static

Return the type of the calculated for of faePatchField.

Definition at line 35 of file calculatedFaePatchField.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.

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

Definition at line 286 of file faePatchField.H.

◆ coupled()

virtual bool coupled ( ) const

inlinevirtual

Return true if this patch field is coupled.

Reimplemented in processorFaePatchField< Type >, and coupledFaePatchField< Type >.

Definition at line 292 of file faePatchField.H.

◆ autoMap()

void autoMap ( const faPatchFieldMapper & m )

virtual

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

Reimplemented in emptyFaePatchField< Type >.

Definition at line 150 of file faePatchField.C.

◆ rmap()

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

virtual

Reverse map the given faePatchField onto this faePatchField.

Reimplemented in emptyFaePatchField< Type >.

Definition at line 160 of file faePatchField.C.

◆ write()

void write ( Ostream & os ) const

virtual

Write.

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

Definition at line 170 of file faePatchField.C.

References os().

Here is the call graph for this function:

◆ check()

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

Check faePatchField<Type> against given faePatchField<Type>

Definition at line 137 of file faePatchField.C.

References Foam::abort(), Foam::FatalError, and FatalErrorInFunction.

Here is the call graph for this function:

◆ operator=() [1/3]

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

virtual

Reimplemented in fixedValueFaePatchField< Type >.

Definition at line 180 of file faePatchField.C.

◆ operator=() [2/3]

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

virtual

Reimplemented in fixedValueFaePatchField< Type >.

Definition at line 190 of file faePatchField.C.

References Foam::check().

Here is the call graph for this function:

◆ operator+=() [1/3]

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

virtual

Reimplemented in fixedValueFaePatchField< Type >.

Definition at line 201 of file faePatchField.C.

References Foam::check().

Here is the call graph for this function:

◆ operator-=() [1/3]

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

virtual

Reimplemented in fixedValueFaePatchField< Type >.

Definition at line 212 of file faePatchField.C.

References Foam::check().

Here is the call graph for this function:

◆ operator*=() [1/3]

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

virtual

Reimplemented in fixedValueFaePatchField< Type >.

Definition at line 223 of file faePatchField.C.

References Foam::abort(), Foam::FatalError, FatalErrorInFunction, and faePatchField< Type >::patch().

Here is the call graph for this function:

◆ operator/=() [1/3]

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

virtual

Reimplemented in fixedValueFaePatchField< Type >.

Definition at line 240 of file faePatchField.C.

References Foam::abort(), Foam::FatalError, FatalErrorInFunction, and faePatchField< Type >::patch().

Here is the call graph for this function:

◆ operator+=() [2/3]

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

virtual

Reimplemented in fixedValueFaePatchField< Type >.

Definition at line 257 of file faePatchField.C.

◆ operator-=() [2/3]

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

virtual

Reimplemented in fixedValueFaePatchField< Type >.

Definition at line 267 of file faePatchField.C.

◆ operator*=() [2/3]

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

virtual

Reimplemented in fixedValueFaePatchField< Type >.

Definition at line 277 of file faePatchField.C.

◆ operator/=() [2/3]

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

virtual

Reimplemented in fixedValueFaePatchField< Type >.

Definition at line 287 of file faePatchField.C.

◆ operator=() [3/3]

void operator= ( const Type & t )

virtual

Reimplemented in fixedValueFaePatchField< Type >.

Definition at line 297 of file faePatchField.C.

◆ operator+=() [3/3]

void operator+= ( const Type & t )

virtual

Reimplemented in fixedValueFaePatchField< Type >.

Definition at line 307 of file faePatchField.C.

◆ operator-=() [3/3]

void operator-= ( const Type & t )

virtual

Reimplemented in fixedValueFaePatchField< Type >.

Definition at line 317 of file faePatchField.C.

◆ operator*=() [3/3]

void operator*= ( const scalar s )

virtual

Reimplemented in fixedValueFaePatchField< Type >.

Definition at line 327 of file faePatchField.C.

References s.

◆ operator/=() [3/3]

void operator/= ( const scalar s )

virtual

Reimplemented in fixedValueFaePatchField< Type >.

Definition at line 337 of file faePatchField.C.

References s.

◆ operator==() [1/3]

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

virtual

Definition at line 347 of file faePatchField.C.

◆ operator==() [2/3]

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

virtual

Definition at line 357 of file faePatchField.C.

◆ operator==() [3/3]

void operator== ( const Type & t )

virtual

Definition at line 367 of file faePatchField.C.

◆ NewCalculatedType() [2/2]

Foam::tmp<Foam::faePatchField<Type> > NewCalculatedType ( const faePatchField< Type2 > & pf )

Definition at line 103 of file calculatedFaePatchField.C.

References faePatchField< Type >::patch().

Here is the call graph for this function:

Friends And Related Function Documentation

◆ operator

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

friend

Member Data Documentation

◆ disallowGenericFaePatchField

int disallowGenericFaePatchField

static

Debug switch to disallow the use of.

Definition at line 103 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
src/finiteArea/fields/faePatchFields/faePatchField/faePatchFieldNew.C
src/finiteArea/fields/faePatchFields/faePatchField/faePatchFields.C

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Friends

Detailed Description

template<class Type> class Foam::faePatchField< Type >

Member Typedef Documentation

◆ Patch

◆ Calculated

Constructor & Destructor Documentation

◆ faePatchField() [1/6]

◆ faePatchField() [2/6]

◆ faePatchField() [3/6]

◆ faePatchField() [4/6]

◆ faePatchField() [5/6]

◆ faePatchField() [6/6]

◆ ~faePatchField()

Member Function Documentation

◆ TypeName()

◆ declareRunTimeSelectionTable() [1/3]

◆ declareRunTimeSelectionTable() [2/3]

◆ declareRunTimeSelectionTable() [3/3]

◆ clone() [1/2]

◆ clone() [2/2]

◆ New() [1/3]

◆ New() [2/3]

◆ New() [3/3]

◆ NewCalculatedType() [1/2]

◆ db()

◆ patch()

◆ internalField()

◆ primitiveField()

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

Friends And Related Function Documentation

◆ operator

Member Data Documentation

◆ disallowGenericFaePatchField

template<class Type>
class Foam::faePatchField< Type >