FV multilevel interpolation coupler to transfer solution data of a coarse grid onto a finer grid. More...

#include <couplerfvmultilevel.h>

Inheritance diagram for CouplerFvMultilevelInterpolation< nDim, SysEqn >:

Collaboration diagram for CouplerFvMultilevelInterpolation< nDim, SysEqn >:

Public Types
using	BaseCoupler = CouplerFvMultilevel< nDim, SysEqn >

using	Base = typename BaseCoupler::Base

using	BaseFv = typename BaseCoupler::BaseFv

Public Types inherited from CouplerFvMultilevel< nDim, SysEqn >
using	Base = Coupling

using	BaseFv = CouplingFv< nDim, SysEqn >

using	SolverType = typename BaseFv::solverType

using	Grid = CartesianGrid< nDim >

using	GridProxy = typename SolverType::GridProxy

Public Types inherited from CouplingFv< nDim, SysEqn >
using	solverType = FvCartesianSolverXD< nDim, SysEqn >

Public Member Functions
	CouplerFvMultilevelInterpolation (const MInt couplingId, std::vector< FvCartesianSolverXD< nDim, SysEqn > * > solvers)
	Constructor for multilevel interpolation coupler. More...

	~CouplerFvMultilevelInterpolation ()

void	postCouple (MInt) override
	Coupling routine to transfer coarse level restart data to the finest level/solver. More...

solverType &	fvSolver (const MInt solverId=0) const

MInt	noSolvers () const

void	prolongation (const MInt level)
	Prolong the solution on the given coarse level onto the next finer level. More...

MBool	startTimer (const MString &name)

MBool	stopTimer (const MString &name)

Public Member Functions inherited from CouplerFvMultilevel< nDim, SysEqn >
	CouplerFvMultilevel (const MInt couplingId, std::vector< FvCartesianSolverXD< nDim, SysEqn > * > solvers)

	~CouplerFvMultilevel ()

void	init () override

void	finalizeSubCoupleInit (MInt)

void	finalizeCouplerInit ()
	call after the initial adaptation when all cells are refined correctly More...

void	preCouple (MInt) override

void	subCouple (MInt, MInt, std::vector< MBool > &) override

void	postCouple (MInt) override

void	cleanUp ()

void	getDomainDecompositionInformation (std::vector< std::pair< MString, MInt > > &NotUsed(domainInfo)) override
	Return information on current domain decomposition (e.g. number of coupled cells/elements/...) More...

void	finalizeAdaptation (MInt solverId)
	call after the initial adaptation when all cells are refined correctly More...

void	readProperties () override

void	checkProperties () override

void	restriction (const MInt level)
	Restrict the solution on the given fine level onto the next coarser level. More...

void	resetTau (const MInt level)
	Reset the coarse level correction tau. More...

void	prolongation (const MInt level)
	Prolong the solution on the given coarse level onto the next finer level. More...

void	sanityCheck ()

MBool	startTimer (const MString &name)

MBool	stopTimer (const MString &name)

solverType &	fvSolver (const MInt solverId=0) const

MInt	noSolvers () const

Public Member Functions inherited from CouplingFv< nDim, SysEqn >
	CouplingFv (const MInt couplingId, std::vector< FvCartesianSolverXD< nDim, SysEqn > * > fvSolvers, const MInt noSolvers)

	CouplingFv (const MInt couplingId, Solver *solvers)

	~CouplingFv () override=default

	CouplingFv (const CouplingFv &)=delete

CouplingFv &	operator= (const CouplingFv &)=delete

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	reset (const MInt level)
	Reset variables/slopes of a level/solver. More...

Additional Inherited Members
Protected Member Functions inherited from CouplingFv< nDim, SysEqn >
MInt	noSolvers () const

solverType &	fvSolver (const MInt solverId=0) const

MInt	a_noFvCells () const

MInt	a_noFvGridCells () const

Protected Member Functions inherited from Coupling
MFloat	returnLoadRecord () const

MFloat	returnIdleRecord () const

Protected Attributes inherited from CouplingFv< nDim, SysEqn >
std::vector< solverType * >	m_fvSolvers {}

Detailed Description

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

Definition at line 106 of file couplerfvmultilevel.h.

