#include <coupling.h>

Inheritance diagram for CouplingLB< nDim, nDist, SysEqn >:

Collaboration diagram for CouplingLB< nDim, nDist, SysEqn >:

Public Types
using	solverType = LbSolverDxQy< nDim, nDist, SysEqn >

using	LbBndCnd = LbBndCndDxQy< nDim, nDist, SysEqn >

using	MbCellCollector = maia::lb::collector::LbMbCellCollector< nDim >

Public Member Functions
	CouplingLB (const MInt couplingId, Solver *solvers, const MInt noSolvers=1)

	CouplingLB (const MInt couplingId, std::vector< solverType * > solvers)

MFloat	a_physicalTime () const

MFloat	lsTimeStep () const

MInt	a_RKStep () const

MInt	a_noLbCells (const MInt id=0) const

MInt	a_noLevelSetsMb (const MInt id=0) const

MFloat	a_Ma (const MInt id=0) const

MFloat	a_Re (const MInt id=0) const

MInt	a_pvu (const MInt id=0) const

MInt	a_pvv (const MInt id=0) const

MInt	a_pvw (const MInt id=0) const

MInt	a_pvrho (const MInt id=0) const

MInt	a_pvt (const MInt id=0) const

MInt	a_isThermal (const MInt id=0) const

MInt	a_noDistributions (const MInt id=0) const

MFloat	a_initTemperatureKelvin (const MInt id=0) const

MFloat	a_time () const

MbCellCollector &	a_mbCell (const MInt id=0)

MInt	a_boundaryCellMb (const MInt cellId, const MInt id=0)

MFloat &	a_levelSetFunctionMb (const MInt cellId, const MInt set, const MInt id=0)

MFloat	a_levelSetFunctionMb (const MInt cellId, const MInt set, const MInt id=0) const

MInt &	a_associatedBodyIdsMb (const MInt cellId, const MInt set, const MInt id=0)

MInt	a_associatedBodyIdsMb (const MInt cellId, const MInt set, const MInt id=0) const

MInt	a_parentId (const MInt cellId, const MInt id=0)

MInt	a_childId (const MInt cellId, const MInt child, const MInt id=0)

MInt	minCell (const MInt index, const MInt id=0) const

MInt	noMinCells (const MInt id=0) const

MInt	a_noCells (const MInt id=0) const

MFloat	a_cellLengthAtLevel (MInt level, const MInt id=0)

MInt	a_noEmbeddedBodiesLB (const MInt id=0) const

MBool	a_isActive (const MInt cellId, const MInt id=0) const

MBool	a_wasActive (const MInt cellId, const MInt id=0) const

MInt	a_noVariables (const MInt id=0) const

MFloat &	a_variable (const MInt cellId, const MInt varId, const MInt id=0)

MFloat &	a_oldVariable (const MInt cellId, const MInt varId, const MInt id=0)

MInt	a_bndCellId (const MInt bndCell, const MInt id=0)

MInt	a_noBndCells (const MInt id=0)

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

Protected Member Functions
MInt	noSolvers () const

solverType &	lbSolver (const MInt solverId=0) const

LbBndCnd &	lbBndCnd (const MInt id=0)

Protected Member Functions inherited from Coupling
MFloat	returnLoadRecord () const

MFloat	returnIdleRecord () const

Private Attributes
std::vector< solverType * >	m_lbSolvers {}

Detailed Description

template<MInt nDim, MInt nDist, class SysEqn>
class CouplingLB< nDim, nDist, SysEqn >

Definition at line 428 of file coupling.h.

Member Typedef Documentation

◆ LbBndCnd

template<MInt nDim, MInt nDist, class SysEqn >

using CouplingLB< nDim, nDist, SysEqn >::LbBndCnd = LbBndCndDxQy<nDim, nDist, SysEqn>

Definition at line 431 of file coupling.h.

◆ MbCellCollector

template<MInt nDim, MInt nDist, class SysEqn >

using CouplingLB< nDim, nDist, SysEqn >::MbCellCollector = maia::lb::collector::LbMbCellCollector<nDim>

Definition at line 432 of file coupling.h.

◆ solverType

template<MInt nDim, MInt nDist, class SysEqn >

using CouplingLB< nDim, nDist, SysEqn >::solverType = LbSolverDxQy<nDim, nDist, SysEqn>

Definition at line 430 of file coupling.h.

