processorFvPatch Class Reference

Processor patch. More...

Inheritance diagram for processorFvPatch:
[legend]
Collaboration diagram for processorFvPatch:
[legend]

Public Member Functions

 TypeName (processorPolyPatch::typeName_())
 Runtime type information. More...
 
 processorFvPatch (const polyPatch &patch, const fvBoundaryMesh &bm)
 Construct from components. More...
 
virtual label comm () const
 Return communicator used for comms. More...
 
virtual int myProcNo () const
 Return processor number. More...
 
virtual int neighbProcNo () const
 Return neighbour processor number. More...
 
virtual int tag () const
 Return message tag used for sending. More...
 
virtual bool coupled () const
 Return true if running parallel. More...
 
const processorPolyPatchprocPolyPatch () const
 
virtual bool parallel () const
 Are the cyclic planes parallel. More...
 
virtual const tensorFieldforwardT () const
 Return face transformation tensor. More...
 
virtual const tensorFieldreverseT () const
 Return neighbour-cell transformation tensor. More...
 
virtual tmp< vectorFielddelta () const
 Return delta (P to N) vectors across coupled patch. More...
 
virtual tmp< labelFieldinterfaceInternalField (const labelUList &internalData) const
 
virtual tmp< labelFieldinterfaceInternalField (const labelUList &internalData, const labelUList &faceCells) const
 
virtual void initInternalFieldTransfer (const Pstream::commsTypes commsType, const labelUList &internalData) const
 Initialise neighbour field transfer. More...
 
virtual void initInternalFieldTransfer (const Pstream::commsTypes commsType, const labelUList &iF, const labelUList &faceCells) const
 Initialise neighbour field transfer using faceCells map. More...
 
virtual tmp< labelFieldinternalFieldTransfer (const Pstream::commsTypes commsType, const labelUList &internalData) const
 Return neighbour field. More...
 
virtual void initInternalFieldTransfer (const Pstream::commsTypes commsType, labelUList &iF) const
 Inherit initInternalFieldTransfer from coupledFvPatch. More...
 
virtual void initInternalFieldTransfer (const Pstream::commsTypes commsType, labelUList &iF, const labelUList &faceCell) const
 Inherit initInternalFieldTransfer from coupledFvPatch. More...
 
virtual void initInternalFieldTransfer (const Pstream::commsTypes commsType, const labelUList &iF) const
 Inherit initInternalFieldTransfer from coupledFvPatch. More...
 
virtual void initInternalFieldTransfer (const Pstream::commsTypes commsType, const labelUList &iF, const labelUList &faceCells) const
 Inherit initInternalFieldTransfer from coupledFvPatch. More...
 
- Public Member Functions inherited from coupledFvPatch
 TypeName (coupledPolyPatch::typeName_())
 Runtime type information. More...
 
 coupledFvPatch (const polyPatch &patch, const fvBoundaryMesh &bm)
 Construct from polyPatch. More...
 
virtual ~coupledFvPatch ()
 Destructor. More...
 
virtual const labelUListfaceCells () const
 Return faceCell addressing. More...
 
virtual void initInternalFieldTransfer (const Pstream::commsTypes commsType, labelUList &iF) const
 Initialise neighbour field transfer. More...
 
virtual void initInternalFieldTransfer (const Pstream::commsTypes commsType, labelUList &iF, const labelUList &faceCell) const
 Initialise neighbour field transfer using faceCells map. More...
 
virtual void initInternalFieldTransfer (const Pstream::commsTypes commsType, const labelUList &iF) const
 Inherit initInternalFieldTransfer from lduInterface. More...
 
virtual void initInternalFieldTransfer (const Pstream::commsTypes commsType, const labelUList &iF, const labelUList &faceCells) const
 Inherit initInternalFieldTransfer from lduInterface. More...
 
- Public Member Functions inherited from lduInterface
 TypeName ("lduInterface")
 Runtime type information. More...
 
 lduInterface ()=default
 Construct null. More...
 
virtual ~lduInterface ()=default
 Destructor. More...
 
- Public Member Functions inherited from fvPatch
virtual void makeDeltaCoeffs (scalarField &) const
 Correct patch deltaCoeffs. More...
 
virtual void makeNonOrthoDeltaCoeffs (scalarField &) const
 Correct patch non-ortho deltaCoeffs. More...
 
