CoupledSim.h

Go to the documentation of this file.

#ifndef COUPLED_SIM_H_INCLUDED
#define COUPLED_SIM_H_INCLUDED
/*
 * Copyright 2011-2016 Universiteit Antwerpen
 *
 * Licensed under the EUPL, Version 1.1 or  as soon they will be approved by
 * the European Commission - subsequent versions of the EUPL (the "Licence");
 * You may not use this work except in compliance with the Licence.
 * You may obtain a copy of the Licence at: http://ec.europa.eu/idabc/eupl5
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the Licence is distributed on an "AS IS" basis,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the Licence for the specific language governing
 * permissions and limitations under the Licence.
 */
#include "CoreData.h"
#include "event/CoupledSimEvent.h"
#include "sim/Sim.h"
#include "SimInterface.h"

#include "util/clock_man/Timeable.h"
#include "util/misc/Subject.h"

#include <boost/property_tree/ptree.hpp>
#include <string>
#include <unordered_map>
#include <vector>

namespace SimPT_Sim {

class ICoupler;

class CoupledSim : public SimPT_Sim::SimInterface,
                   public SimPT_Sim::Util::Subject<SimPT_Sim::Event::CoupledSimEvent, std::weak_ptr<const void>>,
                   public std::enable_shared_from_this<CoupledSim>
{
public:
        CoupledSim();

        virtual ~CoupledSim() {}

        CoreData& GetCoreData() override final { return m_cd; }

        const boost::property_tree::ptree& GetParameters() const;

        std::string GetProjectName() const;

        std::string GetRunDate() const;

        int GetSimStep() const;

        Timings GetTimings() const;

        void IncrementStepCount() { ++m_sim_step; }

        void Initialize(const boost::property_tree::ptree& pt,
                const std::vector<std::shared_ptr<Sim>>& simulators);

        bool IsAtTermination() const;

        bool IsStationary() const;

        void Reinitialize(const boost::property_tree::ptree& parameters);

        void TimeStep();

private:
        std::unordered_map<std::string, std::shared_ptr<Sim>>  m_simulators;    
        std::vector<std::shared_ptr<ICoupler>>                 m_couplers;      
        CoreData                                               m_cd;            
        std::string                                            m_project_name;  
        std::string                                            m_run_date;      
        unsigned int                                           m_sim_step;      
        unsigned int                                           m_sim_ODE_steps; 
        Timings                                                m_timings;       
};

} // namespace

#endif // end_of_include_guard