regionCoupledBaseGAMGInterface Class Reference

Base class for GAMG agglomerated coupled region interface. More...

Inheritance diagram for regionCoupledBaseGAMGInterface:
Collaboration diagram for regionCoupledBaseGAMGInterface:

Public Member Functions

 regionCoupledBaseGAMGInterface (const label index, const lduInterfacePtrsList &coarseInterfaces, const lduInterface &fineInterface, const labelField &restrictAddressing, const labelField &neighbourRestrictAddressing, const label fineLevelIndex, const label coarseComm)
 Construct from fine level interface,. More...
 
 regionCoupledBaseGAMGInterface (const regionCoupledBaseGAMGInterface &)=delete
 Disallow default bitwise copy construction. More...
 
virtual ~regionCoupledBaseGAMGInterface ()
 Destructor. More...
 
virtual tmp< labelFieldinternalFieldTransfer (const Pstream::commsTypes commsType, const labelUList &iF) const
 Transfer and return internal field adjacent to the interface. More...
 
virtual label nbrPatchID () const
 Cyclic interface functions. More...
 
virtual bool owner () const
 Is it owner? More...
 
virtual const regionCoupledBaseGAMGInterfacenbrPatch () const
 Return neighb regionCoupledLduInterface. More...
 
virtual const polyMeshnbrMesh () const
 Return AMI. More...
 
const lduInterfacenbrLduInterface (const label fineLevelIndex, const label index) const
 
void operator= (const regionCoupledBaseGAMGInterface &)=delete
 Disallow default bitwise assignment. More...
 
- Public Member Functions inherited from GAMGInterface
 TypeName ("GAMGInterface")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, GAMGInterface, lduInterface,(const label index, const lduInterfacePtrsList &coarseInterfaces, const lduInterface &fineInterface, const labelField &localRestrictAddressing, const labelField &neighbourRestrictAddressing, const label fineLevelIndex, const label coarseComm),(index, coarseInterfaces, fineInterface, localRestrictAddressing, neighbourRestrictAddressing, fineLevelIndex, coarseComm))
 
 declareRunTimeSelectionTable (autoPtr, GAMGInterface, Istream,(const label index, const lduInterfacePtrsList &coarseInterfaces, Istream &is),(index, coarseInterfaces, is))
 
 GAMGInterface (const label index, const lduInterfacePtrsList &coarseInterfaces)
 Construct from interfaces, restrict addressing set later on. More...
 
 GAMGInterface (const label index, const lduInterfacePtrsList &coarseInterfaces, const labelUList &faceCells, const labelUList &faceRestrictAddressing)
 Construct from interfaces and restrict addressing. More...
 
 GAMGInterface (const label index, const lduInterfacePtrsList &coarseInterfaces, Istream &is)
 Construct from Istream. More...
 
 GAMGInterface (const GAMGInterface &)=delete
 Disallow default bitwise copy construction. More...
 
virtual label size () const
 Return size. More...
 
virtual label index () const
 
virtual const lduInterfacePtrsListcoarseInterfaces () const
 
virtual const labelUListfaceCells () const
 Return faceCell addressing. More...
 
virtual const labelListfaceRestrictAddressing () const
 Return (local)face restrict addressing. More...
 
virtual labelListfaceRestrictAddressing ()
 Return non-const access to face restrict addressing. More...
 
template<class Type >
tmp< Field< Type > > interfaceInternalField (const UList< Type > &internalData) const
 Return the interface internal field of the given field. More...
 
template<class Type >
void interfaceInternalField (const UList< Type > &internalData, List< Type > &) const
 Get the interface internal field of the given field. More...
 
virtual tmp< labelFieldinterfaceInternalField (const labelUList &internalData) const
 Return the values of the given internal data adjacent to. More...
 
void combine (const GAMGInterface &)
 Merge the next level with this level. More...
 
virtual tmp< scalarFieldagglomerateCoeffs (const scalarField &fineCoeffs) const
 Agglomerating the given fine-level coefficients and return. More...
 
virtual void write (Ostream &) const =0
 Write to stream. More...
 
void operator= (const GAMGInterface &)=delete
 Disallow default bitwise assignment. More...
 
template<class Type >
Foam::tmp< Foam::Field< Type > > interfaceInternalField (const UList< Type > &iF) const
 
- 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 regionCoupledLduInterface
 TypeName ("regionCoupledLduInterface")
 Runtime type information. More...
 
 regionCoupledLduInterface ()
 Construct null. More...
 
