regionCoupledBaseFvPatch Class Reference

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	neighbPatchID () const
	Return neighbour. More...
virtual bool	owner () const
	Is it the owner? More...
virtual const regionCoupledBaseFvPatch &	neighbPatch () const
	Return regionCoupledBase neighb Patch. More...
virtual const AMIPatchToPatchInterpolation &	AMI () const
	Return a reference to the AMI interpolator. More...
virtual const polyMesh &	nbrMesh () const
	Returns neighbour polyMesh. More...
const fvPatch &	patch () const
	Return fvPatch. More...
bool	sameRegion () const
	Returns if it is the same Region. More...
const regionCoupledBase &	regionCoupledPatch () const
	Return regionCoupledPolyPatch. More...
const fvPatch &	neighbFvPatch () const
	Return neighbor fvPatch. More...
const word &	regionCoupleType () const
	Return the interface type. More...
virtual const labelUList &	faceCells () 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 fvMesh &	nbrFvMesh () const
	Returns fvMesh. More...

Protected Attributes
const regionCoupledBase &	regionCoupledBase_
	Reference to regionCoupledBase. More...
const fvPatch &	patch_
	Reference to fvPatch. More...

Detailed Description

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

Source files

• regionCoupledBaseFvPatch.H
• regionCoupledBaseFvPatch.C

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.

~regionCoupledBaseFvPatch()

virtual ~regionCoupledBaseFvPatch ( )

inlinevirtual

Destructor.

Definition at line 108 of file regionCoupledBaseFvPatch.H.

Member Function Documentation

nbrFvMesh()

const fvMesh& nbrFvMesh ( ) const

inlineprotected

Returns fvMesh.

Definition at line 71 of file regionCoupledBaseFvPatch.H.

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

Referenced by regionCoupledFvPatch::neighbFvPatch(), regionCoupledWallFvPatch::neighbFvPatch(), regionCoupledBaseFvPatch::neighbFvPatch(), and regionCoupledBaseFvPatch::neighbPatch().

Here is the call graph for this function:

Here is the caller graph for this function:

TypeName()

TypeName

(

"regionCoupledBase"

)

Runtime type information.

neighbPatchID()

virtual label neighbPatchID ( ) const

inlinevirtual

Return neighbour.

Implements regionCoupledLduInterface.

Definition at line 117 of file regionCoupledBaseFvPatch.H.

References regionCoupledBase::neighbPatchID(), and regionCoupledBaseFvPatch::regionCoupledBase_.

Referenced by regionCoupledFvPatch::neighbFvPatch(), and regionCoupledWallFvPatch::neighbFvPatch().

Here is the call graph for this function:

Here is the caller 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(), and regionCoupledBaseFvPatch::regionCoupledBase_.

Here is the call graph for this function:

neighbPatch()

virtual const regionCoupledBaseFvPatch& neighbPatch ( ) const

inlinevirtual

Return regionCoupledBase neighb Patch.

Implements regionCoupledLduInterface.

Definition at line 129 of file regionCoupledBaseFvPatch.H.

References boundary(), regionCoupledBaseFvPatch::nbrFvMesh(), regionCoupledBase::neighbPatchID(), and regionCoupledBaseFvPatch::regionCoupledBase_.

Here is the call graph for this function:

AMI()

virtual const AMIPatchToPatchInterpolation& AMI ( ) const

inlinevirtual

Return a reference to the AMI interpolator.

Definition at line 141 of file regionCoupledBaseFvPatch.H.

References regionCoupledBase::AMI(), and regionCoupledBaseFvPatch::regionCoupledBase_.

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(), regionCoupledBaseFvPatch::patch_, regionCoupledBaseFvPatch::regionCoupledBase_, and fvMesh::time().

Referenced by energyRegionCoupledFvPatchScalarField::setMethod().

Here is the call graph for this function:

Here is the caller 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 regionCoupledBaseFvPatch::regionCoupledBase_, and regionCoupledBase::sameRegion().

Here is the call graph for this function:

regionCoupledPatch()

const regionCoupledBase& regionCoupledPatch ( ) const

inline

Return regionCoupledPolyPatch.

Definition at line 171 of file regionCoupledBaseFvPatch.H.

References regionCoupledBaseFvPatch::regionCoupledBase_.

neighbFvPatch()

const fvPatch& neighbFvPatch ( ) const

inline

Return neighbor fvPatch.

Definition at line 177 of file regionCoupledBaseFvPatch.H.

References boundary(), regionCoupledBaseFvPatch::nbrFvMesh(), regionCoupledBase::neighbPatchID(), and regionCoupledBaseFvPatch::regionCoupledBase_.

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::regionCoupledBase_, and regionCoupledBase::regionCoupleType().

Referenced by energyRegionCoupledFvPatchScalarField::interfaceFieldType().

Here is the call graph for this function:

Here is the caller graph for this function:

faceCells()

virtual const labelUList& faceCells ( ) const

pure virtual

Return faceCell addressing.

Implemented in regionCoupledWallFvPatch, and regionCoupledFvPatch.

Field Documentation

regionCoupledBase_

const regionCoupledBase& regionCoupledBase_

protected

Reference to regionCoupledBase.

Definition at line 62 of file regionCoupledBaseFvPatch.H.

Referenced by regionCoupledBaseFvPatch::AMI(), regionCoupledBaseFvPatch::nbrFvMesh(), regionCoupledBaseFvPatch::nbrMesh(), regionCoupledBaseFvPatch::neighbFvPatch(), regionCoupledBaseFvPatch::neighbPatch(), regionCoupledBaseFvPatch::neighbPatchID(), regionCoupledBaseFvPatch::owner(), regionCoupledBaseFvPatch::regionCoupledPatch(), regionCoupledBaseFvPatch::regionCoupleType(), and regionCoupledBaseFvPatch::sameRegion().

patch_

const fvPatch& patch_

protected

Reference to fvPatch.

Definition at line 65 of file regionCoupledBaseFvPatch.H.

Referenced by regionCoupledBaseFvPatch::nbrFvMesh(), regionCoupledBaseFvPatch::nbrMesh(), and regionCoupledBaseFvPatch::patch().

---

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

• src/finiteVolume/fvMesh/fvPatches/derived/regionCoupled/regionCoupledBaseFvPatch.H