Utopia::Models::SEIRD::ImmunityContParams Struct Reference

Parameters specifying the immunity control. More...

#include <params.hh>

Public Types
using	TimesQueue = std::queue< std::size_t >
	Type of the times queue.
using	TimesValuesQueue = std::queue< std::pair< std::size_t, double > >
	The type of the change p_immune pairs.

Public Member Functions
	ImmunityContParams (const DataIO::Config &cfg)
	Configuration constructor.

Public Attributes
const bool	enabled
	Whether immunity control is enabled.
const std::size_t	num_additional_immunities
	The number of immunities added to the default p_expose.
TimesQueue	at_times
	Add additional immunities at these time steps.
TimesValuesQueue	change_p_immune
	Change p_immune to new value at given times.

Detailed Description

Parameters specifying the immunity control.

Member Typedef Documentation

TimesQueue

using Utopia::Models::SEIRD::ImmunityContParams::TimesQueue = std::queue<std::size_t>

Type of the times queue.

TimesValuesQueue

using Utopia::Models::SEIRD::ImmunityContParams::TimesValuesQueue = std::queue<std::pair<std::size_t, double> >

The type of the change p_immune pairs.

Constructor & Destructor Documentation

ImmunityContParams()

Utopia::Models::SEIRD::ImmunityContParams::ImmunityContParams ( const DataIO::Config &  cfg )

inline

Configuration constructor.

Construct an ImmunityContParams object with required parameters being extracted from a configuration node with the same parameter names.

                                                :
        enabled(get_as<bool>("enabled", cfg)),
        num_additional_immunities {
            get_as<std::size_t>("num_additional_immunities", cfg, 0)},
        at_times {[&]() {
            auto cont = get_as<std::vector<std::size_t>>("at_times", cfg, {});
 
            std::sort(cont.begin(), cont.end());
 
            // Copy elements into the queue
            TimesQueue q {};
            for (const auto& v : cont) {
                q.push(v);
            }
 
            return q;
        }()},
        change_p_immune {[&]() {
            // Check the parameter
            if (not cfg["change_p_immune"] or
                not cfg["change_p_immune"].size()) {
                // Key did not exist or was empty; return empty queue.
                return TimesValuesQueue {};
            }
            else if (not cfg["change_p_immune"].IsSequence()) {
                // Inform about bad type of the given configuration entry
                throw std::invalid_argument(
                    "Parameter change_p_immune need be "
                    "a sequence of pairs, but was not! Given infection control "
                    "parameters:\n" +
                    DataIO::to_string(cfg));
            }
 
            auto cont = get_as<std::vector<std::pair<std::size_t, double>>>(
                "change_p_immune",
                cfg);
 
            // Sort such that low times are in the beginning of the queue
            std::sort(cont.begin(),
                      cont.end(),
                      [](const auto& a, const auto& b) {
                          return a.first < b.first;
                      });
 
            // Copy elements into the queue
            TimesValuesQueue q {};
            for (const auto& v : cont) {
                q.push(v);
            }
 
            return q;
        }()} {};

Member Data Documentation

at_times

TimesQueue Utopia::Models::SEIRD::ImmunityContParams::at_times

mutable

Add additional immunities at these time steps.

change_p_immune

TimesValuesQueue Utopia::Models::SEIRD::ImmunityContParams::change_p_immune

mutable

Change p_immune to new value at given times.

Each element of this container provides a pair of [time, new_value]. If the iteration step (time) of the simulation is reached p_immune is set to new_value

enabled

const bool Utopia::Models::SEIRD::ImmunityContParams::enabled

Whether immunity control is enabled.

num_additional_immunities

const std::size_t Utopia::Models::SEIRD::ImmunityContParams::num_additional_immunities

The number of immunities added to the default p_expose.

---

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

• src/utopia/models/SEIRD/params.hh