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

[Doc] CTI to XML conversion does not generate new files

Browse source
This commit is contained in:
Ray Speth 2015-05-06 18:10:16 -04:00
parent 14b41ea338
commit 11f4b1b7f7
3 changed files with 6 additions and 36 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -282,19 +282,9 @@ to construct the object representing the phase or interface in the
application. While this is the net effect, it is actually a two-step
process. When a function like importPhase is called to import a phase definition
from a file, a preprocessor runs automatically to read the input file and create
a data file that contains the same information but in an XML-based format called
a string that contains the same information but in an XML-based format called
CTML. After the preprocessor finishes, Cantera imports the phase definition from
the CTML data file.
The CTML file is saved in the same directory as the input file, and has the same
name but with the extension changed to ``.xml``. If the input file has the name
``propane.cti``, for example, then the CTML file will be placed in the same
directory with name ``propane.xml``. If you like, once the CTML file has been
created, you can specify it rather than the ``.cti`` input file in calls to
importPhase (or similar functions). This is slightly faster, since the
preprocessing step can be skipped. It also allows Cantera simulations to be run
on systems that do not have Python, which Cantera uses in the preprocessing step
but does not require to read CTML files.
this CTML data.
Two File Formats
----------------
@ -393,8 +383,10 @@ conversion by running::
ctml_writer phasedefs.cti
Of course, most of the time creation of the CTML file will happen behind the
scenes, and you will not need to be concerned with CTML files at all.
This can be used to generate XML input files for use on systems where the
Cantera Python package is not installed. Of course, most of the time creation of
the CTML file will happen behind the scenes, and you will not need to be
concerned with CTML files at all.
Error Handling
==============

6
doc/sphinx/cython/tutorial.rst
View file

@ -224,12 +224,6 @@ two bulk phases and the interface between them from file ``diamond.cti``::
Note that the bulk (i.e., 3D or homogeneous) phases that participate in the
surface reactions must also be passed as arguments to `Interface`.
When Cantera reads a ``.cti`` input file, wherever it is located, it always
writes a file of the same name but with extension ``.xml`` *in the local
directory*. If you happen to have some other file by that name, it will be
overwritten. Once the XML file is created, you can use it instead of the
``.cti`` file, which will result in somewhat faster startup.
Converting CK-format files
~~~~~~~~~~~~~~~~~~~~~~~~~~

16
doc/sphinx/matlab/input-tutorial.rst
View file

@ -56,22 +56,6 @@ two bulk phases and the interface between them from file ``diamond.cti``::
Note that the bulk (i.e., 3D) phases that participate in the surface reactions
must also be passed as arguments to importInterface.
CTML files
----------
Note that when Cantera reads a ``.cti`` input file, wherever it is located, it
always writes a file of the same name but with extension ``.xml`` *in the local
directory*. If you happen to have some other file by that name, it will be
overwritten. Once the XML file is created, you can use it instead of the
``.cti`` file, which will result in somewhat faster startup::
gas4 = importPhase('gri30.xml','gri30');
Interfaces can be imported from XML files too::
diamonnd_surf2 = importInterface('diamond.xml','diamond_100',...
gas2, diamond);
Converting CK-format files
--------------------------