Permalink
Browse files

Minor updates (r1427)

  • Loading branch information...
1 parent d81c7a3 commit e00068a4e0b31fa25ab51f17e8d3997476a88499 @speth speth committed Apr 26, 2012
@@ -363,6 +363,11 @@ Optional Programs
configure --with-cflags=-fPIC
+* `Windows Installer XML (WiX) toolset <http://wix.sourceforge.net/>`_
+
+ * Required to build MSI installers on Windows
+ * Known to work with version 3.5.
+
* `Distribute <http://pypi.python.org/pypi/distribute>`_ (Python)
* Provides the ``easy_install`` command which can be used to install most of
@@ -523,6 +523,12 @@
</li>
</ul>
</li>
+<li><p class="first"><a class="reference external" href="http://wix.sourceforge.net/">Windows Installer XML (WiX) toolset</a></p>
+<ul class="simple">
+<li>Required to build MSI installers on Windows</li>
+<li>Known to work with version 3.5.</li>
+</ul>
+</li>
<li><p class="first"><a class="reference external" href="http://pypi.python.org/pypi/distribute">Distribute</a> (Python)</p>
<ul class="simple">
<li>Provides the <tt class="docutils literal"><span class="pre">easy_install</span></tt> command which can be used to install most of
@@ -154,7 +154,7 @@
this is true in the output above&#8212;the chemical potential of H2 is exactly
twice that of H, the chemical potential for OH is the sum of the values for H
and O, the value for H2O2 is twice as large as the value for OH, and so on.</p>
-<p>We&#8217;ll see later how the <span>equilibrate</span> function really works. For now, though,
+<p>We&#8217;ll see later how the <a class="reference external" href="../../../doxygen/html/group__equil.html#gaa27374c5b1714a38464ac5f0c5dc864b">equilibrate()</a> function really works. For now, though,
the important points are these:</p>
<ul class="simple">
<li>The <cite>equilibrate</cite> procedure operates on an object, setting its state to a
@@ -105,11 +105,11 @@
<dt><tt class="docutils literal"><span class="pre">equilibrium.h</span></tt></dt>
<dd>Chemical equilibrium.</dd>
<dt><tt class="docutils literal"><span class="pre">GRI30.h</span></tt></dt>
-<dd>Provides class <span>GRI30</span>.</dd>
+<dd>Provides class <a class="reference external" href="../../../doxygen/html/classCantera_1_1GRI30.html">GRI30</a>.</dd>
<dt><tt class="docutils literal"><span class="pre">IdealGasMix.h</span></tt></dt>
<dd>Provides class <span>IdealGasMix</span>.</dd>
<dt><tt class="docutils literal"><span class="pre">Interface.h</span></tt></dt>
-<dd>Provides class <span>Interface</span>.</dd>
+<dd>Provides class <a class="reference external" href="../../../doxygen/html/classCantera_1_1Interface.html">Interface</a>.</dd>
<dt><tt class="docutils literal"><span class="pre">integrators.h</span></tt></dt>
<dd>ODE Integrators.</dd>
<dt><tt class="docutils literal"><span class="pre">kinetics.h</span></tt></dt>
@@ -106,7 +106,7 @@
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="simple-example.html">A Very Simple C++ Program</a><ul>
-<li class="toctree-l2"><a class="reference internal" href="simple-example.html#catching-canteraerror-exceptions">Catching <span>CanteraError</span> exceptions</a></li>
+<li class="toctree-l2"><a class="reference internal" href="simple-example.html#catching-canteraerror-exceptions">Catching CanteraError exceptions</a></li>
<li class="toctree-l2"><a class="reference internal" href="simple-example.html#the-report-function">The <tt class="docutils literal"><span class="pre">report</span></tt> function</a></li>
</ul>
</li>
@@ -63,7 +63,7 @@
<h3><a href="../index.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">A Very Simple C++ Program</a><ul>
-<li><a class="reference internal" href="#catching-canteraerror-exceptions">Catching <span>CanteraError</span> exceptions</a></li>
+<li><a class="reference internal" href="#catching-canteraerror-exceptions">Catching CanteraError exceptions</a></li>
<li><a class="reference internal" href="#the-report-function">The <tt class="docutils literal"><span class="pre">report</span></tt> function</a></li>
</ul>
</li>
@@ -177,18 +177,18 @@
the &#8220;Hello, World&#8221; program most programming textbooks begin with. But it
illustrates some important points in writing Cantera C++ programs.</p>
<div class="section" id="catching-canteraerror-exceptions">
-<h2>Catching <span>CanteraError</span> exceptions<a class="headerlink" href="#catching-canteraerror-exceptions" title="Permalink to this headline">¶</a></h2>
+<h2>Catching <a class="reference external" href="../../../doxygen/html/classCantera_1_1CanteraError.html">CanteraError</a> exceptions<a class="headerlink" href="#catching-canteraerror-exceptions" title="Permalink to this headline">¶</a></h2>
<p>The entire body of the program is put inside a function that is invoked within
a <tt class="docutils literal"><span class="pre">try</span></tt> block in the main program. In this way, exceptions thrown in the
function or in any procedure it calls may be caught. In this program, a
-<tt class="docutils literal"><span class="pre">catch</span></tt> block is defined for exceptions of type <span>CanteraError</span>. Cantera
+<tt class="docutils literal"><span class="pre">catch</span></tt> block is defined for exceptions of type <a class="reference external" href="../../../doxygen/html/classCantera_1_1CanteraError.html">CanteraError</a>. Cantera
throws exceptions of this type, so it is always a good idea to catch them. In
-the <tt class="docutils literal"><span class="pre">catch</span></tt> block, function <span>showErrors</span> may be called to print the error
+the <tt class="docutils literal"><span class="pre">catch</span></tt> block, function <a class="reference external" href="../../../doxygen/html/group__errorhandling.html#ga0a45aae524295a5236caf3d9bff37420">showErrors()</a> may be called to print the error
message associated with the exception.</p>
</div>
<div class="section" id="the-report-function">
<h2>The <tt class="docutils literal"><span class="pre">report</span></tt> function<a class="headerlink" href="#the-report-function" title="Permalink to this headline">¶</a></h2>
-<p>The <span>report</span> function generates a nicely-formatted report of the properties of
+<p>The <a class="reference external" href="../../../doxygen/html/classCantera_1_1ThermoPhase.html#adf368cd8c67a3f672bb2915e388fcf6d">report()</a> function generates a nicely-formatted report of the properties of
a phase, including its composition in both mole (X) and mass (Y) units. For
each species present, the non-dimensional chemical potential is also printed.
This is handy particularly when doing equilibrium calculations. This function
@@ -128,18 +128,18 @@
<span class="p">}</span>
</pre></div>
</div>
-<p>Class <span>ThermoPhase</span> is the base class for Cantera classes that represent
+<p>Class <a class="reference external" href="../../../doxygen/html/classCantera_1_1ThermoPhase.html">ThermoPhase</a> is the base class for Cantera classes that represent
phases of matter. It defines the public interface for all classes that represent
-phases. For example, it specifies that they all have a method <span>temperature</span> that returns the current temperature, a method
-<span>setTemperature(double T)</span> that sets the
-temperature, a method <span>getChemPotentials(double* mu)</span> that writes the species chemical potentials
+phases. For example, it specifies that they all have a method <a class="reference external" href="../../../doxygen/html/classCantera_1_1Phase.html#aa9eb6250e94840da359e9e3182271291">temperature()</a> that returns the current temperature, a method
+<a class="reference external" href="../../../doxygen/html/classCantera_1_1Phase.html#adeb5aad57e0139e159018affd970600d">setTemperature(double T)</a> that sets the
+temperature, a method <a class="reference external" href="../../../doxygen/html/classCantera_1_1ThermoPhase.html#a04733b99f18bae806e25ff9d2d2b0046">getChemPotentials(double* mu)</a> that writes the species chemical potentials
into array <tt class="docutils literal"><span class="pre">mu</span></tt>, and so on.</p>
<p>Class ThermoPhase can be used to represent the intensive state of any
single-phase solution of multiple species. The phase may be a bulk,
three-dimensional phase (a gas, a liquid, or a solid), or it may be a
two-dimensional surface phase, or even a one-dimensional &#8220;edge&#8221; phase. The
specific attributes of each type of phase are specified by deriving a class from
-<span>ThermoPhase</span> and providing implementations for its virtual methods.</p>
+<a class="reference external" href="../../../doxygen/html/classCantera_1_1ThermoPhase.html">ThermoPhase</a> and providing implementations for its virtual methods.</p>
<p>Cantera has a wide variety of models for bulk phase currently. Special attention
(in terms of the speed of execution) has been paid to an ideal gas phase
implementation, where the species thermodynamic polynomial representations
@@ -152,11 +152,11 @@
implementation for molten salts.</p>
<div class="section" id="the-intensive-thermodynamic-state">
<h3>The Intensive Thermodynamic State<a class="headerlink" href="#the-intensive-thermodynamic-state" title="Permalink to this headline">¶</a></h3>
-<p>Class <span>ThermoPhase</span> and classes derived from it work only with the intensive
+<p>Class <a class="reference external" href="../../../doxygen/html/classCantera_1_1ThermoPhase.html">ThermoPhase</a> and classes derived from it work only with the intensive
thermodynamic state. That is, all extensive properties (enthalpy, entropy,
internal energy, volume, etc.) are computed for a unit quantity (on a mass or
-mole basis). For example, there is a method <span>enthalpy_mole()</span> that returns
-the molar enthalpy (J/kmol), and a method <span>enthalpy_mass()</span> that returns the
+mole basis). For example, there is a method <a class="reference external" href="../../../doxygen/html/classCantera_1_1PureFluidPhase.html#aa93e126a1c8f2f7d17291b5618b40e3c">enthalpy_mole()</a> that returns
+the molar enthalpy (J/kmol), and a method <a class="reference external" href="../../../doxygen/html/classCantera_1_1ThermoPhase.html#a31e2070849204cfe686ddc877225c8ae">enthalpy_mass()</a> that returns the
specific enthalpy (J/kg), but no method <em>enthalpy()</em> that would return the total
enthalpy (J). This is because class ThermoPhase does not store the total amount
(mass or mole) of the phase.</p>
@@ -175,7 +175,7 @@
<h3>Derived Classes<a class="headerlink" href="#derived-classes" title="Permalink to this headline">¶</a></h3>
<p>Many of the methods of ThermoPhase are declared virtual, and are meant to be
overloaded in classes derived from ThermoPhase. For example, class
-<span>IdealGasPhase</span> derives from <span>ThermoPhase</span>, and represents ideal gas
+<a class="reference external" href="../../../doxygen/html/classCantera_1_1IdealGasPhase.html">IdealGasPhase</a> derives from <a class="reference external" href="../../../doxygen/html/classCantera_1_1ThermoPhase.html">ThermoPhase</a>, and represents ideal gas
mixtures.</p>
<p>Although class ThermoPhase defines the interface for all classes representing
phases, it only provides implementations for a few of the methods. This is
@@ -250,13 +250,13 @@
<tt class="docutils literal"><span class="pre">_mass</span></tt>.</li>
<li>methods that write an array of values into a supplied output array have names
that begin with <tt class="docutils literal"><span class="pre">get</span></tt>. For example, the method
-<span>ThermoPhase::getChemPotentials(double* mu)</span> writes the species chemical
+<a class="reference external" href="../../../doxygen/html/classCantera_1_1ThermoPhase.html#a04733b99f18bae806e25ff9d2d2b0046">ThermoPhase::getChemPotentials(double* mu)</a> writes the species chemical
potentials into the output array <tt class="docutils literal"><span class="pre">mu</span></tt>.</li>
</ul>
-<p>The thermodynamic property methods are declared in class <span>ThermoPhase</span>,
+<p>The thermodynamic property methods are declared in class <a class="reference external" href="../../../doxygen/html/classCantera_1_1ThermoPhase.html">ThermoPhase</a>,
which is the base class from which all classes that represent any type of phase
of matter derive.</p>
-<p>See <span>ThermoPhase</span> for the full list of available thermodynamic properties.</p>
+<p>See <a class="reference external" href="../../../doxygen/html/classCantera_1_1ThermoPhase.html">ThermoPhase</a> for the full list of available thermodynamic properties.</p>
</div>
</div>
</div>

Large diffs are not rendered by default.

Oops, something went wrong.

0 comments on commit e00068a

Please sign in to comment.