SettingsModel.h

#ifndef HYDROBRICKS_SETTINGS_MODEL_H
#define HYDROBRICKS_SETTINGS_MODEL_H
 
#include <yaml-cpp/yaml.h>
 
#include <map>
#include <memory>
#include <utility>
 
#include "Includes.h"
#include "Parameter.h"
 
struct SolverSettings {
    string name;
};
 
struct ChannelRoutingSettings {
    string scheme = "none";
    bool routeLocalRunoff = false;
    vector<Parameter> parameters;
};
 
struct TimerSettings {
    string start;
    string end;
    int timeStep = 1;
    string timeStepUnit;
    int spinupDays = 0;
};
 
struct OutputSettings {
    string target;
    ContentType fluxType = ContentType::Water;
    bool isInstantaneous = false;
    bool isStatic = false;
};
 
struct ProcessSettings {
    string name;
    string type;
    vecStr gateBricks;  // bricks whose state modulates the process rate (no flux; e.g.
                        // percolation:prevah). Several are aggregated by the process.
    vecStr logItems;
    vector<Parameter> parameters;
    vector<VariableType> forcing;
    vector<OutputSettings> outputs;
};
 
struct SplitterSettings {
    string name;
    string type;
    vecStr logItems;
    vector<Parameter> parameters;
    vector<VariableType> forcing;
    vector<OutputSettings> outputs;
};
 
struct BrickSettings {
    string name;
    string type;
    string parent;
    vecStr logItems;
    vector<Parameter> parameters;
    vector<VariableType> forcing;
    vector<ProcessSettings> processes;
    bool computedDirectly = false;  // if true, the brick is solved explicitly (no ODE solver)
    string areaOf;                  // land cover whose area the brick represents (empty: the whole unit)
};
 
struct ModelStructure {
    int id;
    vecStr logItems;
    vector<BrickSettings> hydroUnitBricks;
    vector<BrickSettings> subbasinBricks;
    vecInt landCoverBricks;
    vecInt surfaceComponentBricks;
    vector<SplitterSettings> hydroUnitSplitters;
    vector<SplitterSettings> subbasinSplitters;
};
 
class SettingsModel {
  public:
    explicit SettingsModel();
 
    virtual ~SettingsModel();
 
    void SetSolver(const string& solverName);
 
    void SetChannelRouting(const string& scheme, bool routeLocalRunoff = false);
 
    void SetTimer(const string& start, const string& end, int timeStep, const string& timeStepUnit);
 
    void SetSpinupDays(int days);
 
    void AddHydroUnitBrick(const string& name, const std::string& type = "storage");
 
    void AddSubbasinBrick(const string& name, const std::string& type = "storage");
 
    void AddLandCoverBrick(const string& name, const string& type);
 
    void AddSurfaceComponentBrick(const string& name, const string& type);
 
    void SetSurfaceComponentParent(const string& name);
 
    void AddBrickParameter(const string& name, float value, const std::string& type = "constant");
 
    void SetBrickParameterValue(const string& name, float value, const std::string& type = "constant");
 
    void SetCurrentBrickComputedDirectly();
 
    void SetCurrentBrickAreaOf(const string& landCover);
 
    bool BrickHasParameter(const string& name);
 
    void AddBrickForcing(const string& name);
 
    void AddBrickProcess(const string& name, const string& type, const string& target = "", bool log = false);
 
    void AddProcessParameter(const string& name, float value, const std::string& type = "constant");
 
    void SetProcessParameterValue(const string& name, float value, const std::string& type = "constant");
 
    void AddProcessForcing(const string& name);
 
    void AddProcessOutput(const string& target, ContentType fluxType = ContentType::Water);
 
    void SetProcessGateBrick(const string& name);
 
    void SetProcessOutputsAsInstantaneous();
 
    void SetProcessOutputsAsStatic();
 
    void OutputProcessToSameBrick();
 
    void AddHydroUnitSplitter(const string& name, const string& type);
 
    void AddSubbasinSplitter(const string& name, const string& type);
 
    void AddSplitterParameter(const string& name, float value, const std::string& type = "constant");
 
    void SetSplitterParameterValue(const string& name, float value, const std::string& type = "constant");
 
    void AddSplitterForcing(const string& name);
 
