hydrobricks
Loading...
Searching...
No Matches
SettingsModel Class Reference
Inheritance diagram for SettingsModel:

Public Member Functions

void SetSolver (const string &solverName)
 
void SetTimer (const string &start, const string &end, int timeStep, const string &timeStepUnit)
 
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")
 
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)
 
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 string &fluxType="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)
 
void GenerateSnowpacks (const string &snowMeltProcess)
 
void GenerateSnowpacksWithWaterRetention (const string &snowMeltProcess, const string &outflowProcess)
 
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 ParseStructure (const string &path)
 
bool ParseParameters (const string &path)
 
bool SetParameterValue (const string &component, const string &name, float value)
 
int GetStructuresNb () const
 
int GetHydroUnitBricksNb () const
 
int GetSubBasinBricksNb () const
 
int GetSurfaceComponentBricksNb () const
 
int GetProcessesNb () const
 
int GetHydroUnitSplittersNb () const
 
int GetSubBasinSplittersNb () const
 
SolverSettings GetSolverSettings () const
 
TimerSettings GetTimerSettings () const
 
BrickSettings GetHydroUnitBrickSettings (int index) const
 
BrickSettings GetHydroUnitBrickSettings (const string &name) const
 
BrickSettings GetSurfaceComponentBrickSettings (int index) const
 
vecInt GetSurfaceComponentBricksIndices () const
 
vecInt GetLandCoverBricksIndices () const
 
vecStr GetLandCoverBricksNames () const
 
BrickSettings GetSubBasinBrickSettings (int index) const
 
ProcessSettings GetProcessSettings (int index) const
 
SplitterSettings GetHydroUnitSplitterSettings (int index) const
 
SplitterSettings GetSubBasinSplitterSettings (int index) const
 
vecStr GetSubBasinLogLabels ()
 
vecStr GetSubBasinGenericLogLabels ()
 
vecStr GetHydroUnitLogLabels ()
 
void SetLogAll (bool logAll=true)
 
bool LogAll ()
 

Protected Member Functions

vecStr ParseLandCoverNames (const YAML::Node &settings)
 
vecStr ParseLandCoverTypes (const YAML::Node &settings)
 
string ParseSolver (const YAML::Node &settings)
 
bool LogAll (const YAML::Node &settings)
 

Protected Attributes

bool m_logAll
 
vector< ModelStructurem_modelStructures
 
SolverSettings m_solver
 
TimerSettings m_timer
 
ModelStructurem_selectedStructure
 
BrickSettingsm_selectedBrick
 
ProcessSettingsm_selectedProcess
 
SplitterSettingsm_selectedSplitter
 

The documentation for this class was generated from the following files: