fvsPatchField< Type > Class Template 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< Type >:

[legend]

Collaboration diagram for fvsPatchField< Type >:

[legend]

List of all members.


Public Types
typedef fvPatch	Patch
Public Member Functions
	TypeName ("fvsPatchField")
	Runtime type information.
	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.
	fvsPatchField (const fvPatch &, const DimensionedField< Type, surfaceMesh > &, const Field< Type > &)
	Construct from patch and internal field and patch field.
	fvsPatchField (const fvPatch &, const DimensionedField< Type, surfaceMesh > &, const dictionary &)
	Construct from patch, internal field and dictionary.
	fvsPatchField (const fvsPatchField< Type > &, const fvPatch &, const DimensionedField< Type, surfaceMesh > &, const fvPatchFieldMapper &)
	Construct by mapping the given fvsPatchField onto a new patch.
	fvsPatchField (const fvsPatchField< Type > &)
	Construct as copy.
virtual tmp< fvsPatchField < Type > >	clone () const
	Construct and return a clone.
	fvsPatchField (const fvsPatchField< Type > &, const DimensionedField< Type, surfaceMesh > &)
	Construct as copy setting internal field reference.
virtual tmp< fvsPatchField < Type > >	clone (const DimensionedField< Type, surfaceMesh > &iF) const
	Construct and return a clone setting internal field reference.
virtual	~fvsPatchField ()
const objectRegistry &	db () const
	Return local objectRegistry.
const fvPatch &	patch () const
	Return patch.
const DimensionedField< Type, surfaceMesh > &	dimensionedInternalField () const
	Return dimensioned internal field reference.
const Field< Type > &	internalField () const
	Return internal field reference.
virtual bool	fixesValue () const
	Return true if this patch field fixes a value.
virtual bool	coupled () const
	Return true if this patch field is coupled.
virtual void	autoMap (const fvPatchFieldMapper &)
	Map (and resize as needed) from self given a mapping object.
virtual void	rmap (const fvsPatchField< Type > &, const labelList &)
	Reverse map the given fvsPatchField onto this fvsPatchField.
virtual void	write (Ostream &) const
	Write.
void	check (const fvsPatchField< Type > &) const
	Check fvsPatchField<Type> against given fvsPatchField<Type>.
virtual void	operator= (const UList< Type > &)
	Assignment from UList operator. Takes linear time.
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 &)
	Assignment of all entries to the given value.
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 &)
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.
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.
static tmp< fvsPatchField< Type > >	New (const fvPatch &, const DimensionedField< Type, surfaceMesh > &, const dictionary &)
	Return a pointer to a new patchField created on freestore.
template<class Type2 >
static tmp< fvsPatchField< Type > >	NewCalculatedType (const fvsPatchField< Type2 > &)
	Return a pointer to a new calculatedFvsPatchField created on.
static const word &	calculatedType ()
	Return the type of the calculated for of fvsPatchField.
Static Public Attributes
static int	disallowDefaultFvsPatchField
	Debug switch to disallow the use of.
Friends
Ostream &	operator (Ostream &, const fvsPatchField< Type > &)

Detailed Description

template<class Type>
class Foam::fvsPatchField< Type >

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 72 of file fvsPatchField.H.

Member Typedef Documentation

typedef fvPatch Patch

Definition at line 87 of file fvsPatchField.H.

Constructor & Destructor Documentation

fvsPatchField	(	const fvPatch &	p,
		const DimensionedField< Type, surfaceMesh > &	iF
	)			`[inline]`

Construct from patch and internal field.

Definition at line 32 of file fvsPatchField.C.

References p.

fvsPatchField	(	const fvPatch &	p,
		const DimensionedField< Type, surfaceMesh > &	iF,
		const Field< Type > &	f
	)			`[inline]`

Construct from patch and internal field and patch field.

Definition at line 45 of file fvsPatchField.C.

fvsPatchField	(	const fvPatch &	p,
		const DimensionedField< Type, surfaceMesh > &	iF,
		const dictionary &	dict
	)			`[inline]`

Construct from patch, internal field and dictionary.

Definition at line 74 of file fvsPatchField.C.

fvsPatchField	(	const fvsPatchField< Type > &	ptf,
		const fvPatch &	p,
		const DimensionedField< Type, surfaceMesh > &	iF,
		const fvPatchFieldMapper &	mapper
	)			`[inline]`

Construct by mapping the given fvsPatchField onto a new patch.

