Public Member Functions | Private Attributes
cyclicPointPatchField< Type > Class Template Reference

Cyclic front and back plane patch field. More...

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

Public Member Functions

 TypeName (cyclicPointPatch::typeName_())
 Runtime type information. More...
 
 cyclicPointPatchField (const pointPatch &, const DimensionedField< Type, pointMesh > &)
 Construct from patch and internal field. More...
 
 cyclicPointPatchField (const pointPatch &, const DimensionedField< Type, pointMesh > &, const dictionary &)
 Construct from patch, internal field and dictionary. More...
 
 cyclicPointPatchField (const cyclicPointPatchField< 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
 Construct and return a clone. More...
 
 cyclicPointPatchField (const cyclicPointPatchField< Type > &, const DimensionedField< Type, pointMesh > &)
 Construct as copy setting internal field reference. More...
 
virtual autoPtr< pointPatchField< Type > > clone (const DimensionedField< Type, pointMesh > &iF) const
 Construct and return a clone setting internal field reference. More...
 
virtual const wordconstraintType () const
 Constraint handling. More...
 
virtual bool doTransform () const
 Cyclic coupled interface functions. More...
 
virtual const tensorFieldforwardT () const
 Return face transformation tensor. More...
 
virtual const tensorFieldreverseT () const
 Return neighbour-cell transformation tensor. More...
 
virtual void evaluate (const Pstream::commsTypes commsType=Pstream::blocking)
 Evaluate the patch field. More...
 
virtual void swapAddSeparated (const Pstream::commsTypes commsType, Field< Type > &) const
 Complete swap of patch point values and add to local values. 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 coupledPointPatchField< Type > &, const pointPatch &, const DimensionedField< Type, pointMesh > &, const pointPatchFieldMapper &)
 Construct by mapping given patchField<Type> onto a new patch. More...
 
 coupledPointPatchField (const coupledPointPatchField< Type > &, const DimensionedField< Type, pointMesh > &)
 Construct as copy setting internal field reference. More...
 
virtual bool coupled () const
 Return true if this patch field is derived from. More...
 
virtual void initSwapAddSeparated (const Pstream::commsTypes, Field< Type > &) const
 Initialise swap of patch point 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 > &)
 Construct as copy. More...
 
 pointPatchField (const pointPatchField< Type > &, const DimensionedField< Type, pointMesh > &)
 Construct as copy setting internal field reference. More...
 
virtual autoPtr< pointPatchField< Type > > clone () const=0
 Construct and return a clone. 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 > & dimensionedInternalField () const
 Return dimensioned internal field reference. More...
 
const Field< Type > & internalField () 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...
 
virtual bool coupled () const
 Return true if this patch field is coupled. 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...
 
tmp< Field< Type1 > > patchInternalField (const Field< Type1 > &iF) const
 Return field created from appropriate internal field values. More...
 
tmp< Field< Type1 > > patchInternalField (const Field< Type1 > &iF, const labelList &meshPoints) const
 Return field created from selected internal field values. More...
 
tmp< Field< Type > > patchInternalField () const
 
void addToInternalField (Field< Type1 > &iF, const Field< Type1 > &pF) const
 Given the internal field and a patch field,. More...
 
void addToInternalField (Field< Type1 > &iF, const Field< Type1 > &pF, const labelList &points) const
 Given the internal field and a patch field,. More...
 
void setInInternalField (Field< Type1 > &iF, const Field< Type1 > &pF, const labelList &meshPoints) const
 Given the internal field and a patch field,. More...
 
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::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 Field< Type > &)
 
virtual void operator= (const Type &)
 
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 Field< Type > &)
 
virtual void operator-= (const Type &)
 
virtual void operator*= (const pointPatchField< scalar > &)
 
virtual void operator*= (const Field< scalar > &)
 
virtual void operator*= (const scalar)
 
virtual void operator/= (const pointPatchField< scalar > &)
 
virtual void operator/= (const Field< scalar > &)
 
virtual void operator/= (const scalar)
 
virtual void operator== (const pointPatchField< Type > &)
 
virtual void operator== (const Field< Type > &)
 
virtual void operator== (const Type &)
 

Private Attributes

const cyclicPointPatchcyclicPatch_
 Local reference cast into the cyclic patch. More...
 

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. 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...
 
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::cyclicPointPatchField< Type >

Cyclic front and back plane patch field.

Source files

Definition at line 50 of file cyclicPointPatchField.H.

Constructor & Destructor Documentation

◆ cyclicPointPatchField() [1/4]

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

Construct from patch and internal field.

Definition at line 35 of file cyclicPointPatchField.C.

◆ cyclicPointPatchField() [2/4]

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

Construct from patch, internal field and dictionary.

Definition at line 47 of file cyclicPointPatchField.C.

References dict, Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, and p.

Here is the call graph for this function:

◆ cyclicPointPatchField() [3/4]

cyclicPointPatchField ( const cyclicPointPatchField< 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 70 of file cyclicPointPatchField.C.

References Foam::endl(), Foam::exit(), Foam::FatalError, and FatalErrorInFunction.

Here is the call graph for this function:

◆ cyclicPointPatchField() [4/4]

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

Construct as copy setting internal field reference.

Definition at line 94 of file cyclicPointPatchField.C.

Member Function Documentation

◆ TypeName()

TypeName ( cyclicPointPatch::typeName_()  )

Runtime type information.

◆ clone() [1/2]

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

Construct and return a clone.

Implements coupledPointPatchField< Type >.

Reimplemented in cyclicSlipPointPatchField< Type >, and nonuniformTransformCyclicPointPatchField< Type >.

Definition at line 93 of file cyclicPointPatchField.H.

◆ clone() [2/2]

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

Construct and return a clone setting internal field reference.

Implements coupledPointPatchField< Type >.

Reimplemented in cyclicSlipPointPatchField< Type >, and nonuniformTransformCyclicPointPatchField< Type >.

Definition at line 113 of file cyclicPointPatchField.H.

◆ constraintType()

virtual const word& constraintType ( ) const
inlinevirtual

Constraint handling.

Return the constraint type this pointPatchField implements

Definition at line 132 of file cyclicPointPatchField.H.

◆ doTransform()

virtual bool doTransform ( ) const
inlinevirtual

Cyclic coupled interface functions.

Does the patch field perform the transfromation

Definition at line 140 of file cyclicPointPatchField.H.

References cyclicPointPatchField< Type >::cyclicPatch_, and cyclicPointPatch::parallel().

Here is the call graph for this function:

◆ forwardT()

virtual const tensorField& forwardT ( ) const
inlinevirtual

Return face transformation tensor.

Definition at line 146 of file cyclicPointPatchField.H.

References cyclicPointPatchField< Type >::cyclicPatch_, and cyclicPointPatch::forwardT().

Here is the call graph for this function:

◆ reverseT()

virtual const tensorField& reverseT ( ) const
inlinevirtual

Return neighbour-cell transformation tensor.

Definition at line 152 of file cyclicPointPatchField.H.

References cyclicPointPatchField< Type >::cyclicPatch_, and cyclicPointPatch::reverseT().

Here is the call graph for this function:

◆ evaluate()

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

Evaluate the patch field.

Implements coupledPointPatchField< Type >.

Reimplemented in cyclicSlipPointPatchField< Type >, and nonuniformTransformCyclicPointPatchField< Type >.

Definition at line 162 of file cyclicPointPatchField.H.

◆ swapAddSeparated()

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

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

Implements coupledPointPatchField< Type >.

Definition at line 108 of file cyclicPointPatchField.C.

References dimensionedInternalField(), fld(), forAll, facePointPatch::index(), cyclicPointPatch::neighbPatch(), Foam::Swap(), and Foam::transform().

Here is the call graph for this function:

Field Documentation

◆ cyclicPatch_

const cyclicPointPatch& cyclicPatch_
private

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