virtual void makeNonOrthoCorrVectors (vectorField &) const
 Correct patch non-ortho correction vectors. More...
 
virtual void initMovePoints ()
 Initialise the patches for moving points. More...
 
virtual void movePoints ()
 Correct patches after moving points. More...
 
 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...
 
virtual const wordname () const
 Return name. More...
 
virtual 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
 
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 >
tmp< Field< Type > > patchInternalField (const UList< Type > &, const labelUList &faceCells) const
 
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::PatchpatchField (const GeometricField &) const
 Return the corresponding patchField of the named field. More...
 
template<class GeometricField , class Type >
const GeometricField::PatchlookupPatchField (const word &name, const GeometricField *=nullptr, const Type *=nullptr) const
 
template<class Type >
Foam::tmp< Foam::Field< Type > > patchInternalField (const UList< Type > &f) const
 
template<class Type >
Foam::tmp< Foam::Field< Type > > patchInternalField (const UList< Type > &f, const labelUList &faceCells) const
 
- Public Member Functions inherited from processorLduInterface
 TypeName ("processorLduInterface")
 Runtime type information. More...
 
 processorLduInterface ()=default
 Construct null. More...
 
virtual ~processorLduInterface ()=default
 Destructor. More...
 
template<class Type >
void send (const Pstream::commsTypes commsType, const UList< Type > &f) const
 Raw send function. More...
 
template<class Type >
void receive (const Pstream::commsTypes commsType, UList< Type > &f) const
 Raw receive function. More...
 
template<class Type >
tmp< Field< Type > > receive (const Pstream::commsTypes commsType, const label size) const
 Raw receive function returning field. More...
 
template<class Type >
void compressedSend (const Pstream::commsTypes commsType, const UList< Type > &f) const
 Raw send function with data compression. More...
 
template<class Type >
void compressedReceive (const Pstream::commsTypes commsType, UList< Type > &f) const
 Raw receive function with data compression. More...
 
template<class Type >
tmp< Field< Type > > compressedReceive (const Pstream::commsTypes commsType, const label size) const
 Raw receive function with data compression returning field. More...
 
template<class Type >
Foam::tmp< Foam::Field< Type > > receive (const Pstream::commsTypes commsType, const label size) const
 
template<class Type >
Foam::tmp< Foam::Field< Type > > compressedReceive (const Pstream::commsTypes commsType, const label size) const
 

Protected Member Functions

void makeWeights (scalarField &) const
 Make patch weighting factors. More...
 

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 const fvPatchlookupPatch (const polyPatch &p)
 Lookup the polyPatch index on corresponding fvMesh. 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

Processor patch.

Source files

Definition at line 53 of file processorFvPatch.H.

Constructor & Destructor Documentation

◆ processorFvPatch()

processorFvPatch ( const polyPatch patch,
const fvBoundaryMesh bm 
)
inline

Construct from components.

Definition at line 80 of file processorFvPatch.H.

Member Function Documentation

◆ makeWeights()

void makeWeights ( scalarField w) const
protectedvirtual

Make patch weighting factors.

Implements coupledFvPatch.

Definition at line 44 of file processorFvPatch.C.

References coupledFvPatch::delta(), Foam::mag(), processorPolyPatch::neighbFaceAreas(), processorPolyPatch::neighbFaceCellCentres(), processorPolyPatch::neighbFaceCentres(), fvPatch::nf(), and UPstream::parRun().

Here is the call graph for this function:

◆ TypeName()

TypeName ( processorPolyPatch::typeName_()  )

Runtime type information.

◆ comm()

virtual label comm ( ) const
inlinevirtual

Return communicator used for comms.

Implements processorLduInterface.

Definition at line 90 of file processorFvPatch.H.

References processorPolyPatch::comm().

Referenced by processorFvPatchField< Type >::comm().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ myProcNo()

virtual int myProcNo ( ) const
inlinevirtual

Return processor number.

Implements processorLduInterface.

Definition at line 96 of file processorFvPatch.H.

References processorPolyPatch::myProcNo().

Referenced by processorFvPatchField< Type >::myProcNo().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ neighbProcNo()

virtual int neighbProcNo ( ) const
inlinevirtual

Return neighbour processor number.

Implements processorLduInterface.

