ngen::SurfaceLayer Class Reference

#include <SurfaceLayer.hpp>

Inheritance diagram for ngen::SurfaceLayer:

Collaboration diagram for ngen::SurfaceLayer:

Public Types
using	feature_type = hy_features::HY_Features

Public Member Functions
	SurfaceLayer (const LayerDescription &desc, const std::vector< std::string > &p_u, const Simulation_Time &s_t, feature_type &f, geojson::GeoJSON cd, long idx, const std::shared_ptr< utils::NexusOutputsMgr > &nexus_outputs_mgr)
void	update_models (boost::span< double > catchment_outflows, std::unordered_map< std::string, int > &catchment_indexes, boost::span< double > nexus_downstream_flows, std::unordered_map< std::string, int > &nexus_indexes, int current_step) override
	Run one simulation timestep for each model in this layer.
time_t	next_timestep_epoch_time ()
	Return the next timestep that will be processed by this layer in epoch time units.
time_t	current_timestep_epoch_time ()
	Return the last timestep that was processed by this layer in epoch time units.
int	get_id () const
	Return the numeric id of this layer.
const std::string &	get_name () const
	Return the name of this layer.
const double	get_time_step () const
	Return this time_step interval used for this layer.
const std::string &	get_time_step_units () const
	Return the units for the time_step value of this layer.

Protected Attributes
const LayerDescription	description
const std::vector< std::string >	processing_units
Simulation_Time	simulation_time
feature_type &	features
const geojson::GeoJSON	catchment_data
long	output_time_index

Private Attributes
std::shared_ptr< utils::NexusOutputsMgr >	nexus_outputs_mgr

Member Typedef Documentation

feature_type

using ngen::Layer::feature_type = hy_features::HY_Features

inherited

Constructor & Destructor Documentation

SurfaceLayer()

ngen::SurfaceLayer::SurfaceLayer ( const LayerDescription & desc, const std::vector< std::string > & p_u, const Simulation_Time & s_t, feature_type & f, geojson::GeoJSON cd, long idx, const std::shared_ptr< utils::NexusOutputsMgr > & nexus_outputs_mgr )

inline

Member Function Documentation

current_timestep_epoch_time()

time_t ngen::Layer::current_timestep_epoch_time ( )

inlineinherited

Return the last timestep that was processed by this layer in epoch time units.

References Simulation_Time::get_current_epoch_time(), and ngen::Layer::simulation_time.

get_id()

int ngen::Layer::get_id ( ) const

inlineinherited

Return the numeric id of this layer.

References ngen::Layer::description, and ngen::LayerDescription::id.

get_name()

const std::string & ngen::Layer::get_name ( ) const

inlineinherited

Return the name of this layer.

References ngen::Layer::description, and ngen::LayerDescription::name.

get_time_step()

const double ngen::Layer::get_time_step ( ) const

inlineinherited

Return this time_step interval used for this layer.

References ngen::Layer::description, and ngen::LayerDescription::time_step.

get_time_step_units()

const std::string & ngen::Layer::get_time_step_units ( ) const

inlineinherited

Return the units for the time_step value of this layer.

References ngen::Layer::description, and ngen::LayerDescription::time_step_units.

next_timestep_epoch_time()

time_t ngen::Layer::next_timestep_epoch_time ( )

inlineinherited

Return the next timestep that will be processed by this layer in epoch time units.

References Simulation_Time::next_timestep_epoch_time(), and ngen::Layer::simulation_time.

update_models()

void ngen::SurfaceLayer::update_models ( boost::span< double > catchment_outflows, std::unordered_map< std::string, int > & catchment_indexes, boost::span< double > nexus_downstream_flows, std::unordered_map< std::string, int > & nexus_indexes, int current_step )

overridevirtual

Run one simulation timestep for each model in this layer.

Reimplemented from ngen::Layer.

References utils::NexusOutputsMgr::commit_writes(), ngen::Layer::features, HY_HydroNexus::get_contributing_catchments(), Simulation_Time::get_current_epoch_time(), HY_HydroNexus::get_downstream_flow(), HY_HydroNexus::get_receiving_catchments(), Simulation_Time::get_timestamp(), hy_features::HY_Features::nexus_at(), nexus_outputs_mgr, hy_features::HY_Features::nexuses(), ngen::Layer::output_time_index, utils::NexusOutputsMgr::receive_data_entry(), ngen::Layer::simulation_time, and ngen::Layer::update_models().

Member Data Documentation

catchment_data

const geojson::GeoJSON ngen::Layer::catchment_data

protectedinherited

Referenced by ngen::Layer::update_models().

description

const LayerDescription ngen::Layer::description

protectedinherited

Referenced by ngen::Layer::get_id(), ngen::Layer::get_name(), ngen::Layer::get_time_step(), ngen::Layer::get_time_step_units(), and ngen::DomainLayer::update_models().

features

feature_type& ngen::Layer::features

protectedinherited

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

nexus_outputs_mgr

std::shared_ptr<utils::NexusOutputsMgr> ngen::SurfaceLayer::nexus_outputs_mgr

private

Referenced by update_models().

output_time_index

long ngen::Layer::output_time_index

protectedinherited

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

processing_units

const std::vector<std::string> ngen::Layer::processing_units

protectedinherited

Referenced by ngen::Layer::update_models().

simulation_time

Simulation_Time ngen::Layer::simulation_time

protectedinherited

Referenced by ngen::Layer::current_timestep_epoch_time(), ngen::Layer::next_timestep_epoch_time(), ngen::DomainLayer::update_models(), ngen::Layer::update_models(), and update_models().

---

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

• include/core/SurfaceLayer.hpp
• src/core/SurfaceLayer.cpp