Constructor & Destructor Documentation

◆ CouplingLB() [1/2]

template<MInt nDim, MInt nDist, class SysEqn >

CouplingLB< nDim, nDist, SysEqn >::CouplingLB	(	const MInt	couplingId,
		Solver *	solvers,
		const MInt	noSolvers = `1`
	)

inline

Definition at line 434 of file coupling.h.

                                                                               : Coupling(couplingId) {
    TRACE();
 
    // Store solver pointers
    for(MInt i = 0; i < noSolvers; i++) {
      m_lbSolvers.push_back(static_cast<solverType*>(&solvers[i]));
    }
  }

◆ CouplingLB() [2/2]

template<MInt nDim, MInt nDist, class SysEqn >

CouplingLB< nDim, nDist, SysEqn >::CouplingLB	(	const MInt	couplingId,
		std::vector< solverType * >	solvers
	)

inline

Definition at line 443 of file coupling.h.

                                                                    : Coupling(couplingId) {
    TRACE();
 
    // Store solver pointers
    for(const auto& solver : solvers) {
      m_lbSolvers.push_back(static_cast<solverType*>(solver));
    }
  }

Member Function Documentation

◆ a_associatedBodyIdsMb() [1/2]

template<MInt nDim, MInt nDist, class SysEqn >

MInt & CouplingLB< nDim, nDist, SysEqn >::a_associatedBodyIdsMb	(	const MInt	cellId,
		const MInt	set,
		const MInt	id = `0`
	)

inline

Definition at line 498 of file coupling.h.

                                                                                    {
    return lbSolver(id).a_associatedBodyIds(cellId, set);
  }

◆ a_associatedBodyIdsMb() [2/2]

template<MInt nDim, MInt nDist, class SysEqn >

MInt CouplingLB< nDim, nDist, SysEqn >::a_associatedBodyIdsMb	(	const MInt	cellId,
		const MInt	set,
		const MInt	id = `0`
	)		const

inline

Definition at line 502 of file coupling.h.

                                                                                         {
    return lbSolver(id).a_associatedBodyIds(cellId, set);
  }

◆ a_bndCellId()

template<MInt nDim, MInt nDist, class SysEqn >

MInt CouplingLB< nDim, nDist, SysEqn >::a_bndCellId	(	const MInt	bndCell,
		const MInt	id = `0`
	)

inline

Definition at line 537 of file coupling.h.

537{ return lbBndCnd(id).m_bndCells[bndCell].m_cellId; }

CouplingLB::lbBndCnd

LbBndCnd & lbBndCnd(const MInt id=0)

Definition: coupling.h:461

LbBndCnd::m_bndCells

std::vector< LbGridBoundaryCell< nDim > > m_bndCells

Definition: lbbndcnd.h:130

◆ a_boundaryCellMb()

template<MInt nDim, MInt nDist, class SysEqn >

MInt CouplingLB< nDim, nDist, SysEqn >::a_boundaryCellMb	(	const MInt	cellId,
		const MInt	id = `0`
	)

inline

Definition at line 487 of file coupling.h.

487{ return lbBndCnd(id).a_boundaryCellMb(cellId); }

LbBndCnd::a_boundaryCellMb

MInt a_boundaryCellMb(const MInt cellId)

Definition: lbbndcnd.h:83

◆ a_cellLengthAtLevel()

template<MInt nDim, MInt nDist, class SysEqn >

MFloat CouplingLB< nDim, nDist, SysEqn >::a_cellLengthAtLevel	(	MInt	level,
		const MInt	id = `0`
	)

inline

Definition at line 518 of file coupling.h.

518{ return lbSolver(id).grid().cellLengthAtLevel(level); }

◆ a_childId()

template<MInt nDim, MInt nDist, class SysEqn >

MInt CouplingLB< nDim, nDist, SysEqn >::a_childId	(	const MInt	cellId,
		const MInt	child,
		const MInt	id = `0`
	)

inline

Definition at line 508 of file coupling.h.

                                                                         {
    return lbSolver(id).c_childId(cellId, child);
  }

◆ a_initTemperatureKelvin()

template<MInt nDim, MInt nDist, class SysEqn >

MFloat CouplingLB< nDim, nDist, SysEqn >::a_initTemperatureKelvin ( const MInt id = 0 ) const

inline

Definition at line 482 of file coupling.h.

