regionCoupledFvPatch Class Reference

Common functionality for regionCoupleFvPatch and regionCoupledWallFvPatch. More...

Inheritance diagram for regionCoupledFvPatch:
Collaboration diagram for regionCoupledFvPatch:

Public Member Functions

 TypeName (regionCoupledPolyPatch::typeName_())
 Runtime type information. More...
 
 regionCoupledFvPatch (const polyPatch &patch, const fvBoundaryMesh &bm)
 Construct from polyPatch. More...
 
 ~regionCoupledFvPatch ()
 Destructor. More...
 
virtual const labelUListfaceCells () const
 Return faceCell addressing. More...
 
virtual bool coupled () const
 Return true because this patch is coupled. More...
 
virtual tmp< labelFieldinterfaceInternalField (const labelUList &internalData) const
 Return the values of the given internal data adjacent to. More...
 
virtual void initInternalFieldTransfer (const Pstream::commsTypes commsType, labelUList &iF) const
 Initialise neighbour field transfer. More...
 
virtual tmp< labelFieldinternalFieldTransfer (const Pstream::commsTypes commsType, const labelUList &iF) const
 Return neighbour field. 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...
 
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
 Return the index of this patch in the fvBoundaryMesh. 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...
 
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...
 
virtual tmp< vectorFielddelta () const
 Return cell-centre to face-centre vector. 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 GeometricField *=nullptr, const Type *=nullptr) 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 regionCoupledBaseFvPatch
 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...
 
- Public Member Functions inherited from regionCoupledLduInterface
 TypeName ("regionCoupledLduInterface")
 Runtime type information. More...
 
 regionCoupledLduInterface ()
 Construct null. More...
 
virtual ~regionCoupledLduInterface ()
 Destructor. 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...
 
- Protected Member Functions inherited from fvPatch
virtual void makeWeights (scalarField &) const
 Make patch weighting factors. More...
 
virtual void initMovePoints ()
 Initialise the patches for moving points. More...
 
virtual void movePoints ()
 Correct patches after moving points. More...
 
- Protected Member Functions inherited from regionCoupledBaseFvPatch
const fvMeshnbrFvMesh () const
 Returns fvMesh. More...
 
- Protected Attributes inherited from regionCoupledBaseFvPatch
const regionCoupledBaseregionCoupledBase_
 Reference to regionCoupledBase. More...
 
const fvPatchpatch_
 Reference to fvPatch. More...
 

Detailed Description

Common functionality for regionCoupleFvPatch and regionCoupledWallFvPatch.

Source files

Definition at line 53 of file regionCoupledFvPatch.H.

Constructor & Destructor Documentation

◆ regionCoupledFvPatch()

regionCoupledFvPatch ( const polyPatch patch,
const fvBoundaryMesh bm 
)
inline

Construct from polyPatch.

Definition at line 87 of file regionCoupledFvPatch.H.

◆ ~regionCoupledFvPatch()

~regionCoupledFvPatch ( )
inline

Destructor.

Definition at line 103 of file regionCoupledFvPatch.H.

Member Function Documentation

◆ TypeName()

TypeName ( regionCoupledPolyPatch::typeName_()  )

Runtime type information.

◆ faceCells()

virtual const labelUList& faceCells ( ) const
inlinevirtual

Return faceCell addressing.

Implements regionCoupledBaseFvPatch.

Definition at line 113 of file regionCoupledFvPatch.H.

References fvPatch::faceCells().

Here is the call graph for this function:

◆ coupled()

virtual bool coupled ( ) const
inlinevirtual

Return true because this patch is coupled.

Reimplemented from fvPatch.

Definition at line 119 of file regionCoupledFvPatch.H.

References regionCoupledPolyPatch::coupled(), lduInterface::initInternalFieldTransfer(), regionCoupledFvPatch::initInternalFieldTransfer(), and regionCoupledFvPatch::interfaceInternalField().

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

Definition at line 41 of file regionCoupledFvPatch.C.

References regionCoupledFvPatch::internalFieldTransfer().

Referenced by regionCoupledFvPatch::coupled().

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

◆ initInternalFieldTransfer()

virtual void initInternalFieldTransfer ( const Pstream::commsTypes  commsType,
labelUList iF 
) const
inlinevirtual

Initialise neighbour field transfer.

Definition at line 139 of file regionCoupledFvPatch.H.

References regionCoupledFvPatch::internalFieldTransfer().

Referenced by regionCoupledFvPatch::coupled().

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

◆ internalFieldTransfer()

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

Return neighbour field.

Implements lduInterface.

Definition at line 50 of file regionCoupledFvPatch.C.

References UList< T >::size().

Referenced by regionCoupledFvPatch::initInternalFieldTransfer(), and regionCoupledFvPatch::interfaceInternalField().

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

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