Public Member Functions | Protected Member Functions | List of all members
cyclicFvPatch Class Reference

Cyclic-plane patch. More...

Inheritance diagram for cyclicFvPatch:
Inheritance graph
[legend]
Collaboration diagram for cyclicFvPatch:
Collaboration graph
[legend]

Public Member Functions

 TypeName (cyclicPolyPatch::typeName_())
 Runtime type information. More...
 
 cyclicFvPatch (const polyPatch &patch, const fvBoundaryMesh &bm)
 Construct from polyPatch. More...
 
const cyclicPolyPatchcyclicPatch () const
 Return local reference cast into the cyclic patch. More...
 
virtual label neighbPatchID () const
 Return neighbour. More...
 
virtual bool owner () const
 
virtual const cyclicFvPatchneighbPatch () const
 Return processor number. More...
 
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...
 
const cyclicFvPatchneighbFvPatch () 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 &faceCell) const
 Return the values of the given internal data adjacent to the interface as a field using a mapping faceCell. More...
 
virtual tmp< labelFieldinternalFieldTransfer (const Pstream::commsTypes commsType, const labelUList &internalData) const
 Return neighbour field. 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 bool coupled () const
 Return true because this patch is coupled. 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...
 
virtual void initInternalFieldTransfer (const Pstream::commsTypes commsType, const labelUList &iF) const
 Initialise transfer of internal field adjacent to the interface. More...
 
virtual void initInternalFieldTransfer (const Pstream::commsTypes commsType, const labelUList &iF, const labelUList &faceCells) const
 Initialise transfer of internal field adjacent to the interface using faceCells mapping. 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...
 
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 noexcept
 Return the index of this patch in the fvBoundaryMesh. More...
 
const fvBoundaryMeshboundaryMesh () const noexcept
 Return boundaryMesh reference. More...
 
template<class T >
const List< T >::subList patchSlice (const List< T > &l) const
 Slice List to patch, using the virtual patch size. More...
 
template<class T >
const List< T >::subList patchRawSlice (const List< T > &l) const
 Slice List to patch, using the underlying polyPatch information. 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 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 > &f, const labelUList &faceCells, Field< Type > &pfld) const
 Extract internal field next to patch using faceCells mapping. 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 >
tmp< Field< Type > > patchInternalField (const UList< Type > &f, const labelUList &faceCells) const
 Return given internal field next to patch as patch field using provided addressing. 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 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 > &f) const
 
template<class Type >
Foam::tmp< Foam::Field< Type > > patchInternalField (const UList< Type > &f, const labelUList &faceCells) const
 
- Public Member Functions inherited from cyclicLduInterface
 TypeName ("cyclicLduInterface")
 Runtime type information. More...
 
 cyclicLduInterface ()=default
 Construct null. More...
 
virtual ~cyclicLduInterface ()=default
 Destructor. More...
 

Protected Member Functions

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

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...
 

Detailed Description

Cyclic-plane patch.

Source files

Definition at line 50 of file cyclicFvPatch.H.

Constructor & Destructor Documentation

◆ cyclicFvPatch()

cyclicFvPatch ( const polyPatch patch,
const fvBoundaryMesh bm 
)
inline

Construct from polyPatch.

Definition at line 83 of file cyclicFvPatch.H.

Member Function Documentation

◆ makeWeights()

void makeWeights ( scalarField w) const
protectedvirtual

Make patch weighting factors.

Implements coupledFvPatch.

Definition at line 38 of file cyclicFvPatch.C.

References coupledFvPatch::delta(), forAll, cyclicFvPatch::neighbFvPatch(), and fvPatch::nf().

Here is the call graph for this function:

◆ TypeName()

TypeName ( cyclicPolyPatch::typeName_()  )

Runtime type information.

◆ cyclicPatch()

const cyclicPolyPatch& cyclicPatch ( ) const
inline

Return local reference cast into the cyclic patch.

Definition at line 98 of file cyclicFvPatch.H.

◆ neighbPatchID()

virtual label neighbPatchID ( ) const
inlinevirtual

Return neighbour.

Implements cyclicLduInterface.

Definition at line 106 of file cyclicFvPatch.H.

References cyclicPolyPatch::neighbPatchID().

Here is the call graph for this function:

◆ owner()

virtual bool owner ( ) const
inlinevirtual

Implements cyclicLduInterface.

Definition at line 111 of file cyclicFvPatch.H.

References cyclicPolyPatch::owner().

Here is the call graph for this function:

◆ neighbPatch()

virtual const cyclicFvPatch& neighbPatch ( ) const
inlinevirtual

Return processor number.

Implements cyclicLduInterface.

Definition at line 119 of file cyclicFvPatch.H.

References fvPatch::boundaryMesh(), and cyclicPolyPatch::neighbPatchID().

Here is the call graph for this function:

◆ parallel()

virtual bool parallel ( ) const
inlinevirtual

Are the cyclic planes parallel.

Implements coupledFvPatch.

Definition at line 130 of file cyclicFvPatch.H.

References coupledPolyPatch::parallel().

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

Definition at line 138 of file cyclicFvPatch.H.

References coupledPolyPatch::forwardT().

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

Definition at line 146 of file cyclicFvPatch.H.

References coupledPolyPatch::reverseT().

Referenced by cyclicFvPatchField< Type >::reverseT().

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

◆ neighbFvPatch()

const cyclicFvPatch& neighbFvPatch ( ) const
inline

Definition at line 151 of file cyclicFvPatch.H.

References fvPatch::boundaryMesh(), and cyclicPolyPatch::neighbPatchID().

Referenced by cyclicFvPatch::makeWeights().

Here is the call graph for this function:
Here is the caller 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 55 of file cyclicFvPatch.C.

References coupledFvPatch::delta(), forAll, tmp< T >::ref(), UList< T >::size(), 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 90 of file cyclicFvPatch.C.

◆ interfaceInternalField() [2/2]

Foam::tmp< Foam::labelField > interfaceInternalField ( const labelUList internalData,
const labelUList faceCell 
) 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 99 of file cyclicFvPatch.C.

◆ internalFieldTransfer()

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

Return neighbour field.

Implements coupledFvPatch.

Definition at line 109 of file cyclicFvPatch.C.


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