Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
GAMGInterface Class Referenceabstract

Abstract base class for GAMG agglomerated interfaces. More...

Inheritance diagram for GAMGInterface:
Inheritance graph
[legend]
Collaboration diagram for GAMGInterface:
Collaboration graph
[legend]

Public Member Functions

 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 >
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...
 
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...
 
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...
 
virtual tmp< labelFieldinternalFieldTransfer (const Pstream::commsTypes commsType, const labelUList &iF) const =0
 Transfer and return internal field adjacent to the interface. More...
 

Static Public Member Functions

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

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

Abstract base class for GAMG agglomerated interfaces.

Source files

Definition at line 51 of file GAMGInterface.H.

Constructor & Destructor Documentation

GAMGInterface ( const label  index,
const lduInterfacePtrsList coarseInterfaces 
)
inline

Construct from interfaces, restrict addressing set later on.

Definition at line 165 of file GAMGInterface.H.

GAMGInterface ( const label  index,
const lduInterfacePtrsList coarseInterfaces,
const labelUList faceCells,
const labelUList faceRestrictAddressing 
)
inline

Construct from interfaces and restrict addressing.

Definition at line 177 of file GAMGInterface.H.

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

Construct from Istream.

Definition at line 41 of file GAMGInterface.C.

Member Function Documentation

TypeName ( "GAMGInterface"  )

Runtime type information.

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 )   
)
Foam::autoPtr< Foam::GAMGInterface > New ( const label  index,
const lduInterfacePtrsList coarseInterfaces,
const lduInterface fineInterface,
const labelField localRestrictAddressing,
const labelField neighbourRestrictAddressing,
const label  fineLevelIndex,
const label  coarseComm 
)
static

Return a pointer to a new interface created on freestore given.

the fine interface

Definition at line 34 of file GAMGInterfaceNew.C.

References Foam::exit(), Foam::FatalError, and FatalErrorIn.

Referenced by GAMGSolver::GAMGSolver(), and lduPrimitiveMesh::gather().

Here is the call graph for this function:

Here is the caller graph for this function:

Foam::autoPtr< Foam::GAMGInterface > New ( const word coupleType,
const label  index,
const lduInterfacePtrsList coarseInterfaces,
Istream is 
)
static

Return a pointer to a new interface created on freestore given.

the fine interface

Definition at line 80 of file GAMGInterfaceNew.C.

References Foam::exit(), Foam::FatalError, and FatalErrorIn.

Here is the call graph for this function:

virtual label size ( ) const
inlinevirtual

Return size.

Definition at line 205 of file GAMGInterface.H.

References List< T >::size().

Referenced by regionCoupledGAMGInterfaceField::size(), regionCoupledWallGAMGInterfaceField::size(), cyclicGAMGInterfaceField::size(), cyclicAMIGAMGInterfaceField::size(), cyclicACMIGAMGInterfaceField::size(), and processorGAMGInterfaceField::size().

Here is the call graph for this function:

Here is the caller graph for this function:

virtual label index ( ) const
inlinevirtual

Definition at line 210 of file GAMGInterface.H.

References GAMGInterface::index_.

Referenced by regionCoupledBaseGAMGInterface::nbrLduInterface().

Here is the caller graph for this function:

virtual const lduInterfacePtrsList& coarseInterfaces ( ) const
inlinevirtual

Definition at line 215 of file GAMGInterface.H.

References GAMGInterface::coarseInterfaces_.

virtual const labelUList& faceCells ( ) const
inlinevirtual

Return faceCell addressing.

Implements lduInterface.

Definition at line 221 of file GAMGInterface.H.

References GAMGInterface::faceCells_.

Referenced by cyclicACMIGAMGInterface::internalFieldTransfer(), cyclicAMIGAMGInterface::internalFieldTransfer(), and cyclicGAMGInterface::internalFieldTransfer().

Here is the caller graph for this function:

virtual const labelList& faceRestrictAddressing ( ) const
inlinevirtual

Return (local)face restrict addressing.

Definition at line 227 of file GAMGInterface.H.

References GAMGInterface::faceRestrictAddressing_.

virtual labelList& faceRestrictAddressing ( )
inlinevirtual

Return non-const access to face restrict addressing.

Definition at line 233 of file GAMGInterface.H.

References GAMGInterface::agglomerateCoeffs(), GAMGInterface::combine(), GAMGInterface::faceRestrictAddressing_, GAMGInterface::interfaceInternalField(), and GAMGInterface::write().

Here is the call graph for this function:

tmp<Field<Type> > interfaceInternalField ( const UList< Type > &  internalData) const

Return the interface internal field of the given field.

Referenced by GAMGInterface::combine(), GAMGInterface::faceRestrictAddressing(), and GAMGInterface::interfaceInternalField().

Here is the caller graph for this function:

void interfaceInternalField ( const UList< Type > &  internalData,
List< Type > &  result 
) const

Get the interface internal field of the given field.

Definition at line 44 of file GAMGInterfaceTemplates.C.

References forAll, and List< T >::setSize().

Here is the call graph for this function:

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 70 of file GAMGInterface.C.

References GAMGInterface::agglomerateCoeffs().

Here is the call graph for this function:

void combine ( const GAMGInterface coarseGi)

Merge the next level with this level.

combining the face-restrict addressing and copying the face-cell addressing

Definition at line 56 of file GAMGInterface.C.

References GAMGInterface::faceCells_, GAMGInterface::faceRestrictAddressing_, forAll, and GAMGInterface::interfaceInternalField().

Referenced by GAMGAgglomeration::combineLevels(), and GAMGInterface::faceRestrictAddressing().

Here is the call graph for this function:

Here is the caller graph for this function:

Foam::tmp< Foam::scalarField > agglomerateCoeffs ( const scalarField fineCoeffs) const
virtual

Agglomerating the given fine-level coefficients and return.

Definition at line 79 of file GAMGInterface.C.

References Foam::abort(), Foam::FatalError, FatalErrorIn, forAll, Foam::max(), and List< T >::size().

Referenced by GAMGInterface::faceRestrictAddressing(), and GAMGInterface::interfaceInternalField().

Here is the call graph for this function:

Here is the caller graph for this function:

void write ( Ostream os) const
pure virtual
Foam::tmp<Foam::Field<Type> > interfaceInternalField ( const UList< Type > &  iF) const

Definition at line 32 of file GAMGInterfaceTemplates.C.

References GAMGInterface::interfaceInternalField().

Here is the call graph for this function:

Member Data Documentation

const label index_
protected

My index in coarseInterfaces.

Definition at line 61 of file GAMGInterface.H.

Referenced by GAMGInterface::index().

const lduInterfacePtrsList& coarseInterfaces_
protected
labelList faceCells_
protected

Face-cell addressing.

Definition at line 67 of file GAMGInterface.H.

Referenced by GAMGInterface::combine(), and GAMGInterface::faceCells().

labelList faceRestrictAddressing_
protected

Face restrict addressing.

Definition at line 70 of file GAMGInterface.H.

Referenced by GAMGInterface::combine(), and GAMGInterface::faceRestrictAddressing().


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