General information

General organization

The OpenFLUID libraries features are gathered together into the openfluid namespace, which is made of several parts. The three main parts are:

openfluid::core, defined in openfluid/core.hpp, gathers all the classes for the shared data between the OpenFLUID framework and the functions, and between the functions themselves
openfluid::base, defined in openfluid/base.hpp, gathers all the classes for the dynamic linking between the OpenFLUID framework and the functions, and in particular the openfluid::base::PluggableFunction class
openfluid::tools, defined in openfluid/tools.hpp, gathers tools available for data processing, files reading, ...

These libraries mainly rely on external libraries:

The boost libraries : http://www.boost.org/
The libXML2 library for XML file handling : http://xmlsoft.org/
The C++ Standard Type Library (STL) for common data structures : http://www.sgi.com/tech/stl/
The Glibmm/Gtkmm library for GUI development and convenience features: http://www.gtkmm.org/
The libCURL library for networking capabilities : http://curl.haxx.se/

Features

Plug-in/framework software architecture

The OpenFLUID framework provides a plugin interface for creating functions that can be used by any OpenFLUID software application.
This involves the following classes and structures (non-exhaustive list):

Spatio-temporal data structure

In order to store and manage all the data handled to represent the spatial domain and the simulation information, the OpenFLUID framework defines a data structure for spatio-temporal data management.
This involves the following class (non-exhaustive list):

openfluid::core::Unit

Simulation parameters and input data

Models can be parameterized using functions parameters at simulation function level, or using input data associated to spatial units. This involves the following classes and structures (non-exhaustive list):

openfluid::core::FuncParamsMap_t
openfluid::core::Value and its derived types

See also:: Preliminary information about data types; Access to simulation parameters, input data, variables and events

Simulation variables and events

The simulation variables can be of any defined type. A date is associated to each value of simulation variables. Simulation functions can also handle discrete events, associated to spatial units. This involves the following classes and structures (non-exhaustive list):

openfluid::core::Value and its derived types
openfluid::core::Event
openfluid::core::EventsCollection
openfluid::core::DateTime

See also:: Preliminary information about data types; Access to simulation parameters, input data, variables and events

Tools

This involves the following classes and functions (non-exhaustive list):

The FortranCPP.h header file make Fortran code encapsulation (into simulation functions) easier.