#include <HY_CatchmentRealization.hpp>

Inheritance diagram for HY_CatchmentRealization:

Collaboration diagram for HY_CatchmentRealization:

Public Member Functions
	HY_CatchmentRealization ()

virtual	~HY_CatchmentRealization ()

virtual double	get_response (time_step_t t_index, time_step_t t_delta)=0
	Execute the backing model formulation for the given time step, where it is of the specified size, and return the response output.

Protected Member Functions
virtual std::string	get_catchment_id () const =0

virtual void	set_catchment_id (std::string cat_id)=0

Protected Attributes
std::shared_ptr< HY_Catchment >	realized_catchment

unsigned long	id_number

Constructor & Destructor Documentation

◆ HY_CatchmentRealization()

HY_CatchmentRealization::HY_CatchmentRealization ( )

◆ ~HY_CatchmentRealization()

HY_CatchmentRealization::~HY_CatchmentRealization ( )

virtual

Member Function Documentation

◆ get_catchment_id()

virtual std::string HY_CatchmentRealization::get_catchment_id ( ) const

protectedpure virtual

Implemented in realization::Catchment_Formulation.

◆ get_response()

virtual double HY_CatchmentRealization::get_response	(	time_step_t	t_index,
		time_step_t	t_delta )

pure virtual

Execute the backing model formulation for the given time step, where it is of the specified size, and return the response output.

Any inputs and additional parameters must be made available as instance members.

Types should clearly document the details of their particular response output.

Parameters

t_index	The index of the time step for which to run model calculations.
d_delta_s	The duration, in seconds, of the time step for which to run model calculations.

Returns: The response output of the model for this time step.

Implemented in realization::Bmi_Module_Formulation, realization::Bmi_Multi_Formulation, and realization::Catchment_Formulation.

◆ set_catchment_id()

virtual void HY_CatchmentRealization::set_catchment_id ( std::string cat_id )

protectedpure virtual

Implemented in realization::Catchment_Formulation.

Member Data Documentation

◆ id_number

unsigned long HY_CatchmentRealization::id_number

protected

◆ realized_catchment

std::shared_ptr<HY_Catchment> HY_CatchmentRealization::realized_catchment