Abstract base class for point-mesh patch fields. More...
#include <OpenFOAM/pointPatchField.H>
Abstract base class for point-mesh patch fields.
The base-field does not store values as they are part of the "internal field". There are derived classes to store constraint values e.g. fixedValuePointPatchField derived from the generic valuePointPatchField which ensures the values in the "internal field" are reset to the fixed-values by applying the stored values.
Definition at line 79 of file pointPatchField.H.
Inheritance diagram for pointPatchField< Type >: Collaboration diagram for pointPatchField< Type >:Public Types | |
| typedef pointPatch | Patch |
Public Member Functions | |
| TypeName ("pointPatchField") | |
| Runtime type information.
| |
| declareRunTimeSelectionTable (autoPtr, pointPatchField, pointPatch,(const pointPatch &p, const DimensionedField< Type, pointMesh > &iF),(p, iF)) | |
| declareRunTimeSelectionTable (autoPtr, pointPatchField, patchMapper,(const pointPatchField< Type > &ptf, const pointPatch &p, const DimensionedField< Type, pointMesh > &iF, const pointPatchFieldMapper &m),(dynamic_cast< const pointPatchFieldType & >(ptf), p, iF, m)) | |
| declareRunTimeSelectionTable (autoPtr, pointPatchField, dictionary,(const pointPatch &p, const DimensionedField< Type, pointMesh > &iF, const dictionary &dict),(p, iF, dict)) | |
| pointPatchField (const pointPatch &, const DimensionedField< Type, pointMesh > &) | |
| Construct from patch and internal field.
| |
| pointPatchField (const pointPatch &, const DimensionedField< Type, pointMesh > &, const dictionary &) | |
| Construct from patch, internal field and dictionary.
| |
| pointPatchField (const pointPatchField< Type > &) | |
| Construct as copy.
| |
| virtual autoPtr < pointPatchField< Type > > | clone () const =0 |
| Construct and return a clone.
| |
| pointPatchField (const pointPatchField< Type > &, const DimensionedField< Type, pointMesh > &) | |
| Construct as copy setting internal field reference.
| |
| virtual autoPtr < pointPatchField< Type > > | clone (const DimensionedField< Type, pointMesh > &iF) const =0 |
| Construct and return a clone setting internal field reference.
| |
| virtual | ~pointPatchField () |
| const objectRegistry & | db () const |
| Return local objectRegistry.
| |
| label | size () const |
| Return size.
| |
| const pointPatch & | patch () const |
| Return patch.
| |
| const DimensionedField< Type, pointMesh > & | dimensionedInternalField () const |
| Return dimensioned internal field reference.
| |
| const Field< Type > & | internalField () const |
| Return internal field reference.
| |
| virtual bool | coupled () const |
| Return true if this patch field is coupled.
| |
| bool | updated () const |
| Return true if the boundary condition has already been updated.
| |
| tmp< Field< Type > > | patchInternalField () const |
| Return field created from appropriate internal field values.
| |
| template<class Type1 > | |
| tmp< Field< Type1 > > | patchInternalField (const Field< Type1 > &iF) const |
| Return field created from appropriate internal field values.
| |
| template<class Type1 > | |
| void | addToInternalField (Field< Type1 > &iF, const Field< Type1 > &pF) const |
| Given the internal field and a patch field,.
| |
| template<class Type1 > | |
| void | setInInternalField (Field< Type1 > &iF, const Field< Type1 > &pF, const labelList &meshPoints) const |
| Given the internal field and a patch field,.
| |
| template<class Type1 > | |
| void | setInInternalField (Field< Type1 > &iF, const Field< Type1 > &pF) const |
| Given the internal field and a patch field,.
| |
| virtual void | autoMap (const pointPatchFieldMapper &) |
| Map (and resize as needed) from self given a mapping object.
| |
| virtual void | rmap (const pointPatchField< Type > &, const labelList &) |
| Reverse map the given pointPatchField onto this pointPatchField.
| |
| virtual void | updateCoeffs () |
| Update the coefficients associated with the patch field.
| |
| virtual void | initEvaluate (const Pstream::commsTypes commsType=Pstream::blocking) |
| Initialise evaluation of the patch field (do nothing)
| |
| virtual void | evaluate (const Pstream::commsTypes commsType=Pstream::blocking) |
| Evaluate the patch field.
| |
| virtual void | write (Ostream &) const |
| Write.
| |
| virtual void | operator= (const pointPatchField< Type > &) |
| virtual void | operator+= (const pointPatchField< Type > &) |
| virtual void | operator-= (const pointPatchField< Type > &) |
| virtual void | operator*= (const pointPatchField< scalar > &) |
| virtual void | operator/= (const pointPatchField< scalar > &) |
| virtual void | operator= (const Field< Type > &) |
| 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 pointPatchField< Type > &) |
| virtual void | operator== (const Field< Type > &) |
| virtual void | operator== (const Type &) |
Static Public Member Functions | |
| static autoPtr < pointPatchField< Type > > | New (const word &, const pointPatch &, const DimensionedField< Type, pointMesh > &) |
| Return a pointer to a new patchField created on freestore given.
| |
| static autoPtr < pointPatchField< Type > > | New (const pointPatchField< Type > &, const pointPatch &, const DimensionedField< Type, pointMesh > &, const pointPatchFieldMapper &) |
| Return a pointer to a new patchField created on freestore from.
| |
| static autoPtr < pointPatchField< Type > > | New (const pointPatch &, const DimensionedField< Type, pointMesh > &, const dictionary &) |
| Return a pointer to a new patchField created on freestore.
| |
| template<class Type2 > | |
| static autoPtr < pointPatchField< Type > > | NewCalculatedType (const pointPatchField< Type2 > &) |
| Return a pointer to a new CalculatedpointPatchField created on.
| |
| static const word & | calculatedType () |
| Return the type of the calculated for of pointPatchField.
| |
Static Public Attributes | |
| static int | disallowGenericPointPatchField |
| Debug switch to disallow the use of genericPointPatchField.
| |
Friends | |
| Ostream & | operator (Ostream &, const pointPatchField< Type > &) |
| typedef pointPatch Patch |
Definition at line 101 of file pointPatchField.H.
| pointPatchField | ( | const pointPatch & | p, |
| const DimensionedField< Type, pointMesh > & | iF | ||
| ) |
Construct from patch and internal field.
Definition at line 39 of file pointPatchField.C.
| pointPatchField | ( | const pointPatch & | p, |
| const DimensionedField< Type, pointMesh > & | iF, | ||
| const dictionary & | dict | ||
| ) |
Construct from patch, internal field and dictionary.
Definition at line 53 of file pointPatchField.C.
| pointPatchField | ( | const pointPatchField< Type > & | ptf ) |
Construct as copy.
Definition at line 68 of file pointPatchField.C.
| pointPatchField | ( | const pointPatchField< Type > & | ptf, |
| const DimensionedField< Type, pointMesh > & | iF | ||
| ) |
Construct as copy setting internal field reference.
Definition at line 81 of file pointPatchField.C.
| virtual ~pointPatchField | ( | ) | [inline, virtual]
|
Definition at line 234 of file pointPatchField.H.
| TypeName | ( | "pointPatchField< Type >" | ) |
Runtime type information.
| declareRunTimeSelectionTable | ( | autoPtr | , |
| pointPatchField< Type > | , | ||
| pointPatch | , | ||
| (const pointPatch &p, const DimensionedField< Type, pointMesh > &iF) | , | ||
| (p, iF) | |||
| ) |
| declareRunTimeSelectionTable | ( | autoPtr | , |
| pointPatchField< Type > | , | ||
| patchMapper | , | ||
| (const pointPatchField< Type > &ptf, const pointPatch &p, const DimensionedField< Type, pointMesh > &iF, const pointPatchFieldMapper &m) | , | ||
| (dynamic_cast< const pointPatchFieldType & >(ptf), p, iF, m) | |||
| ) |
| declareRunTimeSelectionTable | ( | autoPtr | , |
| pointPatchField< Type > | , | ||
| dictionary | , | ||
| (const pointPatch &p, const DimensionedField< Type, pointMesh > &iF, const dictionary &dict) | , | ||
| (p, iF, dict) | |||
| ) |
| virtual autoPtr<pointPatchField<Type> > clone | ( | ) | const [pure virtual]
|
Construct and return a clone.
Implemented in angularOscillatingDisplacementPointPatchVectorField, angularOscillatingVelocityPointPatchVectorField, oscillatingDisplacementPointPatchVectorField, oscillatingVelocityPointPatchVectorField, surfaceSlipDisplacementPointPatchVectorField, genericPointPatchField< Type >, basicSymmetryPointPatchField< Type >, calculatedPointPatchField< Type >, coupledPointPatchField< Type >, fixedValuePointPatchField< Type >, mixedPointPatchField< Type >, valuePointPatchField< Type >, zeroGradientPointPatchField< Type >, cyclicPointPatchField< Type >, emptyPointPatchField< Type >, processorPointPatchField< Type >, symmetryPointPatchField< Type >, wedgePointPatchField< Type >, fixedNormalSlipPointPatchField< Type >, globalPointPatchField< Type >, slipPointPatchField< Type >, timeVaryingUniformFixedValuePointPatchField< Type >, uniformFixedValuePointPatchField< Type >, sixDoFRigidBodyDisplacementPointPatchVectorField, uncoupledSixDoFRigidBodyDisplacementPointPatchVectorField, fixedValuePointPatchField< vector >, and valuePointPatchField< vector >.
| virtual autoPtr<pointPatchField<Type> > clone | ( | const DimensionedField< Type, pointMesh > & | iF ) | const [pure virtual]
|
Construct and return a clone setting internal field reference.
Implemented in angularOscillatingDisplacementPointPatchVectorField, angularOscillatingVelocityPointPatchVectorField, oscillatingDisplacementPointPatchVectorField, oscillatingVelocityPointPatchVectorField, genericPointPatchField< Type >, basicSymmetryPointPatchField< Type >, calculatedPointPatchField< Type >, coupledPointPatchField< Type >, fixedValuePointPatchField< Type >, mixedPointPatchField< Type >, valuePointPatchField< Type >, zeroGradientPointPatchField< Type >, cyclicPointPatchField< Type >, emptyPointPatchField< Type >, processorPointPatchField< Type >, symmetryPointPatchField< Type >, wedgePointPatchField< Type >, fixedNormalSlipPointPatchField< Type >, globalPointPatchField< Type >, slipPointPatchField< Type >, timeVaryingUniformFixedValuePointPatchField< Type >, uniformFixedValuePointPatchField< Type >, sixDoFRigidBodyDisplacementPointPatchVectorField, uncoupledSixDoFRigidBodyDisplacementPointPatchVectorField, fixedValuePointPatchField< vector >, and valuePointPatchField< vector >.
| Foam::autoPtr< Foam::pointPatchField< Type > > New | ( | const word & | patchFieldType, |
| const pointPatch & | p, | ||
| const DimensionedField< Type, pointMesh > & | 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 30 of file newPointPatchField.C.
References Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorIn, Foam::Info, and p.
| Foam::autoPtr< Foam::pointPatchField< Type > > New | ( | const pointPatchField< Type > & | ptf, |
| const pointPatch & | p, | ||
| const DimensionedField< Type, pointMesh > & | iF, | ||
| const pointPatchFieldMapper & | pfMapper | ||
| ) | [static]
|
Return a pointer to a new patchField created on freestore from.
a given pointPatchField mapped onto a new patch
Definition at line 153 of file newPointPatchField.C.
References Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorIn, Foam::Info, and p.
| Foam::autoPtr< Foam::pointPatchField< Type > > New | ( | const pointPatch & | p, |
| const DimensionedField< Type, pointMesh > & | iF, | ||
| const dictionary & | dict | ||
| ) | [static]
|
Return a pointer to a new patchField created on freestore.
from dictionary
Definition at line 77 of file newPointPatchField.C.
References Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorIn, dictionary::found(), Foam::Info, dictionary::lookup(), and p.
| autoPtr< pointPatchField< Type > > NewCalculatedType | ( | const pointPatchField< Type2 > & | pf ) | [static]
|
Return a pointer to a new CalculatedpointPatchField created on.
freestore without setting patchField values
Definition at line 93 of file calculatedPointPatchField.C.
References Field< Type >::null(), and pointPatchField< Type >::patch().
| const objectRegistry & db | ( | ) | const |
Return local objectRegistry.
Definition at line 96 of file pointPatchField.C.
Referenced by surfaceSlipDisplacementPointPatchVectorField::surfaces().
| label size | ( | ) | const [inline]
|
Return size.
Reimplemented in valuePointPatchField< Type >, and valuePointPatchField< vector >.
Definition at line 246 of file pointPatchField.H.
| const pointPatch& patch | ( | ) | const [inline]
|
Return patch.
Definition at line 252 of file pointPatchField.H.
Referenced by pointPatchField< Type >::NewCalculatedType(), and pointPatchField< vector >::size().
| const DimensionedField<Type, pointMesh>& dimensionedInternalField | ( | ) | const [inline]
|
Return dimensioned internal field reference.
Definition at line 259 of file pointPatchField.H.
| const Field<Type>& internalField | ( | ) | const [inline]
|
Return internal field reference.
Definition at line 265 of file pointPatchField.H.
| virtual bool coupled | ( | ) | const [inline, virtual]
|
Return true if this patch field is coupled.
Reimplemented in coupledPointPatchField< Type >, and processorPointPatchField< Type >.
Definition at line 271 of file pointPatchField.H.
| bool updated | ( | ) | const [inline]
|
Return true if the boundary condition has already been updated.
Definition at line 277 of file pointPatchField.H.
Return field created from appropriate internal field values.
Definition at line 116 of file pointPatchField.C.
Referenced by valuePointPatchField< Type >::operator=(), and valuePointPatchField< Type >::operator==().
Return field created from appropriate internal field values.
given internal field reference
Definition at line 125 of file pointPatchField.C.
References Foam::abort(), Foam::FatalError, FatalErrorIn, forAll, List< T >::size(), and List< Type >::size().
Given the internal field and a patch field,.
add the patch field to the internal field
Definition at line 161 of file pointPatchField.C.
References Foam::abort(), Foam::FatalError, FatalErrorIn, forAll, and List< Type >::size().
| void setInInternalField | ( | Field< Type1 > & | iF, |
| const Field< Type1 > & | pF, | ||
| const labelList & | meshPoints | ||
| ) | const |
Given the internal field and a patch field,.
set the patch field in the internal field
Definition at line 206 of file pointPatchField.C.
References Foam::abort(), Foam::FatalError, FatalErrorIn, forAll, List< T >::size(), and List< Type >::size().
Referenced by pointPatchInterpolation::interpolate().
Given the internal field and a patch field,.
set the patch field in the internal field
Definition at line 249 of file pointPatchField.C.
| const word & calculatedType | ( | ) | [static]
|
Return the type of the calculated for of pointPatchField.
Definition at line 34 of file calculatedPointPatchField.C.
| virtual void autoMap | ( | const pointPatchFieldMapper & | ) | [inline, virtual]
|
Map (and resize as needed) from self given a mapping object.
Reimplemented in angularOscillatingDisplacementPointPatchVectorField, angularOscillatingVelocityPointPatchVectorField, oscillatingVelocityPointPatchVectorField, genericPointPatchField< Type >, mixedPointPatchField< Type >, valuePointPatchField< Type >, sixDoFRigidBodyDisplacementPointPatchVectorField, uncoupledSixDoFRigidBodyDisplacementPointPatchVectorField, and valuePointPatchField< vector >.
Definition at line 329 of file pointPatchField.H.
| virtual void rmap | ( | const pointPatchField< Type > & | , |
| const labelList & | |||
| ) | [inline, virtual]
|
Reverse map the given pointPatchField onto this pointPatchField.
Reimplemented in angularOscillatingDisplacementPointPatchVectorField, angularOscillatingVelocityPointPatchVectorField, oscillatingVelocityPointPatchVectorField, genericPointPatchField< Type >, mixedPointPatchField< Type >, valuePointPatchField< Type >, sixDoFRigidBodyDisplacementPointPatchVectorField, uncoupledSixDoFRigidBodyDisplacementPointPatchVectorField, and valuePointPatchField< vector >.
Definition at line 336 of file pointPatchField.H.
| virtual void updateCoeffs | ( | ) | [inline, virtual]
|
Update the coefficients associated with the patch field.
Sets Updated to true
Reimplemented in angularOscillatingDisplacementPointPatchVectorField, angularOscillatingVelocityPointPatchVectorField, oscillatingDisplacementPointPatchVectorField, oscillatingVelocityPointPatchVectorField, valuePointPatchField< Type >, timeVaryingUniformFixedValuePointPatchField< Type >, sixDoFRigidBodyDisplacementPointPatchVectorField, uncoupledSixDoFRigidBodyDisplacementPointPatchVectorField, and valuePointPatchField< vector >.
Definition at line 347 of file pointPatchField.H.
Referenced by valuePointPatchField< Type >::updateCoeffs().
| virtual void initEvaluate | ( | const Pstream::commsTypes | commsType = Pstream::blocking
) |
[inline, virtual]
|
Initialise evaluation of the patch field (do nothing)
Definition at line 354 of file pointPatchField.H.
| void evaluate | ( | const Pstream::commsTypes | commsType = Pstream::blocking
) |
[virtual]
|
Evaluate the patch field.
Reimplemented in surfaceSlipDisplacementPointPatchVectorField, basicSymmetryPointPatchField< Type >, coupledPointPatchField< Type >, mixedPointPatchField< Type >, valuePointPatchField< Type >, cyclicPointPatchField< Type >, processorPointPatchField< Type >, wedgePointPatchField< Type >, fixedNormalSlipPointPatchField< Type >, globalPointPatchField< Type >, and valuePointPatchField< vector >.
Definition at line 259 of file pointPatchField.C.
Referenced by valuePointPatchField< Type >::evaluate().
| void write | ( | Ostream & | os ) | const [virtual]
|
Write.
Reimplemented in angularOscillatingDisplacementPointPatchVectorField, angularOscillatingVelocityPointPatchVectorField, oscillatingDisplacementPointPatchVectorField, oscillatingVelocityPointPatchVectorField, surfaceSlipDisplacementPointPatchVectorField, genericPointPatchField< Type >, mixedPointPatchField< Type >, valuePointPatchField< Type >, fixedNormalSlipPointPatchField< Type >, timeVaryingUniformFixedValuePointPatchField< Type >, uniformFixedValuePointPatchField< Type >, sixDoFRigidBodyDisplacementPointPatchVectorField, uncoupledSixDoFRigidBodyDisplacementPointPatchVectorField, and valuePointPatchField< vector >.
Definition at line 103 of file pointPatchField.C.
References token::END_STATEMENT, Foam::nl, Foam::type(), and Ostream::writeKeyword().
Referenced by Foam::operator<<(), uncoupledSixDoFRigidBodyDisplacementPointPatchVectorField::write(), uniformFixedValuePointPatchField< Type >::write(), fixedNormalSlipPointPatchField< Type >::write(), valuePointPatchField< Type >::write(), mixedPointPatchField< Type >::write(), angularOscillatingVelocityPointPatchVectorField::write(), and angularOscillatingDisplacementPointPatchVectorField::write().
| virtual void operator= | ( | const pointPatchField< Type > & | ) | [inline, virtual]
|
Reimplemented in valuePointPatchField< Type >, and valuePointPatchField< vector >.
Definition at line 373 of file pointPatchField.H.
| virtual void operator+= | ( | const pointPatchField< Type > & | ) | [inline, virtual]
|
Definition at line 379 of file pointPatchField.H.
| virtual void operator-= | ( | const pointPatchField< Type > & | ) | [inline, virtual]
|
Definition at line 385 of file pointPatchField.H.
| virtual void operator*= | ( | const pointPatchField< scalar > & | ) | [inline, virtual]
|
Definition at line 391 of file pointPatchField.H.
| virtual void operator/= | ( | const pointPatchField< scalar > & | ) | [inline, virtual]
|
Definition at line 397 of file pointPatchField.H.
| virtual void operator= | ( | const Field< Type > & | ) | [inline, virtual]
|
Reimplemented in fixedValuePointPatchField< Type >, valuePointPatchField< Type >, fixedValuePointPatchField< vector >, and valuePointPatchField< vector >.
Definition at line 402 of file pointPatchField.H.
| virtual void operator+= | ( | const Field< Type > & | ) | [inline, virtual]
|
Definition at line 403 of file pointPatchField.H.
| virtual void operator-= | ( | const Field< Type > & | ) | [inline, virtual]
|
Definition at line 404 of file pointPatchField.H.
| virtual void operator*= | ( | const Field< scalar > & | ) | [inline, virtual]
|
Definition at line 406 of file pointPatchField.H.
| virtual void operator/= | ( | const Field< scalar > & | ) | [inline, virtual]
|
Definition at line 407 of file pointPatchField.H.
| virtual void operator= | ( | const Type & | ) | [inline, virtual]
|
Reimplemented in fixedValuePointPatchField< Type >, valuePointPatchField< Type >, fixedValuePointPatchField< vector >, and valuePointPatchField< vector >.
Definition at line 409 of file pointPatchField.H.
| virtual void operator+= | ( | const Type & | ) | [inline, virtual]
|
Definition at line 410 of file pointPatchField.H.
| virtual void operator-= | ( | const Type & | ) | [inline, virtual]
|
Definition at line 411 of file pointPatchField.H.
| virtual void operator*= | ( | const | scalar ) | [inline, virtual]
|
Definition at line 412 of file pointPatchField.H.
| virtual void operator/= | ( | const | scalar ) | [inline, virtual]
|
Definition at line 413 of file pointPatchField.H.
| virtual void operator== | ( | const pointPatchField< Type > & | ) | [inline, virtual]
|
Reimplemented in valuePointPatchField< Type >, and valuePointPatchField< vector >.
Definition at line 421 of file pointPatchField.H.
| virtual void operator== | ( | const Field< Type > & | ) | [inline, virtual]
|
Reimplemented in valuePointPatchField< Type >, and valuePointPatchField< vector >.
Definition at line 426 of file pointPatchField.H.
| virtual void operator== | ( | const Type & | ) | [inline, virtual]
|
Reimplemented in valuePointPatchField< Type >, and valuePointPatchField< vector >.
Definition at line 427 of file pointPatchField.H.
| Ostream& operator | ( | Ostream & | , |
| const pointPatchField< Type > & | |||
| ) | [friend]
|
int disallowGenericPointPatchField [static]
|
Debug switch to disallow the use of genericPointPatchField.
Definition at line 108 of file pointPatchField.H.
