SettingsModel Class Reference

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")
void	SetCurrentBrickComputedDirectly ()
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	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	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	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)
int	GetStructureCount () const
int	GetHydroUnitBrickCount () const
int	GetSubBasinBrickCount () const
int	GetSurfaceComponentBrickCount () const
int	GetProcessCount () const
int	GetHydroUnitSplitterCount () const
int	GetSubBasinSplitterCount () const
SolverSettings	GetSolverSettings () const
TimerSettings	GetTimerSettings () const
const BrickSettings &	GetHydroUnitBrickSettings (int index) const
const BrickSettings &	GetHydroUnitBrickSettings (const string &name) const
const BrickSettings &	GetSurfaceComponentBrickSettings (int index) const
vecInt	GetSurfaceComponentBricksIndices () const
const vecInt &	GetLandCoverBricksIndices () const
vecStr	GetLandCoverBricksNames () const
const BrickSettings &	GetSubBasinBrickSettings (int index) const
const ProcessSettings &	GetProcessSettings (int index) const
const SplitterSettings &	GetHydroUnitSplitterSettings (int index) const
const SplitterSettings &	GetSubBasinSplitterSettings (int index) const
vecStr	GetSubBasinLogLabels () const
vecStr	GetSubBasinGenericLogLabels () const
vecStr	GetHydroUnitLogLabels () const
void	SetLogAll (bool logAll=true)
bool	LogAll () const
bool	IsValid () const
void	Validate () const

Protected Member Functions
bool	LogAll (const YAML::Node &settings)

Protected Attributes
bool	_logAll
vector< ModelStructure >	_modelStructures
SolverSettings	_solver
TimerSettings	_timer
ModelStructure *	_selectedStructure
BrickSettings *	_selectedBrick
ProcessSettings *	_selectedProcess
SplitterSettings *	_selectedSplitter

Member Function Documentation

AddBrickForcing()

void SettingsModel::AddBrickForcing

(

const string &

name

)

Add a forcing to the selected brick.

Parameters

name	name of the forcing.

AddBrickLogging() [1/2]

void SettingsModel::AddBrickLogging

(

const string &

itemName

)

Add logging to the selected brick.

Parameters

itemName

name of the item to log.

AddBrickLogging() [2/2]

void SettingsModel::AddBrickLogging

(

std::initializer_list< const string >

items

)

Add logging to a list of items in the selected brick.

Parameters

items

list of items to log.

AddBrickParameter()

void SettingsModel::AddBrickParameter	(	const string &	name,
		float	value,
		const std::string &	type = "constant" )

Add a parameter to the selected brick.

Parameters

name	name of the parameter.
value	value of the parameter.
type	type of the parameter.

AddBrickProcess()

void SettingsModel::AddBrickProcess	(	const string &	name,
		const string &	type,
		const string &	target = "",
		bool	log = false )

Add a process to the selected brick.

Parameters

name	name of the process.
type	type of the process.
target	target of the process.
log	true if the process should be logged, false otherwise.

AddHydroUnitBrick()

void SettingsModel::AddHydroUnitBrick	(	const string &	name,
		const std::string &	type = "storage" )

Add a hydro unit brick to the model (e.g. storage).

Parameters

name	name of the hydro unit brick.
type	type of the hydro unit brick.

AddHydroUnitSplitter()

void SettingsModel::AddHydroUnitSplitter	(	const string &	name,
		const string &	type )

Add a hydro unit splitter to the selected structure.

Parameters

name	name of the hydro unit splitter.
type	type of the hydro unit splitter.

AddLandCoverBrick()

void SettingsModel::AddLandCoverBrick	(	const string &	name,
		const string &	type )

Add a land cover brick to the model (e.g. glacier).

Parameters

name	name of the land cover brick.
type	type of the land cover brick.

AddLoggingToItem()

void SettingsModel::AddLoggingToItem

(

const string &

itemName

)

Add logging to a given item.

Parameters

itemName

name of the item to log.

AddLoggingToItems()

void SettingsModel::AddLoggingToItems

(

std::initializer_list< const string >

items

)

Add logging to a list of items.

