ngen::Layer Class Reference

#include <Layer.hpp>

Inheritance diagram for ngen::Layer:

Collaboration diagram for ngen::Layer:

Public Types
using	feature_type = hy_features::HY_Features

Public Member Functions
	Layer (const LayerDescription &desc, const std::vector< std::string > &p_u, const Simulation_Time &s_t, feature_type &f, geojson::GeoJSON cd, long idx)
	Layer (const LayerDescription &desc, const Simulation_Time &s_t, feature_type &f, long idx)
	Construct a minimum layer object.
virtual	~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.
virtual 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)
	Run one simulation timestep for each model in 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

Member Typedef Documentation

feature_type

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

Constructor & Destructor Documentation

Layer() [1/2]

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

inline

Layer() [2/2]

ngen::Layer::Layer ( const LayerDescription & desc, const Simulation_Time & s_t, feature_type & f, long idx )

inline

Construct a minimum layer object.

Parameters

desc
s_t
f
idx

~Layer()

virtual ngen::Layer::~Layer ( )

inlinevirtual

Member Function Documentation

current_timestep_epoch_time()

time_t ngen::Layer::current_timestep_epoch_time ( )

inline

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

References Simulation_Time::get_current_epoch_time(), and simulation_time.

get_id()

int ngen::Layer::get_id ( ) const

inline

Return the numeric id of this layer.

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

get_name()

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

inline

Return the name of this layer.

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

get_time_step()

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

inline

Return this time_step interval used for this layer.

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

get_time_step_units()

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

inline

Return the units for the time_step value of this layer.

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

next_timestep_epoch_time()

time_t ngen::Layer::next_timestep_epoch_time ( )

inline

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

References Simulation_Time::next_timestep_epoch_time(), and simulation_time.

update_models()

void ngen::Layer::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 )

virtual

Run one simulation timestep for each model in this layer.

Reimplemented in ngen::DomainLayer, and ngen::SurfaceLayer.

References Simulation_Time::advance_timestep(), hy_features::HY_Features::catchment_at(), catchment_data, hy_features::HY_Features::destination_nexuses(), features, Simulation_Time::get_output_interval_seconds(), Simulation_Time::get_timestamp(), Simulation_Time::get_total_output_times(), Simulation_Time::next_timestep_index(), output_time_index, processing_units, simulation_time, and models::external::State_Exception::what().

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

Member Data Documentation

catchment_data

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

protected

Referenced by update_models().

description

const LayerDescription ngen::Layer::description

protected

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

features

feature_type& ngen::Layer::features

protected

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

output_time_index

long ngen::Layer::output_time_index

protected

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

processing_units

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

protected

Referenced by update_models().

simulation_time

Simulation_Time ngen::Layer::simulation_time

protected

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

---

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

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