Skip to content

Commit 479abc2

Browse files
committed
Fixing docstrings in surface kinetics.
1 parent 84d4b7b commit 479abc2

File tree

1 file changed

+7
-6
lines changed

1 file changed

+7
-6
lines changed

rmgpy/kinetics/surface.pyx

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ cdef class StickingCoefficient(KineticsModel):
5050
======================= =============================================================
5151
Attribute Description
5252
======================= =============================================================
53-
`A` The preexponential factor
53+
`A` The preexponential factor. Unitless (sticking probability)
5454
`T0` The reference temperature
5555
`n` The temperature exponent
5656
`Ea` The activation energy
@@ -287,9 +287,9 @@ cdef class StickingCoefficient(KineticsModel):
287287

288288
def to_cantera_kinetics(self):
289289
"""
290-
Converts the Arrhenius object to a cantera Arrhenius object
290+
Converts the Arrhenius object to a cantera StickingArrheniusRate object
291291
292-
Arrhenius(A,b,E) where A is in units of m^3/kmol/s, b is dimensionless, and E is in J/kmol
292+
StickingArrheniusRate(A,b,E) where A is dimensionless, b is dimensionless, and E is in J/kmol
293293
"""
294294

295295
import cantera as ct
@@ -380,7 +380,7 @@ cdef class StickingCoefficientBEP(KineticsModel):
380380
self.Pmin, self.Pmax, self.coverage_dependence, self.comment))
381381

382382
property A:
383-
"""The preexponential factor."""
383+
"""The preexponential factor. Dimensionless (sticking probability)"""
384384
def __get__(self):
385385
return self._A
386386
def __set__(self, value):
@@ -423,7 +423,8 @@ cdef class StickingCoefficientBEP(KineticsModel):
423423
cpdef double get_sticking_coefficient(self, double T, double dHrxn=0.0) except -1:
424424
"""
425425
Return the sticking coefficient (dimensionless) at
426-
temperature `T` in K and enthalpy of reaction `dHrxn` in J/mol.
426+
temperature `T` in K and enthalpy of reaction `dHrxn` in J/mol.
427+
Never exceeds 1.0.
427428
"""
428429
cdef double A, n, Ea, stickingCoefficient
429430
Ea = self.get_activation_energy(dHrxn)
@@ -552,7 +553,7 @@ cdef class SurfaceArrhenius(Arrhenius):
552553
property A:
553554
"""The preexponential factor.
554555
555-
This is the only thing different from a normal Arrhenius class."""
556+
This (and the coverage dependence) is the only thing different from a normal Arrhenius class."""
556557
def __get__(self):
557558
return self._A
558559
def __set__(self, value):

0 commit comments

Comments
 (0)