All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
coupledPointPatchField< Type > Class Template Referenceabstract

A Coupled boundary condition for pointField. More...

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

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 >
 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 > &)
 Copy constructor. More...
 
 pointPatchField (const pointPatchField< Type > &, const DimensionedField< Type, pointMesh > &)
 Construct as copy setting internal field reference. More...
 
virtual ~pointPatchField ()
 Destructor. More...
 
const objectRegistrydb () const
 Return local objectRegistry. More...
 
label size () const
 Return size. More...
 
const pointPatchpatch () 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...
 
const wordpatchType () const
 Optional patch type. More...
 
wordpatchType ()
 Optional patch type. More...
 
virtual bool fixesValue () const
 Return true if this patch field fixes a value. 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 const wordconstraintType () const
 Return the constraint type this pointPatchField implements. 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= (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
 

Additional Inherited Members

- Public Types inherited from pointPatchField< Type >
typedef Type value_type
 
typedef pointPatch Patch
 
typedef calculatedPointPatchField< Type > Calculated
 
- Static Public Member Functions inherited from pointPatchField< Type >
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 wordcalculatedType ()
 Return the type of the calculated form of pointPatchField. More...
 
- Static Public Attributes inherited from pointPatchField< Type >
static int disallowGenericPointPatchField
 Debug switch to disallow the use of genericPointPatchField. More...
 

Detailed Description

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

A Coupled boundary condition for pointField.

Source files

Definition at line 50 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 32 of file coupledPointPatchField.C.

Referenced by coupledPointPatchField< Type >::coupledPointPatchField().

Here is the caller graph for this function:

◆ 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 43 of file coupledPointPatchField.C.

References coupledPointPatchField< Type >::coupledPointPatchField().

Here is the call graph for this function:

◆ 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 55 of file coupledPointPatchField.C.

References coupledPointPatchField< Type >::coupledPointPatchField().

Here is the call graph for this function:

◆ coupledPointPatchField() [4/4]

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

Construct as copy setting internal field reference.

Definition at line 68 of file coupledPointPatchField.C.

Member Function Documentation

◆ TypeName()

TypeName ( coupledPointPatch::typeName_()  )

Runtime type information.

◆ clone() [1/2]

◆ clone() [2/2]

◆ 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 110 of file coupledPointPatchField.H.

◆ evaluate()

◆ initSwapAddSeparated()

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

Initialise swap of patch point values.

Reimplemented in processorCyclicPointPatchField< Type >.

Definition at line 124 of file coupledPointPatchField.H.

References coupledPointPatchField< Type >::swapAddSeparated().

Here is the call graph for this function:

◆ swapAddSeparated()

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

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

Implemented in cyclicAMIPointPatchField< Type >, processorCyclicPointPatchField< Type >, processorPointPatchField< Type >, and cyclicPointPatchField< Type >.

Referenced by coupledPointPatchField< Type >::initSwapAddSeparated().

Here is the caller graph for this function:

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