Quick user manual
Contents
1. lt function filelD example functionB gt lt param name parami value strvalue gt lt param name param2 value 1 1 gt lt param name gparami value 50 gt lt function gt lt model gt lt domain gt lt definition gt lt unit class PU ID 1 pcsorder 1 gt lt unit class EU1 ID 3 pcsorder 1 gt lt to class EU1 ID 11 gt lt childof class PU ID 1 gt lt unit gt lt unit class EU1 ID 11 pcsorder 3 gt lt to class EU2 ID 2 gt lt unit gt lt unit class EU2 ID 2 pcsorder 1 gt lt definition gt lt inputdata unitclass EU1 colorder indataA gt 3 1 1 101 0700 lt inputdata gt lt inputdata unitclass EU2 colorder indataB1 indataB3 gt 2 18 STRVALX lt inputdata gt lt calendar gt lt event unitclass EU1 unitID 11 date 1999 12 31 23 59 59 gt lt info key when value before gt lt info key where value 1 gt lt info key vari value 1 13 gt lt info key var2 value EADGBE gt lt event gt lt event unitclass EU2 unitID 3 date 2000 02 05 12 37 51 gt lt info key var3 value 152 27 gt lt info key var4 value XYZ gt lt event gt lt event unitclass EU1 unitID 11 date 2000 02 25 12 00 00 gt lt info key vari value 1 15 gt lt info key var2 value EADG gt lt event gt lt calendar gt lt domain gt 3 6 FILE FORMATS FOR INTERP OR INJECT DATA GENERATOR 23 l2. 3 7 3 colnames as data example of an output data file datetime varl var2 2000 01 01 00 00 00 0 00000 1 00000 2000 01 01 01 00 00 2 00000 3 00000 2000 01 01 02 00 00 4 00000 5 00000 2000 01 01 03 00 00 6 00000 7 00000 2000 01 01 04 00 00 8 00000 9 00000 2000 01 01 05 00 00 10 00000 11 00000 3 8 USEFUL LINKS 25 3 7 4 full example of an output data file simulation ID file TestUnits2_full info scalars out date 2011 Sep 05 10 23 17 394061 unit TestUnits 2 scalar variables order after date and time columns varl var2 20110905 VZIRXC datetime varl var2 2000 01 01 2000 01 01 2000 01 01 2000 01 01 2000 01 01 2000 01 01 00 01 02 03 04 05 00 00 2003 00 00 00 00 0 00000 1 00000 00 2 00000 3 00000 00 4 00000 5 00000 00 6 00000 7 00000 00 8 00000 9 00000 00 10 00000 11 00000 3 8 Useful links 3 8 1 OpenFLUID project e OpenFLUID web site e OpenFLUID web community e OpenFLUID on SourceSup software forge 3 8 2 External tools e Geany http www geany org Gnuplot GRASS GIS http grass itc it jEdit Octave QGIS hitb www agi 019 R Scilab Visit
3. OpenFLUID Software Environment for Modelling Fluxes in Landscapes Quick user manual OpenFLUID 1 7 0 LISAH Fabre J C and the modellin Laboratoire d tude des Interactions group at L ISA Sol Agrosyst me Hydrosysteme Contents Foreword a di As da di ro ee 2 Inputsdatasebl a s rp ori nen ata a Beek AA A Ba oe ee D ee ee 1 4 Explore the results 1 5 Buddies 2 FluidX file s format a o oc e cet Ge A ee 2 2 Sections 3 1 Command line options 3 2 Environment variables 3 3 Structure of an OpenFLUID project sobre ei de nn tb pia isa RE pora ae 3 7 Header types examples 3 8 Useful links 000 NN Foreword This quick reference manual will help you to prepare and run simulations using the OpenFLUID sofware lt will not explain the concepts behind the software nor the scientific approaches in land scapes modelling and simulation Typographic conventions The to note informations are emphasized like this Note to note information The source code examples are emphasized like this example of source code Source code with grey background and fixed size font The warning informations are emphasized like this Warning warning informations Chapter 1 Usage information The OpenFLUID software is available on Linux Windows and MacOSX platforms It is made of the OpenFLUID framework and OpenFLUID applications
4. tags usually into C comments From these sources of information it builds a ATEX document which could be compiled into a PDF document and or HTML pages The func2doc buddy can also use information from an optional sub directory named doc located in the same directory as the input source file The information in the doc subdirectory should be linked to the information from the source code using ATEX input command The func2doc buddy is available on UNIX only systems Linux MacOSX Required options inputcpp path for cpp file to parse outputdir path for generated files Other options html set to 1 in order to generate documentation as HTML files pdf set to 1 in order to generate documentation as PDF file tplfile path to template file Usage example openfluid engine buddy func2doc buddyopts inputcpp path to cppfile cpp outputdir path to out 10 CHAPTER 1 USAGE INFORMATION 1 5 2 newfunc The newfunc buddy generate a skeleton source code of a simulation function using given options Required options cppclass C class name of the function funcid ID of the function Other options authoremail email s of the author s of the function authorname name s of the author s of the function outputdir path for generated files Usage example openfluid engine buddy newfunc buddyopts funcid domain subdomain process method outputdir path to outputdir 1 5 3 newdata The newdata buddy generate a skeleton dataset
5. We encourage you to use the OpenFLUID software on Linux platform as it is the development and usually used platform This usage information is for a command line use of OpenFLUID For usage through the graphical user interface you have to run the openfluid builder software which is not presented in this document 1 1 Installation On linux platforms the OpenFLUID software is available as distribution packages deb rpm or archive files tar gz tar bz2 The recommanded way to install it is to use packages for your Linux distribution If you want to use archive files you have to unarchive the software according to the directory tree Once installed the openfluid engine command should be available You can check it by running the command openfluid engine help or openfluid engine version in your favorite terminal You are now ready to run your first simulation 1 2 Input dataset Before running the simulation the input dataset must be built An OpenFLUID Engine input dataset includes different informations defined in one or many files e the spatial domain definition e the flux model definition the spatial domain input data the discrete events e the run configuration e the outputs configuration All files must be placed into any directory that can be reached by the engine The default searched directory is a directory named openfluid OPENFLUID IN and located into the user home directory the user home directory may vary
6. tag may include zero to many lt param gt tags giving parameters to the func tion Each lt param gt tag must bring a name attribute giving the name of the parameter and a value attribute giving the value of the parameter These parameters can be scalar or vector of integer values floating point values string values In case of vector the values of the vector are separated by a semicolon e Each lt generator gt tag must bring a varname attribute giving the name of the produced variable a unitclass attribute giving the unit class of the produced variable a method attribute giving the method used to produce the variable fixed for constant value random for random value in a range interp for a time interpolated value from given data series inject for an injected value no time interpolation from given data series An optional lt varsize gt attribute can be set in order to produce a vector variable instead of a scalar variable e Each lt generator gt tag may include zero to many lt param gt tags giving parameters to the generator Each lt param gt tag must bring a name attribute giving the name of the parameter and a value attribute giving the value of the parameter e A generator using the fixed method must provide a param named fixedvalue for the value to produce e A generator using the random method must provide a param named min and a param named max delimiting the random range for the value to produce e generator
7. Each lt info gt tag give information about the event and must bring a key attribute giving the name the key of the info and a value attribute giving the value for this key example lt xml version 1 0 standalone yes gt lt openfluid gt lt domain gt lt calendar gt lt event unitclass EU1 unitID 11 date 1999 12 31 23 59 59 gt lt info key when value before gt lt info key where value 1 gt lt info key vari value 1 13 gt lt info key var2 value EADGBE gt lt event gt lt event unitclass EU2 unitID 3 date 2000 02 05 12 37 51 gt lt info key var3 value 152 27 gt lt info key var4 value XYZ gt lt event gt lt event unitclass EU1 unitID 11 date 2000 02 25 12 00 00 gt lt info key vari value 1 15 gt lt info key var2 value EADG gt lt event gt lt calendar gt lt domain gt lt openfluid gt 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 lt run gt tag and must be structured following these rules e Inside the lt run gt tag there must be a lt deltat gt tag giving the data exchange time step in seconds 16 CHAPTER 2 FLUIDX FILE S FORMAT Inside the lt run gt tag there must be a lt period gt tag giving the simulation
8. Required options outputdir Output directory for generated dataset Usage example openfluid engine buddy newdata buddyopts outputdir path to outputdir 1 5 4 convert The convert buddy converts a dataset from a specific version format to another one Currently conversion is possible from 1 3 x format to 1 4 x format and from 1 4 x format to 1 5 x format Required options convmode Conversion mode Available modes are 13_14 14_15 inputdir Input directory for dataset to convert outputdir Output directory for converted dataset Usage example openfluid engine buddy convert buddyopts convmode 13_14 inputdir path to inputdir outputdir Chapter 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 e The model section defined by the lt model gt tag e The spatial domain section defined by the lt domain gt tag e The run configuration section defined by the lt run gt tag e The outputs configuration section defined by the lt output gt tag The order of the sections is not significant All of these sections must be inclose
9. a data exchange time step represented as a date and time The format of the files depends on the configuration of outputs set through the run xml file The default output directory is a directory named openfluid OPENFLUID OUT and located into the user 1 5 BUDDIES 9 home directory the user home directory may vary depending on the used operating system If you prefer to store your outputs into another directory you can specify it using command line options passed to the engine o or output dir In order to process the results of your simulations we encourage you to use software environments such as R Scilab or Octave spreadsheets such as OpenOffice Calc GIS such as GRASS or QGIS 1 5 Buddies Buddies are small tools that help scientific developers in order to complete the modelling and or development works They are usable from the command line using the buddyhelp buddy and buddyopts options Four buddies are available e func2doc e newfunc e newdata e convert Options are given to buddies through a comma separated list of key value arguments using the buddyopts command line option General usage is openfluid engine buddy buddyname buddyopts abuddyopt avalue anotherbuddyopt anothervalue 1 5 1 func2doc The func2doc buddy extracts scientific information from the source code of simulation functions It uses the function signature and ATEX formatted text placed between the lt func2doc gt and lt func2doc gt
10. can be used to include all variables for the given units class The value for the precision attribute must be gt 0 If not provided the default value for the precision is 5 example lt xml version 1 0 standalone yes gt lt openfluid gt lt output gt lt files colsep dtformat Y m d H M S commentchar gt lt set name testRS unitsclass RS unitsIDs 51 232 vars x gt lt set name full unitsclass SU unitsIDs vars precision 7 gt lt files gt lt files colsep dtformat Y m AT H M S commentchar header colnames as data gt lt set name full unitsclass SU unitsIDs vars precision 7 gt lt files gt lt output gt lt openfluid gt Chapter 3 Appendix 3 1 Command line options a auto output dir b buddy lt arg gt buddyhelp lt arg gt buddyopts lt arg gt c clean output dir f functions list h help 1 input dir lt arg gt k enable simulation profiling 0 output dir lt arg gt p functions paths lt arg gt q quiet r functions report S no simreport show paths u matching functions report lt arg gt V verbose version W project lt arg gt x xml functions report Z no result 3 2 Environment variables generate automatic results output directory run specified OpenFLUID buddy display help message for specified OpenFLUID buddy set options for
11. specified OpenFLUID buddy clean results output directory by removing existing files list available functions do not run the simulation display help message set dataset input directory enable time profiling for functions set results output directory add extra functions research paths quiet display during simulation run print a report of available functions with details do not run the simulation do not generate simulation report print the used paths do not run the simulation print a report of functions matching the given wildcard based pattern do not run the simulation verbose display during simulation get version do not run the simulation set project directory print a report of available functions in xml format with details do not run the simulation do not write results files The OpenFLUID framework takes into account the following environment variables if they are set e OPENFLUID_FUNCS_PATH extra search paths for OpenFLUID simulation functions The path are separated by colon on UNIX systems and by semicolon on Windows systems 19 20 CHAPTER 3 APPENDIX e OPENFLUID_INSTALL_PREFIX overrides automatic detection of install path useful on Windows systems 3 3 Structure of an OpenFLUID project An OpenFLUID project can be run using OpenFLUID Engine or OpenFLUID Builder software It is a directory including e a openfluidprj file containing informations about the project e an IN subdirectory conta
12. 4 2007 10 11 25 o Y fm d H M will give 2007 04 19 10 11 e AY thm thd tZH t M tZS will give 2007 04 19 10 11 25 3 5 EXAMPLE OF AN INPUT DATASET AS A SINGLE FLUIDX FILE 21 List of available conversion specifications Format Description a locale s abbreviated weekday name A locale s full weekday name b locale s abbreviated month name B locale s full month name c locale s appropriate date and time representation C century number the year divided by 100 and truncated to an integer as a decimal number 00 99 d day of the month as a decimal number 01 31 D same as m d y e day of the month as a decimal number 1 31 a single digit is preceded by a space h same as b H hour 24 hour clock as a decimal number 00 23 l hour 12 hour clock as a decimal number 01 12 day of the year as a decimal number 001 366 m month as a decimal number 01 12 M minute as a decimal number 00 59 n is replaced by a newline character p locale s equivalent of either a m or p m r time in a m and p m notation in the POSIX locale this is equivalent to l M S p R time in 24 hour notation H M S second as a decimal number 00 61 t is replaced by a tab character T time H M S u weekday as a decimal number 1 7 with 1 representing Monday U week number of the year Sunday as the first day of the week as a decimal number 00 53 V week number of t
13. ction gt lt model gt lt openfluid gt Warning There must be only one model definition in the input dataset Warning The order of the simulation functions and data generators in the lt model gt section is very important the same order will be used for execution on the same time step 2 2 2 Spatial domain 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 lt definition gt tag which is a sub section of the domain tag and must be structured following these rules e Inside the lt definition gt tag there must be a set of lt unit gt tags e Each lt unit gt tag must bring an ID attribute giving the identifier of the unit a class attribute giving the class of the unit a pcsorder attribute giving the process order in the class of the unit e Each lt unit gt tag may include zero or many lt to gt tags giving the outgoing connections to other units Each lt to gt tag must bring an ID attribute giving the identifier of the connected unit and a class attribute giving the class of the connected unit e Each lt unit gt tag may inclu
14. d into an openfluid section defined by the lt openfluid gt tag summary view of the XML tree for FluidX files lt openfluid gt lt model gt lt here is the model definition gt lt model gt lt domain gt lt here is the spatial domain definition associated data and events gt lt domain gt lt output gt lt here is the output configuration gt lt output gt lt run gt lt here is the run configuration gt lt run gt lt openfluid gt 11 12 CHAPTER 2 FLUIDX FILE S FORMAT 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 lt model gt tag and must be structured following these rules e Inside the lt model gt tag there must be a set of lt function gt lt generator gt and lt gparams gt tags e Each lt function gt tag must bring a filelD attribute giving the identifier of the simulation function the value of the fileID attribute must match the file name without extension of a reachable and pluggable simulation function e Each lt function gt
15. de zero or many lt childof gt tags giving the parent units Each lt childof gt tag must bring an ID attribute giving the identifier of the parent unit and a class attribute giving the class of the parent unit 14 CHAPTER 2 FLUIDX FILE S FORMAT example lt xml version 1 0 standalone yes gt lt openfluid gt lt domain gt lt definition gt lt unit class PU ID 1 pcsorder 1 gt lt unit class EU1 ID 3 pcsorder 1 gt lt to class EU1 ID 11 gt lt childof class PU ID 1 gt lt unit gt lt unit class EU1 ID 11 pcsorder 3 gt lt to class EU2 ID 2 gt lt unit gt lt unit class EU2 ID 2 pcsorder 1 gt lt definition gt lt domain gt lt openfluid gt 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 lt inputdata gt tag which is a sub section of the domain tag and must be structured following these rules e The lt inputdata gt tag must bring a unitclass attribute giving the unit class to which input data must be attached and a colorder attribute giving the order of the contained column formatted data e Inside the lt inputdata gt tag there must be the input data as row column text As a rule the first column is the ID of the unit in the class given through the the unitclass attribute of
16. depending on the used operating system This directory is not automatically created it should be created by hand If you prefer to place your dataset in another 8 CHAPTER 1 USAGE INFORMATION directory you can specify it using command line options passed to the engine i or input dir In order to build these files we encouraged you to use a good text editor or better an XML editor You can also use custom scripts or macros in specialized sotware such as spreadsheets or Geographic Information Systems GIS to generate automatically the input dataset 1 3 Run the simulation To run the simulation if the dataset is located in the default searched directory simply run the com mand openfluid engine in your favorite terminal To specify a different input dataset directory use the i or input dir command line option You can also run a simulation from an OpenFLUID project using the w or project command line option followed by the path to the project directory In this case the project must be a valid OpenFLUID project Its structure is described in the appendix section It can be created by hand or using the OpenFLUID Builder software fabrejc lisah crampling Labo OpenFLUID Workspace Engine trunk _ build Fichier Edition Affichage Terminal Aide 1 4 Explore the results The results are stored in files gathered by spatial unit In each files the values for variables are stored as columns each row corresponfing to
17. he 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 Yw weekday as a decimal number 0 6 with O representing Sunday W 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 locale s appropriate date representation YX locale s appropriate time representation y year without century as a decimal number 00 99 Y year with century as a decimal number Z timezone name or abbreviation or by no bytes if no timezone information exists character 3 5 Example of an input dataset as a single FluidX file lt xml version 1 0 standalone yes gt lt openfluid gt lt model gt 22 CHAPTER 3 APPENDIX lt gparams gt lt param name gparami value 100 gt lt param name gparam2 value 0 1 gt lt gparams gt lt function filelD example functionA gt lt generator varname example generator fixed unitclass EU1 method fixed varsize 11 gt lt param name fixedvalue value 20 gt lt generator gt lt generator varname example generator random unitclass EU2 method random gt lt param name min value 20 53 gt lt param name max value 50 gt lt generator gt
18. ining the input dataset e an OUT subdirectory as the default output directory containing the simulation results if any The openfluidprj contains the name of the project the description of the project the authors the creation date the date of the latest modification and a flag for incremental output directory this feature is currently disabled example of openfluidprj file OpenFLUID Project Name a dummy project Description Authors John Doe IncOutput false CreationDate 20110527T121530 LastModDate 20110530T151431 For example if you wish to run a simulation with openfluid engine using the project located in absolute path to workdir a_dummy_project the command line to use is openfluid engine w absolute path to workdir a_dummy_project 3 4 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 e d m 4Y AH M S will give 19 0
19. lt inputdata gt tag the following columns are values following the column order given through the colorder attribute of the lt inputdata gt tag Values for the data can be real integer or string example lt xml version 1 0 standalone yes gt lt openfluid gt lt domain gt lt inputdata unitclass EU1 colorder indataA gt 3 41 L1 4 5 lt inputdata gt lt inputdata unitclass EU2 colorder indataB1 indataB3 gt 2 18 STRVALX lt inputdata gt lt domain gt lt openfluid gt 2 2 SECTIONS 15 Note Old inputdata format with lt columns gt and lt data gt tags are still useable However you are encouraged to use the new FluidX file format 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 lt calendar gt tag which is a sub section of the domain tag and must be structured following these rules e Inside the lt calendar gt tag there must be a set of lt event gt tags e Each lt event gt tag must bring a unitID and a unitclass attribute giving the unit on which occurs the event a date attribute giving the date and time of the event The date format must be YYYY MM DD hh mm ss The lt event gt tag may bring a name attribute and a a category attribute but they are actually ignored e Each lt event gt tag may include zero to many lt info gt tags e
20. mns text file containing a serie of values in time The six first columns are the date using the following format YYYY MM DD HH MM SS The 7 column is the value itself example of a source data file 1999 12 31 12 00 00 1 0 1999 12 31 23 00 00 5 0 2000 01 01 00 30 00 15 0 2000 01 01 00 40 00 5 0 2000 01 01 01 30 00 15 0 24 CHAPTER 3 APPENDIX 3 6 2 Distribution A distribution file is a two column file associating a unit ID 1 column to a source ID 2 column example of distribution file oP WN PNR N 3 7 Header types examples The following examples show output files for 2 variables varl and var2 extracted from a 6 hours simulation ran at a time step of an hour 3 7 1 none example of an output data file 2000 01 01 00 00 00 0 00000 1 00000 2000 01 01 01 00 00 2 00000 3 00000 2000 01 01 02 00 00 4 00000 5 00000 2000 01 01 03 00 00 6 00000 7 00000 2000 01 01 04 00 00 8 00000 9 00000 2000 01 01 05 00 00 10 00000 11 00000 3 7 2 info example of an output data file simulation ID 20110905 VZIRXC file TestUnits2_full info scalars out date 2011 Sep 05 10 23 17 394061 unit TestUnits 2 scalar variables order after date and time columns vari var2 2000 01 01 00 00 00 0 00000 1 00000 2000 01 01 01 00 00 2 00000 3 00000 2000 01 01 02 00 00 4 00000 5 00000 2000 01 01 03 00 00 6 00000 7 00000 2000 01 01 04 00 00 8 00000 9 00000 2000 01 01 05 00 00 10 00000 11 00000
21. period The lt period gt tag must bring a begin and an end attributes giving the dates of the begin ning and the end of the simulation period The dates formats for these attributes must be YYYY MM DD hh mm ss Inside the lt run gt tag there may be a lt valuesbuffer gt tag for the number of time steps kept in memory The number of step is given through a steps attribute If not present all values are kept in memory Inside the lt run gt tag there may be a lt filesbuffer gt tag for the size of the memory buffer for each file of results The size is given in kilobytes through a kbytes attribute If not present the default value is 2KB example lt xml version 1 0 standalone yes gt lt openfluid gt lt run gt lt deltat gt 3600 lt deltat gt lt period begin 2000 01 01 00 00 00 end 2000 03 27 01 12 37 gt lt valuesbuffer steps 10 gt lt filesbuffer kbytes 8 gt lt run gt lt openfluid gt 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 lt output gt tag and must be structured following these rules e Inside the lt output gt tag there must be one to many lt files gt tags defining files formats for saved data These lt files gt tags must bring a colsep attribute defining the separator strings between columns a dtformat attribu
22. t run gt lt deltat gt 3600 lt deltat gt lt period begin 2000 01 01 00 00 00 end 2000 03 27 01 12 37 gt lt valuesbuffer steps 50 gt lt filesbuffer kbytes 8 gt lt run gt lt output gt lt files colsep dtformat Y m d H M S commentchar gt lt set name testRS unitsclass RS unitsIDs 51 232 vars x gt lt set name full unitsclass SU unitsIDs vars precision 7 gt lt files gt lt output gt lt openfluid gt 3 6 File formats for interp or inject data generator 3 6 1 Sources The sources file format is an XML based format which defines a list of sources files associated to an unique ID The sources must be defined in a section delimited by the lt datasources gt tag inside an lt openfluid gt tag and must be structured following these rules e Inside the lt datasources gt tag there must be a set of lt filesource gt tags e Each lt filesource gt tag must bring an ID attribute giving the identifier of source and an file attribute giving the name of the file containing the source of data The files must be placed in the input directory of the simulation example of a sources list file lt xml version 1 0 standalone yes gt lt openfluid gt lt datasources gt lt filesource ID 1 file sourcel dat gt lt filesource ID 2 file source2 dat gt lt datasources gt lt openfluid gt An associated source data file is a seven colu
23. te defining the date time format used it could be 6cols iso or user defined using strftime format whis is described in the appendix part of this document a commentchar attribute defining the string prefixing lines of comments in output files A header attribute may be added giving the type of header in files The values for this attribute can be none for no header info for a header giving commented information about the data contained in the produced file s colnames as data for a first line in file giving names of each column full for a complete header including both info and colnames as data headers see appendix for examples If no header attribute is present info header is used Inside the lt files gt tags there must be one to many lt set gt tags Each lt set gt tag will lead to a set of files Each lt set gt tag must bring a name attribute defining the name of the set this will be used as a suffix for generated output files a unitsclass attribute and a unitsIDs attribute defining the processed units a vars attribute defining the processed variables It may also bring an a precision attribute giving the number of significant digits for the values in the outputs files 2 2 SECTIONS 17 The IDs for the unitsIDs attribute are semicolon separated the wildcard character can be used to include all units IDs for the given class The variables names for the vars attribute are semicolon separated the wildcard character
24. using the interp method must provide a param named sources giving the data sources filename and a param named distribution giving the distribution filename for the value to produce see appendix e generator using the inject method must provide a param named sources giving the data sources filename and a param named distribution giving the distribution filename for the value to produce see appendix e Each lt gparams gt tag may include zero to many lt param gt tags giving the global parameters Each lt param gt tag must bring a name attribute giving the name of the parameter and a value attribute giving the value of the parameter example lt xml version 1 0 standalone yes gt 2 2 SECTIONS 13 lt openfluid gt lt model gt lt gparams gt lt param name gparami value 100 gt lt param name gparam2 value 0 1 gt lt gparams gt lt function fileID example functionA gt lt generator varname example generator fixed unitclass EU1 method fixed varsize 11 gt lt param name fixedvalue value 20 gt lt generator gt lt generator varname example generator random unitclass EU2 method random gt lt param name min value 20 53 gt lt param name max value 50 gt lt generator gt lt function fileID example functionB gt lt param name parami value strvalue gt lt param name param2 value 1 1 gt lt param name gparami value 50 gt lt fun
Download Pdf Manuals
Related Search