An abstract base class with a fat-interface to all derived classes covering all possible ways in which they might be used. More...
#include <finiteVolume/fvsPatchField.H>
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.
Definition at line 77 of file fvsPatchField.H.
Inheritance diagram for fvsPatchField< Type >: Collaboration diagram for fvsPatchField< Type >: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 > &) |
Definition at line 92 of file fvsPatchField.H.
| fvsPatchField | ( | const fvPatch & | p, |
| const DimensionedField< Type, surfaceMesh > & | iF | ||
| ) |
Construct from patch and internal field.
Definition at line 40 of file fvsPatchField.C.
| 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 53 of file fvsPatchField.C.
| fvsPatchField | ( | const fvPatch & | p, |
| const DimensionedField< Type, surfaceMesh > & | iF, | ||
| const dictionary & | dict | ||
| ) |
Construct from patch, internal field and dictionary.
Definition at line 82 of file fvsPatchField.C.
References dictionary::found(), fvsPatchField< Type >::operator=(), and fvPatch::size().
| 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 67 of file fvsPatchField.C.
| fvsPatchField | ( | const fvsPatchField< Type > & | ptf ) |
Construct as copy.
Definition at line 108 of file fvsPatchField.C.
| fvsPatchField | ( | const fvsPatchField< Type > & | ptf, |
| const DimensionedField< Type, surfaceMesh > & | iF | ||
| ) |
Construct as copy setting internal field reference.
Definition at line 120 of file fvsPatchField.C.
| virtual ~fvsPatchField | ( | ) | [inline, virtual]
|
Definition at line 249 of file fvsPatchField.H.
| 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 >, and wedgeFvsPatchField< Type >.
Definition at line 182 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 >, and wedgeFvsPatchField< Type >.
Definition at line 196 of file fvsPatchField.H.
| tmp< 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 35 of file newFvsPatchField.C.
References Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorIn, Foam::Info, and p.
| tmp< 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 157 of file newFvsPatchField.C.
References Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorIn, Foam::Info, and p.
| tmp< 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 81 of file newFvsPatchField.C.
References Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorIn, dictionary::found(), Foam::Info, dictionary::lookup(), and p.
| tmp< fvsPatchField< Type > > NewCalculatedType | ( | const fvsPatchField< Type2 > & | pf ) | [static]
|
Return a pointer to a new calculatedFvsPatchField created on.
freestore without setting patchField values
Definition at line 102 of file calculatedFvsPatchField.C.
References Field< Type >::null(), and fvsPatchField< Type >::patch().
| const objectRegistry & db | ( | ) | const |
Return local objectRegistry.
Definition at line 134 of file fvsPatchField.C.
| const fvPatch& patch | ( | ) | const [inline]
|
Return patch.
Definition at line 261 of file fvsPatchField.H.
Referenced by inversePointDistanceDiffusivity::correct(), inverseFaceDistanceDiffusivity::correct(), fvMeshSubset::interpolate(), fvsPatchField< Type >::NewCalculatedType(), fvsPatchField< Type >::operator*=(), fvsPatchField< Type >::operator/=(), dynamicRefineFvMesh::refine(), extendedUpwindCellToFaceStencil::weightedSum(), and extendedCellToFaceStencil::weightedSum().
| const DimensionedField<Type, surfaceMesh>& dimensionedInternalField | ( | ) | const [inline]
|
Return dimensioned internal field reference.
Definition at line 268 of file fvsPatchField.H.
| const Field<Type>& internalField | ( | ) | const [inline]
|
Return internal field reference.
Definition at line 274 of file fvsPatchField.H.
| const word & calculatedType | ( | ) | [static]
|
Return the type of the calculated for of fvsPatchField.
Definition at line 35 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 285 of file fvsPatchField.H.
| virtual bool coupled | ( | ) | const [inline, virtual]
|
Return true if this patch field is coupled.
Reimplemented in coupledFvsPatchField< Type >, and processorFvsPatchField< Type >.
Definition at line 291 of file fvsPatchField.H.
Referenced by linearUpwind< Type >::correction(), extendedUpwindCellToFaceStencil::weightedSum(), and extendedCellToFaceStencil::weightedSum().
| void autoMap | ( | const fvPatchFieldMapper & | m ) | [virtual]
|
Map (and resize as needed) from self given a mapping object.
Reimplemented in emptyFvsPatchField< Type >.
Definition at line 155 of file fvsPatchField.C.
References Field< Type >::autoMap().
| void rmap | ( | const fvsPatchField< Type > & | ptf, |
| const labelList & | addr | ||
| ) | [virtual]
|
Reverse map the given fvsPatchField onto this fvsPatchField.
Definition at line 166 of file fvsPatchField.C.
References Field< Type >::rmap().
| void write | ( | Ostream & | os ) | const [virtual]
|
Write.
Reimplemented in calculatedFvsPatchField< Type >, coupledFvsPatchField< Type >, fixedValueFvsPatchField< Type >, and slicedFvsPatchField< Type >.
Definition at line 177 of file fvsPatchField.C.
References token::END_STATEMENT, Foam::nl, Foam::type(), and Ostream::writeKeyword().
Referenced by Foam::operator<<(), slicedFvsPatchField< Type >::write(), fixedValueFvsPatchField< Type >::write(), coupledFvsPatchField< Type >::write(), and calculatedFvsPatchField< Type >::write().
| void check | ( | const fvsPatchField< Type > & | ptf ) | const |
Check fvsPatchField<Type> against given fvsPatchField<Type>
Definition at line 141 of file fvsPatchField.C.
References Foam::abort(), Foam::FatalError, and FatalErrorIn.
| void operator= | ( | const UList< Type > & | ) | [virtual]
|
Assignment from UList operator. Takes linear time.
Reimplemented from Field< Type >.
Reimplemented in fixedValueFvsPatchField< Type >, and slicedFvsPatchField< Type >.
Definition at line 187 of file fvsPatchField.C.
References Field< Type >::operator=().
Referenced by fvsPatchField< Type >::fvsPatchField().
| void operator= | ( | const fvsPatchField< Type > & | ptf ) | [virtual]
|
Reimplemented in fixedValueFvsPatchField< Type >, and slicedFvsPatchField< Type >.
Definition at line 197 of file fvsPatchField.C.
References Field< Type >::operator=().
| void operator+= | ( | const fvsPatchField< Type > & | ptf ) | [virtual]
|
Reimplemented in fixedValueFvsPatchField< Type >, and slicedFvsPatchField< Type >.
Definition at line 208 of file fvsPatchField.C.
References Field< Type >::operator+=().
| void operator-= | ( | const fvsPatchField< Type > & | ptf ) | [virtual]
|
Reimplemented in fixedValueFvsPatchField< Type >, and slicedFvsPatchField< Type >.
Definition at line 219 of file fvsPatchField.C.
References Field< Type >::operator-=().
| void operator*= | ( | const fvsPatchField< scalar > & | ptf ) | [virtual]
|
Reimplemented in fixedValueFvsPatchField< Type >, and slicedFvsPatchField< Type >.
Definition at line 230 of file fvsPatchField.C.
References Foam::abort(), Foam::FatalError, FatalErrorIn, Field< Type >::operator*=(), and fvsPatchField< Type >::patch().
| void operator/= | ( | const fvsPatchField< scalar > & | ptf ) | [virtual]
|
Reimplemented in fixedValueFvsPatchField< Type >, and slicedFvsPatchField< Type >.
Definition at line 249 of file fvsPatchField.C.
References Foam::abort(), Foam::FatalError, FatalErrorIn, Field< Type >::operator/=(), and fvsPatchField< Type >::patch().
| void operator+= | ( | const Field< Type > & | tf ) | [virtual]
|
Reimplemented in fixedValueFvsPatchField< Type >, and slicedFvsPatchField< Type >.
Definition at line 268 of file fvsPatchField.C.
References Field< Type >::operator+=().
| void operator-= | ( | const Field< Type > & | tf ) | [virtual]
|
Reimplemented in fixedValueFvsPatchField< Type >, and slicedFvsPatchField< Type >.
Definition at line 278 of file fvsPatchField.C.
References Field< Type >::operator-=().
| void operator*= | ( | const Field< scalar > & | tf ) | [virtual]
|
Reimplemented in fixedValueFvsPatchField< Type >, and slicedFvsPatchField< Type >.
Definition at line 288 of file fvsPatchField.C.
References Field< Type >::operator*=().
| void operator/= | ( | const Field< scalar > & | tf ) | [virtual]
|
Reimplemented in fixedValueFvsPatchField< Type >, and slicedFvsPatchField< Type >.
Definition at line 298 of file fvsPatchField.C.
References Field< Type >::operator/=().
| void operator= | ( | const Type & | ) | [virtual]
|
Assignment of all entries to the given value.
Reimplemented from Field< Type >.
Reimplemented in fixedValueFvsPatchField< Type >, and slicedFvsPatchField< Type >.
Definition at line 308 of file fvsPatchField.C.
References Field< Type >::operator=().
| void operator+= | ( | const Type & | t ) | [virtual]
|
Reimplemented from Field< Type >.
Reimplemented in fixedValueFvsPatchField< Type >, and slicedFvsPatchField< Type >.
Definition at line 318 of file fvsPatchField.C.
References Field< Type >::operator+=().
| void operator-= | ( | const Type & | t ) | [virtual]
|
Reimplemented from Field< Type >.
Reimplemented in fixedValueFvsPatchField< Type >, and slicedFvsPatchField< Type >.
Definition at line 328 of file fvsPatchField.C.
References Field< Type >::operator-=().
| void operator*= | ( | const scalar | s ) | [virtual]
|
Reimplemented in fixedValueFvsPatchField< Type >, and slicedFvsPatchField< Type >.
Definition at line 338 of file fvsPatchField.C.
References Field< Type >::operator*=().
| void operator/= | ( | const scalar | s ) | [virtual]
|
Reimplemented in fixedValueFvsPatchField< Type >, and slicedFvsPatchField< Type >.
Definition at line 348 of file fvsPatchField.C.
References Field< Type >::operator/=().
| void operator== | ( | const fvsPatchField< Type > & | ptf ) | [virtual]
|
Definition at line 359 of file fvsPatchField.C.
References Field< Type >::operator=().
| void operator== | ( | const Field< Type > & | tf ) | [virtual]
|
Definition at line 369 of file fvsPatchField.C.
References Field< Type >::operator=().
| void operator== | ( | const Type & | t ) | [virtual]
|
Definition at line 379 of file fvsPatchField.C.
References Field< Type >::operator=().
| Ostream& operator | ( | Ostream & | , |
| const fvsPatchField< Type > & | |||
| ) | [friend]
|
int disallowDefaultFvsPatchField [static]
|
Debug switch to disallow the use of.
Definition at line 99 of file fvsPatchField.H.