Parameters

items

list of items to log.

AddProcessForcing()

void SettingsModel::AddProcessForcing

(

const string &

name

)

Add a forcing to the selected process.

Parameters

name	name of the forcing.

AddProcessLogging()

void SettingsModel::AddProcessLogging

(

const string &

itemName

)

Add logging to the selected process.

Parameters

itemName

name of the item to log.

AddProcessOutput()

void SettingsModel::AddProcessOutput	(	const string &	target,
		ContentType	fluxType = ContentType::Water )

Add an output to the selected process.

Parameters

target	target of the output.
fluxType	type of the flux.

AddProcessParameter()

void SettingsModel::AddProcessParameter	(	const string &	name,
		float	value,
		const std::string &	type = "constant" )

Add a parameter to the selected process.

Parameters

name	name of the parameter.
value	value of the parameter.
type	type of the parameter.

AddSnowIceTransformation()

void SettingsModel::AddSnowIceTransformation

(

const string &

transformationProcess = "transform:snow_ice_swat"

)

Add a snow-ice transformation process to the model. This is used for glacier bricks to transform snow into ice.

Parameters

transformationProcess

name of the transformation process.

AddSnowRedistribution()

void SettingsModel::AddSnowRedistribution	(	const string &	redistributionProcess = "transport:snow_slide",
		bool	skipGlaciers = false )

Add a snow redistribution process to the model.

Parameters

redistributionProcess	name of the redistribution process.
skipGlaciers	if true, do not redistribute snow for snowpacks on glaciers.

AddSplitterForcing()

void SettingsModel::AddSplitterForcing

(

const string &

name

)

Add a forcing to the selected splitter.

Parameters

name	name of the forcing.

AddSplitterLogging()

void SettingsModel::AddSplitterLogging

(

const string &

itemName

)

Add logging to the selected splitter.

Parameters

itemName

name of the item to log.

AddSplitterOutput()

void SettingsModel::AddSplitterOutput	(	const string &	target,
		const ContentType	fluxType = ContentType::Water )

Add an output to the selected splitter.

Parameters

target	target of the output.
fluxType	type of the flux.

AddSplitterParameter()

void SettingsModel::AddSplitterParameter	(	const string &	name,
		float	value,
		const std::string &	type = "constant" )

Add a parameter to the selected splitter.

Parameters

name	name of the parameter.
value	value of the parameter.
type	type of the parameter.

AddSubBasinBrick()

void SettingsModel::AddSubBasinBrick	(	const string &	name,
		const std::string &	type = "storage" )

Add a sub-basin brick to the model (e.g. lumped storage).

Parameters

name	name of the sub-basin brick.
type	type of the sub-basin brick.

AddSubBasinSplitter()

void SettingsModel::AddSubBasinSplitter	(	const string &	name,
		const string &	type )

Add a sub-basin splitter to the selected structure.

Parameters

name	name of the sub-basin splitter.
type	type of the sub-basin splitter.

AddSurfaceComponentBrick()

void SettingsModel::AddSurfaceComponentBrick	(	const string &	name,
		const string &	type )

Add a surface component brick to the model (e.g. snowpack).

Parameters

name	name of the surface component brick.
type	type of the surface component brick.

BrickHasParameter()

bool SettingsModel::BrickHasParameter

(

const string &

name

)

Check if the selected brick has a parameter.

Parameters

name	name of the parameter.

Returns

true if the brick has the parameter, false otherwise.

GeneratePrecipitationSplitters()

void SettingsModel::GeneratePrecipitationSplitters	(	bool	withSnow,
		const string &	splitterType = "snow_rain:linear" )

Generate precipitation splitters (rain/snow).

Parameters

withSnow	true if snow is included, false otherwise.
splitterType	type of the rain/snow splitter (default: "snow_rain:linear").

GenerateSnowpacks()

void SettingsModel::GenerateSnowpacks

(

const string &

snowMeltProcess

)

Generate snowpacks.

Parameters

snowMeltProcess

name of the snow melt process.

GenerateSnowpacksWithWaterRetention()

