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 fieldMapper &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 fieldMapper &) | |
Construct by mapping given pointPatchField<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 autoPtr< pointPatchField< Type > > | clone (const pointPatch &patch, const DimensionedField< Type, pointMesh > &iF) const |
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 | setInternalField (Field< Type1 > &iF, const Field< Type1 > &pF, const labelList &meshPoints) const |
Given the internal field and a patch field,. More... | |
template<class Type1 > | |
void | setInternalField (Field< Type1 > &iF, const Field< Type1 > &pF) const |
Given the internal field and a patch field,. More... | |
virtual void | map (const pointPatchField< Type > &, const fieldMapper &) |
Map the given pointPatchField onto this pointPatchField. More... | |
virtual void | reset (const pointPatchField< Type > &) |
Reset the pointPatchField to the given 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 fieldMapper &) |
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 79 of file pointPatchField.H.
typedef Type value_type |
Definition at line 96 of file pointPatchField.H.
typedef pointPatch Patch |
Definition at line 97 of file pointPatchField.H.
typedef calculatedPointPatchField<Type> Calculated |
Definition at line 98 of file pointPatchField.H.
pointPatchField | ( | const pointPatch & | p, |
const DimensionedField< Type, pointMesh > & | iF | ||
) |
Construct from patch and internal field.
Definition at line 33 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 46 of file pointPatchField.C.
pointPatchField | ( | const pointPatchField< Type > & | ptf, |
const pointPatch & | p, | ||
const DimensionedField< Type, pointMesh > & | iF, | ||
const fieldMapper & | |||
) |
Construct by mapping given pointPatchField<Type> onto a new patch.
Definition at line 60 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 75 of file pointPatchField.C.
|
inlinevirtual |
Destructor.
Definition at line 265 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 fieldMapper &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 180 of file pointPatchField.H.
References NotImplemented.
|
pure virtual |
Construct and return a clone setting internal field reference.
Implemented in coupledPointPatchField< Type >, uniformFixedValuePointPatchField< Type >, slipPointPatchField< Type >, fixedNormalSlipPointPatchField< Type >, codedFixedValuePointPatchField< Type >, wedgePointPatchField< Type >, symmetryPlanePointPatchField< Type >, symmetryPointPatchField< Type >, processorCyclicPointPatchField< Type >, processorPointPatchField< Type >, internalPointPatchField< Type >, emptyPointPatchField< Type >, cyclicSlipPointPatchField< Type >, cyclicPointPatchField< Type >, zeroGradientPointPatchField< Type >, valuePointPatchField< Type >, fixedValuePointPatchField< Type >, calculatedPointPatchField< Type >, basicSymmetryPointPatchField< Type >, nonConformalProcessorCyclicPointPatchField< Type >, nonConformalErrorPointPatchField< Type >, nonConformalCyclicPointPatchField< Type >, zeroFixedValuePointPatchField< Type >, genericPointPatchField< Type >, and timeVaryingMappedFixedValuePointPatchField< Type >.
|
inlinevirtual |
Construct and return a clone setting internal field reference.
Reimplemented in processorCyclicPointPatchField< Type >, processorPointPatchField< Type >, and nonConformalProcessorCyclicPointPatchField< Type >.
Definition at line 200 of file pointPatchField.H.
References NotImplemented.
|
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.
References Foam::compressible::New(), p, and Foam::patchFieldType().
|
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 29 of file pointPatchFieldNew.C.
References Foam::abort(), Foam::endl(), Foam::FatalError, FatalErrorInFunction, InfoInFunction, IOobject::name(), Foam::nl, p, and Foam::patchFieldType().
|
static |
Return a pointer to a new patchField created on freestore from.
a given pointPatchField mapped onto a new patch
Definition at line 172 of file pointPatchFieldNew.C.
References Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, InfoInFunction, IOobject::name(), Foam::nl, and p.
|
static |
Return a pointer to a new patchField created on freestore.
from dictionary
Definition at line 98 of file pointPatchFieldNew.C.
References dict, Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, InfoInFunction, IOobject::name(), Foam::nl, p, and Foam::patchFieldType().
|
static |
Return a pointer to a new calculatedPointPatchField created on.
freestore without setting patchField values
|
static |
Return the type of the calculated form of pointPatchField.
Definition at line 31 of file calculatedPointPatchField.C.
|
inline |
Return size.
Definition at line 277 of file pointPatchField.H.
References pointPatchField< Type >::patch(), and pointPatch::size().
Referenced by genericPointPatchField< Type >::genericPointPatchField().
|
inlinevirtual |
Return true if this patch field fixes a value.
Reimplemented in fixedValuePointPatchField< Type >, and fixedValuePointPatchField< vector >.
Definition at line 283 of file pointPatchField.H.
|
inlinevirtual |
Return true if this patch field is coupled.
Reimplemented in processorCyclicPointPatchField< Type >, processorPointPatchField< Type >, and coupledPointPatchField< Type >.
Definition at line 289 of file pointPatchField.H.
|
inline |
Return true if this overrides the underlying constraint type.
Definition at line 295 of file pointPatchField.H.
References Foam::type().
const Foam::objectRegistry & db |
Return local objectRegistry.
Definition at line 90 of file pointPatchField.C.
Referenced by surfaceSlipDisplacementPointPatchVectorField::surfaces(), timeVaryingMappedFixedValuePointPatchField< Type >::timeVaryingMappedFixedValuePointPatchField(), and uniformFixedValuePointPatchField< Type >::uniformFixedValuePointPatchField().
|
inline |
Return patch.
Definition at line 317 of file pointPatchField.H.
Referenced by cyclicPointPatchField< Type >::cyclicPointPatchField(), emptyPointPatchField< Type >::emptyPointPatchField(), genericPointPatchField< Type >::genericPointPatchField(), internalPointPatchField< Type >::internalPointPatchField(), pointPatchField< Type >::NewCalculatedType(), nonConformalCyclicPointPatchField< Type >::nonConformalCyclicPointPatchField(), nonConformalErrorPointPatchField< Type >::nonConformalErrorPointPatchField(), pointPatchField< Type >::size(), symmetryPlanePointPatchField< Type >::symmetryPlanePointPatchField(), symmetryPointPatchField< Type >::symmetryPointPatchField(), angularOscillatingVelocityPointPatchVectorField::updateCoeffs(), oscillatingVelocityPointPatchVectorField::updateCoeffs(), and wedgePointPatchField< Type >::wedgePointPatchField().
|
inline |
Return dimensioned internal field reference.
Definition at line 323 of file pointPatchField.H.
Referenced by genericPointPatchField< Type >::genericPointPatchField(), angularOscillatingDisplacementPointPatchVectorField::updateCoeffs(), angularOscillatingVelocityPointPatchVectorField::updateCoeffs(), oscillatingDisplacementPointPatchVectorField::updateCoeffs(), and oscillatingVelocityPointPatchVectorField::updateCoeffs().
|
inline |
Return internal field reference.
Definition at line 329 of file pointPatchField.H.
Referenced by surfaceSlipDisplacementPointPatchVectorField::evaluate().
|
inline |
Return true if the boundary condition has already been updated.
Definition at line 335 of file pointPatchField.H.
Referenced by angularOscillatingDisplacementPointPatchVectorField::updateCoeffs(), angularOscillatingVelocityPointPatchVectorField::updateCoeffs(), oscillatingDisplacementPointPatchVectorField::updateCoeffs(), and oscillatingVelocityPointPatchVectorField::updateCoeffs().
Foam::tmp< Foam::Field< Type > > patchInternalField |
Return field created from appropriate internal field values.
Definition at line 110 of file pointPatchField.C.
Referenced by surfaceSlipDisplacementPointPatchVectorField::evaluate(), and pointConstraints::setPatchFields().
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 153 of file pointPatchField.C.
References Foam::abort(), Foam::FatalError, FatalErrorInFunction, forAll, Foam::constant::atomic::mp, and List< T >::size().
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 190 of file pointPatchField.C.
References Foam::abort(), Foam::FatalError, FatalErrorInFunction, forAll, Foam::constant::atomic::mp, points, and List< T >::size().
void setInternalField | ( | 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 229 of file pointPatchField.C.
References Foam::abort(), Foam::FatalError, FatalErrorInFunction, forAll, and List< T >::size().
Referenced by surfaceSlipDisplacementPointPatchVectorField::evaluate().
Given the internal field and a patch field,.
set the patch field in the internal field
Definition at line 264 of file pointPatchField.C.
|
inlinevirtual |
Map the given pointPatchField onto this pointPatchField.
Reimplemented in valuePointPatchField< Type >, genericPointPatchField< Type >, and timeVaryingMappedFixedValuePointPatchField< Type >.
Definition at line 402 of file pointPatchField.H.
|
inlinevirtual |
Reset the pointPatchField to the given pointPatchField.
Used for mesh to mesh mapping
Reimplemented in valuePointPatchField< Type >, genericPointPatchField< Type >, and timeVaryingMappedFixedValuePointPatchField< Type >.
Definition at line 407 of file pointPatchField.H.
|
inlinevirtual |
Update the coefficients associated with the patch field.
Sets Updated to true
Reimplemented in uniformFixedValuePointPatchField< Type >, codedFixedValuePointPatchField< Type >, valuePointPatchField< Type >, waveDisplacementPointPatchVectorField, uniformInterpolatedDisplacementPointPatchVectorField, timeVaryingMappedFixedValuePointPatchField< Type >, oscillatingVelocityPointPatchVectorField, oscillatingDisplacementPointPatchVectorField, angularOscillatingVelocityPointPatchVectorField, and angularOscillatingDisplacementPointPatchVectorField.
Definition at line 415 of file pointPatchField.H.
Referenced by valuePointPatchField< Type >::updateCoeffs().
|
inlinevirtual |
Initialise evaluation of the patch field (do nothing)
Definition at line 421 of file pointPatchField.H.
|
virtual |
Evaluate the patch field.
Reimplemented in fixedNormalSlipPointPatchField< Type >, codedFixedValuePointPatchField< Type >, wedgePointPatchField< Type >, symmetryPlanePointPatchField< Type >, processorCyclicPointPatchField< Type >, processorPointPatchField< Type >, cyclicSlipPointPatchField< Type >, cyclicPointPatchField< Type >, valuePointPatchField< Type >, basicSymmetryPointPatchField< Type >, and surfaceSlipDisplacementPointPatchVectorField.
Definition at line 275 of file pointPatchField.C.
Referenced by surfaceSlipDisplacementPointPatchVectorField::evaluate(), valuePointPatchField< Type >::evaluate(), and timeVaryingMappedFixedValuePointPatchField< Type >::timeVaryingMappedFixedValuePointPatchField().
|
virtual |
Write.
Reimplemented in uniformFixedValuePointPatchField< Type >, fixedNormalSlipPointPatchField< Type >, codedFixedValuePointPatchField< Type >, valuePointPatchField< Type >, genericPointPatchField< Type >, waveDisplacementPointPatchVectorField, uniformInterpolatedDisplacementPointPatchVectorField, timeVaryingMappedFixedValuePointPatchField< Type >, surfaceSlipDisplacementPointPatchVectorField, oscillatingVelocityPointPatchVectorField, oscillatingDisplacementPointPatchVectorField, angularOscillatingVelocityPointPatchVectorField, and angularOscillatingDisplacementPointPatchVectorField.
Definition at line 97 of file pointPatchField.C.
References Foam::type(), and Foam::writeEntry().
Referenced by angularOscillatingDisplacementPointPatchVectorField::write(), angularOscillatingVelocityPointPatchVectorField::write(), oscillatingDisplacementPointPatchVectorField::write(), oscillatingVelocityPointPatchVectorField::write(), surfaceSlipDisplacementPointPatchVectorField::write(), uniformInterpolatedDisplacementPointPatchVectorField::write(), waveDisplacementPointPatchVectorField::write(), valuePointPatchField< Type >::write(), and fixedNormalSlipPointPatchField< Type >::write().
|
inlinevirtual |
Reimplemented in valuePointPatchField< Type >.
Definition at line 444 of file pointPatchField.H.
|
inlinevirtual |
Definition at line 445 of file pointPatchField.H.
|
inlinevirtual |
Definition at line 446 of file pointPatchField.H.
|
inlinevirtual |
Definition at line 447 of file pointPatchField.H.
|
inlinevirtual |
Definition at line 448 of file pointPatchField.H.
|
inlinevirtual |
Definition at line 449 of file pointPatchField.H.
Reimplemented in valuePointPatchField< Type >, and fixedValuePointPatchField< Type >.
Definition at line 451 of file pointPatchField.H.
Definition at line 452 of file pointPatchField.H.
Definition at line 453 of file pointPatchField.H.
Definition at line 455 of file pointPatchField.H.
Definition at line 456 of file pointPatchField.H.
|
inlinevirtual |
Reimplemented in valuePointPatchField< Type >, and fixedValuePointPatchField< Type >.
Definition at line 458 of file pointPatchField.H.
|
inlinevirtual |
Definition at line 459 of file pointPatchField.H.
|
inlinevirtual |
Definition at line 460 of file pointPatchField.H.
|
inlinevirtual |
Definition at line 461 of file pointPatchField.H.
|
inlinevirtual |
Definition at line 462 of file pointPatchField.H.
|
inlinevirtual |
Reimplemented in valuePointPatchField< Type >.
Definition at line 469 of file pointPatchField.H.
Reimplemented in valuePointPatchField< Type >.
Definition at line 470 of file pointPatchField.H.
|
inlinevirtual |
Reimplemented in valuePointPatchField< Type >.
Definition at line 471 of file pointPatchField.H.
Foam::autoPtr<Foam::pointPatchField<Type> > NewCalculatedType | ( | const pointPatchField< Type2 > & | pf | ) |
Definition at line 89 of file calculatedPointPatchField.C.
References Field< Type >::null(), and pointPatchField< Type >::patch().
Foam::tmp<Foam::Field<Type1> > patchInternalField | ( | const Field< Type1 > & | iF, |
const labelList & | meshPoints | ||
) | const |
Definition at line 119 of file pointPatchField.C.
References Foam::abort(), Foam::FatalError, FatalErrorInFunction, and List< T >::size().
Foam::tmp<Foam::Field<Type1> > patchInternalField | ( | const Field< Type1 > & | iF | ) | const |
Definition at line 142 of file pointPatchField.C.
|
friend |
|
static |
Debug switch to disallow the use of genericPointPatchField.
Definition at line 105 of file pointPatchField.H.