Member Typedef Documentation

◆ Base

template<MInt nDim, class SysEqn >

using CouplerFvMultilevelInterpolation< nDim, SysEqn >::Base = typename BaseCoupler::Base

Definition at line 109 of file couplerfvmultilevel.h.

◆ BaseCoupler

template<MInt nDim, class SysEqn >

using CouplerFvMultilevelInterpolation< nDim, SysEqn >::BaseCoupler = CouplerFvMultilevel<nDim, SysEqn>

Definition at line 108 of file couplerfvmultilevel.h.

◆ BaseFv

template<MInt nDim, class SysEqn >

using CouplerFvMultilevelInterpolation< nDim, SysEqn >::BaseFv = typename BaseCoupler::BaseFv

Definition at line 110 of file couplerfvmultilevel.h.

Constructor & Destructor Documentation

◆ CouplerFvMultilevelInterpolation()

template<MInt nDim, class SysEqn >

CouplerFvMultilevelInterpolation< nDim, SysEqn >::CouplerFvMultilevelInterpolation	(	const MInt	couplingId,
		std::vector< FvCartesianSolverXD< nDim, SysEqn > * >	solvers
	)

Definition at line 1311 of file couplerfvmultilevel.cpp.

  : Base(couplingId), BaseCoupler(couplingId, solvers) {
  TRACE();
}

◆ ~CouplerFvMultilevelInterpolation()

template<MInt nDim, class SysEqn >

CouplerFvMultilevelInterpolation< nDim, SysEqn >::~CouplerFvMultilevelInterpolation ( )

inline

Definition at line 121 of file couplerfvmultilevel.h.

121{ TRACE(); };

Member Function Documentation

◆ fvSolver()

template<MInt nDim, class SysEqn >

solverType & CouplingFv< nDim, SysEqn >::fvSolver ( const MInt solverId = 0 ) const

inline

Definition at line 38 of file coupling.h.

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

◆ noSolvers()

template<MInt nDim, class SysEqn >

MInt CouplingFv< nDim, SysEqn >::noSolvers ( ) const

inline

Definition at line 39 of file coupling.h.

385{ return m_fvSolvers.size(); }

◆ postCouple()

template<MInt nDim, class SysEqn >

void CouplerFvMultilevelInterpolation< nDim, SysEqn >::postCouple ( MInt )

overridevirtual

Reimplemented from CouplerFvMultilevel< nDim, SysEqn >.

Definition at line 1320 of file couplerfvmultilevel.cpp.

                                                                    {
  TRACE();
  startTimer("Main");
 
  for(MInt solverId = 0; solverId < noSolvers(); solverId++) {
    if(fvSolver(solverId).getSolverStatus()) {
      TERMM(1, "Multilevel interpolation postCouple(): found active solver/level - all solvers should be inactive!");
    }
  }
 
  // Reset solution unless for the coarsest level with the actual restart data
  for(MInt i = 0; i < noSolvers() - 1; i++) {
    reset(i); // Resets also the restricted variables for the next coarser level
  }
 
  // Prolong the coarse level restart data to the finest level (since the restricted vars and the stored slopes are set
  // to 0 above the full solution is transferred to the next finer level)
  for(MInt i = noSolvers() - 1; i > 0; i--) {
    prolongation(i);
  }
 
  stopTimer("Main");
}

◆ prolongation()

template<MInt nDim, class SysEqn >

void CouplerFvMultilevel< nDim, SysEqn >::prolongation ( const MInt level )

