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	Unit
class	Vector
Typedefs
typedef unsigned long long	rawtime_t
typedef unsigned int	UnitID_t
typedef int	PcsOrd_t
typedef std::string	UnitClass_t
typedef std::string	InputDataName_t
typedef std::string	VariableName_t
typedef unsigned int	TimeStep_t
typedef double	ScalarValue
typedef Vector< ScalarValue >	VectorValue
typedef std::vector< ScalarValue >	SerieOfScalarValue
typedef std::vector< VectorValue >	SerieOfVectorValue
typedef std::map < FuncParamKey_t, FuncParamValue_t >	FuncParamsMap_t
typedef std::map< UnitID_t, float >	IDFloatMap
typedef std::map< UnitID_t, double >	IDDoubleMap
typedef std::map< UnitID_t, ScalarValue >	IDScalarValueMap
typedef std::map< UnitID_t, int >	IDIntMap
typedef std::map< UnitID_t, bool >	IDBoolMap
typedef std::map< UnitID_t, VectorValue >	IDVectorValueMap
typedef std::map< UnitID_t, VectorValue * >	IDVectorValuePtrMap
typedef std::map< UnitClass_t, UnitsCollection >	UnitsListByClassMap_t
typedef std::list< Unit * >	UnitsPtrList_t
typedef std::list< Unit >	UnitsList_t

---

Detailed Description

Data structures for shared information management

---

Typedef Documentation

typedef std::map<FuncParamKey_t,FuncParamValue_t> openfluid::core::FuncParamsMap_t

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

typedef std::map<UnitID_t,bool> openfluid::core::IDBoolMap

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

typedef std::map<UnitID_t,double> openfluid::core::IDDoubleMap

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

typedef std::map<UnitID_t,float> openfluid::core::IDFloatMap

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

typedef std::map<UnitID_t,int> openfluid::core::IDIntMap

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

typedef std::map<UnitID_t,ScalarValue> openfluid::core::IDScalarValueMap

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

typedef std::map<UnitID_t,VectorValue> openfluid::core::IDVectorValueMap

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

typedef std::map<UnitID_t,VectorValue*> openfluid::core::IDVectorValuePtrMap

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

typedef std::string openfluid::core::InputDataName_t

Type definition for name of input data

typedef int openfluid::core::PcsOrd_t

Type definition for the process order of units

typedef unsigned 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 unsigned int openfluid::core::TimeStep_t

Type definition for a time step value

typedef std::string openfluid::core::UnitClass_t

Type definition for the class of units

typedef unsigned int openfluid::core::UnitID_t

Type definition for the ID of units

typedef std::list<Unit> openfluid::core::UnitsList_t

Type definition for a list of units

typedef std::map<UnitClass_t,UnitsCollection> openfluid::core::UnitsListByClassMap_t

Type for a hashmap of lists of units, indexed by UnitClass

typedef std::list<Unit*> openfluid::core::UnitsPtrList_t

Type for a list of pointers on Unit

typedef std::string openfluid::core::VariableName_t

Type definition for name of a variable

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);