FreeFOAM The Cross-Platform CFD Toolkit
coupledPointPatchField< Type > Class Template Reference

A Coupled boundary condition for pointField. More...

#include <OpenFOAM/coupledPointPatchField.H>


Detailed Description

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

A Coupled boundary condition for pointField.

Source files

Definition at line 51 of file coupledPointPatchField.H.

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

List of all members.

Public Member Functions

 TypeName (coupledPointPatch::typeName_())
 Runtime type information.
 coupledPointPatchField (const pointPatch &, const DimensionedField< Type, pointMesh > &)
 Construct from patch and internal field.
 coupledPointPatchField (const pointPatch &, const DimensionedField< Type, pointMesh > &, const dictionary &dict)
 Construct from patch, internal field and dictionary.
 coupledPointPatchField (const coupledPointPatchField< Type > &, const pointPatch &, const DimensionedField< Type, pointMesh > &, const pointPatchFieldMapper &)
 Construct by mapping given patchField<Type> onto a new patch.
virtual autoPtr
< pointPatchField< Type > > 
clone () const =0
 Construct and return a clone.
 coupledPointPatchField (const coupledPointPatchField< Type > &, const DimensionedField< Type, pointMesh > &)
 Construct as copy setting internal field reference.
virtual autoPtr
< pointPatchField< Type > > 
clone (const DimensionedField< Type, pointMesh > &iF) const =0
 Construct and return a clone setting internal field reference.
virtual bool coupled () const
 Return true if this patch field is derived from.
virtual void evaluate (const Pstream::commsTypes commsType=Pstream::blocking)=0
 Evaluate the patch field.
virtual void initSwapAdd (Field< Type > &) const
 Initialise swap of patch point values.
virtual void swapAdd (Field< Type > &) const =0
 Complete swap of patch point values and add to local values.
- Public Member Functions inherited from pointPatchField< Type >
 TypeName ("pointPatchField")
 Runtime type information.
 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.
 pointPatchField (const pointPatch &, const DimensionedField< Type, pointMesh > &, const dictionary &)
 Construct from patch, internal field and dictionary.
 pointPatchField (const pointPatchField< Type > &)
 Construct as copy.
 pointPatchField (const pointPatchField< Type > &, const DimensionedField< Type, pointMesh > &)
 Construct as copy setting internal field reference.
virtual ~pointPatchField ()
const objectRegistrydb () const
 Return local objectRegistry.
label size () const
 Return size.
const pointPatchpatch () const
 Return patch.
const DimensionedField< Type,
pointMesh > & 
dimensionedInternalField () const
 Return dimensioned internal field reference.
const Field< Type > & internalField () const
 Return internal field reference.
bool updated () const
 Return true if the boundary condition has already been updated.
tmp< Field< Type > > patchInternalField () const
 Return field created from appropriate internal field values.
template<class Type1 >
tmp< Field< Type1 > > patchInternalField (const Field< Type1 > &iF) const
 Return field created from appropriate internal field values.
template<class Type1 >
void addToInternalField (Field< Type1 > &iF, const Field< Type1 > &pF) const
 Given the internal field and a patch field,.
template<class Type1 >
void setInInternalField (Field< Type1 > &iF, const Field< Type1 > &pF, const labelList &meshPoints) const
 Given the internal field and a patch field,.
template<class Type1 >
void setInInternalField (Field< Type1 > &iF, const Field< Type1 > &pF) const
 Given the internal field and a patch field,.
virtual void autoMap (const pointPatchFieldMapper &)
 Map (and resize as needed) from self given a mapping object.
virtual void rmap (const pointPatchField< Type > &, const labelList &)
 Reverse map the given pointPatchField onto this pointPatchField.
virtual void updateCoeffs ()
 Update the coefficients associated with the patch field.
virtual void initEvaluate (const Pstream::commsTypes commsType=Pstream::blocking)
 Initialise evaluation of the patch field (do nothing)
virtual void write (Ostream &) const
 Write.
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 &)

Additional Inherited Members

- Public Types inherited from pointPatchField< Type >
typedef pointPatch Patch
- 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.
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.
static autoPtr
< pointPatchField< Type > > 
New (const pointPatch &, const DimensionedField< Type, pointMesh > &, const dictionary &)
 Return a pointer to a new patchField created on freestore.
template<class Type2 >
static autoPtr
< pointPatchField< Type > > 
NewCalculatedType (const pointPatchField< Type2 > &)
 Return a pointer to a new CalculatedpointPatchField created on.
static const wordcalculatedType ()
 Return the type of the calculated for of pointPatchField.
- Static Public Attributes inherited from pointPatchField< Type >
static int disallowGenericPointPatchField
 Debug switch to disallow the use of genericPointPatchField.

Constructor & Destructor Documentation

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

Construct from patch and internal field.

Definition at line 37 of file coupledPointPatchField.C.

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

Construct from patch, internal field and dictionary.

Definition at line 48 of file coupledPointPatchField.C.

coupledPointPatchField ( const coupledPointPatchField< 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 60 of file coupledPointPatchField.C.

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

Construct as copy setting internal field reference.

Definition at line 73 of file coupledPointPatchField.C.


Member Function Documentation

TypeName ( coupledPointPatch::  typeName_())

Runtime type information.

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

Construct and return a clone setting internal field reference.

Implements pointPatchField< Type >.

Implemented in cyclicPointPatchField< Type >, processorPointPatchField< Type >, and globalPointPatchField< Type >.

virtual bool coupled ( ) const
inlinevirtual

Return true if this patch field is derived from.

coupledFvPatchField<Type>.

Reimplemented from pointPatchField< Type >.

Reimplemented in processorPointPatchField< Type >.

Definition at line 111 of file coupledPointPatchField.H.

virtual void evaluate ( const Pstream::commsTypes  commsType = Pstream::blocking)
pure virtual
virtual void initSwapAdd ( Field< Type > &  ) const
inlinevirtual

Initialise swap of patch point values.

Reimplemented in processorPointPatchField< Type >.

Definition at line 123 of file coupledPointPatchField.H.

virtual void swapAdd ( Field< Type > &  ) const
pure virtual

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

Implemented in processorPointPatchField< Type >, cyclicPointPatchField< Type >, and globalPointPatchField< Type >.


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