Subsections

3. Appendix

3.1 Command line options

-a, ---auto-output-dir generate automatic results output directory
-c, ---clean-output-dir clean results output directory by removing existing files
-f, ---functions-list list available functions (do not run the model)
-h, ---help show this help message
-i, ---input-dir=<str> set dataset input directory
-k, ---openfluid-version get ofelib version used for current OpenFLUID-engine build (do not run the model)
-m, ---trace-dir=<str> set trace directory
-o, ---output-dir=<str> set results output directory
-p, ---functions-paths=<str> add extra functions research paths (colon separated)
-q, ---quiet quiet display during simulation run
-r, ---functions-report print a report of available functions, with details (do not run the model)
-s, ---no-simreport do not generate simulation report
-u, ---matching-functions-report=<str> print a report of functions matching the given wildcard-based pattern (do not run the model)
-v, ---verbose verbose display during simulation
---version get version (do not run the model)
-x, ---xml-functions-report print a report of available functions in xml format, with details (do not run the model)
-z, ---no-results do not write results files
---no-varname-check do not check variable name against nomenclature

3.2 Date-time formats used in outputs configuration

The output.xml file can use the ANSI strftime() standards formats for date time, through a format string. The format string consists of zero or more conversion specifications and ordinary characters. A conversion specification consists of a % character and a terminating conversion character that determines the conversion specification's behaviour. All ordinary characters (including the terminating null byte) are copied unchanged into the array.


For example, the nineteenth of April, two-thousand seven, at eleven hours, ten minutes and twenty-five seconds formatted using different format strings:


List of available conversion specifications:

%a is replaced by the locale's abbreviated weekday name.
%A is replaced by the locale's full weekday name.
%b is replaced by the locale's abbreviated month name.
%B is replaced by the locale's full month name.
%c is replaced by the locale's appropriate date and time representation.
%C is replaced by the century number (the year divided by 100 and truncated to an integer) as a decimal number [00-99].
%d is replaced by the day of the month as a decimal number [01,31].
%D same as %m/%d/%y.
%e is replaced by the day of the month as a decimal number [1,31]; a single digit is preceded by a space.
%h same as %b.
%H is replaced by the hour (24-hour clock) as a decimal number [00,23].
%I is replaced by the hour (12-hour clock) as a decimal number [01,12].
%j is replaced by the day of the year as a decimal number [001,366].
%m is replaced by the month as a decimal number [01,12].
%M is replaced by the minute as a decimal number [00,59].
%n is replaced by a newline character.
%p is replaced by the locale's equivalent of either a.m. or p.m.
%r is replaced by the time in a.m. and p.m. notation; in the POSIX locale this is equivalent to %I:%M:%S %p.
%R is replaced by the time in 24 hour notation (%H:%M).
%S is replaced by the second as a decimal number [00,61].
%t is replaced by a tab character.
%T is replaced by the time (%H:%M:%S).
%u is replaced by the weekday as a decimal number [1,7], with 1 representing Monday.
%U is replaced by the week number of the year (Sunday as the first day of the week) as a decimal number [00,53].
%V is replaced by the week number of the year (Monday as the first day of the week) as a decimal number [01,53]. If the week containing 1 January has four or more days in the new year, then it is considered week 1. Otherwise, it is the last week of the previous year, and the next week is week 1.
%w is replaced by the weekday as a decimal number [0,6], with 0 representing Sunday.
%W is replaced by the week number of the year (Monday as the first day of the week) as a decimal number [00,53]. All days in a new year preceding the first Monday are considered to be in week 0.
%x is replaced by the locale's appropriate date representation.
%X is replaced by the locale's appropriate time representation.
%y is replaced by the year without century as a decimal number [00,99].
%Y is replaced by the year with century as a decimal number.
%Z is replaced by the timezone name or abbreviation, or by no bytes if no timezone information exists.
%% is replaced by %.


3.3 Useful links

3.3.1 OpenFLUID project

3.3.2 External tools

Jean-Christophe Fabre 2009-08-17