Simulation.h 3.81 KB
Newer Older
1
/**
Ulrich Kemloh's avatar
Ulrich Kemloh committed
2 3
 * \file        Simulation.h
 * \date        Dec 15, 2010
4
 * \version     v0.6
5
 * \copyright   <2009-2014> Forschungszentrum J?lich GmbH. All rights reserved.
6
 *
Ulrich Kemloh's avatar
Ulrich Kemloh committed
7
 * \section License
8 9 10
 * This file is part of JuPedSim.
 *
 * JuPedSim is free software: you can redistribute it and/or modify
11
 * it under the terms of the GNU Lesser General Public License as published by
12 13 14 15 16 17 18 19
 * the Free Software Foundation, either version 3 of the License, or
 * any later version.
 *
 * JuPedSim is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
20
 * You should have received a copy of the GNU Lesser General Public License
21 22
 * along with JuPedSim. If not, see <http://www.gnu.org/licenses/>.
 *
Ulrich Kemloh's avatar
Ulrich Kemloh committed
23
 * \section Description
24 25 26 27
 * The Simulation class represents a simulation of pedestrians
 * based on a certain model in a specific scenario. A simulation is defined by
 * various parameters and functions.
 *
Ulrich Kemloh's avatar
Ulrich Kemloh committed
28 29 30 31
 *
 **/


Ulrich Kemloh's avatar
Ulrich Kemloh committed
32 33 34 35

#ifndef SIMULATION_H_
#define SIMULATION_H_

36

Ulrich Kemloh's avatar
Ulrich Kemloh committed
37 38
#include "general/ArgumentParser.h"
#include "geometry/Building.h"
Ulrich Kemloh's avatar
Ulrich Kemloh committed
39
#include "geometry/SubRoom.h"
Ulrich Kemloh's avatar
Ulrich Kemloh committed
40 41
#include "IO/OutputHandler.h"
#include "IO/IODispatcher.h"
42
#include "math/OperationalModel.h"
Ulrich Kemloh's avatar
Ulrich Kemloh committed
43 44 45 46
#include "math/ODESolver.h"
#include "routing/GlobalRouter.h"
#include "routing/QuickestPathRouter.h"
#include "routing/DirectionStrategy.h"
47
#include "routing/DummyRouter.h"
48
#include "routing/MeshRouter.h"
49
#include "routing/RoutingEngine.h"
50
#include "routing/SafestPathRouter.h"
Ulrich Kemloh's avatar
Ulrich Kemloh committed
51
#include "pedestrian/PedDistributor.h"
52
#include "routing/CognitiveMapRouter.h"
Ulrich Kemloh's avatar
Ulrich Kemloh committed
53
#include "events/EventManager.h"
54 55 56 57 58
#include "pedestrian/AgentsSourcesManager.h"

//Forward declarations TO DO
//class AgentsSourcesManager;
class EventManager;
Ulrich Kemloh's avatar
Ulrich Kemloh committed
59

60 61
class Simulation
{
62
private:
63
     ///Number of pedestrians in the simulation
64
    long _nPeds;
65 66 67 68 69 70
    ///Maximum simulation time
    double _tmax;
    /// time step
    double _deltaT;
    /// frame rate for the trajectories
    double _fps;
71 72
    ///seed using for the random number generator
    unsigned int _seed;
73
    /// building object
Oliver Schmidts's avatar
Oliver Schmidts committed
74
    std::unique_ptr<Building> _building;
75
    /// Force model to use
76
    std::shared_ptr<OperationalModel> _operationalModel;
77
    /// differential equation solver
Oliver Schmidts's avatar
Oliver Schmidts committed
78
    std::shared_ptr<RoutingEngine> _routingEngine;
79 80 81
    ODESolver* _solver;
    /// writing the trajectories to file
    IODispatcher* _iod;
82
    ///new: EventManager
83
    EventManager* _em;
84
    /// argument parser
85
    ArgumentParser _argsParser;
86 87
    /// Agents sources manager
    AgentsSourcesManager _agentSrcManager;
88
    /// profiling flag
89
    bool _profiling;
90
    /// architecture flag
91
    int _hpc;
92 93

public:
94 95 96 97

    /**
     * Constructor
     */
98
    Simulation(const ArgumentParser& args);
99 100 101 102

    /**
     * Destructor
     */
Ulrich Kemloh's avatar
Ulrich Kemloh committed
103
    virtual ~Simulation();
104 105 106 107

    /**
     * Initialize the number of agents in the simulation
     */
Oliver Schmidts's avatar
Oliver Schmidts committed
108
    long GetPedsNumber() const;
109 110 111 112

    /**
     * Read parameters from the argument parser class.
     */
113
    bool InitArgs(const ArgumentParser& args);
114 115 116 117

    /**
     * @return the total simulated/evacuation time
     */
Ulrich Kemloh's avatar
Ulrich Kemloh committed
118
    int RunSimulation();
119 120

    /**
121
     * Updathe route of the pedestrians and reassign rooms, in the case a room change happens
122
     */
123 124
    void UpdateRoutesAndLocations();

125 126 127 128 129 130 131 132 133
    /**
     * Set the ProfilingFlag
     */
    void SetProfileFlag(bool flag);

    /**
     * Get the ProfileFlag
     */
    bool GetProfileFlag();
134

135 136 137 138
    /**
     * Get the HPCFlag
     */
    int GetHPCFlag();
Ulrich Kemloh's avatar
Ulrich Kemloh committed
139

140 141 142 143
    /**
     * print some statistics about the simulation
     */
    void PrintStatistics();
Ulrich Kemloh's avatar
Ulrich Kemloh committed
144

145 146 147 148 149 150 151 152 153 154
    /**
     * @return the agents source manager
     */
    const AgentsSourcesManager& GetAgentSrcManager();

    /**
     * Check if any agents are waiting to enter the simulation
     */
    void ProcessAgentsQueue();

Ulrich Kemloh's avatar
Ulrich Kemloh committed
155 156 157
};

#endif /*SIMULATION_H_*/