processorCyclicFvPatch Class Reference

Processor patch. More...

Inheritance diagram for processorCyclicFvPatch:
Collaboration diagram for processorCyclicFvPatch:

Public Member Functions

 TypeName (processorCyclicPolyPatch::typeName_())
 Runtime type information. More...
 
 processorCyclicFvPatch (const polyPatch &patch, const fvBoundaryMesh &bm)
 Construct from components. More...
 
virtual int tag () const
 Return message tag used for sending. More...
 
const processorCyclicPolyPatchprocPolyPatch () 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...
 
- Public Member Functions inherited from processorFvPatch
 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 bool coupled () const
 Return true if running parallel. More...
 
const processorPolyPatchprocPolyPatch () const
 
virtual tmp< vectorFielddelta () const
 Return delta (P to N) vectors across coupled patch. More...
 
virtual tmp< labelFieldinterfaceInternalField (const labelUList &internalData) const
 Return the values of the given internal data adjacent to the interface as a field. More...
 
virtual tmp< labelFieldinterfaceInternalField (const labelUList &internalData, const labelUList &faceCells) const
 Return the values of the given internal data adjacent to the interface as a field using a mapping faceCell. More...
 
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
 TypeNameNoDebug (coupledPolyPatch::typeName_())
 Runtime type information. More...
 
 coupledFvPatch (const polyPatch &patch, const fvBoundaryMesh &bm)
 Construct from polyPatch. More...
 
virtual ~coupledFvPatch ()=default
 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
 TypeNameNoDebug ("lduInterface")
 Runtime type information. More...
 
 lduInterface () noexcept=default
 Default construct. 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 noexcept
 Return the polyPatch. More...
 
virtual const wordname () const
 Return name. More...
 
label index () const noexcept
 The index of this patch in the boundary mesh. More...
 
label start () const noexcept
 The patch start within the polyMesh face list. More...
 
virtual label size () const
 Patch size is the number of faces, but can be overloaded. More...
 
const fvBoundaryMeshboundaryMesh () const noexcept
 Return boundaryMesh reference. More...
 
template<class T >
const List< T >::subList patchSlice (const List< T > &values) const
 This patch slice from the complete list, which has size mesh::nFaces(), using the virtual patch size. More...
 
template<class T >
const List< T >::subList boundarySlice (const List< T > &values) const
 This patch slice from the list of boundary values, which has size mesh::nBoundaryFaces(), using the virtual patch size. More...
 
const vectorFieldCf () const
 Return face centres. More...
 
tmp< vectorFieldCn () const
 Return neighbour cell centres. More...
 
const vectorFieldSf () const
 Return face area vectors, like the fvMesh::Sf() method. More...
 
const scalarFieldmagSf () const
 Return face area magnitudes, like the fvMesh::magSf() method. More...
 
tmp< vectorFieldunitSf () const
 Return face unit normals, like the fvMesh::unitSf() method. Same as nf(). More...
 
tmp< vectorFieldnf () const
 Return face unit normals, like the fvMesh::unitSf() method Same as unitSf(). More...
 
const scalarFieldweights () const
 Return patch weighting factors. More...
 
const scalarFielddeltaCoeffs () const
 Return the face - cell distance coefficient except for coupled patches for which the cell-centre to coupled-cell-centre distance coefficient is returned. More...
 
template<class Type >
void patchInternalField (const UList< Type > &internalData, const labelUList &addressing, Field< Type > &pfld) const
 Extract internal field next to patch using specified addressing. More...
 
template<class Type >
void patchInternalField (const UList< Type > &internalData, Field< Type > &pfld) const
 Extract internal field next to patch as patch field using faceCells() mapping. More...
 
template<class Type >
tmp< Field< Type > > patchInternalField (const UList< Type > &internalData) const
 Return given internal field next to patch as patch field using faceCells() mapping. More...
 