void SettingsModel::GenerateSnowpacksWithWaterRetention	(	const string &	snowMeltProcess,
		const string &	outflowProcess )

Generate snowpacks with water retention.

Parameters

snowMeltProcess	name of the snow melt process.
outflowProcess	name of the outflow process.

GetHydroUnitBrickCount()

int SettingsModel::GetHydroUnitBrickCount ( ) const

inline

Get the number of hydro unit bricks in the selected structure.

Returns

number of hydro unit bricks.

GetHydroUnitBrickSettings() [1/2]

const BrickSettings & SettingsModel::GetHydroUnitBrickSettings ( const string & name ) const

inline

Get the hydro unit brick settings by name.

Parameters

name	name of the hydro unit brick.

Returns

hydro unit brick settings (const reference).

GetHydroUnitBrickSettings() [2/2]

const BrickSettings & SettingsModel::GetHydroUnitBrickSettings ( int index ) const

inline

Get the hydro unit brick settings by index.

Parameters

index

index of the hydro unit brick.

Returns

hydro unit brick settings (const reference).

GetHydroUnitLogLabels()

vecStr SettingsModel::GetHydroUnitLogLabels

(

)

const

Get the logging labels for the hydro unit components

Returns

logging labels for the hydro unit components.

GetHydroUnitSplitterCount()

int SettingsModel::GetHydroUnitSplitterCount ( ) const

inline

Get the number of hydro unit splitters in the selected structure.

Returns

number of hydro unit splitters.

GetHydroUnitSplitterSettings()

const SplitterSettings & SettingsModel::GetHydroUnitSplitterSettings ( int index ) const

inline

Get the splitter settings by index.

Parameters

index

index of the splitter.

Returns

splitter settings (const reference).

GetLandCoverBricksIndices()

const vecInt & SettingsModel::GetLandCoverBricksIndices ( ) const

inline

Get the indices of the land cover bricks.

Returns

indices of the land cover bricks.

GetLandCoverBricksNames()

vecStr SettingsModel::GetLandCoverBricksNames

(

)

const

Get the names of the land cover bricks.

Returns

names of the land cover bricks.

GetProcessCount()

int SettingsModel::GetProcessCount ( ) const

inline

Get the number of processes in the selected brick.

Returns

number of processes.

GetProcessSettings()

const ProcessSettings & SettingsModel::GetProcessSettings ( int index ) const

inline

Get the process settings by index.

Parameters

index

index of the process.

Returns

process settings (const reference).

GetSolverSettings()

SolverSettings SettingsModel::GetSolverSettings ( ) const

inline

Get the solver settings.

Returns

solver settings.

GetStructureCount()

int SettingsModel::GetStructureCount ( ) const

inline

Get the number of structures in the model.

Returns

number of structures.

GetSubBasinBrickCount()

int SettingsModel::GetSubBasinBrickCount ( ) const

inline

Get the number of sub-basin bricks in the selected structure.

Returns

number of sub-basin bricks.

GetSubBasinBrickSettings()

const BrickSettings & SettingsModel::GetSubBasinBrickSettings ( int index ) const

inline

Get the sub basin brick settings by index.

Parameters

index

index of the sub basin brick.

Returns

sub basin brick settings (const reference).

GetSubBasinGenericLogLabels()

vecStr SettingsModel::GetSubBasinGenericLogLabels

(

)

const

Get the generic logging labels for the sub basin components

Returns

generic logging labels for the sub basin components.

GetSubBasinLogLabels()

vecStr SettingsModel::GetSubBasinLogLabels

(

)

const

Get the logging labels for the sub basin components

Returns

logging labels for the sub basin components.

GetSubBasinSplitterCount()

int SettingsModel::GetSubBasinSplitterCount ( ) const

inline

Get the number of sub-basin splitters in the selected structure.

Returns

number of sub-basin splitters.

GetSubBasinSplitterSettings()

const SplitterSettings & SettingsModel::GetSubBasinSplitterSettings ( int index ) const

inline

Get the sub basin splitter settings by index.

Parameters

index

index of the sub basin splitter.

Returns

sub basin splitter settings (const reference).

GetSurfaceComponentBrickCount()

