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

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

#include <OpenFOAM/cyclicPointPatchField.H>


Detailed Description

template<class Type>
class Foam::cyclicPointPatchField< Type >

Cyclic front and back plane patch field.

Source files

Definition at line 51 of file cyclicPointPatchField.H.

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

List of all members.

Public Member Functions

 TypeName (cyclicPointPatch::typeName_())
 Runtime type information.
 cyclicPointPatchField (const pointPatch &, const DimensionedField< Type, pointMesh > &)
 Construct from patch and internal field.
 cyclicPointPatchField (const pointPatch &, const DimensionedField< Type, pointMesh > &, const dictionary &)
 Construct from patch, internal field and dictionary.
 cyclicPointPatchField (const cyclicPointPatchField< 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
 Construct and return a clone.
 cyclicPointPatchField (const cyclicPointPatchField< Type > &, const DimensionedField< Type, pointMesh > &)
 Construct as copy setting internal field reference.
virtual autoPtr
< pointPatchField< Type > > 
clone (const DimensionedField< Type, pointMesh > &iF) const
 Construct and return a clone setting internal field reference.
virtual bool doTransform () const
 Cyclic coupled interface functions.
virtual const tensorFieldforwardT () const
 Return face transformation tensor.
virtual const tensorFieldreverseT () const
 Return neighbour-cell transformation tensor.
virtual void evaluate (const Pstream::commsTypes commsType=Pstream::blocking)
 Evaluate the patch field.
virtual void swapAdd (Field< Type > &) const
 Complete swap of patch point values and add to local values.
- Public Member Functions inherited from coupledPointPatchField< Type >
 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.
 coupledPointPatchField (const coupledPointPatchField< Type > &, const DimensionedField< Type, pointMesh > &)
 Construct as copy setting internal field reference.
virtual bool coupled () const
 Return true if this patch field is derived from.
virtual void initSwapAdd (Field< Type > &) const
 Initialise swap of patch point 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 &)

Constructor & Destructor Documentation

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

Construct from patch and internal field.

Definition at line 38 of file cyclicPointPatchField.C.

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

Construct from patch, internal field and dictionary.

Definition at line 50 of file cyclicPointPatchField.C.

References Foam::exit(), Foam::FatalIOError, and FatalIOErrorIn.

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 79 of file cyclicPointPatchField.C.

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

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

Construct as copy setting internal field reference.

Definition at line 111 of file cyclicPointPatchField.C.


Member Function Documentation

TypeName ( cyclicPointPatch::  typeName_())

Runtime type information.

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

Construct and return a clone.

Implements coupledPointPatchField< Type >.

Definition at line 94 of file cyclicPointPatchField.H.

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

Construct and return a clone setting internal field reference.

Implements coupledPointPatchField< Type >.

Definition at line 114 of file cyclicPointPatchField.H.

virtual bool doTransform ( ) const
inlinevirtual

Cyclic coupled interface functions.

Does the patch field perform the transfromation

Definition at line 133 of file cyclicPointPatchField.H.

References cyclicPointPatch::parallel().

virtual const tensorField& forwardT ( ) const
inlinevirtual

Return face transformation tensor.

Definition at line 139 of file cyclicPointPatchField.H.

References cyclicPointPatch::forwardT().

virtual const tensorField& reverseT ( ) const
inlinevirtual

Return neighbour-cell transformation tensor.

Definition at line 145 of file cyclicPointPatchField.H.

References cyclicPointPatch::reverseT().

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

Evaluate the patch field.

Implements coupledPointPatchField< Type >.

Definition at line 155 of file cyclicPointPatchField.H.

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

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

Implements coupledPointPatchField< Type >.

Definition at line 124 of file cyclicPointPatchField.C.

References forAll, Foam::Swap(), and Foam::transform().


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