faPatchField<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...
Public Types | |
typedef faPatch | Patch |
typedef calculatedFaPatchField< Type > | Calculated |
Public Member Functions | |
TypeName ("faPatchField") | |
Runtime type information. More... | |
declareRunTimeSelectionTable (tmp, faPatchField, patch,(const faPatch &p, const DimensionedField< Type, areaMesh > &iF),(p, iF)) | |
declareRunTimeSelectionTable (tmp, faPatchField, patchMapper,(const faPatchField< Type > &ptf, const faPatch &p, const DimensionedField< Type, areaMesh > &iF, const faPatchFieldMapper &m),(dynamic_cast< const faPatchFieldType & >(ptf), p, iF, m)) | |
declareRunTimeSelectionTable (tmp, faPatchField, dictionary,(const faPatch &p, const DimensionedField< Type, areaMesh > &iF, const dictionary &dict),(p, iF, dict)) | |
faPatchField (const faPatch &, const DimensionedField< Type, areaMesh > &) | |
Construct from patch and internal field. More... | |
faPatchField (const faPatch &, const DimensionedField< Type, areaMesh > &, const Field< Type > &) | |
Construct from patch and internal field and patch field. More... | |
faPatchField (const faPatch &, const DimensionedField< Type, areaMesh > &, const dictionary &) | |
Construct from patch, internal field and dictionary. More... | |
faPatchField (const faPatchField< Type > &, const faPatch &, const DimensionedField< Type, areaMesh > &, const faPatchFieldMapper &) | |
Construct by mapping the given faPatchField onto a new patch. More... | |
faPatchField (const faPatchField< Type > &) | |
Construct as copy. More... | |
virtual tmp< faPatchField< Type > > | clone () const |
Construct and return a clone. More... | |
faPatchField (const faPatchField< Type > &, const DimensionedField< Type, areaMesh > &) | |
Construct as copy setting internal field reference. More... | |
virtual tmp< faPatchField< Type > > | clone (const DimensionedField< Type, areaMesh > &iF) const |
Construct and return a clone setting internal field reference. More... | |
virtual | ~faPatchField ()=default |
Destructor. More... | |
const objectRegistry & | db () const |
Return local objectRegistry. More... | |
const faPatch & | patch () const |
Return patch. More... | |
const DimensionedField< Type, areaMesh > & | internalField () const |
Return dimensioned internal field reference. More... | |
const Field< Type > & | primitiveField () const |
Return internal field reference. More... | |
const word & | patchType () const |
Optional patch type. More... | |
word & | patchType () |
Optional patch type. 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... | |
bool | updated () const |
Return true if the boundary condition has already been updated. More... | |
virtual void | autoMap (const faPatchFieldMapper &) |
Map (and resize as needed) from self given a mapping object. More... | |
virtual void | rmap (const faPatchField< Type > &, const labelList &) |
Reverse map the given faPatchField onto this faPatchField. More... | |
virtual tmp< Field< Type > > | snGrad () const |
Return patch-normal gradient. More... | |
virtual void | updateCoeffs () |
Update the coefficients associated with the patch field. More... | |
virtual tmp< Field< Type > > | patchInternalField () const |
Return internal field next to patch as patch field. More... | |
virtual tmp< Field< Type > > | patchNeighbourField () const |
Return patchField on the opposite patch of a coupled patch. More... | |
virtual void | initEvaluate (const Pstream::commsTypes commsType=Pstream::commsTypes::blocking) |
Initialise the evaluation of the patch field. More... | |
virtual void | evaluate (const Pstream::commsTypes commsType=Pstream::commsTypes::blocking) |
Evaluate the patch field, sets Updated to false. More... | |
virtual tmp< Field< Type > > | valueInternalCoeffs (const tmp< Field< scalar >> &) const |
virtual tmp< Field< Type > > | valueBoundaryCoeffs (const tmp< Field< scalar >> &) const |
virtual tmp< Field< Type > > | gradientInternalCoeffs () const |
virtual tmp< Field< Type > > | gradientBoundaryCoeffs () const |
virtual void | write (Ostream &) const |
Write. More... | |
void | check (const faPatchField< Type > &) const |
Check faPatchField<Type> against given faPatchField<Type> More... | |
virtual void | operator= (const UList< Type > &) |
virtual void | operator= (const faPatchField< Type > &) |
virtual void | operator+= (const faPatchField< Type > &) |
virtual void | operator-= (const faPatchField< Type > &) |
virtual void | operator*= (const faPatchField< scalar > &) |
virtual void | operator/= (const faPatchField< 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 faPatchField< Type > &) |
virtual void | operator== (const Field< Type > &) |
virtual void | operator== (const Type &) |
template<class Type2 > | |
Foam::tmp< Foam::faPatchField< Type > > | NewCalculatedType (const faPatchField< Type2 > &pf) |
Static Public Member Functions | |
static tmp< faPatchField< Type > > | New (const word &patchFieldType, const word &actualPatchType, const faPatch &, const DimensionedField< Type, areaMesh > &) |
static tmp< faPatchField< Type > > | New (const word &patchFieldType, const faPatch &, const DimensionedField< Type, areaMesh > &) |
static tmp< faPatchField< Type > > | New (const faPatchField< Type > &, const faPatch &, const DimensionedField< Type, areaMesh > &, const faPatchFieldMapper &) |
static tmp< faPatchField< Type > > | New (const faPatch &, const DimensionedField< Type, areaMesh > &, const dictionary &) |
template<class Type2 > | |
static tmp< faPatchField< Type > > | NewCalculatedType (const faPatchField< Type2 > &) |
static const word & | calculatedType () |
Return the type of the calculated for of faPatchField. More... | |
Static Public Attributes | |
static int | disallowGenericFaPatchField |
Debug switch to disallow the use of. More... | |
Friends | |
Ostream & | operator (Ostream &, const faPatchField< Type > &) |
faPatchField<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.
Author Zeljko Tukovic, FMENA Hrvoje Jasak, Wikki Ltd.
Definition at line 50 of file areaFieldsFwd.H.
Definition at line 103 of file faPatchField.H.
typedef calculatedFaPatchField<Type> Calculated |
Definition at line 104 of file faPatchField.H.
faPatchField | ( | const faPatch & | p, |
const DimensionedField< Type, areaMesh > & | iF | ||
) |
Construct from patch and internal field.
Definition at line 36 of file faPatchField.C.
faPatchField | ( | const faPatch & | p, |
const DimensionedField< Type, areaMesh > & | iF, | ||
const Field< Type > & | f | ||
) |
Construct from patch and internal field and patch field.
Definition at line 51 of file faPatchField.C.
faPatchField | ( | const faPatch & | p, |
const DimensionedField< Type, areaMesh > & | iF, | ||
const dictionary & | dict | ||
) |
Construct from patch, internal field and dictionary.
Definition at line 84 of file faPatchField.C.
faPatchField | ( | const faPatchField< Type > & | ptf, |
const faPatch & | p, | ||
const DimensionedField< Type, areaMesh > & | iF, | ||
const faPatchFieldMapper & | mapper | ||
) |
Construct by mapping the given faPatchField onto a new patch.
Definition at line 67 of file faPatchField.C.
faPatchField | ( | const faPatchField< Type > & | ptf | ) |
Construct as copy.
Definition at line 112 of file faPatchField.C.
faPatchField | ( | const faPatchField< Type > & | ptf, |
const DimensionedField< Type, areaMesh > & | iF | ||
) |
Construct as copy setting internal field reference.
Definition at line 126 of file faPatchField.C.
|
virtualdefault |
Destructor.
TypeName | ( | "faPatchField< Type >" | ) |
Runtime type information.
declareRunTimeSelectionTable | ( | tmp | , |
faPatchField< Type > | , | ||
patch | , | ||
(const faPatch &p, const DimensionedField< Type, areaMesh > &iF) | , | ||
(p, iF) | |||
) |
declareRunTimeSelectionTable | ( | tmp | , |
faPatchField< Type > | , | ||
patchMapper | , | ||
(const faPatchField< Type > &ptf, const faPatch &p, const DimensionedField< Type, areaMesh > &iF, const faPatchFieldMapper &m) | , | ||
(dynamic_cast< const faPatchFieldType & >(ptf), p, iF, m) | |||
) |
declareRunTimeSelectionTable | ( | tmp | , |
faPatchField< Type > | , | ||
dictionary | , | ||
(const faPatch &p, const DimensionedField< Type, areaMesh > &iF, const dictionary &dict) | , | ||
(p, iF, dict) | |||
) |
|
inlinevirtual |
Construct and return a clone.
Reimplemented in coupledFaPatchField< Type >, transformFaPatchField< Type >, timeVaryingUniformFixedValueFaPatchField< Type >, clampedPlateFaPatchField< Type >, cyclicFaPatchField< Type >, processorFaPatchField< Type >, mixedFaPatchField< Type >, inletOutletFaPatchField< Type >, fixedGradientFaPatchField< Type >, zeroGradientFaPatchField< Type >, emptyFaPatchField< Type >, symmetryFaPatchField< Type >, slipFaPatchField< Type >, genericFaPatchField< Type >, fixedValueFaPatchField< Type >, fixedValueOutflowFaPatchField< Type >, calculatedFaPatchField< Type >, basicSymmetryFaPatchField< Type >, and wedgeFaPatchField< Type >.
Definition at line 194 of file faPatchField.H.
|
inlinevirtual |
Construct and return a clone setting internal field reference.
Reimplemented in timeVaryingUniformFixedValueFaPatchField< Type >, clampedPlateFaPatchField< Type >, cyclicFaPatchField< Type >, processorFaPatchField< Type >, mixedFaPatchField< Type >, inletOutletFaPatchField< Type >, fixedGradientFaPatchField< Type >, genericFaPatchField< Type >, zeroGradientFaPatchField< Type >, emptyFaPatchField< Type >, symmetryFaPatchField< Type >, slipFaPatchField< Type >, fixedValueFaPatchField< Type >, fixedValueOutflowFaPatchField< Type >, calculatedFaPatchField< Type >, basicSymmetryFaPatchField< Type >, wedgeFaPatchField< Type >, coupledFaPatchField< Type >, and transformFaPatchField< Type >.
Definition at line 208 of file faPatchField.H.
|
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 faPatchFieldNew.C.
References DebugInFunction, Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInLookup, p, and tmp< T >::ref().
Referenced by emptyFaPatchField< Type >::valueBoundaryCoeffs(), and emptyFaPatchField< Type >::valueInternalCoeffs().
|
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 91 of file faPatchFieldNew.C.
References Foam::New(), and p.
|
static |
Return a pointer to a new patchField created on freestore from a given faPatchField mapped onto a new patch
Definition at line 150 of file faPatchFieldNew.C.
References DebugInFunction, Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInLookup, and p.
|
static |
Return a pointer to a new patchField created on freestore from dictionary
Definition at line 103 of file faPatchFieldNew.C.
References DebugInFunction, dict, Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, Foam::nl, and p.
|
static |
Return a pointer to a new calculatedFaPatchField created on freestore without setting patchField values
const Foam::objectRegistry & db | ( | ) | const |
Return local objectRegistry.
Definition at line 142 of file faPatchField.C.
References IOobject::db().
|
inline |
Return patch.
Definition at line 279 of file faPatchField.H.
Referenced by contactAngleForce::correct(), faPatchField< Type >::NewCalculatedType(), faPatchField< Type >::operator*=(), and faPatchField< Type >::operator/=().
|
inline |
Return dimensioned internal field reference.
Definition at line 285 of file faPatchField.H.
|
inline |
Return internal field reference.
Definition at line 291 of file faPatchField.H.
|
inline |
Optional patch type.
Definition at line 297 of file faPatchField.H.
|
inline |
Optional patch type.
Definition at line 303 of file faPatchField.H.
|
static |
Return the type of the calculated for of faPatchField.
Definition at line 35 of file calculatedFaPatchField.C.
|
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 mixedFaPatchField< Type >, fixedValueFaPatchField< Type >, fixedValueOutflowFaPatchField< Type >, and calculatedFaPatchField< Type >.
Definition at line 314 of file faPatchField.H.
|
inlinevirtual |
Return true if this patch field is coupled.
Reimplemented in processorFaPatchField< Type >, and coupledFaPatchField< Type >.
Definition at line 320 of file faPatchField.H.
Referenced by faMatrix< Type >::addBoundarySource(), and faMatrix< Type >::relax().
|
inline |
Return true if the boundary condition has already been updated.
Definition at line 326 of file faPatchField.H.
|
virtual |
Map (and resize as needed) from self given a mapping object.
Reimplemented in mixedFaPatchField< Type >, fixedGradientFaPatchField< Type >, genericFaPatchField< Type >, and emptyFaPatchField< Type >.
Definition at line 177 of file faPatchField.C.
|
virtual |
Reverse map the given faPatchField onto this faPatchField.
Reimplemented in mixedFaPatchField< Type >, fixedGradientFaPatchField< Type >, emptyFaPatchField< Type >, and genericFaPatchField< Type >.
Definition at line 185 of file faPatchField.C.
|
virtual |
Return patch-normal gradient.
Reimplemented in transformFaPatchField< Type >, mixedFaPatchField< Type >, processorFaPatchField< Type >, clampedPlateFaPatchField< Type >, fixedGradientFaPatchField< Type >, basicSymmetryFaPatchField< Type >, coupledFaPatchField< Type >, wedgeFaPatchField< Type >, zeroGradientFaPatchField< Type >, basicSymmetryFaPatchField< Type >, wedgeFaPatchField< Type >, basicSymmetryFaPatchField< Type >, and wedgeFaPatchField< Type >.
Definition at line 162 of file faPatchField.C.
|
inlinevirtual |
Update the coefficients associated with the patch field.
Sets Updated to true
Reimplemented in timeVaryingUniformFixedValueFaPatchField< Type >, emptyFaPatchField< Type >, and inletOutletFaPatchField< Type >.
Definition at line 355 of file faPatchField.H.
|
virtual |
Return internal field next to patch as patch field.
Definition at line 170 of file faPatchField.C.
Return patchField on the opposite patch of a coupled patch.
Reimplemented in coupledFaPatchField< Type >, processorFaPatchField< Type >, and cyclicFaPatchField< Type >.
Definition at line 364 of file faPatchField.H.
References NotImplemented.
Referenced by faMatrix< Type >::addBoundarySource().
|
inlinevirtual |
Initialise the evaluation of the patch field.
Reimplemented in processorFaPatchField< Type >, and coupledFaPatchField< Type >.
Definition at line 372 of file faPatchField.H.
|
virtual |
Evaluate the patch field, sets Updated to false.
Reimplemented in clampedPlateFaPatchField< Type >, basicSymmetryFaPatchField< Type >, wedgeFaPatchField< Type >, mixedFaPatchField< Type >, clampedPlateFaPatchField< Type >, fixedGradientFaPatchField< Type >, zeroGradientFaPatchField< Type >, basicSymmetryFaPatchField< Type >, wedgeFaPatchField< Type >, processorFaPatchField< Type >, coupledFaPatchField< Type >, basicSymmetryFaPatchField< Type >, and wedgeFaPatchField< Type >.
Definition at line 195 of file faPatchField.C.
Referenced by clampedPlateFaPatchField< Type >::evaluate(), and zeroGradientFaPatchField< Type >::evaluate().
Return the matrix diagonal coefficients corresponding to the evaluation of the value of this patchField with given weights
Definition at line 388 of file faPatchField.H.
References NotImplemented.
Referenced by gaussConvectionScheme< Type >::famDiv().
Return the matrix source coefficients corresponding to the evaluation of the value of this patchField with given weights
Definition at line 399 of file faPatchField.H.
References NotImplemented.
Referenced by gaussConvectionScheme< Type >::famDiv().
Return the matrix diagonal coefficients corresponding to the evaluation of the gradient of this patchField
Reimplemented in mixedFaPatchField< Type >, clampedPlateFaPatchField< Type >, fixedGradientFaPatchField< Type >, emptyFaPatchField< Type >, coupledFaPatchField< Type >, zeroGradientFaPatchField< Type >, genericFaPatchField< Type >, fixedValueFaPatchField< Type >, fixedValueOutflowFaPatchField< Type >, calculatedFaPatchField< Type >, transformFaPatchField< Type >, transformFaPatchField< Type >, and transformFaPatchField< Type >.
Definition at line 409 of file faPatchField.H.
References NotImplemented.
Referenced by gaussLaplacianScheme< Type >::famLaplacian().
Return the matrix source coefficients corresponding to the evaluation of the gradient of this patchField
Reimplemented in mixedFaPatchField< Type >, clampedPlateFaPatchField< Type >, fixedGradientFaPatchField< Type >, emptyFaPatchField< Type >, coupledFaPatchField< Type >, zeroGradientFaPatchField< Type >, genericFaPatchField< Type >, fixedValueFaPatchField< Type >, fixedValueOutflowFaPatchField< Type >, calculatedFaPatchField< Type >, and transformFaPatchField< Type >.
Definition at line 417 of file faPatchField.H.
References NotImplemented.
Referenced by gaussLaplacianScheme< Type >::famLaplacian().
|
virtual |
Write.
Reimplemented in mixedFaPatchField< Type >, coupledFaPatchField< Type >, timeVaryingUniformFixedValueFaPatchField< Type >, clampedPlateFaPatchField< Type >, fixedGradientFaPatchField< Type >, fixedValueFaPatchField< Type >, fixedValueOutflowFaPatchField< Type >, calculatedFaPatchField< Type >, inletOutletFaPatchField< Type >, and genericFaPatchField< Type >.
Definition at line 207 of file faPatchField.C.
References os().
Referenced by clampedPlateFaPatchField< Type >::write().
void check | ( | const faPatchField< Type > & | ptf | ) | const |
Check faPatchField<Type> against given faPatchField<Type>
Definition at line 150 of file faPatchField.C.
References Foam::abort(), Foam::FatalError, and FatalErrorInFunction.
Reimplemented in mixedFaPatchField< Type >, fixedValueFaPatchField< Type >, and fixedValueOutflowFaPatchField< Type >.
Definition at line 222 of file faPatchField.C.
Referenced by clampedPlateFaPatchField< Type >::clampedPlateFaPatchField().
|
virtual |
Reimplemented in mixedFaPatchField< Type >, fixedValueFaPatchField< Type >, fixedValueOutflowFaPatchField< Type >, and transformFaPatchField< Type >.
Definition at line 232 of file faPatchField.C.
References Foam::check().
|
virtual |
Reimplemented in mixedFaPatchField< Type >, fixedValueFaPatchField< Type >, and fixedValueOutflowFaPatchField< Type >.
Definition at line 243 of file faPatchField.C.
References Foam::check().
|
virtual |
Reimplemented in mixedFaPatchField< Type >, fixedValueFaPatchField< Type >, and fixedValueOutflowFaPatchField< Type >.
Definition at line 254 of file faPatchField.C.
References Foam::check().
|
virtual |
Reimplemented in mixedFaPatchField< Type >, fixedValueFaPatchField< Type >, and fixedValueOutflowFaPatchField< Type >.
Definition at line 265 of file faPatchField.C.
References Foam::abort(), Foam::FatalError, FatalErrorInFunction, and faPatchField< Type >::patch().
|
virtual |
Reimplemented in mixedFaPatchField< Type >, fixedValueFaPatchField< Type >, and fixedValueOutflowFaPatchField< Type >.
Definition at line 282 of file faPatchField.C.
References Foam::abort(), Foam::FatalError, FatalErrorInFunction, and faPatchField< Type >::patch().
Reimplemented in mixedFaPatchField< Type >, fixedValueFaPatchField< Type >, and fixedValueOutflowFaPatchField< Type >.
Definition at line 299 of file faPatchField.C.
Reimplemented in mixedFaPatchField< Type >, fixedValueFaPatchField< Type >, and fixedValueOutflowFaPatchField< Type >.
Definition at line 309 of file faPatchField.C.
Reimplemented in mixedFaPatchField< Type >, fixedValueFaPatchField< Type >, and fixedValueOutflowFaPatchField< Type >.
Definition at line 319 of file faPatchField.C.
Reimplemented in mixedFaPatchField< Type >, fixedValueFaPatchField< Type >, and fixedValueOutflowFaPatchField< Type >.
Definition at line 329 of file faPatchField.C.
|
virtual |
Reimplemented in mixedFaPatchField< Type >, fixedValueFaPatchField< Type >, and fixedValueOutflowFaPatchField< Type >.
Definition at line 339 of file faPatchField.C.
|
virtual |
Reimplemented in mixedFaPatchField< Type >, fixedValueFaPatchField< Type >, and fixedValueOutflowFaPatchField< Type >.
Definition at line 349 of file faPatchField.C.
|
virtual |
Reimplemented in mixedFaPatchField< Type >, fixedValueFaPatchField< Type >, and fixedValueOutflowFaPatchField< Type >.
Definition at line 359 of file faPatchField.C.
|
virtual |
Reimplemented in mixedFaPatchField< Type >, fixedValueFaPatchField< Type >, and fixedValueOutflowFaPatchField< Type >.
Definition at line 369 of file faPatchField.C.
References s.
|
virtual |
Reimplemented in mixedFaPatchField< Type >, fixedValueFaPatchField< Type >, and fixedValueOutflowFaPatchField< Type >.
Definition at line 379 of file faPatchField.C.
References s.
|
virtual |
Definition at line 389 of file faPatchField.C.
Definition at line 399 of file faPatchField.C.
|
virtual |
Definition at line 409 of file faPatchField.C.
Foam::tmp<Foam::faPatchField<Type> > NewCalculatedType | ( | const faPatchField< Type2 > & | pf | ) |
Definition at line 103 of file calculatedFaPatchField.C.
References faPatchField< Type >::patch().
|
friend |
|
static |
Debug switch to disallow the use of.
Definition at line 111 of file faPatchField.H.