int SettingsModel::GetSurfaceComponentBrickCount ( ) const

inline

Get the number of surface component bricks in the selected structure.

Returns

number of surface component bricks.

GetSurfaceComponentBrickSettings()

const BrickSettings & SettingsModel::GetSurfaceComponentBrickSettings ( int index ) const

inline

Get the surface component brick settings by index.

Parameters

index

index of the surface component brick.

Returns

surface component brick settings (const reference).

GetSurfaceComponentBricksIndices()

vecInt SettingsModel::GetSurfaceComponentBricksIndices ( ) const

inline

Get the indices of the surface component bricks.

Returns

indices of the surface component bricks.

GetTimerSettings()

TimerSettings SettingsModel::GetTimerSettings ( ) const

inline

Get the timer settings.

Returns

timer settings.

IsValid()

bool SettingsModel::IsValid ( ) const

nodiscard

Check if the settings model is valid. Verifies that critical settings are configured (solver, timer, structures).

Returns

true if the settings are valid, false otherwise.

LogAll()

bool SettingsModel::LogAll ( ) const

inline

Check if all components are logged.

Returns

true if all components are logged, false otherwise.

OutputProcessToSameBrick()

void SettingsModel::OutputProcessToSameBrick

(

)

Set the outputs of the selected process to the same brick.

SelectHydroUnitBrick() [1/2]

void SettingsModel::SelectHydroUnitBrick

(

const string &

name

)

Select a hydro unit brick by its name. Raise an exception if the brick is not found.

Parameters

name	name of the hydro unit brick.

SelectHydroUnitBrick() [2/2]

void SettingsModel::SelectHydroUnitBrick

(

int

index

)

Select a hydro unit brick by its index.

Parameters

index

index of the hydro unit brick.

SelectHydroUnitBrickByName()

void SettingsModel::SelectHydroUnitBrickByName

(

const string &

name

)

Select a hydro unit brick by its name. Raise an exception if the brick is not found. Same as SelectHydroUnitBrick, but used in the Python bindings.

Parameters

name	name of the hydro unit brick.

SelectHydroUnitBrickIfFound()

bool SettingsModel::SelectHydroUnitBrickIfFound

(

const string &

name

)

Select a hydro unit brick by its name. Tolerate if the brick is not found.

Parameters

name	name of the hydro unit brick.

Returns

true if the hydro unit brick is found, false otherwise.

SelectHydroUnitSplitter() [1/2]

void SettingsModel::SelectHydroUnitSplitter

(

const string &

name

)

Select a hydro unit splitter by its name. Raise an exception if the splitter is not found.

Parameters

name	name of the hydro unit splitter.

SelectHydroUnitSplitter() [2/2]

void SettingsModel::SelectHydroUnitSplitter

(

int

index

)

Select a hydro unit splitter by its index.

Parameters

index

index of the hydro unit splitter.

SelectHydroUnitSplitterIfFound()

bool SettingsModel::SelectHydroUnitSplitterIfFound

(

const string &

name

)

Select a hydro unit splitter by its name. Tolerate if the splitter is not found.

Parameters

name	name of the hydro unit splitter.

Returns

true if the hydro unit splitter is found, false otherwise.

SelectProcess() [1/2]

void SettingsModel::SelectProcess

(

const string &

name

)

Select a process by its name.

Parameters

name	name of the process.

SelectProcess() [2/2]

void SettingsModel::SelectProcess

(

int

index

)

Select a process by its index.

Parameters

index

index of the process.

SelectProcessWithParameter()

void SettingsModel::SelectProcessWithParameter

(

const string &

name

)

Select a process by one of its parameter name.

Parameters

name	name of the process.

SelectStructure()

bool SettingsModel::SelectStructure

(

int

id

)

Select a structure by its ID.

Parameters

id	ID of the structure.

Returns

true if the structure is found, false otherwise.

SelectSubBasinBrick() [1/2]

void SettingsModel::SelectSubBasinBrick

(

const string &

name

)

Select a sub-basin brick by its name. Raise an exception if the brick is not found.

Parameters

name	name of the sub-basin brick.

SelectSubBasinBrick() [2/2]

