processorCyclicPointPatchField< Type > Class Template Reference

Foam::processorCyclicPointPatchField. More...

Inheritance diagram for processorCyclicPointPatchField< Type >:
Collaboration diagram for processorCyclicPointPatchField< Type >:

Public Member Functions

 TypeName (processorCyclicPointPatch::typeName_())
 Runtime type information. More...
 
 processorCyclicPointPatchField (const pointPatch &, const DimensionedField< Type, pointMesh > &)
 Construct from patch and internal field. More...
 
 processorCyclicPointPatchField (const pointPatch &, const DimensionedField< Type, pointMesh > &, const dictionary &)
 Construct from patch, internal field and dictionary. More...
 
 processorCyclicPointPatchField (const this_bctype &, const pointPatch &, const DimensionedField< Type, pointMesh > &, const pointPatchFieldMapper &)
 Construct by mapping onto a new patch. More...
 
 processorCyclicPointPatchField (const this_bctype &, const DimensionedField< Type, pointMesh > &)
 Construct as copy setting internal field reference. More...
 
 processorCyclicPointPatchField (const this_bctype &pfld)=delete
 No copy without an internal field. More...
 
virtual autoPtr< pointPatchField< Type > > clone (const DimensionedField< Type, pointMesh > &iF) const
 Clone with an internal field reference. More...
 
virtual ~processorCyclicPointPatchField ()=default
 Destructor. More...
 
virtual bool coupled () const
 Return true if running parallel. More...
 
virtual bool doTransform () const
 Does the patch field perform the transformation. More...
 
virtual void evaluate (const Pstream::commsTypes commsType=Pstream::commsTypes::buffered)
 Evaluate the patch field. More...
 
virtual void initSwapAddSeparated (const Pstream::commsTypes commsType, Field< Type > &) const
 Initialise swap of non-collocated patch point values. More...
 
virtual void swapAddSeparated (const Pstream::commsTypes commsType, Field< Type > &) const
 Complete swap of patch point values and add to local values. More...
 
virtual void operator= (const pointPatchField< Type > &)
 Inherit assignment. More...
 
virtual void operator= (const Field< Type > &)
 Inherit assignment. More...
 
virtual void operator= (const Type &)
 Inherit assignment. More...
 
- Public Member Functions inherited from coupledPointPatchField< Type >
 TypeName (coupledPointPatch::typeName_())
 Runtime type information. More...
 
 coupledPointPatchField (const pointPatch &, const DimensionedField< Type, pointMesh > &)
 Construct from patch and internal field. More...
 
 coupledPointPatchField (const pointPatch &, const DimensionedField< Type, pointMesh > &, const dictionary &dict)
 Construct from patch, internal field and dictionary. More...
 
 coupledPointPatchField (const this_bctype &, const pointPatch &, const DimensionedField< Type, pointMesh > &, const pointPatchFieldMapper &)
 Construct by mapping onto a new patch. More...
 
 coupledPointPatchField (const this_bctype &, const DimensionedField< Type, pointMesh > &)
 Construct as copy setting internal field reference. More...
 
 coupledPointPatchField (const this_bctype &pfld)=delete
 No copy without an internal field. More...
 
virtual void operator= (const pointPatchField< Type > &)
 Inherit assignment. More...
 
virtual void operator= (const Field< Type > &)
 Inherit assignment. More...
 
virtual void operator= (const Type &)
 Inherit assignment. More...
 
