.. _sec-usage: ===== Usage ===== .. toctree:: :maxdepth: 1 The following are instructions for usage of CanSen. Windows ======= CanSen can be run from the command line (``cmd.exe``). From the command line, change into the directory with your input files, and run:: cansen [options] Ubuntu ====== CanSen can be run as an executable. To run as an executable, change to the directory where your input file is located:: cansen [options] Options ======= All of the previous commands have shown ``[options]`` to indicate where command line options should be specified. The following options are available, and can also be seen by using the ``-h`` or ``--help`` options:: -i: Specify the simulation input file in SENKIN format. Required. -o: Specify the text output file. Optional, default: ``output.out`` -x: Specify the binary save output file. Optional, default: ``save.hdf`` -c: Specify the chemistry input file, in either CHEMKIN, Cantera CTI or CTML format. Optional, default: ``chem.xml`` -d: Specify the thermodyanmic database. Optional if the thermodyanmic database is specified in the chemistry input file. Otherwise, required. --convert: Convert the input mechanism to CTI format and quit. If ``--convert`` is specified, the SENKIN input file is optional. -m, --multi: Run multiple cases from the input file. Optional. If ``-m`` is used, must specify number of processors to be used (e.g., ``-m 4``). If ``--multi`` is specified, CanSen uses the available number of processors by default. -h, --help: Print this help message and quit. Multiple Inputs =============== While the default operation of CanSen reads and runs a single input case, using the ``-m`` or ``--multi`` option enables multiple cases to be run independently (and in parallel). In this mode, normal output is omitted, and only the calculated ignition delay times (along with initial pressure, temperature, and equivalence ratio) are printed to the output file. In addition, no binary save output file is created. Input files should be formatted normally for each case, with an ``END`` keyword indicating the end of one case. For example:: CONV TEMP 1600.0 PRES 1.0 TIME 1.0E1 EQUI 1.0 FUEL CH4 1.0 OXID O2 0.21 OXID N2 0.79 CPROD CO2 CPROD H2O CPROD N2 END CONP TEMP 1000.0 PRES 10.0 TIME 1.0E1 EQUI 0.5 FUEL CH4 1.0 OXID O2 0.21 OXID N2 0.79 CPROD CO2 CPROD H2O CPROD N2 END