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]

Public Types

typedef fvPatch Patch
 
typedef calculatedFvsPatchField< Type > Calculated
 

Public Member Functions

 TypeName ("fvsPatchField")
 Runtime type information. More...
 
 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. More...
 
 fvsPatchField (const fvPatch &, const DimensionedField< Type, surfaceMesh > &, const Field< Type > &)
 Construct from patch and internal field and patch field. More...
 
 fvsPatchField (const fvPatch &, const DimensionedField< Type, surfaceMesh > &, const dictionary &)
 Construct from patch, internal field and dictionary. More...
 
 fvsPatchField (const fvsPatchField< Type > &, const fvPatch &, const DimensionedField< Type, surfaceMesh > &, const fvPatchFieldMapper &)
 Construct by mapping the given fvsPatchField onto a new patch. More...
 
 fvsPatchField (const fvsPatchField< Type > &)
 Construct as copy. More...
 
virtual tmp< fvsPatchField< Type > > clone () const
 Construct and return a clone. More...
 
 fvsPatchField (const fvsPatchField< Type > &, const DimensionedField< Type, surfaceMesh > &)
 Construct as copy setting internal field reference. More...
 
virtual tmp< fvsPatchField< Type > > clone (const DimensionedField< Type, surfaceMesh > &iF) const
 Construct and return a clone setting internal field reference. More...
 
virtual ~fvsPatchField ()=default
 Destructor. More...
 
const objectRegistrydb () const
 Return local objectRegistry. More...
 
const fvPatchpatch () const
 Return patch. More...
 
const DimensionedField< Type, surfaceMesh > & 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 fvPatchFieldMapper &)
 Map (and resize as needed) from self given a mapping object. More...
 
virtual void rmap (const fvsPatchField< Type > &, const labelList &)
 Reverse map the given fvsPatchField onto this fvsPatchField. More...
 
virtual void write (Ostream &) const
 Write. More...
 
void check (const fvsPatchField< Type > &) const
 Check fvsPatchField<Type> against given fvsPatchField<Type> More...
 
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 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 > &)
 Return a pointer to a new patchField created on freestore given. More...
 
static tmp< fvsPatchField< Type > > New (const word &, const word &actualPatchType, const fvPatch &, const DimensionedField< Type, surfaceMesh > &)
 Return a pointer to a new patchField created on freestore given. More...
 
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. More...
 
static tmp< fvsPatchField< Type > > New (const fvPatch &, const DimensionedField< Type, surfaceMesh > &, const dictionary &)
 Return a pointer to a new patchField created on freestore. More...
 
static tmp< fvsPatchField< Type > > NewCalculatedType (const fvPatch &)
 Return a pointer to a new calculatedFvsPatchField created on. More...
 
template<class Type2 >
static tmp< fvsPatchField< Type > > NewCalculatedType (const fvsPatchField< Type2 > &)
 Return a pointer to a new calculatedFvsPatchField created on. More...
 
static const wordcalculatedType ()
 Return the type of the calculated for of fvsPatchField. More...
 

Static Public Attributes

static int disallowGenericFvsPatchField
 Debug switch to disallow the use of genericFvsPatchField. More...
 

Friends

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

Source files

Definition at line 68 of file fvsPatchField.H.

Member Typedef Documentation

◆ Patch

typedef fvPatch Patch

Definition at line 97 of file fvsPatchField.H.

◆ Calculated

Definition at line 98 of file fvsPatchField.H.

Constructor & Destructor Documentation

◆ fvsPatchField() [1/6]

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

Construct from patch and internal field.

Definition at line 39 of file fvsPatchField.C.

◆ fvsPatchField() [2/6]

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

Construct from patch and internal field and patch field.

Definition at line 52 of file fvsPatchField.C.

◆ fvsPatchField() [3/6]

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

Construct from patch, internal field and dictionary.

Definition at line 81 of file fvsPatchField.C.

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

Here is the call graph for this function:

◆ fvsPatchField() [4/6]

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

Construct by mapping the given fvsPatchField onto a new patch.

Definition at line 66 of file fvsPatchField.C.

◆ fvsPatchField() [5/6]