- Public Member Functions inherited from pointPatchField< Type >
 declareRunTimeSelectionTable (autoPtr, pointPatchField, patch,(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 onto a new patch. More...
 
 pointPatchField (const pointPatchField< Type > &pfld, const pointPatch &p, const DimensionedField< Type, pointMesh > &iF, const Type &value)
 Copy construct onto a new patch with (unused) value. More...
 
 pointPatchField (const pointPatchField< Type > &pfld, const DimensionedField< Type, pointMesh > &iF)
 Copy construct with internal field reference. More...
 
 pointPatchField (const pointPatchField &pfld)
 No copy without an internal field. More...
 
virtual autoPtr< pointPatchField< Type > > clone () const
 No clone without an internal field reference. More...
 
virtual ~pointPatchField ()=default
 Destructor. More...
 
label size () const noexcept
 Return the patch size. More...
 
const DimensionedField< Type, pointMesh > & internalField () const noexcept
 Return const-reference to the dimensioned internal field. More...
 
const Field< Type > & primitiveField () const noexcept
 Return const-reference to the internal field values. More...
 
template<class Type1 >
void patchInternalField (const UList< Type1 > &internalData, const labelUList &addressing, UList< Type1 > &pfld) const
 Extract field using specified addressing. More...
 
template<class Type1 >
tmp< Field< Type1 > > patchInternalField (const UList< Type1 > &internalData, const labelUList &addressing) const
 Return field created from selected internal field values given internal field reference. More...
 
template<class Type1 >
tmp< Field< Type1 > > patchInternalField (const UList< Type1 > &internalData) const
 Return field created from appropriate internal field values given internal field reference. More...
 
tmp< Field< Type > > patchInternalField () const
 Return field created from appropriate 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, add the patch field to the internal field. More...
 
template<class Type1 >
void addToInternalField (Field< Type1 > &iF, const Field< Type1 > &pF, const labelUList &points) const
 Given the internal field and a patch field, add selected elements of the patch field to the internal field. More...
 
template<class Type1 >
void setInInternalField (Field< Type1 > &iF, const Field< Type1 > &pF, const labelUList &meshPoints) const
 Given the internal field and a patch field, set the patch field in the internal field. More...
 
template<class Type1 >
void setInInternalField (Field< Type1 > &iF, const Field< Type1 > &pF) const
 Given the internal field and a patch field, set the patch field in the internal 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::buffered)
 Initialise evaluation of the patch field (do nothing) More...
 
virtual void initEvaluateLocal (const Pstream::commsTypes commsType=Pstream::commsTypes::buffered)
 Initialise the evaluation of the patch field after a local operation. More...
 
virtual void evaluateLocal (const Pstream::commsTypes commsType=Pstream::commsTypes::buffered)
 Evaluate the patch field after a local operation (e.g. *=) More...
 
virtual void write (Ostream &os) const
 Write. More...
 
virtual void operator= (const pointPatchField< Type > &)
 
virtual void operator= (const Field< Type > &)
 
virtual void operator= (const 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< scalar > &)
 
virtual void operator/= (const Field< scalar > &)
 
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 &)
 
bool operator!= (const pointPatchField< Type > &) const =delete
 
bool operator!= (const Field< Type > &) const =delete
 
bool operator!= (const Type &) const =delete
 
void negate ()
 Negate the field inplace. Dummy placeholder for FieldField. More...
 
void normalise ()
 Normalise the field inplace. Dummy placeholder for FieldField. More...
 
- Public Member Functions inherited from pointPatchFieldBase
 TypeName ("pointPatchField")
 Runtime type information. More...
 
 pointPatchFieldBase (const pointPatch &p)
 Construct from patch. More...
 
 pointPatchFieldBase (const pointPatch &p, const word &patchType)
 Construct from patch and patch type. More...
 
 pointPatchFieldBase (const pointPatch &p, const dictionary &dict)
 Construct from patch and dictionary. More...
 
 pointPatchFieldBase (const pointPatchFieldBase &, const pointPatch &p)
 Copy construct with new patch. More...
 
 pointPatchFieldBase (const pointPatchFieldBase &)
 Copy construct. More...
 
virtual ~pointPatchFieldBase ()=default
 Destructor. More...
 
virtual bool assignable () const
 True if the value of the patch field is altered by assignment. More...
 
virtual bool fixesValue () const
 True if the patch field fixes a value. More...
 
virtual const wordconstraintType () const
 The constraint type the pointPatchField implements. More...
 
const objectRegistrydb () const
 The associated objectRegistry. More...
 
const pointPatchpatch () const noexcept
 Return the patch. More...
 
const wordpatchType () const noexcept
 The optional patch type. More...
 
wordpatchType () noexcept
 The optional patch type. More...
 
virtual bool constraintOverride () const
 True if the type does not correspond to the constraint type. More...
 
bool updated () const noexcept
 True if the boundary condition has already been updated. More...
 
void setUpdated (bool state) noexcept
 Set updated state. More...
 
bool manipulatedMatrix () const noexcept
 True if the matrix has already been manipulated. Currently always false for pointPatchField. More...
 
void setManipulated (bool state) noexcept
 Set matrix manipulated state. Currently a no-op for pointPatchField. More...
 
void checkPatch (const pointPatchFieldBase &rhs) const
 Check that patches are identical. More...
 

Additional Inherited Members

- Public Types inherited from pointPatchField< Type >
typedef pointPatch Patch
 The patch type for the patch field. More...
 
typedef Type value_type
 The value_type for the patch field. More...
 
typedef pTraits< Type >::cmptType cmptType
 The component type for patch field. More...
 
typedef DimensionedField< Type, pointMeshInternal
 The internal field type associated with the patch field. More...
 
typedef calculatedPointPatchField< Type > Calculated
 Type for a calculated patch. More...
 
- Static Public Member Functions inherited from pointPatchField< Type >
template<class DerivedPatchField , class... Args>
static autoPtr< pointPatchField< Type > > Clone (const DerivedPatchField &pf, Args &&... args)
 Clone a patch field, optionally with internal field reference etc. More...
 
static autoPtr< pointPatchField< Type > > New (const word &patchFieldType, const pointPatch &p, const DimensionedField< Type, pointMesh > &iF)
 Return a pointer to a new patchField created on freestore given. More...
 
