Adjustment of importPhase to Solution in MatLab documentation
Searched for importPhase and updated respective locations to Solution. Modified wording around changes.
This commit is contained in:
parent
d707e059e0
commit
5b2406470c
4 changed files with 6 additions and 6 deletions
|
|
@ -280,7 +280,7 @@ From the point of view of the user, it appears that a Cantera application that
|
|||
imports a phase definition reads the input file, and uses the information there
|
||||
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
|
||||
process. When a constructor like ``Solution`` is called to import a phase definition
|
||||
from a file, a preprocessor runs automatically to read the input file and create
|
||||
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
|
||||
|
|
@ -709,4 +709,3 @@ in the report for Chemkin referenced above. These errors include:
|
|||
|
||||
.. [SAND98] See R. J. Kee, G. Dixon-Lewis, J. Warnatz, M. E. Coltrin, J. A. Miller,
|
||||
H. K. Moffat, Sandia National Laboratories Report SAND86-8246B (1998).
|
||||
|
||||
|
|
@ -96,7 +96,8 @@ example, if a phase definition specifies the elements as::
|
|||
then when this definition is imported by an application, element-specific
|
||||
properties will be ordered in the same way::
|
||||
|
||||
>>> gas = importPhase('example.cti', 'gasmix')
|
||||
>>> import cantera as ct
|
||||
>>> gas = ct.Solution('example.cti', 'gasmix')
|
||||
>>> for n in range(gas.nElements()):
|
||||
... print n, gas.elementSymbol(n)
|
||||
0 H
|
||||
|
|
@ -286,7 +287,7 @@ If we import this into Matlab, for example, we get a gas mixture containing the
|
|||
|
||||
.. code-block:: matlabsession
|
||||
|
||||
>> gas = importPhase('gas.cti', 'hydrogen_mech')
|
||||
>> gas = Solution('gas.cti', 'hydrogen_mech')
|
||||
|
||||
hydrogen_mech:
|
||||
|
||||
|
|
|
|||
|
|
@ -230,7 +230,7 @@ directions :ref:`above <sec-install-conda>`.
|
|||
- Matlab::
|
||||
|
||||
gas = IdealGasMix('gri30.cti')
|
||||
h2o = importPhase('liquidvapor.cti','water')
|
||||
h2o = Solution('liquidvapor.cti','water')
|
||||
|
||||
.. _sec-install-osx:
|
||||
|
||||
|
|
|
|||
|
|
@ -12,7 +12,7 @@ This is the typical way to create a Cantera "phase" object in Matlab::
|
|||
|
||||
gas1 = Solution('gri30.cti', 'gri30');
|
||||
|
||||
Function ``Solution`` constructs an object representing a phase of matter by
|
||||
This statement constructs a ``Solution`` object representing a phase of matter by
|
||||
reading in attributes of the phase from a file, which in this case is
|
||||
``gri30.cti``. This file contains several phase specifications; the one we want
|
||||
here is ``gri30``, which is specified by the second argument. This file contains
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue