CouplingFvMb< nDim, SysEqn > Class Template Reference

#include <coupling.h>

Inheritance diagram for CouplingFvMb< nDim, SysEqn >:

Collaboration diagram for CouplingFvMb< nDim, SysEqn >:

Public Types
using	solverType = FvMbCartesianSolverXD< nDim, SysEqn >

Public Member Functions
	CouplingFvMb (const MInt couplingId, solverType *b)
solverType &	fvMbSolver () const
MInt	a_noFvCells () const
MInt	a_noFvGridCells () const
MInt	a_noLevelSetsMb () const
Public Member Functions inherited from Coupling
	Coupling (const MInt couplingId)
virtual	~Coupling ()=default
	Coupling (const Coupling &)=delete
Coupling &	operator= (const Coupling &)=delete
MInt	couplerId () const
virtual void	init ()=0
virtual void	finalizeSubCoupleInit (MInt solverId)=0
virtual void	finalizeCouplerInit ()=0
virtual void	preCouple (MInt recipeStep)=0
virtual void	subCouple (MInt recipeStep, MInt solverId, std::vector< MBool > &solverCompleted)=0
virtual void	postCouple (MInt recipeStep)=0
virtual void	cleanUp ()=0
virtual void	balancePre ()
	Load balancing. More...
virtual void	balancePost ()
virtual void	reinitAfterBalance ()
virtual void	prepareAdaptation ()
virtual void	postAdaptation ()
virtual void	finalizeAdaptation (const MInt)
virtual void	writeRestartFile (const MInt)
virtual MInt	noCellDataDlb () const
	Methods to inquire coupler data during balancing. More...
virtual MInt	cellDataTypeDlb (const MInt NotUsed(dataId)) const
virtual MInt	cellDataSizeDlb (const MInt NotUsed(dataId), const MInt NotUsed(cellId))
virtual void	getCellDataDlb (const MInt NotUsed(dataId), const MInt NotUsed(oldNoCells), const MInt *const NotUsed(bufferIdToCellId), MInt *const NotUsed(data))
virtual void	getCellDataDlb (const MInt NotUsed(dataId), const MInt NotUsed(oldNoCells), const MInt *const NotUsed(bufferIdToCellId), MLong *const NotUsed(data))
virtual void	getCellDataDlb (const MInt NotUsed(dataId), const MInt NotUsed(oldNoCells), const MInt *const NotUsed(bufferIdToCellId), MFloat *const NotUsed(data))
virtual void	setCellDataDlb (const MInt NotUsed(dataId), const MInt *const NotUsed(data))
virtual void	setCellDataDlb (const MInt NotUsed(dataId), const MLong *const NotUsed(data))
virtual void	setCellDataDlb (const MInt NotUsed(dataId), const MFloat *const NotUsed(data))
virtual void	finalizeBalance (const MInt)
virtual MInt	noCouplingTimers (const MBool NotUsed(allTimings)) const
	Number of coupling timers. More...
virtual void	getCouplingTimings (std::vector< std::pair< MString, MFloat > > &NotUsed(timings), const MBool NotUsed(allTimings))
	Return coupling timings. More...
virtual void	getDomainDecompositionInformation (std::vector< std::pair< MString, MInt > > &NotUsed(domainInfo))
	Return information on current domain decomposition (e.g. number of coupled cells/elements/...) More...
void	setDlbTimer (const MInt timerId)
void	startLoadTimer (const MString &name) const
	Start the load timer of the coupler. More...
void	stopLoadTimer (const MString &name) const
	Stop the load timer of the coupler. More...

Private Member Functions
void	cleanUp () override

Private Attributes
solverType *	m_solver

Additional Inherited Members
Protected Member Functions inherited from Coupling
MFloat	returnLoadRecord () const
MFloat	returnIdleRecord () const

Detailed Description

template<MInt nDim, class SysEqn>
class CouplingFvMb< nDim, SysEqn >

Definition at line 249 of file coupling.h.

Member Typedef Documentation

solverType

template<MInt nDim, class SysEqn >

using CouplingFvMb< nDim, SysEqn >::solverType = FvMbCartesianSolverXD<nDim, SysEqn>

Definition at line 251 of file coupling.h.

Constructor & Destructor Documentation

CouplingFvMb()

template<MInt nDim, class SysEqn >

CouplingFvMb< nDim, SysEqn >::CouplingFvMb ( const MInt  couplingId, solverType *  b  )

inline

Definition at line 252 of file coupling.h.

: Coupling(couplingId) { m_solver = b; }

Member Function Documentation

a_noFvCells()

template<MInt nDim, class SysEqn >

MInt CouplingFvMb< nDim, SysEqn >::a_noFvCells ( ) const

inline

Definition at line 256 of file coupling.h.

{ return fvMbSolver().a_noCells(); }

a_noFvGridCells()

template<MInt nDim, class SysEqn >

MInt CouplingFvMb< nDim, SysEqn >::a_noFvGridCells ( ) const

inline

Definition at line 257 of file coupling.h.

{ return fvMbSolver().c_noCells(); }

a_noLevelSetsMb()

template<MInt nDim, class SysEqn >

MInt CouplingFvMb< nDim, SysEqn >::a_noLevelSetsMb ( ) const

inline

Definition at line 258 of file coupling.h.

{ return fvMbSolver().m_noLevelSetsUsedForMb; }

cleanUp()

template<MInt nDim, class SysEqn >

void CouplingFvMb< nDim, SysEqn >::cleanUp ( )

inlineoverrideprivatevirtual

Implements Coupling.

Reimplemented in CouplerFvMbZonal< nDim, SysEqn >.

Definition at line 262 of file coupling.h.

{};

fvMbSolver()

template<MInt nDim, class SysEqn >

solverType & CouplingFvMb< nDim, SysEqn >::fvMbSolver ( ) const

inline

Definition at line 253 of file coupling.h.

{ return *m_solver; }

Member Data Documentation

m_solver

template<MInt nDim, class SysEqn >

solverType* CouplingFvMb< nDim, SysEqn >::m_solver

private

Definition at line 263 of file coupling.h.

---

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

• /home/gitlab-runner/scratch/builds/oxpnswJ6/1/aia/m-AIA/m-AIA/src/COUPLER/coupling.h