MobilityEdgeStochastic< FP > Class Template Reference

CPP API: mio::MobilityEdgeStochastic< FP > Class Template Reference
mio::MobilityEdgeStochastic< FP > Class Template Reference

represents the mobility between two nodes. More...

#include <metapopulation_mobility_stochastic.h>

Public Member Functions

template<class Sim >
void apply_mobility (size_t event, SimulationNode< FP, Sim > &node_from, SimulationNode< FP, Sim > &node_to)
 compute mobility from node_from to node_to for a given event More...
 
const MobilityParametersStochastic< FP > & get_parameters () const
 get the mobility parameters. More...
 
template<class Sim >
Eigen::VectorX< FP > get_transition_rates (SimulationNode< FP, Sim > &node_from)
 get the cumulative transition rate of the edge. More...
 
 MobilityEdgeStochastic (const Eigen::VectorX< FP > &coeffs)
 create edge with coefficients. More...
 
 MobilityEdgeStochastic (const MobilityParametersStochastic< FP > &params)
 create edge with coefficients. More...
 

Private Attributes

MobilityParametersStochastic< FP > m_parameters
 

Detailed Description

template<typename FP>
class mio::MobilityEdgeStochastic< FP >

represents the mobility between two nodes.

Constructor & Destructor Documentation

◆ MobilityEdgeStochastic() [1/2]

template<typename FP >
mio::MobilityEdgeStochastic< FP >::MobilityEdgeStochastic ( const MobilityParametersStochastic< FP > &  params)
inline

create edge with coefficients.

Parameters
coeffsmobility rate for each group and compartment

◆ MobilityEdgeStochastic() [2/2]

template<typename FP >
mio::MobilityEdgeStochastic< FP >::MobilityEdgeStochastic ( const Eigen::VectorX< FP > &  coeffs)
inline

create edge with coefficients.

Parameters
coeffsmobility rate for each group and compartment

Member Function Documentation

◆ apply_mobility()

template<typename FP >
template<class Sim >
void mio::MobilityEdgeStochastic< FP >::apply_mobility ( size_t  event,
SimulationNode< FP, Sim > &  node_from,
SimulationNode< FP, Sim > &  node_to 
)

compute mobility from node_from to node_to for a given event

Parameters
[in]eventindex specifying which compartment and age group change nodes
node_fromnode that people changed from
node_tonode that people changed to

◆ get_parameters()

template<typename FP >
const MobilityParametersStochastic<FP>& mio::MobilityEdgeStochastic< FP >::get_parameters ( ) const
inline

get the mobility parameters.

◆ get_transition_rates()

template<typename FP >
template<class Sim >
Eigen::VectorX<FP> mio::MobilityEdgeStochastic< FP >::get_transition_rates ( SimulationNode< FP, Sim > &  node_from)
inline

get the cumulative transition rate of the edge.

Member Data Documentation

◆ m_parameters

template<typename FP >
MobilityParametersStochastic<FP> mio::MobilityEdgeStochastic< FP >::m_parameters
private