SimulationNode< FP, Sim > Class Template Reference

CPP API: mio::SimulationNode< FP, Sim > Class Template Reference
mio::SimulationNode< FP, Sim > Class Template Reference

represents the simulation in one node of the graph. More...

#include <metapopulation_mobility_instant.h>

Public Types

using Simulation = Sim
 

Public Member Functions

void advance (FP t, FP dt)
 
Eigen::Ref< const Eigen::VectorX< FP > > get_last_state () const
 
FP get_t0 () const
 
template<class... Args>
requires std::is_constructible_v< Sim, Args... > SimulationNode (Args &&... args)
 
decltype(auto) get_result () const
 get the result of the simulation in this node. More...
 
decltype(auto) get_result ()
 get the result of the simulation in this node. More...
 
Sim & get_simulation ()
 get the the simulation in this node. More...
 
const Sim & get_simulation () const
 get the the simulation in this node. More...
 

Private Attributes

Eigen::VectorX< FP > m_last_state
 
Sim m_simulation
 
FP m_t0
 

Detailed Description

template<typename FP, class Sim>
class mio::SimulationNode< FP, Sim >

represents the simulation in one node of the graph.

Member Typedef Documentation

◆ Simulation

template<typename FP , class Sim >
using mio::SimulationNode< FP, Sim >::Simulation = Sim

Constructor & Destructor Documentation

◆ SimulationNode()

template<typename FP , class Sim >
template<class... Args>
requires std::is_constructible_v<Sim, Args...> mio::SimulationNode< FP, Sim >::SimulationNode ( Args &&...  args)
inline

Member Function Documentation

◆ advance()

template<typename FP , class Sim >
void mio::SimulationNode< FP, Sim >::advance ( FP  t,
FP  dt 
)
inline

◆ get_last_state()

template<typename FP , class Sim >
Eigen::Ref<const Eigen::VectorX<FP> > mio::SimulationNode< FP, Sim >::get_last_state ( ) const
inline

◆ get_result() [1/2]

template<typename FP , class Sim >
decltype(auto) mio::SimulationNode< FP, Sim >::get_result ( )
inline

get the result of the simulation in this node.

◆ get_result() [2/2]

template<typename FP , class Sim >
decltype(auto) mio::SimulationNode< FP, Sim >::get_result ( ) const
inline

get the result of the simulation in this node.

◆ get_simulation() [1/2]

template<typename FP , class Sim >
Sim& mio::SimulationNode< FP, Sim >::get_simulation ( )
inline

get the the simulation in this node.

◆ get_simulation() [2/2]

template<typename FP , class Sim >
const Sim& mio::SimulationNode< FP, Sim >::get_simulation ( ) const
inline

get the the simulation in this node.

◆ get_t0()

template<typename FP , class Sim >
FP mio::SimulationNode< FP, Sim >::get_t0 ( ) const
inline

Member Data Documentation

◆ m_last_state

template<typename FP , class Sim >
Eigen::VectorX<FP> mio::SimulationNode< FP, Sim >::m_last_state
private

◆ m_simulation

template<typename FP , class Sim >
Sim mio::SimulationNode< FP, Sim >::m_simulation
private

◆ m_t0

template<typename FP , class Sim >
FP mio::SimulationNode< FP, Sim >::m_t0
private