From 71ba021467379270aa6c0f5bdaf32641768a81db Mon Sep 17 00:00:00 2001 From: Ray Speth Date: Tue, 8 Oct 2019 13:34:56 -0400 Subject: [PATCH] Add sticking coefficients to CTI API docs --- doc/sphinx/cti/classes.rst | 3 +++ interfaces/cython/cantera/cti2yaml.py | 4 ++++ interfaces/cython/cantera/ctml_writer.py | 4 ++++ 3 files changed, 11 insertions(+) diff --git a/doc/sphinx/cti/classes.rst b/doc/sphinx/cti/classes.rst index 2c49e84ba..47c91f3f7 100644 --- a/doc/sphinx/cti/classes.rst +++ b/doc/sphinx/cti/classes.rst @@ -119,6 +119,9 @@ Reactions .. autoclass:: edge_reaction :no-undoc-members: +.. autoclass:: stick + :no-undoc-members: + Falloff Parameterizations ------------------------- diff --git a/interfaces/cython/cantera/cti2yaml.py b/interfaces/cython/cantera/cti2yaml.py index 9d24497d5..fa8b89705 100644 --- a/interfaces/cython/cantera/cti2yaml.py +++ b/interfaces/cython/cantera/cti2yaml.py @@ -591,6 +591,10 @@ class Arrhenius: class stick(Arrhenius): + """ + A rate expression for a surface reaction given as a sticking probability, + parameterized using a modified Arrhenius expression. + """ def __init__(self, *args, **kwargs): """ :param motz_wise: diff --git a/interfaces/cython/cantera/ctml_writer.py b/interfaces/cython/cantera/ctml_writer.py index 2d62289ca..afe51ab30 100644 --- a/interfaces/cython/cantera/ctml_writer.py +++ b/interfaces/cython/cantera/ctml_writer.py @@ -1082,6 +1082,10 @@ class Arrhenius(rate_expression): addFloat(c, 'e', cov[3], fmt = '%f', defunits = _ue) class stick(Arrhenius): + """ + A rate expression for a surface reaction given as a sticking probability, + parameterized using a modified Arrhenius expression. + """ def __init__(self, *args, **kwargs): """ :param motz_wise: 'True' if the Motz & Wise correction should be used,