FreeFOAM The Cross-Platform CFD Toolkit
Hosted by SourceForge:
Get FreeFOAM at SourceForge.net.
            Fast, secure and Free Open Source software downloads

coupledFvPatch Class Reference

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

#include <finiteVolume/coupledFvPatch.H>


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 52 of file coupledFvPatch.H.

Inheritance diagram for coupledFvPatch:
Collaboration diagram for coupledFvPatch:

List of all members.

Public Member Functions

 TypeName (coupledPolyPatch::typeName_())
 Runtime type information.
 coupledFvPatch (const polyPatch &patch, const fvBoundaryMesh &bm)
 Construct from polyPatch.
virtual  ~coupledFvPatch ()
virtual bool  coupled () const
 Return true because this patch is coupled.
const tensorField &  forwardT () const
 Return face transformation tensor.
const tensorField &  reverseT () const
 Return neighbour-cell transformation tensor.
bool  parallel () const
 Are the cyclic planes parallel.
virtual const unallocLabelList &  faceCells () const
 Return faceCell addressing.
virtual tmp< vectorField >  delta () const =0
 Return delta (P to N) vectors across coupled patch.
virtual tmp< labelField >  interfaceInternalField (const unallocLabelList &internalData) const =0
 Return the values of the given internal data adjacent to.
virtual void  initTransfer (const Pstream::commsTypes commsType, const unallocLabelList &interfaceData) const
 Initialise interface data transfer.
virtual tmp< labelField >  transfer (const Pstream::commsTypes commsType, const unallocLabelList &interfaceData) const =0
 Transfer and return neighbour field.
virtual void  initInternalFieldTransfer (const Pstream::commsTypes commsType, unallocLabelList &iF) const
 Initialise neighbour field transfer.
virtual tmp< labelField >  internalFieldTransfer (const Pstream::commsTypes commsType, const unallocLabelList &iF) const =0
 Return neighbour field.

Protected Member Functions

virtual void  makeWeights (scalarField &) const =0
 Make patch weighting factors.
virtual void  makeDeltaCoeffs (scalarField &) const =0
 Make patch face - neighbour cell distances.

Friends

class  surfaceInterpolation

Constructor & Destructor Documentation

coupledFvPatch ( const polyPatch &   patch,
const fvBoundaryMesh &   bm  
) [inline]

Construct from polyPatch.

Definition at line 85 of file coupledFvPatch.H.

~coupledFvPatch (  ) [virtual]

Definition at line 44 of file coupledFvPatch.C.


Member Function Documentation

virtual void makeWeights ( scalarField &    ) const [protected, pure virtual]

Make patch weighting factors.

Reimplemented from fvPatch.

Implemented in cyclicFvPatch, and processorFvPatch.

virtual void makeDeltaCoeffs ( scalarField &    ) const [protected, pure virtual]

Make patch face - neighbour cell distances.

Reimplemented from fvPatch.

Implemented in cyclicFvPatch, and processorFvPatch.

TypeName ( coupledPolyPatch::   typeName_()  )

Runtime type information.

virtual bool coupled (  ) const [inline, virtual]

Return true because this patch is coupled.

Reimplemented from fvPatch.

Reimplemented in processorFvPatch.

Definition at line 102 of file coupledFvPatch.H.

References coupledPolyPatch::coupled().

const tensorField& forwardT (  ) const [inline]

Return face transformation tensor.

Reimplemented in cyclicFvPatch, and processorFvPatch.

Definition at line 108 of file coupledFvPatch.H.

References coupledPolyPatch::forwardT().

const tensorField& reverseT (  ) const [inline]

Return neighbour-cell transformation tensor.

Reimplemented in cyclicFvPatch.

Definition at line 114 of file coupledFvPatch.H.

References coupledPolyPatch::reverseT().

bool parallel (  ) const [inline]
virtual const unallocLabelList& faceCells (  ) const [inline, virtual]

Return faceCell addressing.

Reimplemented from fvPatch.

Definition at line 126 of file coupledFvPatch.H.

virtual tmp<vectorField> delta (  ) const [pure virtual]

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

Reimplemented from fvPatch.

Implemented in cyclicFvPatch, and processorFvPatch.

virtual tmp<labelField> interfaceInternalField ( const unallocLabelList &   internalData  ) const [pure virtual]

Return the values of the given internal data adjacent to.

the interface as a field

Implements lduInterface.

Implemented in cyclicFvPatch, and processorFvPatch.

virtual void initTransfer ( const Pstream::commsTypes   commsType,
const unallocLabelList &   interfaceData  
) const [inline, virtual]

Initialise interface data transfer.

Reimplemented from lduInterface.

Reimplemented in processorFvPatch.

Definition at line 146 of file coupledFvPatch.H.

virtual tmp<labelField> transfer ( const Pstream::commsTypes   commsType,
const unallocLabelList &   interfaceData  
) const [pure virtual]

Transfer and return neighbour field.

Implements lduInterface.

Implemented in cyclicFvPatch, and processorFvPatch.

virtual void initInternalFieldTransfer ( const Pstream::commsTypes   commsType,
unallocLabelList &   iF  
) const [inline, virtual]

Initialise neighbour field transfer.

Definition at line 161 of file coupledFvPatch.H.

virtual tmp<labelField> internalFieldTransfer ( const Pstream::commsTypes   commsType,
const unallocLabelList &   iF  
) const [pure virtual]

Return neighbour field.

Implements lduInterface.

Implemented in cyclicFvPatch, and processorFvPatch.


Friends And Related Function Documentation

friend class surfaceInterpolation [friend]

Reimplemented from fvPatch.

Definition at line 75 of file coupledFvPatch.H.


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