482{ return lbSolver(id).m_initTemperatureKelvin; }

◆ a_isActive()

template<MInt nDim, MInt nDist, class SysEqn >

MBool CouplingLB< nDim, nDist, SysEqn >::a_isActive	(	const MInt	cellId,
		const MInt	id = `0`
	)		const

inline

Definition at line 522 of file coupling.h.

522{ return lbSolver(id).a_isActive(cellId); }

◆ a_isThermal()

template<MInt nDim, MInt nDist, class SysEqn >

MInt CouplingLB< nDim, nDist, SysEqn >::a_isThermal ( const MInt id = 0 ) const

inline

Definition at line 479 of file coupling.h.

479{ return lbSolver(id).m_isThermal; }

◆ a_levelSetFunctionMb() [1/2]

template<MInt nDim, MInt nDist, class SysEqn >

MFloat & CouplingLB< nDim, nDist, SysEqn >::a_levelSetFunctionMb	(	const MInt	cellId,
		const MInt	set,
		const MInt	id = `0`
	)

inline

Definition at line 490 of file coupling.h.

                                                                                     {
    return lbSolver(id).a_levelSetFunctionMB(cellId, set);
  }

◆ a_levelSetFunctionMb() [2/2]

template<MInt nDim, MInt nDist, class SysEqn >

MFloat CouplingLB< nDim, nDist, SysEqn >::a_levelSetFunctionMb	(	const MInt	cellId,
		const MInt	set,
		const MInt	id = `0`
	)		const

inline

Definition at line 494 of file coupling.h.

                                                                                          {
    return lbSolver(id).a_levelSetFunctionMB(cellId, set);
  }

◆ a_Ma()

template<MInt nDim, MInt nDist, class SysEqn >

MFloat CouplingLB< nDim, nDist, SysEqn >::a_Ma ( const MInt id = 0 ) const

inline

Definition at line 472 of file coupling.h.

472{ return lbSolver(id).m_Ma; }

◆ a_mbCell()

template<MInt nDim, MInt nDist, class SysEqn >

MbCellCollector & CouplingLB< nDim, nDist, SysEqn >::a_mbCell ( const MInt id = 0 )

inline

Definition at line 486 of file coupling.h.

486{ return lbBndCnd(id).m_boundaryCellsMb; }

LbBndCnd::m_boundaryCellsMb

MbCellCollector m_boundaryCellsMb

Definition: lbbndcnd.h:57

◆ a_noBndCells()

template<MInt nDim, MInt nDist, class SysEqn >

MInt CouplingLB< nDim, nDist, SysEqn >::a_noBndCells ( const MInt id = 0 )

inline

Definition at line 539 of file coupling.h.

539{ return lbBndCnd(id).m_bndCells.size(); }

◆ a_noCells()

template<MInt nDim, MInt nDist, class SysEqn >

MInt CouplingLB< nDim, nDist, SysEqn >::a_noCells ( const MInt id = 0 ) const

inline

Definition at line 516 of file coupling.h.

516{ return lbSolver(id).grid().noCells(); }

◆ a_noDistributions()

template<MInt nDim, MInt nDist, class SysEqn >

MInt CouplingLB< nDim, nDist, SysEqn >::a_noDistributions ( const MInt id = 0 ) const

inline

Definition at line 481 of file coupling.h.

481{ return lbSolver(id).m_noDistributions; }

LbSolverDxQy::m_noDistributions

static constexpr MInt m_noDistributions

Definition: lbsolverdxqy.h:180

◆ a_noEmbeddedBodiesLB()

template<MInt nDim, MInt nDist, class SysEqn >

MInt CouplingLB< nDim, nDist, SysEqn >::a_noEmbeddedBodiesLB ( const MInt id = 0 ) const

inline

Definition at line 520 of file coupling.h.

520{ return lbSolver(id).m_noEmbeddedBodies; }

◆ a_noLbCells()

template<MInt nDim, MInt nDist, class SysEqn >

MInt CouplingLB< nDim, nDist, SysEqn >::a_noLbCells ( const MInt id = 0 ) const

inline

Definition at line 470 of file coupling.h.

470{ return lbSolver(id).a_noCells(); }

◆ a_noLevelSetsMb()

template<MInt nDim, MInt nDist, class SysEqn >

MInt CouplingLB< nDim, nDist, SysEqn >::a_noLevelSetsMb ( const MInt id = 0 ) const

