Abstract base class for point-mesh patch fields. More...
Public Types | |
typedef Type | value_type |
typedef pointPatch | Patch |
typedef calculatedPointPatchField< Type > | Calculated |
Public Member Functions | |
TypeName ("pointPatchField") | |
Runtime type information. More... | |
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. More... | |
pointPatchField (const pointPatch &, const DimensionedField< Type, pointMesh > &, const dictionary &) | |
Construct from patch, internal field and dictionary. More... | |
pointPatchField (const pointPatchField< Type > &, const pointPatch &, const DimensionedField< Type, pointMesh > &, const pointPatchFieldMapper &) | |
Construct by mapping given patchField<Type> onto a new patch. More... | |
pointPatchField (const pointPatchField< Type > &)=delete | |
Disallow copy without setting internal field reference. More... | |
autoPtr< pointPatchField< Type > > | clone () const |
Disallow clone without setting internal field reference. More... | |
pointPatchField (const pointPatchField< Type > &, const DimensionedField< Type, pointMesh > &) | |
Construct as copy setting internal field reference. More... | |
virtual autoPtr< pointPatchField< Type > > | clone (const DimensionedField< Type, pointMesh > &iF) const =0 |
Construct and return a clone setting internal field reference. More... | |
virtual | ~pointPatchField () |
Destructor. More... | |
label | size () const |
Return size. 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 | overridesConstraint () const |
Return true if this overrides the underlying constraint type. More... | |
const objectRegistry & | db () const |
Return local objectRegistry. More... | |
const pointPatch & | patch () const |
Return patch. More... | |
const DimensionedField< Type, pointMesh > & | internalField () const |
Return dimensioned internal field reference. More... | |
const Field< Type > & | primitiveField () const |
Return internal field reference. More... | |
bool | updated () const |
Return true if the boundary condition has already been updated. More... | |
tmp< Field< Type > > | patchInternalField () const |
Return field created from appropriate internal field values. More... | |
template<class Type1 > | |
tmp< Field< Type1 > > | patchInternalField (const Field< Type1 > &iF) const |
Return field created from appropriate internal field values. More... | |
template<class Type1 > | |
tmp< Field< Type1 > > | patchInternalField (const Field< Type1 > &iF, const labelList &meshPoints) const |
Return field created from selected internal field values. More... | |
template<class Type1 > | |
void | addToInternalField (Field< Type1 > &iF, const Field< Type1 > &pF) const |
Given the internal field and a patch field,. More... | |
template<class Type1 > | |
void | addToInternalField (Field< Type1 > &iF, const Field< Type1 > &pF, const labelList &points) const |
Given the internal field and a patch field,. More... | |
template<class Type1 > | |
void | setInInternalField (Field< Type1 > &iF, const Field< Type1 > &pF, const labelList &meshPoints) const |
Given the internal field and a patch field,. More... | |
template<class Type1 > | |
void | setInInternalField (Field< Type1 > &iF, const Field< Type1 > &pF) const |
Given the internal field and a patch field,. More... | |
virtual void | autoMap (const pointPatchFieldMapper &) |
Map (and resize as needed) from self given a mapping object. More... | |
virtual void | rmap (const pointPatchField< Type > &, const labelList &) |
Reverse map the given pointPatchField onto this pointPatchField. More... | |
virtual void | updateCoeffs () |
Update the coefficients associated with the patch field. More... | |
virtual void | initEvaluate (const Pstream::commsTypes commsType=Pstream::commsTypes::blocking) |
Initialise evaluation of the patch field (do nothing) More... | |
virtual void | evaluate (const Pstream::commsTypes commsType=Pstream::commsTypes::blocking) |
Evaluate the patch field. More... | |
virtual void | write (Ostream &) const |
Write. More... | |
virtual void | operator= (const pointPatchField< Type > &) |
virtual void | operator= (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 &) |
template<class Type2 > | |
Foam::autoPtr< Foam::pointPatchField< Type > > | NewCalculatedType (const pointPatchField< Type2 > &pf) |
template<class Type1 > | |
Foam::tmp< Foam::Field< Type1 > > | patchInternalField (const Field< Type1 > &iF, const labelList &meshPoints) const |
template<class Type1 > | |
Foam::tmp< Foam::Field< Type1 > > | patchInternalField (const Field< Type1 > &iF) const |
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. More... | |
static autoPtr< pointPatchField< Type > > | New (const word &, const word &actualPatchType, const pointPatch &, const DimensionedField< Type, pointMesh > &) |
Return a pointer to a new patchField created on freestore given. More... | |
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. More... | |
static autoPtr< pointPatchField< Type > > | New (const pointPatch &, const DimensionedField< Type, pointMesh > &, const dictionary &) |
Return a pointer to a new patchField created on freestore. More... | |
template<class Type2 > | |
static autoPtr< pointPatchField< Type > > | NewCalculatedType (const pointPatchField< Type2 > &) |
Return a pointer to a new calculatedPointPatchField created on. More... | |
static const word & | calculatedType () |
Return the type of the calculated form of pointPatchField. More... | |
Static Public Attributes | |
static int | disallowGenericPointPatchField |
Debug switch to disallow the use of genericPointPatchField. More... | |
Friends | |
Ostream & | operator (Ostream &, const pointPatchField< Type > &) |
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 58 of file pointMVCWeight.H.
typedef Type value_type |
Definition at line 98 of file pointPatchField.H.
typedef pointPatch Patch |
Definition at line 99 of file pointPatchField.H.
typedef calculatedPointPatchField<Type> Calculated |
Definition at line 100 of file pointPatchField.H.
pointPatchField | ( | const pointPatch & | p, |
const DimensionedField< Type, pointMesh > & | iF | ||
) |
Construct from patch and internal field.
Definition at line 34 of file pointPatchField.C.
Referenced by pointPatchField< vector >::clone(), and pointPatchField< vector >::pointPatchField().
pointPatchField | ( | const pointPatch & | p, |
const DimensionedField< Type, pointMesh > & | iF, | ||
const dictionary & | dict | ||
) |
Construct from patch, internal field and dictionary.
Definition at line 47 of file pointPatchField.C.
pointPatchField | ( | const pointPatchField< Type > & | ptf, |
const pointPatch & | p, | ||
const DimensionedField< Type, pointMesh > & | iF, | ||
const pointPatchFieldMapper & | |||
) |
Construct by mapping given patchField<Type> onto a new patch.
Definition at line 61 of file pointPatchField.C.
|
delete |
Disallow copy without setting internal field reference.
pointPatchField | ( | const pointPatchField< Type > & | ptf, |
const DimensionedField< Type, pointMesh > & | iF | ||
) |
Construct as copy setting internal field reference.
Definition at line 76 of file pointPatchField.C.
|
inlinevirtual |
Destructor.
Definition at line 256 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) | |||
) |
|
inline |
Disallow clone without setting internal field reference.
Definition at line 182 of file pointPatchField.H.
Referenced by pointPatchField< vector >::clone().
|
pure virtual |
Construct and return a clone setting internal field reference.
Implemented in waveDisplacementPointPatchVectorField, codedFixedValuePointPatchField< Type >, surfaceSlipDisplacementPointPatchVectorField, timeVaryingMappedFixedValuePointPatchField< Type >, cyclicAMIPointPatchField< Type >, uniformFixedValuePointPatchField< Type >, uniformInterpolatedDisplacementPointPatchVectorField, fixedNormalSlipPointPatchField< Type >, zeroFixedValuePointPatchField< Type >, genericPointPatchField< Type >, angularOscillatingDisplacementPointPatchVectorField, angularOscillatingVelocityPointPatchVectorField, valuePointPatchField< Type >, processorCyclicPointPatchField< Type >, valuePointPatchField< vector >, oscillatingVelocityPointPatchVectorField, cyclicPointPatchField< Type >, symmetryPlanePointPatchField< Type >, processorPointPatchField< Type >, oscillatingDisplacementPointPatchVectorField, internalPointPatchField< Type >, calculatedPointPatchField< Type >, coupledPointPatchField< Type >, fixedValuePointPatchField< Type >, cyclicSlipPointPatchField< Type >, emptyPointPatchField< Type >, symmetryPointPatchField< Type >, wedgePointPatchField< Type >, fixedValuePointPatchField< vector >, zeroGradientPointPatchField< Type >, slipPointPatchField< Type >, basicSymmetryPointPatchField< Type >, cyclicACMIPointPatchField< Type >, and cyclicRepeatAMIPointPatchField< Type >.
|
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 86 of file pointPatchFieldNew.C.
Referenced by pointPatchField< vector >::clone(), and pointPatchField< vector >::New().
|
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 30 of file pointPatchFieldNew.C.
|
static |
Return a pointer to a new patchField created on freestore from.
a given pointPatchField mapped onto a new patch
Definition at line 170 of file pointPatchFieldNew.C.
|
static |
Return a pointer to a new patchField created on freestore.
from dictionary
Definition at line 98 of file pointPatchFieldNew.C.
|
static |
Return a pointer to a new calculatedPointPatchField created on.
freestore without setting patchField values
Referenced by calculatedPointPatchField< Type >::calculatedPointPatchField(), and pointPatchField< vector >::clone().
|
static |
Return the type of the calculated form of pointPatchField.
Definition at line 31 of file calculatedPointPatchField.C.
Referenced by pointPatchField< vector >::~pointPatchField().
|
inline |
Return size.
Definition at line 268 of file pointPatchField.H.
Referenced by valuePointPatchField< vector >::valuePointPatchField().
|
inlinevirtual |
Return true if this patch field fixes a value.
Reimplemented in fixedValuePointPatchField< Type >, and fixedValuePointPatchField< vector >.
Definition at line 274 of file pointPatchField.H.
|
inlinevirtual |
Return true if this patch field is coupled.
Reimplemented in cyclicAMIPointPatchField< Type >, processorCyclicPointPatchField< Type >, processorPointPatchField< Type >, and coupledPointPatchField< Type >.
Definition at line 280 of file pointPatchField.H.
|
inline |
Return true if this overrides the underlying constraint type.
Definition at line 286 of file pointPatchField.H.
const Foam::objectRegistry & db | ( | ) | const |
Return local objectRegistry.
Definition at line 90 of file pointPatchField.C.
Referenced by pointPatchField< vector >::overridesConstraint().
|
inline |
Return patch.
Definition at line 308 of file pointPatchField.H.
Referenced by pointPatchField< vector >::NewCalculatedType(), and pointPatchField< vector >::size().
|
inline |
Return dimensioned internal field reference.
Definition at line 314 of file pointPatchField.H.
|
inline |
Return internal field reference.
Definition at line 320 of file pointPatchField.H.
|
inline |
Return true if the boundary condition has already been updated.
Definition at line 326 of file pointPatchField.H.
Foam::tmp< Foam::Field< Type > > patchInternalField | ( | ) | const |
Return field created from appropriate internal field values.
Definition at line 110 of file pointPatchField.C.
Referenced by pointPatchField< vector >::patchInternalField(), pointConstraints::setPatchFields(), and pointPatchField< vector >::updated().
Return field created from appropriate internal field values.
given internal field reference
tmp<Field<Type1> > patchInternalField | ( | const Field< Type1 > & | iF, |
const labelList & | meshPoints | ||
) | const |
Return field created from selected internal field values.
given internal field reference
Given the internal field and a patch field,.
add the patch field to the internal field
Definition at line 154 of file pointPatchField.C.
Referenced by pointPatchField< vector >::addToInternalField(), pointPatchField< vector >::patchInternalField(), and pointPatchField< vector >::updated().
void addToInternalField | ( | Field< Type1 > & | iF, |
const Field< Type1 > & | pF, | ||
const labelList & | points | ||
) | const |
Given the internal field and a patch field,.
add selected elements of the patch field to the internal field
Definition at line 191 of file pointPatchField.C.
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 230 of file pointPatchField.C.
Referenced by pointPatchField< vector >::addToInternalField(), pointPatchField< vector >::setInInternalField(), and pointPatchField< vector >::updated().
Given the internal field and a patch field,.
set the patch field in the internal field
Definition at line 265 of file pointPatchField.C.
|
inlinevirtual |
Map (and resize as needed) from self given a mapping object.
Used to update fields following mesh topology change
Reimplemented in timeVaryingMappedFixedValuePointPatchField< Type >, valuePointPatchField< Type >, valuePointPatchField< vector >, genericPointPatchField< Type >, angularOscillatingDisplacementPointPatchVectorField, angularOscillatingVelocityPointPatchVectorField, and oscillatingVelocityPointPatchVectorField.
Definition at line 394 of file pointPatchField.H.
Referenced by pointPatchField< vector >::updated().
|
inlinevirtual |
Reverse map the given pointPatchField onto this pointPatchField.
Used to reconstruct fields
Reimplemented in timeVaryingMappedFixedValuePointPatchField< Type >, valuePointPatchField< Type >, valuePointPatchField< vector >, genericPointPatchField< Type >, angularOscillatingDisplacementPointPatchVectorField, angularOscillatingVelocityPointPatchVectorField, and oscillatingVelocityPointPatchVectorField.
Definition at line 399 of file pointPatchField.H.
Referenced by pointPatchField< vector >::updated().
|
inlinevirtual |
Update the coefficients associated with the patch field.
Sets Updated to true
Reimplemented in waveDisplacementPointPatchVectorField, codedFixedValuePointPatchField< Type >, timeVaryingMappedFixedValuePointPatchField< Type >, uniformFixedValuePointPatchField< Type >, valuePointPatchField< Type >, valuePointPatchField< vector >, uniformInterpolatedDisplacementPointPatchVectorField, angularOscillatingDisplacementPointPatchVectorField, angularOscillatingVelocityPointPatchVectorField, oscillatingVelocityPointPatchVectorField, and oscillatingDisplacementPointPatchVectorField.
Definition at line 407 of file pointPatchField.H.
Referenced by pointPatchField< vector >::updated().
|
inlinevirtual |
Initialise evaluation of the patch field (do nothing)
Definition at line 414 of file pointPatchField.H.
Referenced by pointPatchField< vector >::updated().
|
virtual |
Evaluate the patch field.
Reimplemented in codedFixedValuePointPatchField< Type >, surfaceSlipDisplacementPointPatchVectorField, cyclicAMIPointPatchField< Type >, valuePointPatchField< Type >, valuePointPatchField< vector >, processorCyclicPointPatchField< Type >, processorPointPatchField< Type >, fixedNormalSlipPointPatchField< Type >, cyclicPointPatchField< Type >, symmetryPlanePointPatchField< Type >, coupledPointPatchField< Type >, cyclicSlipPointPatchField< Type >, wedgePointPatchField< Type >, and basicSymmetryPointPatchField< Type >.
Definition at line 275 of file pointPatchField.C.
Referenced by pointPatchField< vector >::initEvaluate().
|
virtual |
Write.
Reimplemented in waveDisplacementPointPatchVectorField, codedFixedValuePointPatchField< Type >, surfaceSlipDisplacementPointPatchVectorField, timeVaryingMappedFixedValuePointPatchField< Type >, valuePointPatchField< Type >, valuePointPatchField< vector >, uniformFixedValuePointPatchField< Type >, uniformInterpolatedDisplacementPointPatchVectorField, angularOscillatingDisplacementPointPatchVectorField, angularOscillatingVelocityPointPatchVectorField, genericPointPatchField< Type >, fixedNormalSlipPointPatchField< Type >, oscillatingVelocityPointPatchVectorField, and oscillatingDisplacementPointPatchVectorField.
Definition at line 97 of file pointPatchField.C.
Referenced by pointPatchField< vector >::evaluate(), pointPatchField< vector >::initEvaluate(), oscillatingDisplacementPointPatchVectorField::write(), oscillatingVelocityPointPatchVectorField::write(), angularOscillatingVelocityPointPatchVectorField::write(), angularOscillatingDisplacementPointPatchVectorField::write(), uniformInterpolatedDisplacementPointPatchVectorField::write(), and waveDisplacementPointPatchVectorField::write().
|
inlinevirtual |
Reimplemented in valuePointPatchField< Type >, and valuePointPatchField< vector >.
Definition at line 436 of file pointPatchField.H.
|
inlinevirtual |
Definition at line 437 of file pointPatchField.H.
|
inlinevirtual |
Definition at line 438 of file pointPatchField.H.
|
inlinevirtual |
Definition at line 439 of file pointPatchField.H.
|
inlinevirtual |
Definition at line 440 of file pointPatchField.H.
|
inlinevirtual |
Definition at line 441 of file pointPatchField.H.
Reimplemented in valuePointPatchField< Type >, valuePointPatchField< vector >, fixedValuePointPatchField< Type >, and fixedValuePointPatchField< vector >.
Definition at line 443 of file pointPatchField.H.
Definition at line 444 of file pointPatchField.H.
Definition at line 445 of file pointPatchField.H.
Definition at line 447 of file pointPatchField.H.
Definition at line 448 of file pointPatchField.H.
|
inlinevirtual |
Reimplemented in valuePointPatchField< Type >, valuePointPatchField< vector >, fixedValuePointPatchField< Type >, and fixedValuePointPatchField< vector >.
Definition at line 450 of file pointPatchField.H.
|
inlinevirtual |
Definition at line 451 of file pointPatchField.H.
|
inlinevirtual |
Definition at line 452 of file pointPatchField.H.
|
inlinevirtual |
Definition at line 453 of file pointPatchField.H.
|
inlinevirtual |
Definition at line 454 of file pointPatchField.H.
|
inlinevirtual |
Reimplemented in valuePointPatchField< Type >, and valuePointPatchField< vector >.
Definition at line 461 of file pointPatchField.H.
Reimplemented in valuePointPatchField< Type >, and valuePointPatchField< vector >.
Definition at line 462 of file pointPatchField.H.
|
inlinevirtual |
Reimplemented in valuePointPatchField< Type >, and valuePointPatchField< vector >.
Definition at line 463 of file pointPatchField.H.
Foam::autoPtr<Foam::pointPatchField<Type> > NewCalculatedType | ( | const pointPatchField< Type2 > & | pf | ) |
Definition at line 90 of file calculatedPointPatchField.C.
Foam::tmp<Foam::Field<Type1> > patchInternalField | ( | const Field< Type1 > & | iF, |
const labelList & | meshPoints | ||
) | const |
Definition at line 120 of file pointPatchField.C.
Foam::tmp<Foam::Field<Type1> > patchInternalField | ( | const Field< Type1 > & | iF | ) | const |
Definition at line 143 of file pointPatchField.C.
|
friend |
|
static |
Debug switch to disallow the use of genericPointPatchField.
Definition at line 107 of file pointPatchField.H.