cyclicGAMGInterface Class Reference

GAMG agglomerated cyclic interface. More...

Inheritance diagram for cyclicGAMGInterface:
[legend]
Collaboration diagram for cyclicGAMGInterface:
[legend]

Public Member Functions

 TypeName ("cyclic")
 Runtime type information. More...
 
 cyclicGAMGInterface (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...
 
 cyclicGAMGInterface (const label index, const lduInterfacePtrsList &coarseInterfaces, Istream &is)
 Construct from Istream. More...
 
virtual ~cyclicGAMGInterface ()=default
 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 neighbPatchID () const
 Cyclic interface functions. More...
 
virtual bool owner () const
 
virtual const cyclicGAMGInterfaceneighbPatch () const
 Return processor number. More...
 
virtual const tensorFieldforwardT () const
 Return face transformation tensor. More...
 
virtual const tensorFieldreverseT () const
 Return neighbour-cell transformation tensor. More...
 
virtual void write (Ostream &os) const
 Write to stream. 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...
 
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 >
tmp< Field< Type > > interfaceInternalField (const UList< Type > &internalData, const labelUList &faceCells) const
 
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...
 
virtual tmp< labelFieldinterfaceInternalField (const labelUList &internalData, const labelUList &faceCells) const
 
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...
 
template<class Type >
Foam::tmp< Foam::Field< Type > > interfaceInternalField (const UList< Type > &iF) const
 
template<class Type >
Foam::tmp< Foam::Field< Type > > interfaceInternalField (const UList< Type > &iF, const labelUList &faceCells) const
 
- Public Member Functions inherited from lduInterface
 TypeName ("lduInterface")
 Runtime type information. More...
 
 lduInterface ()=default
 Construct null. More...
 
virtual ~lduInterface ()=default
 Destructor. More...
 
virtual const labelUListfaceCells () const =0
 Return faceCell addressing. More...
 
virtual tmp< labelFieldinterfaceInternalField (const labelUList &internalData) const =0
 Return the values of the given internal data adjacent to. More...
 
virtual tmp< labelFieldinterfaceInternalField (const labelUList &internalData, const labelUList &faceCells) const =0
 
virtual void initInternalFieldTransfer (const Pstream::commsTypes commsType, const labelUList &iF) const
 Initialise transfer of internal field adjacent to the interface. More...
 
virtual void initInternalFieldTransfer (const Pstream::commsTypes commsType, const labelUList &iF, const labelUList &faceCells) const
 
virtual tmp< labelFieldinternalFieldTransfer (const Pstream::commsTypes commsType, const labelUList &iF) const =0
 Transfer and return internal field adjacent to the interface. More...
 
- Public Member Functions inherited from cyclicLduInterface
 TypeName ("cyclicLduInterface")
 Runtime type information. More...
 
 cyclicLduInterface ()=default
 Construct null. More...
 
virtual ~cyclicLduInterface ()=default
 Destructor. More...
 
virtual label neighbPatchID () const =0
 Return neighbour. More...
 
virtual bool owner () const =0
 
virtual const cyclicLduInterfaceneighbPatch () const =0
 Return processor number. More...
 
virtual const tensorFieldforwardT () const =0
 Return face transformation tensor. More...
 
virtual const tensorFieldreverseT () const =0
 Return face reverse transformation tensor. 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 Member Functions inherited from GAMGInterface
 GAMGInterface (const GAMGInterface &)=delete
 No copy construct. More...
 
void operator= (const GAMGInterface &)=delete
 No copy assignment. 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

GAMG agglomerated cyclic interface.

Source files

Definition at line 52 of file cyclicGAMGInterface.H.

Constructor & Destructor Documentation

◆ cyclicGAMGInterface() [1/2]

cyclicGAMGInterface ( 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 72 of file cyclicGAMGInterface.C.

References DynamicList< T, SizeMin >::append(), HashTable< T, Key, Hash >::cfind(), GAMGInterface::faceCells_, GAMGInterface::faceRestrictAddressing_, forAll, HashTable< T, Key, Hash >::insert(), cyclicGAMGInterface::owner(), Foam::refCast(), UList< T >::size(), and List< T >::transfer().

Here is the call graph for this function:

◆ cyclicGAMGInterface() [2/2]

cyclicGAMGInterface ( const label  index,
const lduInterfacePtrsList coarseInterfaces,
Istream is 
)

Construct from Istream.

Definition at line 150 of file cyclicGAMGInterface.C.

◆ ~cyclicGAMGInterface()

virtual ~cyclicGAMGInterface ( )
virtualdefault

Destructor.

Member Function Documentation

◆ TypeName()

TypeName ( "cyclic"  )

Runtime type information.

◆ 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 167 of file cyclicGAMGInterface.C.

References GAMGInterface::faceCells(), forAll, and tmp< T >::ref().

Here is the call graph for this function:

◆ neighbPatchID()

virtual label neighbPatchID ( ) const
inlinevirtual

Cyclic interface functions.

Return neighbour processor number

Implements cyclicLduInterface.

Definition at line 130 of file cyclicGAMGInterface.H.

Referenced by cyclicGAMGInterface::neighbPatch().

Here is the caller graph for this function:

◆ owner()

virtual bool owner ( ) const
inlinevirtual

Implements cyclicLduInterface.

Definition at line 135 of file cyclicGAMGInterface.H.

Referenced by cyclicGAMGInterface::cyclicGAMGInterface().

Here is the caller graph for this function:

◆ neighbPatch()

virtual const cyclicGAMGInterface & neighbPatch ( ) const
inlinevirtual

Return processor number.

Implements cyclicLduInterface.

Definition at line 140 of file cyclicGAMGInterface.H.

References GAMGInterface::coarseInterfaces_, and cyclicGAMGInterface::neighbPatchID().

Here is the call graph for this function:

◆ forwardT()

virtual const tensorField & forwardT ( ) const
inlinevirtual

Return face transformation tensor.

Implements cyclicLduInterface.

Definition at line 149 of file cyclicGAMGInterface.H.

Referenced by cyclicGAMGInterfaceField::forwardT().

Here is the caller graph for this function:

◆ reverseT()

virtual const tensorField & reverseT ( ) const
inlinevirtual

Return neighbour-cell transformation tensor.

Implements cyclicLduInterface.

Definition at line 155 of file cyclicGAMGInterface.H.

Referenced by cyclicGAMGInterfaceField::reverseT().

Here is the caller graph for this function:

◆ write()

void write ( Ostream os) const
virtual

Write to stream.

Implements GAMGInterface.

Definition at line 188 of file cyclicGAMGInterface.C.

References os(), token::SPACE, and ObukhovLength::write().

Here is the call graph for this function:

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