Subsections

2. FluidX file(s) format

This part of the manual describes the FluidX file(s) format. Refer to the "Usage" part of this manual to run the simulation.

2.1 Overview

The FluidX file format is an XML based format for OpenFLUID input file(s). The OpenFLUID input information can be provided by a one or many files using the FluidX format.
Whatever the input information is put into one or many files, the following sections must be defined in the input file set:

The order of the sections is not significant. All of these sections must be inclosed into an openfluid section defined by the <openfluid> tag.


\begin{lstlisting}[language=xml,title=\footnotesize\textit{summary view of the
X...
...!-- here is the run configuration -->
</run>
\par
</openfluid>
\end{lstlisting}

2.2 Sections

2.2.1 Model

The flux model is defined by an ordered set of data generators and simulations functions that will be plugged to the OpenFLUID kernel. It defines the model for the simulation. It can also include a global parameters section which applies to all simulation functions and generators. The global parameters may be overridden by local parameters of simulation functions or generators.
The flux model must be defined in a section delimited by the <model> tag, and must be structured following these rules:


\begin{lstlisting}[language=xml,title=\footnotesize\textit{example}]
<?xml versi...
...aram1'' value=''50'' />
</function>
\par
</model>
</openfluid>
\end{lstlisting}


Warning: There must be only one model definition in the input dataset.


Warning: The order of the simulation functions and data generators in the <model> section is very important : the same order will be used for execution on the same time step


2.2.2 Spatial domain

2.2.2.1 Definition and relationships

The spatial domain is defined by a set of spatial units that are connected each others. These spatial units are defined by a numerical identifier (ID) and a class. They also include information about the processing order of the unit in the class. Each unit can be connected to zero or many other units from the same or a different unit class.
The spatial domain definition must be defined in a section delimited by the <definition> tag, which is a sub-section of the domain tag, and must be structured following these rules:


\begin{lstlisting}[language=xml,title=\footnotesize\textit{example}]
<?xml versi...
...'' pcsorder=''1'' />
\par
</definition>
</domain>
</openfluid>
\end{lstlisting}


2.2.2.2 Input data

The spatial domain input data are static data brought by units, usually properties and initial conditions for each unit.
The spatial domain input data must be defined in a section delimited by the <inputdata> tag, which is a sub-section of the domain tag, and must be structured following these rules:



\begin{lstlisting}[language=xml,title=\footnotesize\textit{example}]
<?xml versi...
...taB3''>
2 18 STRVALX
</inputdata>
\par
</domain>
</openfluid>
\end{lstlisting}



Note: Old inputdata format, with <columns> and <data> tags are still useable. However, you are encouraged to use the new FluidX file format.


2.2.2.3 Discrete events

The discrete events are events occuring on units, and that can be processed by simulation functions. The spatial events must be defined in a section delimited by the <calendar> tag, which is a sub-section of the domain tag, and must be structured following these rules:


\begin{lstlisting}[language=xml,title=\footnotesize\textit{example}]
<?xml versi...
...=''EADG'' />
</event>
\par
</calendar>
</domain>
</openfluid>
\end{lstlisting}


2.2.3 Run configuration

The configuration of the simulation gives the simulation period, the data exchange time step, and the optionnal progressive output parameters.
The run configuration must be defined in a section delimited by the <run> tag, and must be structured following these rules:


\begin{lstlisting}[language=xml,title=\footnotesize\textit{example}]
<?xml versi...
...'10'' />
<filesbuffer kbytes=''8'' />
\par
</run>
</openfluid>
\end{lstlisting}


2.2.4 Outputs configuration

The configuration of the simulation outputs gives the description of the saved results.
The outputs configuration must be defined in a section delimited by the <output> tag, and must be structured following these rules:


\begin{lstlisting}[language=xml,title=\footnotesize\textit{example}]
<?xml versi...
...=''*'' precision=''7''/>
</files>
\par
</output>
</openfluid>
\end{lstlisting}

Jean-Christophe Fabre 2012-07-17