Definition at line 102 of file processorFvPatch.H.

References processorPolyPatch::neighbProcNo().

Referenced by processorFvPatchField< Type >::neighbProcNo().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ tag()

virtual int tag ( ) const
inlinevirtual

Return message tag used for sending.

Implements processorLduInterface.

Reimplemented in processorCyclicFvPatch.

Definition at line 108 of file processorFvPatch.H.

References UPstream::msgType().

Here is the call graph for this function:

◆ coupled()

virtual bool coupled ( ) const
inlinevirtual

Return true if running parallel.

Reimplemented from coupledFvPatch.

Definition at line 114 of file processorFvPatch.H.

References UPstream::parRun().

Here is the call graph for this function:

◆ procPolyPatch()

const processorPolyPatch& procPolyPatch ( ) const
inline

Definition at line 119 of file processorFvPatch.H.

◆ parallel()

virtual bool parallel ( ) const
inlinevirtual

Are the cyclic planes parallel.

Implements coupledFvPatch.

Reimplemented in processorCyclicFvPatch.

Definition at line 125 of file processorFvPatch.H.

References coupledPolyPatch::parallel().

Referenced by processorFvPatchField< Type >::doTransform().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ forwardT()

virtual const tensorField& forwardT ( ) const
inlinevirtual

Return face transformation tensor.

Implements coupledFvPatch.

Reimplemented in processorCyclicFvPatch.

Definition at line 131 of file processorFvPatch.H.

References coupledPolyPatch::forwardT().

Referenced by processorFvPatchField< Type >::forwardT().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ reverseT()

virtual const tensorField& reverseT ( ) const
inlinevirtual

Return neighbour-cell transformation tensor.

Implements coupledFvPatch.

Reimplemented in processorCyclicFvPatch.

Definition at line 137 of file processorFvPatch.H.

References coupledPolyPatch::reverseT().

Here is the call graph for this function:

◆ delta()

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

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

Implements coupledFvPatch.

Definition at line 70 of file processorFvPatch.C.

References coupledFvPatch::delta(), UPstream::parRun(), and Foam::transform().

Here is the call graph for this function:

◆ interfaceInternalField() [1/2]

Foam::tmp< Foam::labelField > interfaceInternalField ( const labelUList internalData) const
virtual

Return the values of the given internal data adjacent to the interface as a field

Implements coupledFvPatch.

Definition at line 106 of file processorFvPatch.C.

◆ interfaceInternalField() [2/2]

Foam::tmp< Foam::labelField > interfaceInternalField ( const labelUList internalData,
const labelUList faceCells 
) const
virtual

Return the values of the given internal data adjacent to the interface as a field using a mapping faceCell

Implements coupledFvPatch.

Definition at line 115 of file processorFvPatch.C.

◆ initInternalFieldTransfer() [1/6]

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

Initialise neighbour field transfer.

Reimplemented from lduInterface.

Definition at line 125 of file processorFvPatch.C.

◆ initInternalFieldTransfer() [2/6]

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

Initialise neighbour field transfer using faceCells map.

Reimplemented from lduInterface.

Definition at line 135 of file processorFvPatch.C.

◆ internalFieldTransfer()

Foam::tmp< Foam::labelField > internalFieldTransfer ( const Pstream::commsTypes  commsType,
const labelUList internalData 
) const
virtual

Return neighbour field.

Implements coupledFvPatch.

Definition at line 146 of file processorFvPatch.C.

◆ initInternalFieldTransfer() [3/6]

virtual void initInternalFieldTransfer
inline

Inherit initInternalFieldTransfer from coupledFvPatch.

Definition at line 146 of file coupledFvPatch.H.

◆ initInternalFieldTransfer() [4/6]

virtual void initInternalFieldTransfer
inline

Inherit initInternalFieldTransfer from coupledFvPatch.

Definition at line 154 of file coupledFvPatch.H.

◆ initInternalFieldTransfer() [5/6]

virtual void initInternalFieldTransfer
inline

Inherit initInternalFieldTransfer from coupledFvPatch.

Definition at line 100 of file lduInterface.H.

◆ initInternalFieldTransfer() [6/6]

virtual void initInternalFieldTransfer
inline

Inherit initInternalFieldTransfer from coupledFvPatch.

Definition at line 109 of file lduInterface.H.


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