Model< FP > Class Template Reference

CPP API: mio::oseair::Model< FP > Class Template Reference
mio::oseair::Model< FP > Class Template Reference

#include <model.h>

Inheritance diagram for mio::oseair::Model< FP >:
Collaboration diagram for mio::oseair::Model< FP >:

Public Member Functions

void get_derivatives (Eigen::Ref< const Eigen::VectorX< FP >> pop, Eigen::Ref< const Eigen::VectorX< FP >> y, FP, Eigen::Ref< Eigen::VectorX< FP >> dydt) const override
 
 Model ()
 
- Public Member Functions inherited from mio::CompartmentalModel< FP, InfectionState, mio::Populations< FP, InfectionState >, Parameters< FP > >
bool apply_constraints ()
 Checks whether the model satisfies all constraints. More...
 
bool check_constraints () const
 Checks that the model satisfies all constraints (e.g. More...
 
 CompartmentalModel (CompartmentalModel &&)=default
 
 CompartmentalModel (const CompartmentalModel &)=default
 
 CompartmentalModel (Populations const &po, ParameterSet const &pa)
 CompartmentalModel default constructor. More...
 
void eval_right_hand_side (Eigen::Ref< const Eigen::VectorX< FP >> pop, Eigen::Ref< const Eigen::VectorX< FP >> y, FP t, Eigen::Ref< Eigen::VectorX< FP >> dydt) const
 This function evaluates the right-hand-side f of the ODE dydt = f(y, t). More...
 
Eigen::VectorX< FP > get_initial_values () const
 Get the initial conditions for the ODE dydt = f(y, t). More...
 
CompartmentalModeloperator= (CompartmentalModel &&)=default
 
CompartmentalModeloperator= (const CompartmentalModel &)=default
 
virtual ~CompartmentalModel ()=default
 

Private Types

using Base = mio::CompartmentalModel< FP, InfectionState, mio::Populations< FP, InfectionState >, Parameters< FP > >
 

Additional Inherited Members

- Public Types inherited from mio::CompartmentalModel< FP, InfectionState, mio::Populations< FP, InfectionState >, Parameters< FP > >
using Compartments = InfectionState
 
using ParameterSet = Parameters< FP >
 
using Populations = mio::Populations< FP, InfectionState >
 
- Public Attributes inherited from mio::CompartmentalModel< FP, InfectionState, mio::Populations< FP, InfectionState >, Parameters< FP > >
ParameterSet parameters
 
Populations populations
 

Member Typedef Documentation

◆ Base

template<typename FP >
using mio::oseair::Model< FP >::Base = mio::CompartmentalModel<FP, InfectionState, mio::Populations<FP, InfectionState>, Parameters<FP> >
private

Constructor & Destructor Documentation

◆ Model()

template<typename FP >
mio::oseair::Model< FP >::Model ( )
inline

Member Function Documentation

◆ get_derivatives()

template<typename FP >
void mio::oseair::Model< FP >::get_derivatives ( Eigen::Ref< const Eigen::VectorX< FP >>  pop,
Eigen::Ref< const Eigen::VectorX< FP >>  y,
FP  ,
Eigen::Ref< Eigen::VectorX< FP >>  dydt 
) const
inlineoverridevirtual