Definition at line 59 of file fvsPatchField.C.

fvsPatchField ( const fvsPatchField< Type > & ptf ) [inline]

Construct as copy.

Definition at line 100 of file fvsPatchField.C.

References fvsPatchField< Type >::operator=().

Here is the call graph for this function:

fvsPatchField	(	const fvsPatchField< Type > &	ptf,
		const DimensionedField< Type, surfaceMesh > &	iF
	)			`[inline]`

Construct as copy setting internal field reference.

Definition at line 112 of file fvsPatchField.C.

virtual ~fvsPatchField ( ) [inline, virtual]

Member Function Documentation

TypeName ( "fvsPatchField< Type >" )

Runtime type information.

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

declareRunTimeSelectionTable	(	tmp	,
		fvsPatchField< Type >	,
		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< Type >	,
		dictionary	,
		(const fvPatch &p, const DimensionedField< Type, surfaceMesh > &iF, const dictionary &dict)	,
		(p, iF, dict)
	)

virtual tmp<fvsPatchField<Type> > clone ( ) const [inline, virtual]

Construct and return a clone.

Reimplemented from Field< Type >.

Reimplemented in calculatedFvsPatchField< Type >, coupledFvsPatchField< Type >, fixedValueFvsPatchField< Type >, slicedFvsPatchField< Type >, cyclicFvsPatchField< Type >, emptyFvsPatchField< Type >, processorFvsPatchField< Type >, symmetryFvsPatchField< Type >, wedgeFvsPatchField< Type >, and coupledFvsPatchField< Type >.

Definition at line 177 of file fvsPatchField.H.

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

Construct and return a clone setting internal field reference.

Reimplemented in calculatedFvsPatchField< Type >, coupledFvsPatchField< Type >, fixedValueFvsPatchField< Type >, slicedFvsPatchField< Type >, cyclicFvsPatchField< Type >, emptyFvsPatchField< Type >, processorFvsPatchField< Type >, symmetryFvsPatchField< Type >, wedgeFvsPatchField< Type >, and coupledFvsPatchField< Type >.

Definition at line 191 of file fvsPatchField.H.