virtual ~regionCoupledLduInterface ()
 Destructor. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from GAMGInterface
static autoPtr< GAMGInterfaceNew (const label index, const lduInterfacePtrsList &coarseInterfaces, const lduInterface &fineInterface, const labelField &localRestrictAddressing, const labelField &neighbourRestrictAddressing, const label fineLevelIndex, const label coarseComm)
 Return a pointer to a new interface created on freestore given. More...
 
static autoPtr< GAMGInterfaceNew (const word &coupleType, const label index, const lduInterfacePtrsList &coarseInterfaces, Istream &is)
 Return a pointer to a new interface created on freestore given. More...
 
- Protected Attributes inherited from GAMGInterface
const label index_
 My index in coarseInterfaces. More...
 
const lduInterfacePtrsListcoarseInterfaces_
 All interfaces. More...
 
labelList faceCells_
 Face-cell addressing. More...
 
labelList faceRestrictAddressing_
 Face restrict addressing. More...
 

Detailed Description

Base class for GAMG agglomerated coupled region interface.

Source files

Definition at line 50 of file regionCoupledBaseGAMGInterface.H.

Constructor & Destructor Documentation

◆ regionCoupledBaseGAMGInterface() [1/2]

regionCoupledBaseGAMGInterface ( const label  index,
const lduInterfacePtrsList coarseInterfaces,
const lduInterface fineInterface,
const labelField restrictAddressing,
const labelField neighbourRestrictAddressing,
const label  fineLevelIndex,
const label  coarseComm 
)

Construct from fine level interface,.

local and neighbour restrict addressing

Definition at line 35 of file regionCoupledBaseGAMGInterface.C.

References HashTableCore::end(), HashTable< T, Key, Hash >::find(), forAll, and List< T >::size().

Here is the call graph for this function:

◆ regionCoupledBaseGAMGInterface() [2/2]

Disallow default bitwise copy construction.

◆ ~regionCoupledBaseGAMGInterface()

Destructor.

Definition at line 207 of file regionCoupledBaseGAMGInterface.C.

References regionCoupledBaseGAMGInterface::internalFieldTransfer().

Here is the call graph for this function:

Member Function Documentation

◆ internalFieldTransfer()

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

Transfer and return internal field adjacent to the interface.

Implements lduInterface.

Definition at line 215 of file regionCoupledBaseGAMGInterface.C.

Referenced by regionCoupledBaseGAMGInterface::~regionCoupledBaseGAMGInterface().

Here is the caller graph for this function:

◆ nbrPatchID()

virtual label nbrPatchID ( ) const
inlinevirtual

Cyclic interface functions.

Return neighbour processor number

Implements regionCoupledLduInterface.

Definition at line 106 of file regionCoupledBaseGAMGInterface.H.

References regionCoupledLduInterface::nbrPatchID().

Here is the call graph for this function:

◆ owner()

virtual bool owner ( ) const
inlinevirtual

Is it owner?

Implements regionCoupledLduInterface.

Definition at line 111 of file regionCoupledBaseGAMGInterface.H.

References regionCoupledLduInterface::owner().

Here is the call graph for this function:

◆ nbrPatch()

virtual const regionCoupledBaseGAMGInterface& nbrPatch ( ) const
inlinevirtual

Return neighb regionCoupledLduInterface.

Implements regionCoupledLduInterface.

Definition at line 116 of file regionCoupledBaseGAMGInterface.H.

References regionCoupledLduInterface::nbrPatch().

Here is the call graph for this function:

◆ nbrMesh()

virtual const polyMesh& nbrMesh ( ) const
inlinevirtual

Return AMI.

virtual const AMIInterpolation& AMI() const = 0;Return nbrMesh

Implements regionCoupledLduInterface.

Definition at line 129 of file regionCoupledBaseGAMGInterface.H.

References regionCoupledBaseGAMGInterface::nbrLduInterface(), and regionCoupledLduInterface::nbrMesh().

Referenced by regionCoupledBaseGAMGInterface::nbrLduInterface().

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

◆ nbrLduInterface()

const lduInterface& nbrLduInterface ( const label  fineLevelIndex,
const label  index 
) const
inline

◆ operator=()

void operator= ( const regionCoupledBaseGAMGInterface )
delete

Disallow default bitwise assignment.

Referenced by regionCoupledBaseGAMGInterface::nbrLduInterface().

Here is the caller graph for this function:

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