static autoPtr< pointPatchField< Type > > New (const word &patchFieldType, const word &actualPatchType, const pointPatch &p, const DimensionedField< Type, pointMesh > &iF)
 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...
 
static autoPtr< pointPatchField< Type > > NewCalculatedType (const pointPatch &p)
 Return a pointer to a new calculatedPointPatchField created on. More...
 
template<class AnyType >
static autoPtr< pointPatchField< Type > > NewCalculatedType (const pointPatchField< AnyType > &pf)
 Return a pointer to a new calculatedPointPatchField created on. More...
 
- Static Public Member Functions inherited from pointPatchFieldBase
static const wordemptyType () noexcept
 The type name for empty patch fields. More...
 
static const wordcalculatedType () noexcept
 The type name for calculated patch fields. More...
 
static const wordzeroGradientType () noexcept
 The type name for zeroGradient patch fields. More...
 
static const wordzeroValueType () noexcept
 The type name for zeroValue patch fields. More...
 
- Static Public Attributes inherited from pointPatchFieldBase
static int disallowGenericPatchField
 Debug switch to disallow the use of generic pointPatchField. More...
 
- Protected Member Functions inherited from pointPatchFieldBase
virtual void readDict (const dictionary &dict)
 Read dictionary entries. More...
 

Detailed Description

template<class Type>
class Foam::processorCyclicPointPatchField< Type >

Foam::processorCyclicPointPatchField.

Source files

Definition at line 49 of file processorCyclicPointPatchField.H.

Constructor & Destructor Documentation

◆ processorCyclicPointPatchField() [1/5]

Construct from patch and internal field.

◆ processorCyclicPointPatchField() [2/5]

processorCyclicPointPatchField ( const pointPatch ,
const DimensionedField< Type, pointMesh > &  ,
const dictionary  
)

Construct from patch, internal field and dictionary.

◆ processorCyclicPointPatchField() [3/5]

processorCyclicPointPatchField ( const this_bctype ,
const pointPatch ,
const DimensionedField< Type, pointMesh > &  ,
const pointPatchFieldMapper  
)

Construct by mapping onto a new patch.

◆ processorCyclicPointPatchField() [4/5]

Construct as copy setting internal field reference.

◆ processorCyclicPointPatchField() [5/5]

processorCyclicPointPatchField ( const this_bctype pfld)
delete

No copy without an internal field.

◆ ~processorCyclicPointPatchField()

virtual ~processorCyclicPointPatchField ( )
virtualdefault

Destructor.

Member Function Documentation

◆ TypeName()

TypeName ( processorCyclicPointPatch::typeName_()  )

Runtime type information.

◆ clone()

virtual autoPtr<pointPatchField<Type> > clone ( const DimensionedField< Type, pointMesh > &  iF) const
inlinevirtual

Clone with an internal field reference.

Implements coupledPointPatchField< Type >.

Definition at line 138 of file processorCyclicPointPatchField.H.

References pointPatchField< Type >::Clone().

Here is the call graph for this function:

◆ coupled()

virtual bool coupled ( ) const
inlinevirtual

Return true if running parallel.

Reimplemented from coupledPointPatchField< Type >.

Definition at line 159 of file processorCyclicPointPatchField.H.

References UPstream::parRun().

Here is the call graph for this function:

◆ doTransform()

virtual bool doTransform ( ) const
inlinevirtual

Does the patch field perform the transformation.

Definition at line 167 of file processorCyclicPointPatchField.H.

References coupledPolyPatch::parallel(), and processorPointPatch::procPolyPatch().

Here is the call graph for this function:

◆ evaluate()

virtual void evaluate ( const Pstream::commsTypes  commsType = Pstream::commsTypes::buffered)
inlinevirtual

Evaluate the patch field.

Implements coupledPointPatchField< Type >.

Definition at line 183 of file processorCyclicPointPatchField.H.

◆ initSwapAddSeparated()

virtual void initSwapAddSeparated ( const Pstream::commsTypes  commsType,
Field< Type > &   
) const
virtual

Initialise swap of non-collocated patch point values.

Reimplemented from coupledPointPatchField< Type >.

◆ swapAddSeparated()

virtual void swapAddSeparated ( const Pstream::commsTypes  commsType,
Field< Type > &   
) const
virtual

Complete swap of patch point values and add to local values.

Implements coupledPointPatchField< Type >.

◆ operator=() [1/3]

virtual void operator=
inline

Inherit assignment.

Definition at line 799 of file pointPatchField.H.

◆ operator=() [2/3]

virtual void operator=
inline

Inherit assignment.

Definition at line 800 of file pointPatchField.H.

◆ operator=() [3/3]

virtual void operator=
inline

Inherit assignment.

Definition at line 801 of file pointPatchField.H.


The documentation for this class was generated from the following file: