coupledFvPatch Class Referenceabstract

An abstract base class for patches that couple regions of the computational domain e.g. cyclic and processor-processor links. More...

Inheritance diagram for coupledFvPatch:
Collaboration diagram for coupledFvPatch:

Public Member Functions

 TypeName (coupledPolyPatch::typeName_())
 Runtime type information. More...
 
 coupledFvPatch (const polyPatch &patch, const fvBoundaryMesh &bm)
 Construct from polyPatch. More...
 
virtual ~coupledFvPatch ()
 Destructor. More...
 
virtual bool coupled () const
 Return true because this patch is coupled. More...
 
virtual bool parallel () const =0
 Are the cyclic planes parallel. More...
 
virtual const tensorFieldforwardT () const =0
 Return face transformation tensor. More...
 
virtual const tensorFieldreverseT () const =0
 Return neighbour-cell transformation tensor. More...
 
virtual const labelUListfaceCells () const
 Return faceCell addressing. More...
 
virtual tmp< vectorFielddelta () const =0
 Return delta (P to N) vectors across coupled patch. More...
 
virtual tmp< labelFieldinterfaceInternalField (const labelUList &internalData) const =0
 Return the values of the given internal data adjacent to. More...
 
virtual void initInternalFieldTransfer (const Pstream::commsTypes commsType, labelUList &iF) const
 Initialise neighbour field transfer. More...
 
virtual tmp< labelFieldinternalFieldTransfer (const Pstream::commsTypes commsType, const labelUList &iF) const =0
 Return neighbour field. More...
 
- Public Member Functions inherited from lduInterface
 TypeName ("lduInterface")
 Runtime type information. More...
 
 lduInterface ()
 Construct null. More...
 
virtual ~lduInterface ()
 Destructor. More...
 
virtual void initInternalFieldTransfer (const Pstream::commsTypes commsType, const labelUList &iF) const
 Initialise transfer of internal field adjacent to the interface. More...
 
- Public Member Functions inherited from fvPatch
 TypeName (polyPatch::typeName_())
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, fvPatch, polyPatch,(const polyPatch &patch, const fvBoundaryMesh &bm),(patch, bm))
 
 fvPatch (const polyPatch &, const fvBoundaryMesh &)
 Construct from polyPatch and fvBoundaryMesh. More...
 
virtual ~fvPatch ()
 Destructor. More...
 
const polyPatchpatch () const
 Return the polyPatch. More...
 
const wordname () const
 Return name. More...
 
label start () const
 Return start label of this patch in the polyMesh face list. More...
 
virtual label size () const
 Return size. More...
 
label index () const
 Return the index of this patch in the fvBoundaryMesh. More...
 
const fvBoundaryMeshboundaryMesh () const
 Return boundaryMesh reference. More...
 
template<class T >
const List< T >::subList patchSlice (const List< T > &l) const
 Slice list to patch. More...
 
const vectorFieldCf () const
 Return face centres. More...
 
tmp< vectorFieldCn () const
 Return neighbour cell centres. More...
 
const vectorFieldSf () const
 Return face area vectors. More...
 
const scalarFieldmagSf () const
 Return face area magnitudes. More...
 
tmp< vectorFieldnf () const
 Return face normals. More...
 
const scalarFieldweights () const
 Return patch weighting factors. More...
 
const scalarFielddeltaCoeffs () const
 Return the face - cell distance coeffient. More...
 
template<class Type >
tmp< Field< Type > > patchInternalField (const UList< Type > &) const
 Return given internal field next to patch as patch field. More...
 
template<class Type >
void patchInternalField (const UList< Type > &, Field< Type > &) const
 Return given internal field next to patch as patch field. More...
 
template<class GeometricField , class Type >
const
GeometricField::PatchFieldType
patchField (const GeometricField &) const
 Return the corresponding patchField of the named field. More...
 
template<class GeometricField , class Type >
const
GeometricField::PatchFieldType
lookupPatchField (const word &name, const GeometricField *=NULL, const Type *=NULL) const
 Lookup and return the patchField of the named field from the. More...
 
template<class Type >
Foam::tmp< Foam::Field< Type > > patchInternalField (const UList< Type > &f) const
 

Protected Member Functions

virtual void makeWeights (scalarField &) const =0
 Make patch weighting factors. More...
 
- Protected Member Functions inherited from fvPatch
virtual void initMovePoints ()
 Initialise the patches for moving points. More...
 
virtual void movePoints ()
 Correct patches after moving points. More...
 

Friends