void SettingsModel::SelectSubBasinBrick

(

int

index

)

Select a sub-basin brick by its index.

Parameters

index

index of the sub-basin brick.

SelectSubBasinBrickIfFound()

bool SettingsModel::SelectSubBasinBrickIfFound

(

const string &

name

)

Select a sub-basin brick by its name. Tolerate if the brick is not found.

Parameters

name	name of the sub-basin brick.

Returns

true if the sub-basin brick is found, false otherwise.

SelectSubBasinSplitter() [1/2]

void SettingsModel::SelectSubBasinSplitter

(

const string &

name

)

Select a sub-basin splitter by its name. Raise an exception if the splitter is not found.

Parameters

name	name of the sub-basin splitter.

SelectSubBasinSplitter() [2/2]

void SettingsModel::SelectSubBasinSplitter

(

int

index

)

Select a sub-basin splitter by its index.

Parameters

index

index of the sub-basin splitter.

SelectSubBasinSplitterIfFound()

bool SettingsModel::SelectSubBasinSplitterIfFound

(

const string &

name

)

Select a sub-basin splitter by its name. Tolerate if the splitter is not found.

Parameters

name	name of the sub-basin splitter.

Returns

true if the sub-basin splitter is found, false otherwise.

SetBrickParameterValue()

void SettingsModel::SetBrickParameterValue	(	const string &	name,
		float	value,
		const std::string &	type = "constant" )

Set the value of a parameter of the selected brick.

Parameters

name	name of the parameter.
value	value of the parameter.
type	type of the parameter.

SetCurrentBrickComputedDirectly()

void SettingsModel::SetCurrentBrickComputedDirectly

(

)

Mark the selected brick as computed directly (explicitly, without the ODE solver). Used for fully explicit formulations such as the GR4J production store and routing, where processes apply an exact discrete update each time step.

SetLogAll()

void SettingsModel::SetLogAll ( bool logAll = true )

inline

Flag to log all components.

Parameters

logAll

true to log all components, false to log only the selected ones.

SetParameterValue()

bool SettingsModel::SetParameterValue	(	const string &	component,
		const string &	name,
		float	value )

Set parameter value for a component.

Parameters

component	name of the component.
name	name of the parameter.
value	value of the parameter.

Returns

true if the parameter is set, false otherwise.

SetProcessOutputsAsInstantaneous()

void SettingsModel::SetProcessOutputsAsInstantaneous

(

)

Set the outputs of the selected process as instantaneous.

SetProcessOutputsAsStatic()

void SettingsModel::SetProcessOutputsAsStatic

(

)

Set the outputs of the selected process as static.

SetProcessParameterValue()

void SettingsModel::SetProcessParameterValue	(	const string &	name,
		float	value,
		const std::string &	type = "constant" )

Set the value of the selected process parameter.

Parameters

name	name of the parameter.
value	value of the parameter.
type	type of the parameter.

SetSolver()

void SettingsModel::SetSolver

(

const string &

solverName

)

Set the solver name.

Parameters

solverName

name of the solver.

SetSplitterParameterValue()

void SettingsModel::SetSplitterParameterValue	(	const string &	name,
		float	value,
		const std::string &	type = "constant" )

Set the value of the selected splitter parameter.

Parameters

name	name of the parameter.
value	value of the parameter.
type	type of the parameter.

SetSurfaceComponentParent()

void SettingsModel::SetSurfaceComponentParent

(

const string &

name

)

Set the parent of the selected surface component brick.

Parameters

name	name of the parent brick.

SetTimer()

void SettingsModel::SetTimer	(	const string &	start,
		const string &	end,
		int	timeStep,
		const string &	timeStepUnit )

Set the timer settings.

Parameters

start	start date.
end	end date.
timeStep	time step.
timeStepUnit	time step unit.

Validate()

void SettingsModel::Validate

(

)

const

Validate the settings model. Throws an exception if the settings are invalid.

Exceptions

ModelConfigError

if validation fails.

---

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

• /github/workspace/core/src/base/SettingsModel.h
• /github/workspace/core/src/base/SettingsModel.cpp