Parametric signature

Table of Contents

• In openfluid-wareinfo.json
• In cmake
• In sources
• In doc (optional)

Even if compiled simulators require an explicit definition of variable and unit class, the underlying code and signature can be templated. Before json signature, such change was possible through precompilation blocks around signature lines.

Since json signature we provide a new workflow to handle parametric information both in code and documentation.

In openfluid-wareinfo.json

Template variables (in id, unit definition...) should be surrounded by '@'

Example: water.surf-@foo@

In cmake

Affect a value to your variable in the main CMakeLists.txt

Example: SET(foo "SU")

Uncomment CONFIGURED_SIGNATURE ON in the CMakeLists.txt of src

In sources

(as before the parametric signature change)

Variable can be transmitted to cpp as precompilation variable by adding a definition in the CMakeLists.txt

Example: ADD_DEFINITIONS(-DISFOO=1)

Afterwards the precompilation variable ISFOO will be found in cpp code

In doc (optional)

Patterns in README and README.md in root dir of the ware will also be converted

Example:

# water.runoff.@foo@
 
 
Effect on @foo@ will...