class surfaceInterpolation
 

Additional Inherited Members

- Public Types inherited from fvPatch
typedef fvBoundaryMesh BoundaryMesh
 
- Static Public Member Functions inherited from fvPatch
static autoPtr< fvPatchNew (const polyPatch &, const fvBoundaryMesh &)
 Return a pointer to a new patch created on freestore from polyPatch. More...
 
static bool constraintType (const word &pt)
 Return true if the given type is a constraint type. More...
 
static wordList constraintTypes ()
 Return a list of all the constraint patch types. More...
 

Detailed Description

An abstract base class for patches that couple regions of the computational domain e.g. cyclic and processor-processor links.

Source files

Definition at line 51 of file coupledFvPatch.H.

Constructor & Destructor Documentation

coupledFvPatch ( const polyPatch patch,
const fvBoundaryMesh bm 
)
inline

Construct from polyPatch.

Definition at line 81 of file coupledFvPatch.H.

~coupledFvPatch ( )
virtual

Destructor.

Definition at line 38 of file coupledFvPatch.C.

Member Function Documentation

virtual void makeWeights ( scalarField ) const
protectedpure virtual

Make patch weighting factors.

Reimplemented from fvPatch.

Implemented in cyclicACMIFvPatch, cyclicFvPatch, cyclicAMIFvPatch, and processorFvPatch.

TypeName ( coupledPolyPatch::  typeName_())

Runtime type information.

virtual bool coupled ( ) const
inlinevirtual

Return true because this patch is coupled.

Reimplemented from fvPatch.

Reimplemented in cyclicACMIFvPatch, cyclicAMIFvPatch, and processorFvPatch.

Definition at line 97 of file coupledFvPatch.H.

References coupledPolyPatch::coupled().

Here is the call graph for this function:

virtual bool parallel ( ) const
pure virtual

Are the cyclic planes parallel.

Implemented in cyclicACMIFvPatch, cyclicAMIFvPatch, processorFvPatch, cyclicFvPatch, and processorCyclicFvPatch.

virtual const tensorField& forwardT ( ) const
pure virtual

Return face transformation tensor.

Implemented in cyclicACMIFvPatch, cyclicAMIFvPatch, processorFvPatch, cyclicFvPatch, and processorCyclicFvPatch.

virtual const tensorField& reverseT ( ) const
pure virtual

Return neighbour-cell transformation tensor.

Implemented in cyclicACMIFvPatch, cyclicAMIFvPatch, processorFvPatch, cyclicFvPatch, and processorCyclicFvPatch.

virtual const labelUList& faceCells ( ) const
inlinevirtual

Return faceCell addressing.

Reimplemented from fvPatch.

Definition at line 112 of file coupledFvPatch.H.

References fvPatch::faceCells().

Here is the call graph for this function:

Foam::tmp< Foam::vectorField > delta ( ) const
pure virtual

Return delta (P to N) vectors across coupled patch.

Reimplemented from fvPatch.

Implemented in cyclicACMIFvPatch, cyclicAMIFvPatch, processorFvPatch, and cyclicFvPatch.

Definition at line 44 of file coupledFvPatch.C.

Referenced by cyclicFvPatch::delta(), processorFvPatch::delta(), cyclicAMIFvPatch::delta(), cyclicACMIFvPatch::delta(), processorFvPatch::makeWeights(), cyclicFvPatch::makeWeights(), cyclicAMIFvPatch::makeWeights(), and cyclicACMIFvPatch::makeWeights().

Here is the caller graph for this function:

virtual tmp<labelField> interfaceInternalField ( const labelUList internalData) const
pure virtual

Return the values of the given internal data adjacent to.

the interface as a field

Implements lduInterface.

Implemented in cyclicACMIFvPatch, cyclicAMIFvPatch, processorFvPatch, and cyclicFvPatch.

virtual void initInternalFieldTransfer ( const Pstream::commsTypes  commsType,
labelUList iF 
) const
inlinevirtual

Initialise neighbour field transfer.

Definition at line 132 of file coupledFvPatch.H.

virtual tmp<labelField> internalFieldTransfer ( const Pstream::commsTypes  commsType,
const labelUList iF 
) const
pure virtual

Return neighbour field.

Implements lduInterface.

Implemented in cyclicACMIFvPatch, cyclicAMIFvPatch, processorFvPatch, and cyclicFvPatch.

Friends And Related Function Documentation

friend class surfaceInterpolation
friend

Definition at line 71 of file coupledFvPatch.H.


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