simulation_base.h

Go to the documentation of this file.

/* 
* Copyright (C) 2020-2026 MEmilio
*
* Authors: Jan Kleinert, Daniel Abele, Rene Schmieding
*
* 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_COMPARTMENTS_SIMULATION_BASE_H
#define MIO_COMPARTMENTS_SIMULATION_BASE_H
 
#include "memilio/compartments/compartmental_model.h"
#include "memilio/math/integrator.h"
#include "memilio/utils/time_series.h"
 
namespace mio
{
namespace details
{
 
template <typename FP, IsCompartmentalModel<FP> M, class... Integrands>
class SimulationBase
{
 
public:
    using Model = M;
    using Core  = IntegratorCore<FP, Integrands...>;
 
    SimulationBase(Model const& model, std::unique_ptr<Core>&& integrator_core, FP t0, FP dt)
        : m_model(std::make_unique<Model>(model))
        , m_integrator(std::move(integrator_core))
        , m_result(t0, m_model->get_initial_values())
        , m_dt(dt)
    {
    }
 
    SimulationBase(const SimulationBase& other)
        : m_model(std::make_unique<Model>(*other.m_model))
        , m_integrator(other.m_integrator)
        , m_result(other.m_result)
        , m_dt(other.m_dt)
    {
    }
 
    SimulationBase& operator=(const SimulationBase& other)
    {
        if (this != &other) {
            m_model      = std::make_unique<Model>(*other.m_model);
            m_integrator = other.m_integrator;
            m_result     = other.m_result;
            m_dt         = other.m_dt;
        }
        return *this;
    }
 
    void set_integrator_core(std::unique_ptr<Core>&& integrator_core)
    {
        m_integrator.set_integrator_core(std::move(integrator_core));
    }
 
    Core& get_integrator_core()
    {
        return m_integrator.get_integrator_core();
    }
    const Core& get_integrator_core() const
    {
        return m_integrator.get_integrator_core();
    }
    TimeSeries<FP>& get_result()
    {
        return m_result;
    }
    const TimeSeries<FP>& get_result() const
    {
        return m_result;
    }
    const Model& get_model() const
    {
        return *m_model;
    }
    Model& get_model()
    {
        return *m_model;
    }
    FP& get_dt()
    {
        return m_dt;
    }
    const FP& get_dt() const
    {
        return m_dt;
    }
protected:
    Eigen::Ref<Eigen::VectorX<FP>> advance(const Integrands&... fs, FP tmax, TimeSeries<FP>& results)
    {
        return m_integrator.advance(fs..., tmax, m_dt, results);
    }
 
private:
    std::unique_ptr<Model> m_model; 
    SystemIntegrator<FP, Integrands...>
        m_integrator; 
    TimeSeries<FP> m_result; 
    FP m_dt; 
};
 
template <typename FP, class M, class... Integrands>
class SimulationBase<FP, M, SystemIntegrator<FP, Integrands...>> : public SimulationBase<FP, M, Integrands...>
{
    using SimulationBase<FP, M, Integrands...>::SimulationBase;
};
 
} // namespace details
} // namespace mio
 
#endif // MIO_COMPARTMENTS_SIMULATION_BASE_H