diff --git a/platform/posix/man/ck2cti2.1 b/platform/posix/man/ck2cti2.1 new file mode 100644 index 000000000..f6550e4de --- /dev/null +++ b/platform/posix/man/ck2cti2.1 @@ -0,0 +1,55 @@ +.TH "ck2cti2" 1 "4 Jun 2012" "ck2cti2" \" -*- nroff -*- +.ad l +.nh +.SH NAME +ck2cti2 \- convert Chemkin-II-format mechanisms to Cantera input files (.cti) + +.SH SYNOPSIS +.B ck2cti2 +--input=\fImech-file\fR +[--thermo=\fIthermo-file\fR] +[--transport=\fItransport-file\fR] +[--id=\fIphase-id\fR] +[--output=\fIout-file\fR] +[-d | --debug] + +.SH DESCRIPTION + +.I ck2cti2 +converts a Chemkin-II-format reaction mechanism file to Cantera input +format. The resulting Cantera input file contains a definition of one +.B ideal_gas +entry that represents an ideal gas mixture corresponding to the +Chemkin-II reaction mechanism. The file also contains Cantera-format +definitions for each species and each reaction in the input reaction +mechanism file. The Cantera-format mechanism is written to +.I out-file + +The parameters are as follows: +.TP +.B --input=\fImech-file\fR +Chemkin-II reaction mechanism file to be converted. Required. This +file must contain the declarations of the elements and species, as +well as the reactions (if any). It may also contain the thermodyamic +and transport data. +.TP +.B --thermo=\fIthermo-file\fR +Thermodynamic property database. If the THERMO section of the input +file is missing or does not have entries for one or more species, this +file will be searched for the required thermo data. +.TP +.B --transport=\fItransport-file\fR +Transport property database. If this file name is supplied, transport +property parameters will be taken from this file and included in the +output Cantera-format file. If this parameter is omitted, and no +TRANSPORT section was included in the main input file, no transport +property parameters will be included in the output. +.TP +.B --id=\fIphase-id\fR +Optional identification string, used to set the \fIid\fR field of the +\fBideal_gas\fR entry in the Cantera-format output. If this parameter +is omitted, it will be set to +.B gas + +.SH EXAMPLE +ck2cti2 --input=chem.inp --thermo=therm.dat --transport=tran.dat diff --git a/platform/posix/man/cti2ctml.1 b/platform/posix/man/cti2ctml.1 new file mode 100644 index 000000000..9882013db --- /dev/null +++ b/platform/posix/man/cti2ctml.1 @@ -0,0 +1,23 @@ +.TH "cti2ctml" 1 "4 Jun 2012" "cti2ctml" \" -*- nroff -*- +.ad l +.nh +.SH NAME +cti2ctml \- process Cantera .cti input files + +.SH SYNOPSIS +.B cti2ctml +.I input-file.cti + +.SH DESCRIPTION + +.I cti2ctml +processes a Cantera .cti file and produces a CTML (.xml) file. The +output file name is based on the input file name, with the extension +changed to .xml. + +.SH EXAMPLE +.TP +cti2ctml infile.cti + +This will produce the CTML file +.I infile.xml diff --git a/platform/posix/man/ctml_writer.1 b/platform/posix/man/ctml_writer.1 new file mode 100644 index 000000000..1ab8c7696 --- /dev/null +++ b/platform/posix/man/ctml_writer.1 @@ -0,0 +1,23 @@ +.TH "ctml_writer" 1 "4 Jun 2012" "ctml_writer" \" -*- nroff -*- +.ad l +.nh +.SH NAME +ctml_writer \- process Cantera .cti input files + +.SH SYNOPSIS +.B ctml_writer +.I input-file.cti + +.SH DESCRIPTION + +.I ctml_writer +processes a Cantera .cti file and produces a CTML (.xml) file. It +can be imported as a module, or used as a script. The output file name +is based on the input file name, with the extension changed to .xml. + +.SH EXAMPLE +.TP +ctml_writer infile.cti + +This will produce the CTML file +.I infile.xml