fvsPatchField ( const fvsPatchField< Type > &  ptf)

Construct as copy.

Definition at line 108 of file fvsPatchField.C.

◆ fvsPatchField() [6/6]

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

Construct as copy setting internal field reference.

Definition at line 118 of file fvsPatchField.C.

◆ ~fvsPatchField()

virtual ~fvsPatchField ( )
virtualdefault

Destructor.

Member Function Documentation

◆ TypeName()

TypeName ( "fvsPatchField< Type >"  )

Runtime type information.

◆ declareRunTimeSelectionTable() [1/3]

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

◆ declareRunTimeSelectionTable() [2/3]

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

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

◆ clone() [1/2]

◆ clone() [2/2]

◆ New() [1/4]

Foam::tmp< Foam::fvsPatchField< Type > > New ( const word patchFieldType,
const fvPatch p,
const DimensionedField< Type, surfaceMesh > &  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 74 of file fvsPatchFieldNew.C.

References Foam::New(), and p.

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

Here is the call graph for this function:
Here is the caller graph for this function:

◆ New() [2/4]

Foam::tmp< Foam::fvsPatchField< Type > > New ( const word patchFieldType,
const word actualPatchType,
const fvPatch p,
const DimensionedField< Type, surfaceMesh > &  iF 
)
static

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

patch and internal field (does not set the patch field values) Allows override of constraint type

Definition at line 33 of file fvsPatchFieldNew.C.

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

Here is the call graph for this function:

◆ New() [3/4]

Foam::tmp< Foam::fvsPatchField< Type > > New ( const fvsPatchField< Type > &  ptf,
const fvPatch p,
const DimensionedField< Type, surfaceMesh > &  iF,
const fvPatchFieldMapper pfMapper 
)
static

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

a given fvsPatchField mapped onto a new patch

Definition at line 140 of file fvsPatchFieldNew.C.

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

Here is the call graph for this function:

◆ New() [4/4]

Foam::tmp< Foam::fvsPatchField< Type > > New ( const fvPatch p,
const DimensionedField< Type, surfaceMesh > &  iF,
const dictionary dict 
)
static

Return a pointer to a new patchField created on freestore.

from dictionary

Definition at line 86 of file fvsPatchFieldNew.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/3]

Foam::tmp< Foam::fvsPatchField< Type > > NewCalculatedType ( const fvPatch p)
static

Return a pointer to a new calculatedFvsPatchField created on.

freestore without setting patchField values

Definition at line 102 of file calculatedFvsPatchField.C.

References p.

◆ NewCalculatedType() [2/3]

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

Return a pointer to a new calculatedFvsPatchField created on.

freestore without setting patchField values

◆ db()

const Foam::objectRegistry & db ( ) const

Return local objectRegistry.

Definition at line 132 of file fvsPatchField.C.

◆ patch()

◆ internalField()

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

Return dimensioned internal field reference.

Definition at line 287 of file fvsPatchField.H.

◆ primitiveField()

const Field<Type>& primitiveField ( ) const
inline

Return internal field reference.

Definition at line 293 of file fvsPatchField.H.

◆ calculatedType()

const Foam::word & calculatedType ( )
static

Return the type of the calculated for of fvsPatchField.

Definition at line 35 of file calculatedFvsPatchField.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 slicedFvsPatchField< Type >, fixedValueFvsPatchField< Type >, and calculatedFvsPatchField< Type >.

Definition at line 304 of file fvsPatchField.H.

◆ coupled()

◆ autoMap()

void autoMap ( const fvPatchFieldMapper m)
virtual

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

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

Definition at line 151 of file fvsPatchField.C.

References Field< Type >::autoMap().

Here is the call graph for this function:

◆ rmap()

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

Reverse map the given fvsPatchField onto this fvsPatchField.

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

Definition at line 160 of file fvsPatchField.C.

References Field< Type >::rmap().

Here is the call graph for this function:

◆ write()

void write ( Ostream os) const
virtual

Write.

Reimplemented in genericFvsPatchField< Type >.

Definition at line 170 of file fvsPatchField.C.

References os(), Foam::type(), and Ostream::writeEntry().

