#include <HY_CatchmentArea.hpp>

Inheritance diagram for HY_CatchmentArea:

Collaboration diagram for HY_CatchmentArea:

Public Member Functions
	HY_CatchmentArea ()

	HY_CatchmentArea (utils::StreamHandler output_stream)

void	set_output_stream (std::string file_path)

void	write_output (std::string out)

virtual	~HY_CatchmentArea ()

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
polygon_t	bounds

utils::StreamHandler	output

std::shared_ptr< HY_Catchment >	realized_catchment

unsigned long	id_number

Constructor & Destructor Documentation

◆ HY_CatchmentArea() [1/2]

HY_CatchmentArea::HY_CatchmentArea ( )

◆ HY_CatchmentArea() [2/2]

HY_CatchmentArea::HY_CatchmentArea ( utils::StreamHandler output_stream )

◆ ~HY_CatchmentArea()

HY_CatchmentArea::~HY_CatchmentArea ( )

virtual

Member Function Documentation

◆ get_catchment_id()

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

protectedpure virtualinherited

Implemented in realization::Catchment_Formulation.

◆ get_response()

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

pure virtualinherited

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 virtualinherited

Implemented in realization::Catchment_Formulation.

◆ set_output_stream()

void HY_CatchmentArea::set_output_stream ( std::string file_path )

inline

References output.

◆ write_output()

void HY_CatchmentArea::write_output ( std::string out )

inline

References output.

Referenced by ngen::DomainLayer::DomainLayer(), and ngen::DomainLayer::update_models().

Member Data Documentation

◆ bounds

polygon_t HY_CatchmentArea::bounds

protected

◆ id_number

unsigned long HY_CatchmentRealization::id_number

protectedinherited

◆ output

utils::StreamHandler HY_CatchmentArea::output