HY_CatchmentDivide Class Reference

#include <HY_CatchmentDivide.hpp>

Inheritance diagram for HY_CatchmentDivide:

Collaboration diagram for HY_CatchmentDivide:

Public Types
typedef bg::model::point< double, 2, bg::cs::cartesian >	point_t
typedef bg::model::linestring< point_t >	linestring_t

Public Member Functions
	HY_CatchmentDivide ()
virtual	~HY_CatchmentDivide ()
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

Private Attributes
std::shared_ptr< linestring_t >	divide_path
unsigned long	id_number
std::string	id

Member Typedef Documentation

linestring_t

bg::model::linestring<point_t> HY_CatchmentDivide::linestring_t

point_t

bg::model::point<double, 2, bg::cs::cartesian> HY_CatchmentDivide::point_t

Constructor & Destructor Documentation

HY_CatchmentDivide()

HY_CatchmentDivide::HY_CatchmentDivide

(

)

~HY_CatchmentDivide()

HY_CatchmentDivide::~HY_CatchmentDivide ( )

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.

Member Data Documentation

divide_path

std::shared_ptr<linestring_t> HY_CatchmentDivide::divide_path

private

id

std::string HY_CatchmentDivide::id

private

id_number

unsigned long HY_CatchmentDivide::id_number

private

realized_catchment

std::shared_ptr<HY_Catchment> HY_CatchmentRealization::realized_catchment

protectedinherited

---

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

• include/core/catchment/HY_CatchmentDivide.hpp
• src/core/catchment/HY_CatchmentDivide.cpp