General information

General organization

The OpenFLUID libraries features are gathered 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):

• openfluid::base::PluggableFunction
• openfluid::base::SimulationStatus
• openfluid::base::SimulationInfo

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 classes (non-exhaustive list):

• openfluid::core::Unit

Simulation data types and structure

The simulation variables can be scalar data (a double precision floating value) or vector data (vector of double precision floating values). A date is associated to each value of simulation variables. This involves the following classes and structures (non-exhaustive list):

• openfluid::core::DateTime
• openfluid::core::ScalarValue
• openfluid::core::VectorValue

Simulation data types and structure

Simulation functions can handle discrete events, associated to homogeneous units. This involves the following classes and structures (non-exhaustive list):

• openfluid::core::Event
• openfluid::core::EventsCollection

Tools

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

• openfluid::tools::ColumnTextParser
• openfluid::tools::DateTimeSerie
• openfluid::tools::DistributeInterpolate
• openfluid::tools::IsCloseEnough
• openfluid::tools::IsVeryClose

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