Model.hpp

Go to the documentation of this file.

 
#ifndef MODEL_HPP
#define MODEL_HPP
 
#include "include/Logged.hpp"
 
#include "include/Configured.hpp"
#include "include/Iterator.hpp"
#include "include/ModelMetadata.hpp"
#include "include/ModelState.hpp"
#include "include/PrognosticData.hpp"
 
#include "DevStep.hpp"
#include <string>
 
namespace Nextsim {
 
class Model : public Configured<Model> {
public:
    Model(); // TODO add arguments to pass the desired
             // environment and configuration to the model
    ~Model(); // Finalize the model. Collect data and so on.
 
    void configure() override;
    enum {
        RESTARTFILE_KEY,
        STARTTIME_KEY,
        STOPTIME_KEY,
        RUNLENGTH_KEY,
        TIMESTEP_KEY,
        MISSINGVALUE_KEY,
    };
 
    ConfigMap getConfig() const;
 
    static HelpMap& getHelpText(HelpMap& map, bool getAll);
    static HelpMap& getHelpRecursive(HelpMap& map, bool getAll);
 
    void run();
 
    void writeRestartFile();
 
    void setFinalFilename(const std::string& finalFile);
 
    ModelMetadata& metadata();
 
    // Configuration option that holds the restart file name
    const static std::string restartOptionName;
 
private:
    Iterator iterator;
    DevStep modelStep; // Change the model step calculation here
    PrognosticData pData;
    ModelMetadata m_etadata;
 
    std::string initialFileName;
    std::string finalFileName;
 
    // Cached values of the start-step-stop/duration times
    std::string startTimeStr;
    std::string stopTimeStr;
    std::string durationStr;
    std::string stepStr;
};
 
} /* namespace Nextsim */
 
#endif /* MODEL_HPP */