Here is the call graph for this function:

◆ check()

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

Check fvsPatchField<Type> against given fvsPatchField<Type>

Definition at line 139 of file fvsPatchField.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 fixedValueFvsPatchField< Type >, and slicedFvsPatchField< Type >.

Definition at line 181 of file fvsPatchField.C.

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

Here is the call graph for this function:

◆ operator=() [2/3]

void operator= ( const fvsPatchField< Type > &  ptf)
virtual

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

Definition at line 191 of file fvsPatchField.C.

References Foam::check(), and Field< Type >::operator=().

Here is the call graph for this function:

◆ operator+=() [1/3]

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

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

Definition at line 202 of file fvsPatchField.C.

References Foam::check(), and Field< Type >::operator+=().

Here is the call graph for this function:

◆ operator-=() [1/3]

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

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

Definition at line 213 of file fvsPatchField.C.

References Foam::check(), and Field< Type >::operator-=().

Here is the call graph for this function:

◆ operator*=() [1/3]

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

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

Definition at line 224 of file fvsPatchField.C.

References Foam::abort(), Foam::FatalError, FatalErrorInFunction, Field< Type >::operator*=(), and fvsPatchField< Type >::patch().

Here is the call graph for this function:

◆ operator/=() [1/3]

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

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

Definition at line 241 of file fvsPatchField.C.

References Foam::abort(), Foam::FatalError, FatalErrorInFunction, Field< Type >::operator/=(), and fvsPatchField< Type >::patch().

Here is the call graph for this function:

◆ operator+=() [2/3]

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

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

Definition at line 257 of file fvsPatchField.C.

References Field< Type >::operator+=().

Here is the call graph for this function:

◆ operator-=() [2/3]

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

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

Definition at line 267 of file fvsPatchField.C.

References Field< Type >::operator-=().

Here is the call graph for this function:

◆ operator*=() [2/3]

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

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

Definition at line 277 of file fvsPatchField.C.

References Field< Type >::operator*=().

Here is the call graph for this function:

◆ operator/=() [2/3]

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

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

Definition at line 287 of file fvsPatchField.C.

References Field< Type >::operator/=().

Here is the call graph for this function:

◆ operator=() [3/3]

void operator= ( const Type &  t)
virtual

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

Definition at line 297 of file fvsPatchField.C.

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

Here is the call graph for this function:

◆ operator+=() [3/3]

void operator+= ( const Type &  t)
virtual

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

Definition at line 307 of file fvsPatchField.C.

References Field< Type >::operator+=().

Here is the call graph for this function:

◆ operator-=() [3/3]

void operator-= ( const Type &  t)
virtual

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

Definition at line 317 of file fvsPatchField.C.

References Field< Type >::operator-=().

Here is the call graph for this function:

◆ operator*=() [3/3]

void operator*= ( const scalar  s)
virtual

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

Definition at line 327 of file fvsPatchField.C.

References Field< Type >::operator*=(), and s.

Here is the call graph for this function:

◆ operator/=() [3/3]

void operator/= ( const scalar  s)
virtual

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

Definition at line 337 of file fvsPatchField.C.

References Field< Type >::operator/=(), and s.

Here is the call graph for this function:

◆ operator==() [1/3]

void operator== ( const fvsPatchField< Type > &  ptf)
virtual

Definition at line 347 of file fvsPatchField.C.

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

Here is the call graph for this function:

◆ operator==() [2/3]

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

Definition at line 357 of file fvsPatchField.C.

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

Here is the call graph for this function:

◆ operator==() [3/3]

void operator== ( const Type &  t)
virtual

Definition at line 367 of file fvsPatchField.C.

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

Here is the call graph for this function:

◆ NewCalculatedType() [3/3]

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

Definition at line 134 of file calculatedFvsPatchField.C.

References fvsPatchField< Type >::patch().

Here is the call graph for this function:

Friends And Related Function Documentation

◆ operator

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

Member Data Documentation

◆ disallowGenericFvsPatchField

int disallowGenericFvsPatchField
static

Debug switch to disallow the use of genericFvsPatchField.

Definition at line 105 of file fvsPatchField.H.


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