Definition at line 60 of file couplerfvmultilevel.cpp.

                                                                     {
  TRACE();
 
  startTimer("Prolongation");
 
  // Store references and variables for convenience
  auto& coarse = static_cast<SolverType&>(fvSolver(level));
  auto& fine = static_cast<SolverType&>(fvSolver(level - 1));
 
  // only halo cells only primary variables are  correct at this point!
  if(m_prolongationMethod == 2) {
    // Temporarily store gradients
    startTimer("StoreGradients");
    const MInt noCells = coarse.noInternalCells();
    const MInt noVars = coarse.CV->noVariables;
    MFloatScratchSpace slopes(noCells * noVars * nDim, AT_, "slopes");
    for(MInt cellId = 0; cellId < noCells; cellId++) {
      for(MInt varId = 0; varId < noVars; varId++) {
        for(MInt i = 0; i < nDim; i++) {
          slopes[cellId * noVars * nDim + varId * nDim + i] = coarse.a_storedSlope(cellId, varId, i);
        }
      }
    }
    stopTimer("StoreGradients");
 
    // Calculate new gradients after the completed coarse time step
    startTimer("CalcGradientsProlongation");
    coarse.LSReconstructCellCenterCons(0);
    stopTimer("CalcGradientsProlongation");
 
    // Compute delta in gradients
    startTimer("CalcGradientDelta");
    for(MInt cellId = 0; cellId < noCells; cellId++) {
      for(MInt varId = 0; varId < noVars; varId++) {
        for(MInt i = 0; i < nDim; i++) {
          coarse.a_storedSlope(cellId, varId, i) -= slopes[cellId * noVars * nDim + varId * nDim + i];
        }
      }
    }
    stopTimer("CalcGradientDelta");
  }
 
  prolongData(level);
 
  // Re-compute boundary conditions etc. based on new/corrected variable state in the fine cell
  startTimer("FineLhsBnd");
  fine.exchangeData(&fine.a_variable(0, 0), fine.CV->noVariables);
 
  fine.lhsBnd();
 
  stopTimer("FineLhsBnd");
 
  stopTimer("Prolongation");
}

◆ reset()

template<MInt nDim, class SysEqn >

void CouplerFvMultilevelInterpolation< nDim, SysEqn >::reset ( const MInt level )

private

Definition at line 1347 of file couplerfvmultilevel.cpp.

                                                                           {
  TRACE();
 
  auto& fine = fvSolver(level);
  auto& coarse = fvSolver(level + 1);
  const MInt noVars = fine.CV->noVariables;
 
  for(MInt cellId = 0; cellId < fine.noInternalCells(); cellId++) {
    for(MInt varId = 0; varId < noVars; varId++) {
      // Reset variables on this level
      fine.a_variable(cellId, varId) = 0.0;
      for(MInt dim = 0; dim < nDim; dim++) {
        // ... and slopes (of conservative variables)
        fine.a_storedSlope(cellId, varId, dim) = 0.0;
      }
    }
  }
 
  for(MInt cellId = 0; cellId < coarse.noInternalCells(); cellId++) {
    for(MInt varId = 0; varId < noVars; varId++) {
      // Reset restricted variables on next coarser level
      coarse.a_restrictedVar(cellId, varId) = 0.0;
      for(MInt dim = 0; dim < nDim; dim++) {
        // ... and slopes (of conservative variables)
        coarse.a_storedSlope(cellId, varId, dim) = 0.0;
      }
    }
  }
}

◆ startTimer()

template<MInt nDim, class SysEqn >

MBool CouplerFvMultilevel< nDim, SysEqn >::startTimer ( const MString & name )

Definition at line 62 of file couplerfvmultilevel.cpp.

                                                                       {
  if(name.empty()) {
    TERMM(1, "Empty timer name");
  }
  RECORD_TIMER_START(timer(name));
  return true;
}

◆ stopTimer()

template<MInt nDim, class SysEqn >

MBool CouplerFvMultilevel< nDim, SysEqn >::stopTimer ( const MString & name )

Definition at line 63 of file couplerfvmultilevel.cpp.

                                                                      {
  if(name.empty()) {
    TERMM(1, "Empty timer name");
  }
  RECORD_TIMER_STOP(timer(name));
  return true;
}

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/couplerfvmultilevel.h
/home/gitlab-runner/scratch/builds/oxpnswJ6/1/aia/m-AIA/m-AIA/src/COUPLER/couplerfvmultilevel.cpp

Public Types

Public Member Functions

Private Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Base

◆ BaseCoupler

◆ BaseFv

Constructor & Destructor Documentation

◆ CouplerFvMultilevelInterpolation()

◆ ~CouplerFvMultilevelInterpolation()

Member Function Documentation

◆ fvSolver()

◆ noSolvers()

◆ postCouple()

◆ prolongation()

◆ reset()

◆ startTimer()

◆ stopTimer()