All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
regionCoupledBaseFvPatch Class Referenceabstract

Base class of regionCoupledFvPatch with common functionality for regionCoupledFvPatch and regionCoupledWallFvPatch. More...

Inheritance diagram for regionCoupledBaseFvPatch:
Collaboration diagram for regionCoupledBaseFvPatch:

Public Member Functions

 TypeName ("regionCoupledBase")
 Runtime type information. More...
 
 regionCoupledBaseFvPatch (const polyPatch &pp, const fvPatch &patch)
 Construct from polyPatch. More...
 
virtual ~regionCoupledBaseFvPatch ()
 Destructor. More...
 
virtual label nbrPatchID () const
 Return neighbour. More...
 
virtual bool owner () const
 Is it the owner? More...
 
virtual const regionCoupledBaseFvPatchnbrPatch () const
 Return regionCoupledBase neighb Patch. More...
 
virtual const AMIInterpolationAMI () const
 Return a reference to the AMI interpolator. More...
 
virtual const polyMeshnbrMesh () const
 Returns neighbour polyMesh. More...
 
const fvPatchpatch () const
 Return fvPatch. More...
 
bool sameRegion () const
 Returns if it is the same Region. More...
 
const regionCoupledBaseregionCoupledPatch () const
 Return regionCoupledPolyPatch. More...
 
const fvPatchneighbFvPatch () const
 Return neighbor fvPatch. More...
 
const wordregionCoupleType () const
 Return the interface type. More...
 
virtual const labelUListfaceCells () const =0
 Return faceCell addressing. More...
 
- Public Member Functions inherited from regionCoupledLduInterface
 TypeName ("regionCoupledLduInterface")
 Runtime type information. More...
 
 regionCoupledLduInterface ()
 Construct null. More...
 
virtual ~regionCoupledLduInterface ()
 Destructor. More...
 

Protected Member Functions

const fvMeshnbrFvMesh () const
 Returns fvMesh. More...
 

Protected Attributes

const regionCoupledBaseregionCoupledBase_
 Reference to regionCoupledBase. More...
 
const fvPatchpatch_
 Reference to fvPatch. More...
 

Detailed Description

Base class of regionCoupledFvPatch with common functionality for regionCoupledFvPatch and regionCoupledWallFvPatch.

Source files

Definition at line 53 of file regionCoupledBaseFvPatch.H.

Constructor & Destructor Documentation

◆ regionCoupledBaseFvPatch()

regionCoupledBaseFvPatch ( const polyPatch pp,
const fvPatch patch 
)
inline

Construct from polyPatch.

Definition at line 93 of file regionCoupledBaseFvPatch.H.

Referenced by regionCoupledBaseFvPatch::nbrFvMesh().

Here is the caller graph for this function:

◆ ~regionCoupledBaseFvPatch()

virtual ~regionCoupledBaseFvPatch ( )
inlinevirtual

Destructor.

Definition at line 108 of file regionCoupledBaseFvPatch.H.

Member Function Documentation

◆ nbrFvMesh()

const fvMesh& nbrFvMesh ( ) const
inlineprotected

◆ TypeName()

TypeName ( "regionCoupledBase"  )

Runtime type information.

Referenced by regionCoupledBaseFvPatch::nbrFvMesh().

Here is the caller graph for this function:

◆ nbrPatchID()

virtual label nbrPatchID ( ) const
inlinevirtual

Return neighbour.

Implements regionCoupledLduInterface.

Definition at line 117 of file regionCoupledBaseFvPatch.H.

References regionCoupledBase::nbrPatchID().

Here is the call graph for this function:

◆ owner()

virtual bool owner ( ) const
inlinevirtual

Is it the owner?

Implements regionCoupledLduInterface.

Definition at line 123 of file regionCoupledBaseFvPatch.H.

References regionCoupledBase::owner().

Here is the call graph for this function:

◆ nbrPatch()

virtual const regionCoupledBaseFvPatch& nbrPatch ( ) const
inlinevirtual

Return regionCoupledBase neighb Patch.

Implements regionCoupledLduInterface.

Definition at line 129 of file regionCoupledBaseFvPatch.H.

References fvMesh::boundary(), regionCoupledBaseFvPatch::nbrFvMesh(), and regionCoupledBase::nbrPatchID().

Here is the call graph for this function:

◆ AMI()

virtual const AMIInterpolation& AMI ( ) const
inlinevirtual

Return a reference to the AMI interpolator.

Definition at line 141 of file regionCoupledBaseFvPatch.H.

References regionCoupledBase::AMI().

Here is the call graph for this function:

◆ nbrMesh()

virtual const polyMesh& nbrMesh ( ) const
inlinevirtual

Returns neighbour polyMesh.

Implements regionCoupledLduInterface.

Definition at line 147 of file regionCoupledBaseFvPatch.H.

References fvPatch::boundaryMesh(), objectRegistry::lookupObject(), fvBoundaryMesh::mesh(), regionCoupledBase::nbrRegionName(), and fvMesh::time().

Here is the call graph for this function:

◆ patch()

const fvPatch& patch ( ) const
inline

Return fvPatch.

Definition at line 159 of file regionCoupledBaseFvPatch.H.

References regionCoupledBaseFvPatch::patch_.

◆ sameRegion()

bool sameRegion ( ) const
inline

Returns if it is the same Region.

Definition at line 165 of file regionCoupledBaseFvPatch.H.

References regionCoupledBase::sameRegion().

Here is the call graph for this function:

◆ regionCoupledPatch()

const regionCoupledBase& regionCoupledPatch ( ) const
inline

◆ neighbFvPatch()

const fvPatch& neighbFvPatch ( ) const
inline

Return neighbor fvPatch.

Definition at line 177 of file regionCoupledBaseFvPatch.H.

References fvMesh::boundary(), regionCoupledBaseFvPatch::nbrFvMesh(), and regionCoupledBase::nbrPatchID().

Here is the call graph for this function:

◆ regionCoupleType()

const word& regionCoupleType ( ) const
inline

Return the interface type.

Definition at line 189 of file regionCoupledBaseFvPatch.H.

References regionCoupledBaseFvPatch::faceCells(), and regionCoupledBase::regionCoupleType().

Here is the call graph for this function:

◆ faceCells()

virtual const labelUList& faceCells ( ) const
pure virtual

Return faceCell addressing.

Implemented in regionCoupledWallFvPatch, and regionCoupledFvPatch.

Referenced by regionCoupledBaseFvPatch::regionCoupleType().

Here is the caller graph for this function:

Member Data Documentation

◆ regionCoupledBase_

const regionCoupledBase& regionCoupledBase_
protected

Reference to regionCoupledBase.

Definition at line 62 of file regionCoupledBaseFvPatch.H.

Referenced by regionCoupledBaseFvPatch::regionCoupledPatch().

◆ patch_

const fvPatch& patch_
protected

Reference to fvPatch.

Definition at line 65 of file regionCoupledBaseFvPatch.H.

Referenced by regionCoupledBaseFvPatch::patch().


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