nonConformalCyclicFvPatch Class Reference

Non-conformal cyclic FV patch. As nonConformalCoupledFvPatch, but the neighbouring patch is local and known and is made available by this class. More...

Inheritance diagram for nonConformalCyclicFvPatch:
Collaboration diagram for nonConformalCyclicFvPatch:

Public Member Functions

 TypeName (nonConformalCyclicPolyPatch::typeName_())
 Runtime type information. More...
 
 nonConformalCyclicFvPatch (const polyPatch &patch, const fvBoundaryMesh &bm)
 Construct from polyPatch and fvBoundaryMesh. More...
 
virtual ~nonConformalCyclicFvPatch ()
 Destructor. More...
 
const nonConformalCyclicPolyPatchnonConformalCyclicPatch () const
 Poly patch. More...
 
const nonConformalCyclicFvPatchnbrPatch () const
 Neighbour patch. More...
 
virtual bool coupled () const
 Is this patch coupled? Returns true. For NCC patches the poly. More...
 
virtual label start () const
 Return the start label of this patch in the polyMesh face list. More...
 
virtual label size () const
 Return the size. More...
 
virtual const labelUListfaceCells () const
 Return the face-cells. More...
 
virtual tmp< vectorFielddelta () const
 Return delta (P to N) vectors across coupled patch. More...
 
- Public Member Functions inherited from cyclicFvPatch
 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 nbrPatchID () const
 Return neighbour. More...
 
virtual bool owner () const
 Does this side own the patch ? More...
 
virtual const transformertransform () const
 Return transformation between the coupled patches. More...
 
const cyclicFvPatchneighbFvPatch () const
 
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 neighbour () const
 Does the coupled side own the patch ? More...
 
virtual void initInternalFieldTransfer (const Pstream::commsTypes commsType, labelUList &iF) const
 Initialise neighbour field transfer. 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 &)
 Disallow default bitwise copy construction. More...
 
virtual ~fvPatch ()
 Destructor. More...
 
const polyPatchpatch () const
 Return the polyPatch. More...
 
virtual const wordname () const
 Return name. More...
 
label index () const
 Return the index of this patch in the fvBoundaryMesh. More...
 
const fvBoundaryMeshboundaryMesh () const
 Return boundaryMesh reference. More...
 
const objectRegistrydb () const
 Return the local object registry. 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
 Return the face - cell distance coeffient. 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...
 
void operator= (const fvPatch &)
 Disallow default bitwise assignment. More...
 
template<class Type >
Foam::tmp< Foam::Field< Type > > patchInternalField (const UList< Type > &f) const
 
- Public Member Functions inherited from cyclicLduInterface
 TypeName ("cyclicLduInterface")
 Runtime type information. More...
 
virtual ~cyclicLduInterface ()
 Destructor. More...
 
- Public Member Functions inherited from nonConformalCoupledFvPatch
 TypeName (nonConformalCoupledPolyPatch::typeName_())
 Runtime type information. More...
 
 nonConformalCoupledFvPatch (const fvPatch &patch)
 Construct from a patch. More...
 
virtual ~nonConformalCoupledFvPatch ()
 Destructor. More...
 
const nonConformalCoupledPolyPatchnonConformalCoupledPatch () const
 Return the reference to the polyPatch. More...
 
bool owner () const
 Does this side own the patch? More...
 
bool neighbour () const
 Does the coupled side own the patch? More...
 
const transformertransform () const
 Return transformation between the coupled patches. More...
 
const worderrorPatchName () const
 Error patch name. More...
 
label errorPatchID () const
 Error patch ID. More...
 
const nonConformalErrorFvPatcherrorPatch () const
 Error patch. More...
 
- Public Member Functions inherited from nonConformalFvPatch
 TypeName (nonConformalPolyPatch::typeName_())
 Runtime type information. More...
 
 nonConformalFvPatch (const fvPatch &patch)
 Construct from a patch. More...
 
virtual ~nonConformalFvPatch ()
 Destructor. More...
 
const nonConformalPolyPatchnonConformalPatch () const
 Return the reference to the polyPatch. More...
 
const wordorigPatchName () const
 Original patch name. More...
 
