cyclicFvPatch Class Reference

Cyclic-plane patch. More...

Inheritance diagram for cyclicFvPatch:
Collaboration diagram for cyclicFvPatch:

Public Member Functions

 TypeName (cyclicPolyPatch::typeName_())
 Runtime type information. More...
 
 cyclicFvPatch (const polyPatch &patch, const fvBoundaryMesh &bm)
 Construct from polyPatch. More...
 
virtual label nbrPatchIndex () const
 Return neighbour. More...
 
virtual bool owner () const
 Does this side own the patch ? More...
 
virtual const cyclicFvPatchnbrPatch () const
 Return processor number. More...
 
virtual const transformertransform () const
 Return transformation between the coupled patches. 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. 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 bool neighbour () const
 Does the coupled side own the patch ? 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, const labelUList &iF) const
 Inherit initInternalFieldTransfer from lduInterface. More...
 
- Public Member Functions inherited from lduInterface
 TypeName ("lduInterface")
 Runtime type information. More...
 
 lduInterface ()
 Construct null. More...
 
 lduInterface (const lduInterface &)=delete
 Disallow default bitwise copy construction. 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...
 
void operator= (const lduInterface &)=delete
 Disallow default bitwise assignment. 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...
 
 fvPatch (const fvPatch &)=delete
 Disallow default bitwise copy construction. More...
 
virtual ~fvPatch ()
 Destructor. More...
 
const polyPatchpoly () 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...
 
virtual bool constraint () const
 Return true if this patch is a constraint type. More...
 
label index () const
 Return the index of this patch in the fvBoundaryMesh. More...
 
const objectRegistrydb () const
 Return the local object registry. More...
 
const fvMeshmesh () const
 Return mesh reference. More...
 
const Timetime () const
 Return time. 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...
 
const DimensionedField< vector, fvPatch > & C () const
 Return dimensioned 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...
 
tmp< scalarFieldpolyFaceFraction () const
 Return the fraction of the poly-face that each fv-face in this. More...
 
const scalarFieldweights () const
 Return patch weighting factors. More...
 
virtual const scalarFielddeltaCoeffs () const
 Return the face - cell distance coefficient. 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::PatchpatchField (const GeometricField &) const
 Return the corresponding patchField of the named field. More...
 
template<class GeometricField , class Type >
GeometricField::PatchpatchField (GeometricField &) const
 Return the corresponding patchField reference of the named field. More...
 
template<class GeometricField , class Type >
const GeometricField::PatchlookupPatchField (const word &name) const
 Lookup and return the patchField of the named field from the. More...
 
template<class Type >
tmp< DimensionedField< Type, fvPatch > > lookupField (const word &) const
 Lookup a dimensioned field for this geometry. More...
 
void operator= (const fvPatch &)=delete
 Disallow default bitwise assignment. More...
 
const fvMeshoperator() () const
 Return reference to fvMesh. More...
 
template<class Type >
Foam::tmp< Foam::Field< Type > > patchInternalField (const UList< Type > &f) const
 
template<class Type >
Foam::tmp< Foam::DimensionedField< Type, Foam::fvPatch > > lookupField (const word &name) const
 
- Public Member Functions inherited from cyclicLduInterface
 TypeName ("cyclicLduInterface")
 Runtime type information. More...
 
virtual ~cyclicLduInterface ()
 Destructor. More...
 

Protected Member Functions

void makeWeights (scalarField &) const
 Make patch weighting factors. More...
 
- Protected Member Functions inherited from coupledFvPatch
void makeWeights (scalarField &w, const vectorField &nbrSf, const vectorField &nbrDelta) const
 Make patch weighting factors. More...
 

Additional Inherited Members

- Public Types inherited from fvPatch
typedef fvMesh Mesh
 Mesh type. More...
 
typedef fvBoundaryMesh BoundaryMesh
 Boundary mesh type. More...
 
typedef faceZone Zone
 Zone type. 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...
 

Detailed Description

Cyclic-plane patch.

Source files

Definition at line 51 of file cyclicFvPatch.H.

Constructor & Destructor Documentation

◆ cyclicFvPatch()

cyclicFvPatch ( const polyPatch patch,
const fvBoundaryMesh bm 
)
inline

Construct from polyPatch.

Definition at line 79 of file cyclicFvPatch.H.

Member Function Documentation

◆ makeWeights()

void makeWeights ( scalarField w) const
protectedvirtual

Make patch weighting factors.

Implements coupledFvPatch.

Reimplemented in nonConformalCyclicFvPatch.

Definition at line 42 of file cyclicFvPatch.C.

References coupledFvPatch::delta(), coupledFvPatch::makeWeights(), cyclicFvPatch::nbrPatch(), and fvPatch::Sf().

Here is the call graph for this function:

◆ TypeName()

TypeName ( cyclicPolyPatch::typeName_()  )

Runtime type information.

◆ nbrPatchIndex()

virtual label nbrPatchIndex ( ) const
inlinevirtual

Return neighbour.

Implements cyclicLduInterface.

Definition at line 91 of file cyclicFvPatch.H.

References cyclicPolyPatch::nbrPatchIndex().

Here is the call graph for this function:

◆ owner()

virtual bool owner ( ) const
inlinevirtual

Does this side own the patch ?

Reimplemented from coupledFvPatch.

Definition at line 96 of file cyclicFvPatch.H.

References cyclicPolyPatch::owner().

Here is the call graph for this function:

◆ nbrPatch()

virtual const cyclicFvPatch& nbrPatch ( ) const
inlinevirtual

Return processor number.

Implements cyclicLduInterface.

Reimplemented in nonConformalCyclicFvPatch.

Definition at line 102 of file cyclicFvPatch.H.

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

Referenced by FvFaceCellWave< Type, TrackingData >::checkCyclic(), FvFaceCellWave< Type, TrackingData >::handleCyclicPatches(), cyclicFvPatch::makeWeights(), and nonConformalCyclicFvPatch::nbrPatch().

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

◆ transform()

virtual const transformer& transform ( ) const
inlinevirtual

Return transformation between the coupled patches.

Implements coupledFvPatch.

Definition at line 111 of file cyclicFvPatch.H.

References cyclicPolyPatch::transform().

Referenced by FvFaceCellWave< Type, TrackingData >::handleCyclicPatches(), and cyclicFvPatchField< Type >::transform().

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 116 of file cyclicFvPatch.H.

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

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 55 of file cyclicFvPatch.C.

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

Here is the call graph for this function:

◆ interfaceInternalField()

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 63 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 72 of file cyclicFvPatch.C.


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