inline

Definition at line 471 of file coupling.h.

471{ return lbSolver(id).m_noLevelSetsUsedForMb; }

◆ a_noVariables()

template<MInt nDim, MInt nDist, class SysEqn >

MInt CouplingLB< nDim, nDist, SysEqn >::a_noVariables ( const MInt id = 0 ) const

inline

Definition at line 526 of file coupling.h.

526{ return lbSolver(id).noVariables(); }

◆ a_oldVariable()

template<MInt nDim, MInt nDist, class SysEqn >

MFloat & CouplingLB< nDim, nDist, SysEqn >::a_oldVariable	(	const MInt	cellId,
		const MInt	varId,
		const MInt	id = `0`
	)

inline

Definition at line 533 of file coupling.h.

                                                                                {
    return lbSolver(id).a_oldVariable(cellId, varId);
  }

◆ a_parentId()

template<MInt nDim, MInt nDist, class SysEqn >

MInt CouplingLB< nDim, nDist, SysEqn >::a_parentId	(	const MInt	cellId,
		const MInt	id = `0`
	)

inline

Definition at line 506 of file coupling.h.

506{ return lbSolver(id).c_parentId(cellId); }

◆ a_physicalTime()

template<MInt nDim, MInt nDist, class SysEqn >

MFloat CouplingLB< nDim, nDist, SysEqn >::a_physicalTime ( ) const

inline

Definition at line 467 of file coupling.h.

467{ return globalTimeStep; } // The nondimensional time in LB is the globalTimeStep

globalTimeStep

MInt globalTimeStep

Definition: globalvariables.cpp:33

◆ a_pvrho()

template<MInt nDim, MInt nDist, class SysEqn >

MInt CouplingLB< nDim, nDist, SysEqn >::a_pvrho ( const MInt id = 0 ) const

inline

Definition at line 477 of file coupling.h.

477{ return lbSolver(id).PV->RHO; }

◆ a_pvt()

template<MInt nDim, MInt nDist, class SysEqn >

MInt CouplingLB< nDim, nDist, SysEqn >::a_pvt ( const MInt id = 0 ) const

inline

Definition at line 478 of file coupling.h.

478{ return lbSolver(id).PV->T; }

◆ a_pvu()

template<MInt nDim, MInt nDist, class SysEqn >

MInt CouplingLB< nDim, nDist, SysEqn >::a_pvu ( const MInt id = 0 ) const

inline

Definition at line 474 of file coupling.h.

474{ return lbSolver(id).PV->U; }

◆ a_pvv()

template<MInt nDim, MInt nDist, class SysEqn >

MInt CouplingLB< nDim, nDist, SysEqn >::a_pvv ( const MInt id = 0 ) const

inline

Definition at line 475 of file coupling.h.

475{ return lbSolver(id).PV->V; }

◆ a_pvw()

template<MInt nDim, MInt nDist, class SysEqn >

MInt CouplingLB< nDim, nDist, SysEqn >::a_pvw ( const MInt id = 0 ) const

inline

Definition at line 476 of file coupling.h.

476{ return lbSolver(id).PV->W; }

◆ a_Re()

template<MInt nDim, MInt nDist, class SysEqn >

MFloat CouplingLB< nDim, nDist, SysEqn >::a_Re ( const MInt id = 0 ) const

inline

Definition at line 473 of file coupling.h.

473{ return lbSolver(id).m_Re; }

◆ a_RKStep()

template<MInt nDim, MInt nDist, class SysEqn >

MInt CouplingLB< nDim, nDist, SysEqn >::a_RKStep ( ) const

inline

Definition at line 469 of file coupling.h.

469{ return 0; } // There is no Runge Kutta Step in LB

◆ a_time()

template<MInt nDim, MInt nDist, class SysEqn >

MFloat CouplingLB< nDim, nDist, SysEqn >::a_time ( ) const

inline

Definition at line 484 of file coupling.h.

484{ return globalTimeStep; }

◆ a_variable()

template<MInt nDim, MInt nDist, class SysEqn >

MFloat & CouplingLB< nDim, nDist, SysEqn >::a_variable	(	const MInt	cellId,
		const MInt	varId,
		const MInt	id = `0`
	)

inline

Definition at line 528 of file coupling.h.

                                                                             {
    return lbSolver(id).a_variable(cellId, varId);
  }

◆ a_wasActive()

