models::bmi::protocols Namespace Reference

Classes
struct	Context
class	NgenBmiProtocol
class	NgenBmiProtocols
class	NgenMassBalance
class	ProtocolError

Typedefs
using	ModelPtr = std::shared_ptr<models::bmi::Bmi_Adapter>
using	Properties = geojson::PropertyMap

Enumerations
enum class	Error {   UNITIALIZED_MODEL ,   UNSUPPORTED_PROTOCOL ,   INTEGRATION_ERROR ,   PROTOCOL_ERROR ,   PROTOCOL_WARNING }
enum class	Protocol { MASS_BALANCE }

Functions
auto	operator<< (std::ostream &os, Protocol p) -> std::ostream &

Variables
constexpr const char *const	INPUT_MASS_NAME = "ngen::mass_in"
	Mass balance variable names.
constexpr const char *const	OUTPUT_MASS_NAME = "ngen::mass_out"
constexpr const char *const	STORED_MASS_NAME = "ngen::mass_stored"
constexpr const char *const	LEAKED_MASS_NAME = "ngen::mass_leaked"
constexpr const char *const	CONFIGURATION_KEY = "mass_balance"
	Configuration keys for defining configurable properties of the protocol.
constexpr const char *const	TOLERANCE_KEY = "tolerance"
constexpr const char *const	FATAL_KEY = "fatal"
constexpr const char *const	CHECK_KEY = "check"
constexpr const char *const	FREQUENCY_KEY = "frequency"

Typedef Documentation

ModelPtr

using models::bmi::protocols::ModelPtr = std::shared_ptr<models::bmi::Bmi_Adapter>

Properties

using models::bmi::protocols::Properties = geojson::PropertyMap

Enumeration Type Documentation

Error

enum class models::bmi::protocols::Error

strong

Enumerator
UNITIALIZED_MODEL
UNSUPPORTED_PROTOCOL
INTEGRATION_ERROR
PROTOCOL_ERROR
PROTOCOL_WARNING

Protocol

enum class models::bmi::protocols::Protocol

strong

Enumerator
MASS_BALANCE

Function Documentation

operator<<()

auto models::bmi::protocols::operator<<	(	std::ostream &	os,
		Protocol	p ) -> std::ostream&

References MASS_BALANCE.

Variable Documentation

CHECK_KEY

const char* const models::bmi::protocols::CHECK_KEY = "check"

constexpr

Referenced by models::bmi::protocols::NgenMassBalance::initialize().

CONFIGURATION_KEY

const char* const models::bmi::protocols::CONFIGURATION_KEY = "mass_balance"

constexpr

Configuration keys for defining configurable properties of the protocol.

Referenced by models::bmi::protocols::NgenMassBalance::initialize().

FATAL_KEY

const char* const models::bmi::protocols::FATAL_KEY = "fatal"

constexpr

Referenced by models::bmi::protocols::NgenMassBalance::initialize().

FREQUENCY_KEY

const char* const models::bmi::protocols::FREQUENCY_KEY = "frequency"

constexpr

Referenced by models::bmi::protocols::NgenMassBalance::initialize().

INPUT_MASS_NAME

const char* const models::bmi::protocols::INPUT_MASS_NAME = "ngen::mass_in"

constexpr

Mass balance variable names.

Referenced by models::bmi::protocols::NgenMassBalance::check_support(), and models::bmi::protocols::NgenMassBalance::run().

LEAKED_MASS_NAME

const char* const models::bmi::protocols::LEAKED_MASS_NAME = "ngen::mass_leaked"

constexpr

Referenced by models::bmi::protocols::NgenMassBalance::check_support(), and models::bmi::protocols::NgenMassBalance::run().

OUTPUT_MASS_NAME

const char* const models::bmi::protocols::OUTPUT_MASS_NAME = "ngen::mass_out"

constexpr

Referenced by models::bmi::protocols::NgenMassBalance::check_support(), and models::bmi::protocols::NgenMassBalance::run().

STORED_MASS_NAME

const char* const models::bmi::protocols::STORED_MASS_NAME = "ngen::mass_stored"

constexpr

Referenced by models::bmi::protocols::NgenMassBalance::check_support(), and models::bmi::protocols::NgenMassBalance::run().

TOLERANCE_KEY

const char* const models::bmi::protocols::TOLERANCE_KEY = "tolerance"

constexpr

Referenced by models::bmi::protocols::NgenMassBalance::initialize().