Skip to content

Commit

Permalink
[Doc] Put titles on raw links to main site
Browse files Browse the repository at this point in the history
  • Loading branch information
bryanwweber authored and speth committed Jul 29, 2018
1 parent c28bc02 commit d33e67c
Show file tree
Hide file tree
Showing 5 changed files with 22 additions and 17 deletions.
5 changes: 3 additions & 2 deletions interfaces/cython/cantera/ck2cti.py
Original file line number Diff line number Diff line change
Expand Up @@ -820,9 +820,10 @@ def to_cti(self):

class Sri(object):
"""
A kinetic model of a phenomenological rate coefficient k(T, P) using the
A kinetic model of a phenomenological rate coefficient :math:`k(T, P)` using the
"SRI" formulation of the blending function :math:`F` using either 3 or
5 parameters. See https://cantera.org/science/reactions.html#sec-sri-falloff.
5 parameters. See `The SRI Falloff Function
<https://cantera.org/science/reactions.html#sec-sri-falloff>`__.
The attributes are:
Expand Down
28 changes: 16 additions & 12 deletions interfaces/cython/cantera/ctml_writer.py
Original file line number Diff line number Diff line change
Expand Up @@ -543,14 +543,15 @@ def __init__(self,
:param thermo:
The parameterization to use to compute the reference-state
thermodynamic properties. This must be one of the entry types
described in https://cantera.org/science/science-species.html#sec-thermo-models.
described in `Thermodynamic Property Models
<https://cantera.org/science/science-species.html#sec-thermo-models>`__.
To specify multiple parameterizations, each for a different temperature range,
group them in parentheses.
:param transport:
An entry specifying parameters to compute this species'
contribution to the transport properties. This must be one of the
entry types described in
https://cantera.org/science/science-species.html#species-transport-coefficients,
entry types described in `Species Transport Coefficients
<https://cantera.org/science/science-species.html#species-transport-coefficients>`__,
and must be consistent with the transport model of the phase into which
the species is imported. To specify parameters for multiple
transport models, group the entries in parentheses.
Expand Down Expand Up @@ -1145,9 +1146,9 @@ def __init__(self,
:param order:
Override the default reaction orders implied by the reactant
stoichiometric coefficients. Given as a string of key:value pairs,
e.g. ``"CH4:0.25 O2:1.5"``.
e.g., ``"CH4:0.25 O2:1.5"``.
:param options: Processing options, as described in
https://cantera.org/tutorials/cti/reactions.html#options.
`Options <https://cantera.org/tutorials/cti/reactions.html#options>`__.
May be one or more (as a list) of the
following: ``'skip'``, ``'duplicate'``, ``'negative_A'``,`` 'negative_orders'``,
``'nonreactant_orders'``.
Expand Down Expand Up @@ -1374,7 +1375,7 @@ def __init__(self,
four-digit numeric string beginning with 0001 for the first
reaction in the file.
:param options: Processing options, as described in
https://cantera.org/tutorials/cti/reactions.html#options.
`Options <https://cantera.org/tutorials/cti/reactions.html#options>`__.
"""
reaction.__init__(self, equation, kf, id, '', options)
self._type = 'threeBody'
Expand Down Expand Up @@ -1465,7 +1466,7 @@ def __init__(self, equation, kf0, kf,
reaction in the file.
:param options:
Processing options, as described in
https://cantera.org/tutorials/cti/reactions.html#options.
`Options <https://cantera.org/tutorials/cti/reactions.html#options>`__.
"""
kf2 = (kf, kf0)
reaction.__init__(self, equation, kf2, id, '', options)
Expand Down Expand Up @@ -1509,7 +1510,7 @@ def __init__(self, equation, kLow, kHigh,
reaction in the file.
:param options:
Processing options, as described in
https://cantera.org/tutorials/cti/reactions.html#options.
`Options <https://cantera.org/tutorials/cti/reactions.html#options>`__.
"""
reaction.__init__(self, equation, (kLow, kHigh), id, '', options)
self._type = 'chemAct'
Expand Down Expand Up @@ -1641,7 +1642,7 @@ def __init__(self, equation='', kf=None, id='', order='', beta = 0.0,
reaction in the file.
:param options:
Processing options, as described in
https://cantera.org/tutorials/cti/reactions.html#options.
`Options <https://cantera.org/tutorials/cti/reactions.html#options>`__.
:param beta:
Charge transfer coefficient: A number between 0 and 1 which, for a
charge transfer reaction, determines how much of the electric
Expand Down Expand Up @@ -1740,13 +1741,15 @@ def __init__(self,
The elements. A string of element symbols.
:param species:
The species. A string or sequence of strings in the format
described in https://cantera.org/tutorials/cti/phases.html#defining-the-species.
described in `Defining the Species
<https://cantera.org/tutorials/cti/phases.html#defining-the-species>`__.
:param note:
A user-defined comment. Not evaluated by Cantera itself.
:param reactions:
The homogeneous reactions. If omitted, no reactions will be
included. A string or sequence of strings in the format described
in https://cantera.org/tutorials/cti/phases.html#defining-the-reactions.
in `Declaring the Reactions
<https://cantera.org/tutorials/cti/phases.html#declaring-the-reactions>`__.
This field is not allowed for ``stoichiometric_solid`` and
``stoichiometric_liquid`` entries.
:param kinetics:
Expand Down Expand Up @@ -2358,7 +2361,8 @@ def __init__(self,
:param reactions:
The heterogeneous reactions at this interface. If omitted, no
reactions will be included. A string or sequence of strings in the
format described in https://cantera.org/tutorials/cti/phases.html#declaring-the-reactions.
format described in `Declaring the Reactions
<https://cantera.org/tutorials/cti/phases.html#declaring-the-reactions>`__.
:param site_density:
The number of adsorption sites per unit area.
:param phases:
Expand Down
2 changes: 1 addition & 1 deletion interfaces/matlab/toolbox/@Interface/Interface.m
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
function s = Interface(src, id, p1, p2, p3, p4)
% INTERFACE Interface class constructor.
% s = Interface(src, id, p1, p2, p3, p4)
% See https://cantera.org/tutorials/cti/phases.html#interfaces.
% See `Interfaces <https://cantera.org/tutorials/cti/phases.html#interfaces>`__.
%
% See also: :mat:func:`importEdge`, :mat:func:`importInterface`
%
Expand Down
2 changes: 1 addition & 1 deletion interfaces/matlab/toolbox/importEdge.m
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
% IMPORTEDGE Import edges between phases.
% s = importEdge(file, name, phase1, phase2, phase3, phase4)
% Supports up to four neighbor phases. See
% https://cantera.org/tutorials/cti/phases.html#interfaces
% `Interfaces <https://cantera.org/tutorials/cti/phases.html#interfaces>`__
%
% :param file:
% File containing phases
Expand Down
2 changes: 1 addition & 1 deletion interfaces/matlab/toolbox/importInterface.m
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
function s = importInterface(file, name, phase1, phase2)
% IMPORTINTERFACE Import an interface between phases.
% s = importInterface(file, name, phase1, phase2)
% See https://cantera.org/tutorials/cti/phases.html#interfaces.
% See `Interfaces <https://cantera.org/tutorials/cti/phases.html#interfaces>`__.
%
% :param file:
% CTI or CTML file containing the interface
Expand Down

0 comments on commit d33e67c

Please sign in to comment.