template<MInt nDim, MInt nDist, class SysEqn >

MBool CouplingLB< nDim, nDist, SysEqn >::a_wasActive	(	const MInt	cellId,
		const MInt	id = `0`
	)		const

inline

Definition at line 524 of file coupling.h.

524{ return lbSolver(id).a_wasActive(cellId); }

◆ lbBndCnd()

template<MInt nDim, MInt nDist, class SysEqn >

LbBndCnd & CouplingLB< nDim, nDist, SysEqn >::lbBndCnd ( const MInt id = 0 )

inlineprotected

Definition at line 461 of file coupling.h.

461{ return *lbSolver(id).m_bndCnd; }

LbSolverDxQy::m_bndCnd

LbBndCnd * m_bndCnd

Pointers for the Boundary Conditions, for flow solving.

Definition: lbsolverdxqy.h:332

◆ lbSolver()

template<MInt nDim, MInt nDist, class SysEqn >

solverType & CouplingLB< nDim, nDist, SysEqn >::lbSolver ( const MInt solverId = 0 ) const

inlineprotected

Definition at line 454 of file coupling.h.

                                                      {
    ASSERT(solverId < noSolvers(), "Invalid solverId " + std::to_string(solverId) + "/" + std::to_string(noSolvers()));
    return *m_lbSolvers[solverId];
  }

◆ lsTimeStep()

template<MInt nDim, MInt nDist, class SysEqn >

MFloat CouplingLB< nDim, nDist, SysEqn >::lsTimeStep ( ) const

inline

Definition at line 468 of file coupling.h.

468{ return 1.0; } // The nondimensional time step in LB is 1

◆ minCell()

template<MInt nDim, MInt nDist, class SysEqn >

MInt CouplingLB< nDim, nDist, SysEqn >::minCell	(	const MInt	index,
		const MInt	id = `0`
	)		const

inline

Definition at line 512 of file coupling.h.

512{ return lbSolver(id).grid().minCell(index); }

◆ noMinCells()

template<MInt nDim, MInt nDist, class SysEqn >

MInt CouplingLB< nDim, nDist, SysEqn >::noMinCells ( const MInt id = 0 ) const

inline

Definition at line 514 of file coupling.h.

514{ return lbSolver(id).grid().noMinCells(); }

◆ noSolvers()

template<MInt nDim, MInt nDist, class SysEqn >

MInt CouplingLB< nDim, nDist, SysEqn >::noSolvers ( ) const

inlineprotected

Definition at line 453 of file coupling.h.

453{ return m_lbSolvers.size(); }

Member Data Documentation

◆ m_lbSolvers

template<MInt nDim, MInt nDist, class SysEqn >

std::vector<solverType*> CouplingLB< nDim, nDist, SysEqn >::m_lbSolvers {}

private

Definition at line 464 of file coupling.h.

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

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

Public Types

Public Member Functions

Protected Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ LbBndCnd

◆ MbCellCollector

◆ solverType

Constructor & Destructor Documentation

◆ CouplingLB() [1/2]

◆ CouplingLB() [2/2]

Member Function Documentation

◆ a_associatedBodyIdsMb() [1/2]

◆ a_associatedBodyIdsMb() [2/2]

◆ a_bndCellId()

◆ a_boundaryCellMb()

◆ a_cellLengthAtLevel()

◆ a_childId()

◆ a_initTemperatureKelvin()

◆ a_isActive()

◆ a_isThermal()

◆ a_levelSetFunctionMb() [1/2]

◆ a_levelSetFunctionMb() [2/2]

◆ a_Ma()

◆ a_mbCell()

◆ a_noBndCells()

◆ a_noCells()

◆ a_noDistributions()

◆ a_noEmbeddedBodiesLB()

◆ a_noLbCells()

◆ a_noLevelSetsMb()

◆ a_noVariables()

◆ a_oldVariable()

◆ a_parentId()

◆ a_physicalTime()

◆ a_pvrho()

◆ a_pvt()

◆ a_pvu()

◆ a_pvv()

◆ a_pvw()

◆ a_Re()

◆ a_RKStep()

◆ a_time()

◆ a_variable()

◆ a_wasActive()

◆ lbBndCnd()

◆ lbSolver()

◆ lsTimeStep()

◆ minCell()

◆ noMinCells()

◆ noSolvers()

Member Data Documentation

◆ m_lbSolvers