models/abm/simulation.h

Go to the documentation of this file.

/* 
* Copyright (C) 2020-2026 MEmilio
*
* Authors: Daniel Abele, Khoa Nguyen
*
* 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_ABM_SIMULATION_H
#define MIO_ABM_SIMULATION_H
 
#include "abm/model.h"
#include "abm/time.h"
#include "memilio/io/history.h"
 
namespace mio
{
namespace abm
{
 
template <class M = Model>
class Simulation
{
public:
    using Model = M;
 
    Simulation(TimePoint t0, Model&& model)
        : m_model(std::move(model))
        , m_t(t0)
        , m_dt(hours(1))
    {
    }
 
    Simulation(TimePoint t0, size_t num_agegroups)
        : Simulation(t0, M(num_agegroups))
    {
    }
 
    template <typename... History>
    void advance(TimePoint tmax, History&... history)
    {
        //log initial system state
        (history.log(*this), ...);
        while (m_t < tmax) {
            evolve_model(tmax);
            (history.log(*this), ...);
        }
    }
 
    TimePoint get_time() const
    {
        return m_t;
    }
 
    Model& get_model()
    {
        return m_model;
    }
    const Model& get_model() const
    {
        return m_model;
    }
 
private:
    void store_result_at(TimePoint t);
    void evolve_model(TimePoint tmax)
    {
        auto dt = std::min(m_dt, tmax - m_t);
        m_model.evolve(m_t, dt);
        m_t += m_dt;
    }
 
    Model m_model; 
    TimePoint m_t; 
    TimeSpan m_dt; 
};
 
} // namespace abm
} // namespace mio
 
#endif