    void AddSplitterOutput(const string& target, const ContentType fluxType = ContentType::Water);
 
    void ChangeSplitterOutputTarget(const string& currentTarget, const string& newTarget);
 
    bool ChangeSplitterOutputTargetIfFound(const string& currentTarget, const string& newTarget);
 
    void GenerateCanopyInterception(const string& coverName, const string& throughfallTarget,
                                    const string& throughfallProcess = "outflow:threshold",
                                    const string& interceptionEtProcess = "et:open_water");
 
    void AddLoggingToItem(const string& itemName);
 
    void AddLoggingToItems(std::initializer_list<const string> items);
 
    void AddBrickLogging(const string& itemName);
 
    void AddBrickLogging(std::initializer_list<const string> items);
 
    void AddProcessLogging(const string& itemName);
 
    void AddSplitterLogging(const string& itemName);
 
    void GeneratePrecipitationSplitters(bool withSnow, const string& splitterType = "snow_rain:linear");
 
    void GenerateSnowpacks(const string& snowMeltProcess);
 
    void AddSnowIceTransformation(const string& transformationProcess = "transform:snow_ice_swat");
 
    void AddSnowRedistribution(const string& redistributionProcess = "transport:snow_slide", bool skipGlaciers = false);
 
    void GenerateSnowpacksWithWaterRetention(const string& snowMeltProcess, const string& outflowProcess,
                                             bool rainToSnowpack = false);
 
    void AddSnowpackRefreezing(const string& refreezingProcess = "refreeze:degree_day");
 
    void AddSnowpackSublimation(const string& sublimationProcess);
 
    int AddStructure();
 
    bool SelectStructure(int id);
 
    void SelectHydroUnitBrick(int index);
 
    void SelectSubbasinBrick(int index);
 
    bool SelectHydroUnitBrickIfFound(const string& name);
 
    bool SelectSubbasinBrickIfFound(const string& name);
 
    void SelectHydroUnitBrick(const string& name);
 
    void SelectHydroUnitBrickByName(const string& name);
 
    void SelectSubbasinBrick(const string& name);
 
    void SelectProcess(int index);
 
    void SelectProcess(const string& name);
 
    void SelectProcessWithParameter(const string& name);
 
    void SelectHydroUnitSplitter(int index);
 
    void SelectSubbasinSplitter(int index);
 
    bool SelectHydroUnitSplitterIfFound(const string& name);
 
    bool SelectSubbasinSplitterIfFound(const string& name);
 
    void SelectHydroUnitSplitter(const string& name);
 
    void SelectSubbasinSplitter(const string& name);
 
    bool SetParameterValue(const string& component, const string& name, float value);
 
    bool SetParameterMonthlyValues(const string& component, const string& name, const vecFloat& values);
 
    vector<Parameter*> GetParametersWithModifier();
 
    void SetParameterSpatialFromProperty(const string& component, const string& name, const string& property);
 
    const std::map<std::pair<string, string>, string>& GetSpatialParameterBindings() const {
        return _spatialParameterBindings;
    }
 
    void SetParameterSpatialMonthlyFromProperties(const string& component, const string& name,
                                                  const vecStr& properties);
 
    const std::map<std::pair<string, string>, vecStr>& GetSpatialMonthlyParameterBindings() const {
        return _spatialMonthlyParameterBindings;
    }
 
    int GetSelectedStructureId() const {
        assert(_selectedStructure);
        return _selectedStructure->id;
    }
 
    int GetStructureCount() const {
        return static_cast<int>(_modelStructures.size());
    }
 
    int GetHydroUnitBrickCount() const {
        assert(_selectedStructure);
        return static_cast<int>(_selectedStructure->hydroUnitBricks.size());
    }
 
    int GetSubbasinBrickCount() const {
        assert(_selectedStructure);
        return static_cast<int>(_selectedStructure->subbasinBricks.size());
    }
 
    int GetSurfaceComponentBrickCount() const {
        assert(_selectedStructure);
        return static_cast<int>(_selectedStructure->surfaceComponentBricks.size());
    }
 
    int GetProcessCount() const {
        assert(_selectedBrick);
        return static_cast<int>(_selectedBrick->processes.size());
    }
 