tmp< fvsPatchField< Type > > New	(	const word &	patchFieldType,
		const fvPatch &	p,
		const DimensionedField< Type, surfaceMesh > &	iF
	)			`[inline, 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 27 of file newFvsPatchField.C.

References Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorIn, Foam::Info, and p.

Here is the call graph for this function:

tmp< fvsPatchField< Type > > New	(	const fvsPatchField< Type > &	ptf,
		const fvPatch &	p,
		const DimensionedField< Type, surfaceMesh > &	iF,
		const fvPatchFieldMapper &	pfMapper
	)			`[inline, static]`

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

a given fvsPatchField mapped onto a new patch

Definition at line 149 of file newFvsPatchField.C.

tmp< fvsPatchField< Type > > New	(	const fvPatch &	p,
		const DimensionedField< Type, surfaceMesh > &	iF,
		const dictionary &	dict
	)			`[inline, static]`

Return a pointer to a new patchField created on freestore.

from dictionary

Definition at line 73 of file newFvsPatchField.C.

tmp< fvsPatchField< Type > > NewCalculatedType ( const fvsPatchField< Type2 > & pf ) [inline, static]

Return a pointer to a new calculatedFvsPatchField created on.

freestore without setting patchField values

Definition at line 94 of file calculatedFvsPatchField.C.

const objectRegistry & db ( ) const [inline]

Return local objectRegistry.

Definition at line 126 of file fvsPatchField.C.

const fvPatch& patch ( ) const [inline]

Return patch.

Definition at line 264 of file fvsPatchField.H.

Referenced by extendedUpwindCellToFaceStencil::weightedSum().

Here is the caller graph for this function:

const DimensionedField<Type, surfaceMesh>& dimensionedInternalField ( ) const [inline]

Return dimensioned internal field reference.

Definition at line 271 of file fvsPatchField.H.

const Field<Type>& internalField ( ) const [inline]

Return internal field reference.

Definition at line 277 of file fvsPatchField.H.

const word & calculatedType ( ) [inline, static]

Return the type of the calculated for of fvsPatchField.

Definition at line 27 of file calculatedFvsPatchField.C.

virtual bool fixesValue ( ) const [inline, virtual]

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 calculatedFvsPatchField< Type >, fixedValueFvsPatchField< Type >, and slicedFvsPatchField< Type >.

Definition at line 290 of file fvsPatchField.H.

virtual bool coupled ( ) const [inline, virtual]

Return true if this patch field is coupled.

Reimplemented in coupledFvsPatchField< Type >, processorFvsPatchField< Type >, and coupledFvsPatchField< Type >.

Definition at line 296 of file fvsPatchField.H.

Referenced by linearUpwind< Type >::correction(), and extendedUpwindCellToFaceStencil::weightedSum().

Here is the caller graph for this function:

void autoMap ( const fvPatchFieldMapper & m ) [inline, virtual]

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

Reimplemented in emptyFvsPatchField< Type >.

Definition at line 147 of file fvsPatchField.C.

void rmap	(	const fvsPatchField< Type > &	ptf,
		const labelList &	addr
	)			`[inline, virtual]`

Reverse map the given fvsPatchField onto this fvsPatchField.

Definition at line 158 of file fvsPatchField.C.

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

Here is the caller graph for this function:

void write ( Ostream & os ) const [inline, virtual]

Write.

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

Definition at line 169 of file fvsPatchField.C.

References fvsPatchField< Type >::rmap().

Here is the call graph for this function:

void check ( const fvsPatchField< Type > & ptf ) const [inline]

Check fvsPatchField<Type> against given fvsPatchField<Type>.

Definition at line 133 of file fvsPatchField.C.

void operator= ( const UList< Type > & ) [inline, virtual]

Assignment from UList operator. Takes linear time.

Reimplemented from Field< Type >.

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

Definition at line 179 of file fvsPatchField.C.

References Foam::nl, Foam::type(), and Ostream::writeKeyword().

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

Here is the call graph for this function:

Here is the caller graph for this function:

void operator= ( const fvsPatchField< Type > & ptf ) [inline, virtual]

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

Definition at line 189 of file fvsPatchField.C.

void operator+= ( const fvsPatchField< Type > & ptf ) [inline, virtual]

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

Definition at line 200 of file fvsPatchField.C.

void operator-= ( const fvsPatchField< Type > & ptf ) [inline, virtual]

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

Definition at line 211 of file fvsPatchField.C.

void operator*= ( const fvsPatchField< scalar > & ptf ) [inline, virtual]

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

Definition at line 222 of file fvsPatchField.C.

void operator/= ( const fvsPatchField< scalar > & ptf ) [inline, virtual]

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

Definition at line 241 of file fvsPatchField.C.

void operator+= ( const Field< Type > & tf ) [inline, virtual]

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

Definition at line 260 of file fvsPatchField.C.

void operator-= ( const Field< Type > & tf ) [inline, virtual]

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

Definition at line 270 of file fvsPatchField.C.

References tf.

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

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

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

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

void operator= ( const Type & ) [inline, virtual]

Assignment of all entries to the given value.

Reimplemented from Field< Type >.

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

Definition at line 300 of file fvsPatchField.C.

References tf.

void operator+= ( const Type & t ) [inline, virtual]

Reimplemented from Field< Type >.

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

Definition at line 310 of file fvsPatchField.C.

void operator-= ( const Type & t ) [inline, virtual]

Reimplemented from Field< Type >.

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

Definition at line 320 of file fvsPatchField.C.

void operator*= ( const scalar s ) [inline, virtual]

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

Definition at line 330 of file fvsPatchField.C.

void operator/= ( const scalar s ) [inline, virtual]

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

Definition at line 340 of file fvsPatchField.C.

void operator== ( const fvsPatchField< Type > & ptf ) [inline, virtual]

Definition at line 351 of file fvsPatchField.C.

void operator== ( const Field< Type > & tf ) [inline, virtual]

Definition at line 361 of file fvsPatchField.C.

void operator== ( const Type & t ) [inline, virtual]

Definition at line 371 of file fvsPatchField.C.

References tf.

Friends And Related Function Documentation

Ostream& operator	(	Ostream &	,
		const fvsPatchField< Type > &
	)			`[friend]`

Member Data Documentation

int disallowDefaultFvsPatchField [inline, static]

Debug switch to disallow the use of.

Definition at line 94 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
src/finiteVolume/fields/fvsPatchFields/fvsPatchField/fvsPatchFields.C
src/finiteVolume/fields/fvsPatchFields/fvsPatchField/newFvsPatchField.C

fvsPatchField< Type > Class Template Reference

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Friends

Detailed Description

template<class Type> class Foam::fvsPatchField< Type >

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation

template<class Type>
class Foam::fvsPatchField< Type >