mio::omseirs4::Model< FP > Class Template Reference

#include <model.h>

Inheritance diagram for mio::omseirs4::Model< FP >:

Collaboration diagram for mio::omseirs4::Model< FP >:

Public Member Functions
void	get_derivatives (Eigen::Ref< const Eigen::VectorX< FP >> pop, Eigen::Ref< const Eigen::VectorX< FP >> y, FP t, Eigen::Ref< Eigen::VectorX< FP >> dydt) const override
	Model ()
	Model (const Populations &pop, const ParameterSet &params)
template<class IOContext >
void	serialize (IOContext &io) const
	serialize this. More...
Public Member Functions inherited from mio::CompartmentalModel< ScalarType, InfectionState, mio::Populations< ScalarType, InfectionState >, Parameters< ScalarType > >
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< ScalarType >> pop, Eigen::Ref< const Eigen::VectorX< ScalarType >> y, ScalarType t, Eigen::Ref< Eigen::VectorX< ScalarType >> dydt) const
	This function evaluates the right-hand-side f of the ODE dydt = f(y, t). More...
virtual void	get_derivatives (Eigen::Ref< const Eigen::VectorX< ScalarType >>, Eigen::Ref< const Eigen::VectorX< ScalarType >>, ScalarType, Eigen::Ref< Eigen::VectorX< ScalarType >>) const
Eigen::VectorX< ScalarType >	get_initial_values () const
	Get the initial conditions for the ODE dydt = f(y, t). More...
CompartmentalModel &	operator= (CompartmentalModel &&)=default
CompartmentalModel &	operator= (const CompartmentalModel &)=default
virtual	~CompartmentalModel ()=default

Static Public Member Functions
template<class IOContext >
static IOResult< Model >	deserialize (IOContext &io)
	deserialize an object of this class. More...

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

Additional Inherited Members
Public Types inherited from mio::CompartmentalModel< ScalarType, InfectionState, mio::Populations< ScalarType, InfectionState >, Parameters< ScalarType > >
using	Compartments = InfectionState
using	ParameterSet = Parameters< ScalarType >
using	Populations = mio::Populations< ScalarType, InfectionState >
Public Attributes inherited from mio::CompartmentalModel< ScalarType, InfectionState, mio::Populations< ScalarType, InfectionState >, Parameters< ScalarType > >
ParameterSet	parameters
Populations	populations

Member Typedef Documentation

Base

template<typename FP = ScalarType>

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

private

Constructor & Destructor Documentation

Model() [1/2]

template<typename FP = ScalarType>

mio::omseirs4::Model< FP >::Model ( const Populations &  pop, const ParameterSet &  params  )

inline

Model() [2/2]

template<typename FP = ScalarType>

mio::omseirs4::Model< FP >::Model ( )

inline

Member Function Documentation

deserialize()

template<typename FP = ScalarType>

template<class IOContext >

static IOResult<Model> mio::omseirs4::Model< FP >::deserialize ( IOContext &  io )

inlinestatic

deserialize an object of this class.

See also

mio::deserialize

get_derivatives()

template<typename FP = ScalarType>

void mio::omseirs4::Model< FP >::get_derivatives ( Eigen::Ref< const Eigen::VectorX< FP >>  pop, Eigen::Ref< const Eigen::VectorX< FP >>  y, FP  t, Eigen::Ref< Eigen::VectorX< FP >>  dydt  ) const

inlineoverride

serialize()

template<typename FP = ScalarType>

template<class IOContext >

void mio::omseirs4::Model< FP >::serialize ( IOContext &  io ) const

inline

serialize this.

See also

mio::serialize