#include <executionrecipe.h>

Inheritance diagram for ExecutionRecipeIntraStepCoupling:

Collaboration diagram for ExecutionRecipeIntraStepCoupling:

Public Member Functions
	ExecutionRecipeIntraStepCoupling (std::vector< std::unique_ptr< Solver > > const solvers, std::vector< std::unique_ptr< Coupling > > const couplers)

MBool	updateCallOrder () override

void	timeStep () override
	: Single solver time step function. Calls solutionStep() of the specific solver More...

Public Member Functions inherited from ExecutionRecipe
	ExecutionRecipe (std::vector< std::unique_ptr< Solver > > const solvers, std::vector< std::unique_ptr< Coupling > > const couplers)

virtual void	preTimeStep () final
	: Calls each solvers preTimeStep - might be empty More...

virtual void	timeStep ()
	: Single solver time step function. Calls solutionStep() of the specific solver More...

virtual void	postTimeStep () final
	: Calls each solvers postTimeStep - might be empty More...

virtual void	preCouple () final
	: Calls each couplers preCouple - might be empty More...

virtual void	postCouple () final
	: Calls each couplers postCouple - might be empty More...

virtual MBool	updateCallOrder ()

MInt	a_step () const

MInt &	a_step ()

MBool	callAdaptation () const

Additional Inherited Members
Protected Member Functions inherited from ExecutionRecipe
void	readCallOrder ()
	: Reads the call order of solvers, couplers and adaptation More...

void	initFunctionPointers ()
	: Initialize the vector containing function pointers to preTimeStep, solutionStep and postTimestep as well as preCouple, subCouple and postCouple. All are set active. More...

void	setSolverStatus (MInt, MBool)
	: Wrapper function to set solvers active or idle More...

void	setCouplerStatus (const MInt couplerId, const MBool active)
	: Wrapper function to set couplers active or empty More...

MInt	noSolvers () const

MInt	noCouplers () const

void	nextStep ()

MBool	solverOrder (const MInt solverId) const

MBool	couplerOrder (const MInt couplerId) const

void	setAdaptation ()

MInt	maxNoSteps () const

MBool	solutionStep (const MInt solverId)

void	preSolutionStep (const MInt solverId, const MInt mode)

MBool	postSolutionStep (const MInt solverId)

void	subCouple (const MInt couplerId, const MInt step, const MInt solverId, std::vector< MBool > &solverCompleted)

const std::vector< std::unique_ptr< Solver > > *	a_solvers () const

const std::vector< std::unique_ptr< Coupling > > *	a_couplers () const

MInt	swapedSolverId (const MInt oldSolverId)

void	startLoadTimer (const MInt solverId)

void	stopLoadTimer (const MInt solverId)

MBool	solverIsActive (const MInt solverId)

Protected Attributes inherited from ExecutionRecipe
MInt	m_maxSolutionIteration = 1

std::map< MInt, MInt >	m_swapSolverIds {}

Detailed Description

Recipe for any number of solvers/couplers, where the couplers (if any) are executed once after each solver's substep.

Definition at line 424 of file executionrecipe.h.

Constructor & Destructor Documentation

◆ ExecutionRecipeIntraStepCoupling()

ExecutionRecipeIntraStepCoupling::ExecutionRecipeIntraStepCoupling	(	std::vector< std::unique_ptr< Solver > > *const	solvers,
		std::vector< std::unique_ptr< Coupling > > *const	couplers
	)

inline

Definition at line 426 of file executionrecipe.h.

    : ExecutionRecipe(solvers, couplers) {
    // This function initializes function pointers to the preTimeStep, solutionStep
    // and postTimeStep functions of each solver
    initFunctionPointers();
 
    // Read the callOrder from the propertiesFile
    readCallOrder();
  }

Member Function Documentation

◆ timeStep()

void ExecutionRecipeIntraStepCoupling::timeStep ( )

inlineoverridevirtual

Author: Thomas Hoesgen

Date: 01/2020

Reimplemented from ExecutionRecipe.

Definition at line 467 of file executionrecipe.h.

                           {
    TRACE();
 
    MBool completed = false;
    // Store solver completed status to allow solvers to have different number of RK steps, i.e.,
    // skip solutionStep of a solver that is already finished
    std::vector<MBool> solverCompleted(noSolvers(), false);
 
    while(!completed) {
      // Exit once all solvers are completed.
      completed = true;
 
      // Intermediate loop over all solvers
      for(auto&& solver : *a_solvers()) {
        const MInt solverId = m_swapSolverIds.empty() ? solver->solverId() : swapedSolverId(solver->solverId());
 
        // Solver is active on this domain (has cells) and has not already completed its current
        // solution step, i.e., all RK stages
        if(solverIsActive(solverId) && !solverCompleted[solverId]) {
          // Call solver specific solutionStep() - solvers might be idle (in this step)
          startLoadTimer(solverId);
          solverCompleted[solverId] = solutionStep(solverId);
          stopLoadTimer(solverId);
        }
 
        // Inner-most loop over all couplers
        // Each couplers subCouple() is executed after each solvers solutionStep()
        // Couplers can, however, be disabled via the callOrder
        for(auto&& coupler : *a_couplers()) {
          coupler->startLoadTimer(AT_);
          subCouple(coupler->couplerId(), a_step(), solverId, solverCompleted);
          coupler->stopLoadTimer(AT_);
        }
        if(solverIsActive(solverId) && !solverCompleted[solverId]) {
          completed &= solverCompleted[solverId];
        }
      }
    }
  };

◆ updateCallOrder()

MBool ExecutionRecipeIntraStepCoupling::updateCallOrder ( )

inlineoverridevirtual

Reimplemented from ExecutionRecipe.

Definition at line 442 of file executionrecipe.h.

                                   {
    MBool advanceTimeStep = false;
 
    nextStep();
 
    if(a_step() == maxNoSteps()) {
      a_step() = 0;
      advanceTimeStep = true;
    }
 
 
    for(MInt solver = 0; solver < noSolvers(); solver++) {
      setSolverStatus(solver, solverOrder(solver));
    }
 
    for(MInt cpl = 0; cpl < noCouplers(); cpl++) {
      setCouplerStatus(cpl, couplerOrder(cpl));
    }
 
    setAdaptation();
 
    return advanceTimeStep;
  }

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

/home/gitlab-runner/scratch/builds/oxpnswJ6/1/aia/m-AIA/m-AIA/src/executionrecipe.h