sde_sirs/parameters.h

Go to the documentation of this file.

/*
* Copyright (C) 2020-2026 MEmilio
*
* Authors: Nils Wassmuth, Rene Schmieding, Martin J. Kuehn
*
* Contact: Martin J. Kuehn <Martin.Kuehn@DLR.de>
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
*     http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
 
#ifndef MIO_SDE_SIRS_PARAMETERS_H
#define MIO_SDE_SIRS_PARAMETERS_H
 
#include "memilio/utils/uncertain_value.h"
#include "memilio/epidemiology/contact_matrix.h"
#include "memilio/utils/parameter_set.h"
 
namespace mio
{
namespace ssirs
{
 
/***************************************
 * Define Parameters of the SIRS model *
 ***************************************/
 
template <typename FP>
struct TransmissionProbabilityOnContact {
    using Type = UncertainValue<FP>;
    static Type get_default()
    {
        return Type(1.0);
    }
    static std::string name()
    {
        return "TransmissionProbabilityOnContact";
    }
};
 
template <typename FP>
struct TimeInfected {
    using Type = UncertainValue<FP>;
    static Type get_default()
    {
        return Type(6.0);
    }
    static std::string name()
    {
        return "TimeInfected";
    }
};
 
template <typename FP>
struct TimeImmune {
    using Type = UncertainValue<FP>;
    static Type get_default()
    {
        return Type(6.0);
    }
    static std::string name()
    {
        return "TimeImmune";
    }
};
 
template <typename FP>
struct ContactPatterns {
    using Type = ContactMatrix<FP>;
    static Type get_default()
    {
        return Type{1};
    }
    static std::string name()
    {
        return "ContactPatterns";
    }
};
 
template <typename FP>
struct StartDay {
    using Type = FP;
    static Type get_default()
    {
        return Type(0.0);
    }
    static std::string name()
    {
        return "StartDay";
    }
};
 
template <typename FP>
struct Seasonality {
    using Type = UncertainValue<FP>;
    static Type get_default()
    {
        return Type(0.);
    }
    static std::string name()
    {
        return "Seasonality";
    }
};
 
template <typename FP>
using ParametersBase = ParameterSet<TransmissionProbabilityOnContact<FP>, TimeInfected<FP>, ContactPatterns<FP>,
                                    TimeImmune<FP>, Seasonality<FP>, StartDay<FP>>;
 
template <typename FP>
class Parameters : public ParametersBase<FP>
{
public:
    Parameters()
        : ParametersBase<FP>()
    {
    }
 
    bool apply_constraints()
    {
        FP tol_times = 1e-1;
 
        int corrected = false;
        if (this->template get<Seasonality<FP>>() < 0.0 || this->template get<Seasonality<FP>>() > 0.5) {
            log_warning("Constraint check: Parameter Seasonality changed from {} to {}",
                        this->template get<Seasonality<FP>>(), 0);
            this->template set<Seasonality<FP>>(0);
            corrected = true;
        }
        if (this->template get<TimeInfected<FP>>() < tol_times) {
            log_warning("Constraint check: Parameter TimeInfected changed from {} to {}. Please note that "
                        "unreasonably small compartment stays lead to massively increased run time. Consider to cancel "
                        "and reset parameters.",
                        this->template get<TimeInfected<FP>>(), tol_times);
            this->template get<TimeInfected<FP>>() = tol_times;
            corrected                              = true;
        }
        if (this->template get<TimeImmune<FP>>() < tol_times) {
            log_warning("Constraint check: Parameter TimeInfected changed from {} to {}. Please note that "
                        "unreasonably small compartment stays lead to massively increased run time. Consider to cancel "
                        "and reset parameters.",
                        this->template get<TimeImmune<FP>>(), tol_times);
            this->template get<TimeImmune<FP>>() = tol_times;
            corrected                            = true;
        }
        if (this->template get<TransmissionProbabilityOnContact<FP>>() < 0.0 ||
            this->template get<TransmissionProbabilityOnContact<FP>>() > 1.0) {
            log_warning("Constraint check: Parameter TransmissionProbabilityOnContact changed from {} to {} ",
                        this->template get<TransmissionProbabilityOnContact<FP>>(), 0.0);
            this->template get<TransmissionProbabilityOnContact<FP>>() = 0.0;
            corrected                                                  = true;
        }
        return corrected;
    }
 
    bool check_constraints() const
    {
        FP tol_times = 1e-1;
 
        if (this->template get<Seasonality<FP>>() < 0.0 || this->template get<Seasonality<FP>>() > 0.5) {
            log_error("Constraint check: Parameter Seasonality smaller {} or larger {:4f}", 0, 0.5);
            return true;
        }
        if (this->template get<TimeInfected<FP>>() < tol_times) {
            log_error("Constraint check: Parameter TimeInfected {} smaller or equal {}. Please note that "
                      "unreasonably small compartment stays lead to massively increased run time. Consider to cancel "
                      "and reset parameters.",
                      this->template get<TimeInfected<FP>>(), 0.0);
            return true;
        }
        if (this->template get<TimeImmune<FP>>() < tol_times) {
            log_error("Constraint check: Parameter TimeInfected {} smaller or equal {}. Please note that "
                      "unreasonably small compartment stays lead to massively increased run time. Consider to cancel "
                      "and reset parameters.",
                      this->template get<TimeImmune<FP>>(), 0.0);
            return true;
        }
        if (this->template get<TransmissionProbabilityOnContact<FP>>() < 0.0 ||
            this->template get<TransmissionProbabilityOnContact<FP>>() > 1.0) {
            log_error("Constraint check: Parameter TransmissionProbabilityOnContact {} smaller {} or greater {}",
                      this->template get<TransmissionProbabilityOnContact<FP>>(), 0.0, 1.0);
            return true;
        }
        return false;
    }
 
private:
    Parameters(ParametersBase<FP>&& base)
        : ParametersBase<FP>(std::move(base))
    {
    }
 
public:
    template <class IOContext>
    static IOResult<Parameters> deserialize(IOContext& io)
    {
        BOOST_OUTCOME_TRY(auto&& base, ParametersBase<FP>::deserialize(io));
        return success(Parameters(std::move(base)));
    }
};
 
} // namespace ssirs
} // namespace mio
 
#endif // MIO_SDE_SIRS_PARAMETERS_H