openfluid::core Namespace Reference

Classes
class	DateTime
	Class for management of date and time information. More...
class	DistributedEvent
	Class defining a discrete event, including attached information. More...
class	EventCollection
	Class defining a collection of discrete events. More...
class	GroundwaterUnit
	Definition class for Groundwater Hydrological Units. More...
class	HydroObject
class	ReachSegment
	Definition class for reach segments. More...
class	SpatialRepository
class	SurfaceUnit
	Class definition for Surface Units (SUs). More...
class	ValueFactory
	Class for numerical values conversions and manipulations. More...
class	Vector
Typedefs
typedef long long	rawtime_t
typedef int	UnitID
typedef double	ScalarValue
typedef Vector< ScalarValue >	VectorValue
typedef std::vector< ScalarValue >	SerieOfScalarValue
typedef std::vector< VectorValue >	SerieOfVectorValue
Enumerations
enum	SUDownstreamCode
	Enumerates possible flow types from a surface unit. More...
Functions
	WX_DECLARE_STRING_HASH_MAP (wxString, EventInfosMap)
	WX_DECLARE_STRING_HASH_MAP (SerieOfScalarValue *, SimulatedVarsMap)
	WX_DECLARE_STRING_HASH_MAP (SerieOfVectorValue *, SimulatedVectorVarsMap)
	WX_DECLARE_STRING_HASH_MAP (ScalarValue, PropertiesMap)
	WX_DECLARE_STRING_HASH_MAP (wxString, ParamsMap)
	WX_DECLARE_HASH_MAP (openfluid::core::UnitID, float, wxIntegerHash, wxIntegerEqual, IDFloatMap)
	WX_DECLARE_HASH_MAP (openfluid::core::UnitID, double, wxIntegerHash, wxIntegerEqual, IDDoubleMap)
	WX_DECLARE_HASH_MAP (openfluid::core::UnitID, openfluid::core::ScalarValue, wxIntegerHash, wxIntegerEqual, IDScalarValueMap)
	WX_DECLARE_HASH_MAP (openfluid::core::UnitID, int, wxIntegerHash, wxIntegerEqual, IDIntMap)
	WX_DECLARE_HASH_MAP (openfluid::core::UnitID, bool, wxIntegerHash, wxIntegerEqual, IDBoolMap)
	WX_DECLARE_HASH_MAP (openfluid::core::UnitID, openfluid::core::VectorValue, wxIntegerHash, wxIntegerEqual, IDVectorValueMap)
	WX_DECLARE_HASH_MAP (openfluid::core::UnitID, openfluid::core::VectorValue *, wxIntegerHash, wxIntegerEqual, IDVectorValuePtrMap)

---

Detailed Description

Gathers data structures for shared information management

---

Typedef Documentation

typedef long long openfluid::core::rawtime_t

Type for raw time (seconds since 4713BC)

typedef double openfluid::core::ScalarValue

Type definition for scalar values

typedef std::vector<ScalarValue> openfluid::core::SerieOfScalarValue

Type definition for a time serie of scalar values

typedef std::vector<VectorValue> openfluid::core::SerieOfVectorValue

Type definition for a time serie of vectorvalues

typedef int openfluid::core::UnitID

Type definition for the ID of units

typedef Vector<ScalarValue> openfluid::core::VectorValue

Type definition for vector values. This type is based on the openfluid::core::Vector template.

See also:

openfluid::core::Vector

usage examples:

  // create an empty vector
  openfluid::core::VectorValue TmpValue;

  // give a size of 10 to this vector
  TmpValue = openfluid::core::VectorValue(10);

  // give a size of 10 to this vector and fill it with a value of2
  TmpValue = openfluid::core::VectorValue(10,2);

  // read the value at index 6 in put it in a variable MyVar
  MyVar = TmpValue[6];
  // or
  MyVar = TmpValue.at(6);

  // set or modify the value 15 at index 3
  TmpValue.setElement(3,15);

---

Enumeration Type Documentation

enum openfluid::core::SUDownstreamCode

Enumerates possible flow types from a surface unit.

Author:

Jean-Christophe FABRE <fabrejc@ensam.inra.fr>

---

Function Documentation

openfluid::core::WX_DECLARE_HASH_MAP	(	openfluid::core::UnitID	,
		openfluid::core::VectorValue *	,
		wxIntegerHash	,
		wxIntegerEqual	,
		IDVectorValuePtrMap
	)

Map associating a pointer to an openfluid::core::VectorValue value to a unit, indexed by its ID

openfluid::core::WX_DECLARE_HASH_MAP	(	openfluid::core::UnitID	,
		openfluid::core::VectorValue	,
		wxIntegerHash	,
		wxIntegerEqual	,
		IDVectorValueMap
	)

Map associating an openfluid::core::VectorValue value to a unit, indexed by its ID

openfluid::core::WX_DECLARE_HASH_MAP	(	openfluid::core::UnitID	,
		bool	,
		wxIntegerHash	,
		wxIntegerEqual	,
		IDBoolMap
	)

Map associating a boolean value to a unit, indexed by its ID

openfluid::core::WX_DECLARE_HASH_MAP	(	openfluid::core::UnitID	,
		int	,
		wxIntegerHash	,
		wxIntegerEqual	,
		IDIntMap
	)

Map associating an integer value to a unit, indexed by its ID

openfluid::core::WX_DECLARE_HASH_MAP	(	openfluid::core::UnitID	,
		openfluid::core::ScalarValue	,
		wxIntegerHash	,
		wxIntegerEqual	,
		IDScalarValueMap
	)

Map associating an openfluid::core::ScalarValue value to a unit, indexed by its ID

openfluid::core::WX_DECLARE_HASH_MAP	(	openfluid::core::UnitID	,
		double	,
		wxIntegerHash	,
		wxIntegerEqual	,
		IDDoubleMap
	)

Map associating a double precision value to a unit, indexed by its ID

openfluid::core::WX_DECLARE_HASH_MAP	(	openfluid::core::UnitID	,
		float	,
		wxIntegerHash	,
		wxIntegerEqual	,
		IDFloatMap
	)

Map associating a float value to a unit, indexed by its ID

openfluid::core::WX_DECLARE_STRING_HASH_MAP	(	wxString	,
		ParamsMap
	)

Hash table for parameters (distributed properties, distributed initial conditions, ...)

openfluid::core::WX_DECLARE_STRING_HASH_MAP	(	ScalarValue	,
		PropertiesMap
	)

Hash table for parameters (distributed properties, distributed initial conditions, ...)

openfluid::core::WX_DECLARE_STRING_HASH_MAP	(	SerieOfVectorValue *	,
		SimulatedVectorVarsMap
	)

Hash table for calculated vector variables during simulation. Each variable is stored in the hash table as an entry, located by its name. (exemple "effrain" for efficient rain calculated by the production function) Each variable is stored as a vector of double (one vector item = one step, vector[25] is calculated at the 25th step)

openfluid::core::WX_DECLARE_STRING_HASH_MAP	(	SerieOfScalarValue *	,
		SimulatedVarsMap
	)

Hash table for calculated scalar variables during simulation. Each variable is stored in the hash table as an entry, located by its name. (exemple "effrain" for efficient rain calculated by the production function) Each variable is stored as a vector of double (one vector item = one step, vector[25] is calculated at the 25th step)

openfluid::core::WX_DECLARE_STRING_HASH_MAP	(	wxString	,
		EventInfosMap
	)

The map associating a key to a value