    int GetHydroUnitSplitterCount() const {
        assert(_selectedStructure);
        return static_cast<int>(_selectedStructure->hydroUnitSplitters.size());
    }
 
    int GetSubbasinSplitterCount() const {
        assert(_selectedStructure);
        return static_cast<int>(_selectedStructure->subbasinSplitters.size());
    }
 
    SolverSettings GetSolverSettings() const {
        return _solver;
    }
 
    const ChannelRoutingSettings& GetChannelRoutingSettings() const {
        return _channelRouting;
    }
 
    TimerSettings GetTimerSettings() const {
        return _timer;
    }
 
    const BrickSettings& GetHydroUnitBrickSettings(int index) const {
        assert(_selectedStructure);
        return _selectedStructure->hydroUnitBricks[index];
    }
 
    const BrickSettings& GetHydroUnitBrickSettings(const string& name) const {
        assert(_selectedStructure);
 
        for (const auto& brick : _selectedStructure->hydroUnitBricks) {
            if (brick.name == name) {
                return brick;
            }
        }
 
        throw std::runtime_error("Brick not found.");
    }
 
    const BrickSettings& GetSurfaceComponentBrickSettings(int index) const {
        assert(_selectedStructure);
        int brickIndex = _selectedStructure->surfaceComponentBricks[index];
        return _selectedStructure->hydroUnitBricks[brickIndex];
    }
 
    vecInt GetSurfaceComponentBricksIndices() const {
        assert(_selectedStructure);
        return _selectedStructure->surfaceComponentBricks;
    }
 
    const vecInt& GetLandCoverBricksIndices() const {
        assert(_selectedStructure);
        return _selectedStructure->landCoverBricks;
    }
 
    vecStr GetLandCoverBricksNames() const;
 
    vecStr GetSelectedStructureLandCoverNames() const;
 
    const BrickSettings& GetSubbasinBrickSettings(int index) const {
        assert(_selectedStructure);
        return _selectedStructure->subbasinBricks[index];
    }
 
    const ProcessSettings& GetProcessSettings(int index) const {
        assert(_selectedBrick);
        return _selectedBrick->processes[index];
    }
 
    const SplitterSettings& GetHydroUnitSplitterSettings(int index) const {
        assert(_selectedStructure);
        return _selectedStructure->hydroUnitSplitters[index];
    }
 
    const SplitterSettings& GetSubbasinSplitterSettings(int index) const {
        assert(_selectedStructure);
        return _selectedStructure->subbasinSplitters[index];
    }
 
    vecStr GetSubbasinLogLabels() const;
 
    vecStr GetSubbasinGenericLogLabels() const;
 
    vecStr GetHydroUnitLogLabels() const;
 
    void SetLogAll(bool logAll = true) {
        if (logAll) {
            LogDebug("Logging all components.");
            _recordFractions = true;
        } else {
            LogDebug("Minimal logging.");
        }
        _logAll = logAll;
    }
 
    bool LogAll() const {
        return _logAll;
    }
 
    void SetRecordFractions(bool record = true) {
        _recordFractions = record;
    }
 
    bool RecordsFractions() const {
        return _recordFractions;
    }
 
    [[nodiscard]] bool IsValid() const;
 
    void Validate() const;
 
  protected:
    bool SetParameterValueInSelectedStructure(const string& component, const string& name, float value);
 
    Parameter* FindParameterInSelectedStructure(const string& component, const string& name);
 
    bool _logAll;
    bool _recordFractions;
    vector<ModelStructure> _modelStructures;
    SolverSettings _solver;
    ChannelRoutingSettings _channelRouting;
    TimerSettings _timer;
    ModelStructure* _selectedStructure;   // non-owning reference
    BrickSettings* _selectedBrick;        // non-owning reference
    ProcessSettings* _selectedProcess;    // non-owning reference
    SplitterSettings* _selectedSplitter;  // non-owning reference
    // Spatial parameter bindings: (component, name) -> hydro-unit property name.
    std::map<std::pair<string, string>, string> _spatialParameterBindings;
    std::map<std::pair<string, string>, vecStr> _spatialMonthlyParameterBindings;
 
    bool LogAll(const YAML::Node& settings);
};
 
#endif  // HYDROBRICKS_SETTINGS_MODEL_H