template<class GeometricField , class AnyType = bool>
const GeometricField::PatchpatchField (const GeometricField &gf) const
 Return the patch field of the GeometricField corresponding to this patch. More...
 
template<class GeometricField , class AnyType = bool>
const GeometricField::PatchlookupPatchField (const word &name, const GeometricField *=nullptr, const AnyType *=nullptr) const
 Lookup the named field from the local registry and return the patch field corresponding to this patch. More...
 
template<class Type >
Foam::tmp< Foam::Field< Type > > patchInternalField (const UList< Type > &internalData) const
 
- Public Member Functions inherited from processorLduInterface
 TypeNameNoDebug ("processorLduInterface")
 Runtime type information. More...
 
 processorLduInterface () noexcept=default
 Default construct. More...
 
virtual ~processorLduInterface ()=default
 Destructor. More...
 
template<class Type >
void send (const UPstream::commsTypes commsType, const UList< Type > &f) const
 Raw send function. More...
 
template<class Type >
void receive (const UPstream::commsTypes commsType, UList< Type > &f) const
 Raw receive function. More...
 
template<class Type >
tmp< Field< Type > > receive (const UPstream::commsTypes commsType, const label size) const
 Raw receive function returning field. More...
 
template<class Type >
void compressedSend (const UPstream::commsTypes commsType, const UList< Type > &f) const
 Raw send function with data compression. More...
 
template<class Type >
void compressedReceive (const UPstream::commsTypes commsType, UList< Type > &f) const
 Raw receive function with data compression. More...
 
template<class Type >
tmp< Field< Type > > compressedReceive (const UPstream::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 UPstream::commsTypes commsType, const label size) const
 
template<class Type >
Foam::tmp< Foam::Field< Type > > compressedReceive (const UPstream::commsTypes commsType, const label size) const
 

Additional Inherited Members

- Public Types inherited from fvPatch
typedef fvBoundaryMesh BoundaryMesh
 The boundary type associated with the patch. More...
 
- 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 &patchType)
 Return true if the given type is a constraint type. More...
 
static wordList constraintTypes ()
 Return a list of all the constraint patch types. More...
 
- Protected Member Functions inherited from processorFvPatch
void makeWeights (scalarField &) const
 Make patch weighting factors. More...
 

Detailed Description

Processor patch.

Source files

Definition at line 47 of file processorCyclicFvPatch.H.

Constructor & Destructor Documentation

◆ processorCyclicFvPatch()

processorCyclicFvPatch ( const polyPatch patch,
const fvBoundaryMesh bm 
)
inline

Construct from components.

Definition at line 68 of file processorCyclicFvPatch.H.

Member Function Documentation

◆ TypeName()

TypeName ( processorCyclicPolyPatch::typeName_()  )

Runtime type information.

◆ tag()

virtual int tag ( ) const
inlinevirtual

Return message tag used for sending.

Reimplemented from processorFvPatch.

Definition at line 80 of file processorCyclicFvPatch.H.

References processorCyclicPolyPatch::tag().

Here is the call graph for this function:

◆ procPolyPatch()

const processorCyclicPolyPatch& procPolyPatch ( ) const
inline

Definition at line 86 of file processorCyclicFvPatch.H.

◆ parallel()

virtual bool parallel ( ) const
inlinevirtual

Are the cyclic planes parallel.

Reimplemented from processorFvPatch.

Definition at line 94 of file processorCyclicFvPatch.H.

References processorCyclicPolyPatch::parallel().

Referenced by processorCyclicFvPatchField< 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.

Reimplemented from processorFvPatch.

Definition at line 102 of file processorCyclicFvPatch.H.

References processorCyclicPolyPatch::forwardT().

Referenced by processorCyclicFvPatchField< 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.

Reimplemented from processorFvPatch.

Definition at line 110 of file processorCyclicFvPatch.H.

References processorCyclicPolyPatch::reverseT().

Here is the call graph for this function:

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