Public Member Functions | List of all members
coupledPointPatchField< Type > Class Template Referenceabstract

A Coupled boundary condition for pointField. More...

Inheritance diagram for coupledPointPatchField< Type >:
Inheritance graph
[legend]
Collaboration diagram for coupledPointPatchField< Type >:
Collaboration graph
[legend]

Public Member Functions

 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 coupledPointPatchField< Type > &, const pointPatch &, const DimensionedField< Type, pointMesh > &, const pointPatchFieldMapper &)
 Construct by mapping given patchField<Type> onto a new patch. More...
 
virtual autoPtr< pointPatchField< Type > > clone () const =0
 Construct and return a clone. More...
 
 coupledPointPatchField (const coupledPointPatchField< 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 bool coupled () const
 Return true if this patch field is derived from. More...
 
virtual void evaluate (const Pstream::commsTypes commsType=Pstream::commsTypes::blocking)=0
 Evaluate the patch field. More...
 
virtual void initSwapAddSeparated (const Pstream::commsTypes, Field< Type > &) const
 Initialise swap of patch point values. More...
 
virtual void swapAddSeparated (const Pstream::commsTypes, Field< Type > &) const =0
 Complete swap of patch point values and add to local values. 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 given patchField<Type> onto a new patch. More...
 
 pointPatchField (const pointPatchField< Type > &)
 Construct as copy. More...
 
 pointPatchField (const pointPatchField< Type > &, const DimensionedField< Type, pointMesh > &)
 Construct as copy setting internal field reference. More...
 
virtual ~pointPatchField ()=default
 Destructor. More...
 
virtual bool fixesValue () const
 True if this patch field fixes a value. More...
 
virtual const wordconstraintType () const
 The constraint type this pointPatchField implements. More...
 
label size () const
 Return the patch size. More...
 
const DimensionedField< Type, pointMesh > & internalField () const noexcept
 Return dimensioned internal field reference. More...
 
const Field< Type > & primitiveField () const noexcept
 Return internal field reference. 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 write (Ostream &) const
 Write. More...
 
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 &)
 
void negate ()
 Negate the field inplace. Dummy placeholder for FieldField. More...
 
void normalise ()
 Normalise the field inplace. Dummy placeholder for FieldField. More...
 
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
 
- 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...
 
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...
 
bool updated () const noexcept
 True if the boundary condition has already been updated. More...
 
void checkPatch (const pointPatchFieldBase &rhs) const
 Check that patches are identical. More...
 

Additional Inherited Members

- Public Types inherited from pointPatchField< Type >
typedef Type value_type
 The Field value_type. More...
 
typedef DimensionedField< Type, pointMeshInternal
 The internal field type associated with the patch field. More...
 
typedef pointPatch Patch
 The patch type for the patch field. More...
 
typedef calculatedPointPatchField< Type > Calculated
 Type for a calculated patch. More...
 
- Static Public Member Functions inherited from pointPatchField< Type >
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...
 
template<class Type2 >
static autoPtr< pointPatchField< Type > > NewCalculatedType (const pointPatchField< Type2 > &)
 Return a pointer to a new calculatedPointPatchField created on. More...
 
static const wordcalculatedType ()
 The type name for calculated patch fields. More...
 
static const wordzeroGradientType ()
 The type name for zeroGradient 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...
 
void setUpdated (bool state) noexcept
 Set updated state. More...
 

Detailed Description

template<class Type>
class Foam::coupledPointPatchField< Type >

A Coupled boundary condition for pointField.

Source files

Definition at line 48 of file coupledPointPatchField.H.

Constructor & Destructor Documentation

◆ coupledPointPatchField() [1/4]

coupledPointPatchField ( const pointPatch p,
const DimensionedField< Type, pointMesh > &  iF 
)

Construct from patch and internal field.

Definition at line 27 of file coupledPointPatchField.C.

◆ coupledPointPatchField() [2/4]

coupledPointPatchField ( const pointPatch p,
const DimensionedField< Type, pointMesh > &  iF,
const dictionary dict 
)

Construct from patch, internal field and dictionary.

Definition at line 38 of file coupledPointPatchField.C.

◆ coupledPointPatchField() [3/4]

coupledPointPatchField ( const coupledPointPatchField< Type > &  ptf,
const pointPatch p,
const DimensionedField< Type, pointMesh > &  iF,
const pointPatchFieldMapper mapper 
)

Construct by mapping given patchField<Type> onto a new patch.

Definition at line 50 of file coupledPointPatchField.C.

◆ coupledPointPatchField() [4/4]

coupledPointPatchField ( const coupledPointPatchField< Type > &  ptf,
const DimensionedField< Type, pointMesh > &  iF 
)

Construct as copy setting internal field reference.

Definition at line 63 of file coupledPointPatchField.C.

Member Function Documentation

◆ TypeName()

TypeName ( coupledPointPatch::typeName_()  )

Runtime type information.

◆ clone() [1/2]

virtual autoPtr<pointPatchField<Type> > clone ( ) const
pure virtual

◆ clone() [2/2]

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

◆ coupled()

virtual bool coupled ( ) const
inlinevirtual

Return true if this patch field is derived from.

coupledFvPatchField<Type>.

Reimplemented from pointPatchField< Type >.

Reimplemented in cyclicAMIPointPatchField< Type >, processorCyclicPointPatchField< Type >, and processorPointPatchField< Type >.

Definition at line 125 of file coupledPointPatchField.H.

◆ evaluate()

virtual void evaluate ( const Pstream::commsTypes  commsType = Pstream::commsTypes::blocking)
pure virtual

◆ initSwapAddSeparated()

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

Initialise swap of patch point values.

Reimplemented in processorCyclicPointPatchField< Type >.

Definition at line 143 of file coupledPointPatchField.H.

◆ swapAddSeparated()

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

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