research/cantera
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

[Doc] Fix syntax highlighting in CTI guide

Browse source
This commit is contained in:
Ray Speth 2014-07-25 18:32:47 +00:00
parent a6350348a1
commit 93719f0261
3 changed files with 17 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
doc/sphinx/cti/input-files.rst
View file

@ -42,7 +42,7 @@ The fields of an entry are specified in the form ``<field_name> = <value>``, and
be listed on one line, or extend across several. For example, two entries for
graphite are shown below. The first is compact::
stoichiometric_solid(name='graphite', species='C(gr)', elements='C', density=(2.2, 'g/cm3')))
stoichiometric_solid(name='graphite', species='C(gr)', elements='C', density=(2.2, 'g/cm3'))
and the second is formatted to be easier to read::
@ -226,7 +226,8 @@ length, which are set with a units directive::
units(length = 'cm', quantity = 'molec')
interface(name = 'Si-100',
site_density = 1.0e15, # molecules/cm2 (default units)
...)
# ...
)
The second version uses a different default unit system, but overrides the
default units by specifying an explicit units string for the site density::
@ -234,7 +235,8 @@ default units by specifying an explicit units string for the site density::
units(length = 'cm', quantity = 'mol')
interface(name = 'Si-100',
site_density = (1.0e15, 'molec/cm2') # override default units
...)
# ...
)
The second version is equivalent to the first, but would be very different if
the units of the site density were not specified!

17
doc/sphinx/cti/phases.rst
View file

@ -90,7 +90,8 @@ example, if a phase definition specifies the elements as::
ideal_gas(name = "gasmix",
elements = "H C O N Ar",
...)
# ...
)
then when this definition is imported by an application, element-specific
properties will be ordered in the same way::
@ -285,7 +286,7 @@ reaction mechanism, as follows::
If we import this into Matlab, for example, we get a gas mixture containing the
8 species (out of 53 total) that contain only H and O:
.. code-block:: matlab
.. code-block:: matlabsession
>> gas = importPhase('gas.cti', 'hydrogen_mech')
@ -391,14 +392,16 @@ the string ``'Multi'``, and to select the mixture-averaged model, set it to the
string ``'Mix'``::
ideal_gas(name="gas1",
...,
# ...
transport="Multi", # use multicomponent formulation
...)
# ...
)
ideal_gas(name="gas2",
...,
# ...
transport="Mix", # use mixture-averaged formulation
...)
# ...
)
Stoichiometric Solid
--------------------
@ -414,7 +417,7 @@ reactions, since the composition is fixed.) ::
species='C(gr)',
density=(2.2, 'g/cm3'),
initial_state=state(temperature=300.0,
pressure=(1.0, 'atm'))
pressure=(1.0, 'atm')))
In the example above, the definition of the species ``'C(gr)'`` must appear
elsewhere in the input file.

3
doc/sphinx/cti/species.rst
View file

@ -64,7 +64,8 @@ defined to be composed solely of electrons::
species(name = 'ysz-oxygen-vacancy',
atoms = 'O:0, E:2',
...)
# ...,
)
Note that an atom number of zero may be given if desired, but is completely
equivalent to omitting that element.