label origPatchID () const
 Original patch ID. More...
 
const fvPatchorigPatch () const
 Original patch. More...
 
const labelListpolyFaces () const
 Return face face-poly-faces. 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...
 
tmp< vectorFielddelta (const vectorField &nbrDelta) const
 Return delta (P to N) vectors across coupled patch. More...
 
- Protected Member Functions inherited from fvPatch
virtual void initMovePoints ()
 Initialise the patches for moving points. More...
 
virtual void movePoints ()
 Correct patches after moving points. More...
 
- Protected Member Functions inherited from nonConformalCoupledFvPatch
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 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 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

Non-conformal cyclic FV patch. As nonConformalCoupledFvPatch, but the neighbouring patch is local and known and is made available by this class.

See also
Foam::nonConformalCyclicPolyPatch Foam::nonConformalCoupledFvPatch
Source files

Definition at line 57 of file nonConformalCyclicFvPatch.H.

Constructor & Destructor Documentation

◆ nonConformalCyclicFvPatch()

nonConformalCyclicFvPatch ( const polyPatch patch,
const fvBoundaryMesh bm 
)

Construct from polyPatch and fvBoundaryMesh.

Definition at line 57 of file nonConformalCyclicFvPatch.C.

Referenced by nonConformalCyclicFvPatch::makeWeights().

Here is the caller graph for this function:

◆ ~nonConformalCyclicFvPatch()

Destructor.

Definition at line 73 of file nonConformalCyclicFvPatch.C.

Member Function Documentation

◆ makeWeights()

void makeWeights ( scalarField w) const
protectedvirtual

Make patch weighting factors.

Reimplemented from cyclicFvPatch.

Definition at line 43 of file nonConformalCyclicFvPatch.C.

References coupledFvPatch::delta(), nonConformalCoupledFvPatch::makeWeights(), and nonConformalCyclicFvPatch::nonConformalCyclicFvPatch().

Here is the call graph for this function:

◆ TypeName()

TypeName ( nonConformalCyclicPolyPatch::typeName_()  )

Runtime type information.

◆ nonConformalCyclicPatch()

const Foam::nonConformalCyclicPolyPatch & nonConformalCyclicPatch ( ) const

Poly patch.

Definition at line 80 of file nonConformalCyclicFvPatch.C.

Referenced by fvMeshStitcher::connect(), and Foam::meshEdge().

Here is the caller graph for this function:

◆ nbrPatch()

const Foam::nonConformalCyclicFvPatch & nbrPatch ( ) const
virtual

Neighbour patch.

Reimplemented from cyclicFvPatch.

Definition at line 87 of file nonConformalCyclicFvPatch.C.

References cyclicFvPatch::nbrPatch().

Referenced by Foam::meshEdge().

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

◆ coupled()

bool coupled ( ) const
virtual

Is this patch coupled? Returns true. For NCC patches the poly.

mesh is considered non-coupled whilst the finite volume mesh is considered coupled.

Reimplemented from coupledFvPatch.

Definition at line 105 of file nonConformalCyclicFvPatch.C.

◆ start()

Foam::label start ( ) const
virtual

Return the start label of this patch in the polyMesh face list.

Raises an error unless the patch is empty.

Reimplemented from nonConformalFvPatch.

Definition at line 93 of file nonConformalCyclicFvPatch.C.

References nonConformalFvPatch::start().

Here is the call graph for this function:

◆ size()

Foam::label size ( ) const
virtual

Return the size.

Reimplemented from nonConformalFvPatch.

Definition at line 99 of file nonConformalCyclicFvPatch.C.

References nonConformalFvPatch::size().

Here is the call graph for this function:

◆ faceCells()

const Foam::labelUList & faceCells ( ) const
virtual

Return the face-cells.

Reimplemented from coupledFvPatch.

Definition at line 111 of file nonConformalCyclicFvPatch.C.

References nonConformalFvPatch::faceCells().

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.

Reimplemented from cyclicFvPatch.

Definition at line 118 of file nonConformalCyclicFvPatch.C.

References coupledFvPatch::delta().

Here is the call graph for this function:

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