cantera/interfaces/python/Cantera/gases.py
Ray Speth b4ceb7da2e Reformatted the Python docstrings to work better with Sphinx
This means that the docstrings are now parsed as reStructuredText.
2012-03-13 17:34:47 +00:00

47 lines
1.2 KiB
Python
Executable file

"""Gas mixtures.
These functions all return instances of class Solution that represent
gas mixtures.
"""
# for pydoc
import solution, constants
from constants import *
from Cantera.solution import Solution
#import _cantera
import os
def IdealGasMix(src="", id = "", loglevel = 0):
"""Return a :class:`.Solution` object representing an ideal gas mixture.
:param src:
input file
:param id:
XML id tag for phase
"""
return Solution(src=src,id=id,loglevel=loglevel)
def GRI30(transport = ""):
"""Return a :class:`.Solution` instance implementing reaction mechanism
GRI-Mech 3.0."""
if transport == "":
return Solution(src="gri30.cti", id="gri30")
elif transport == "Mix":
return Solution(src="gri30.cti", id="gri30_mix")
elif transport == "Multi":
return Solution(src="gri30.cti", id="gri30_multi")
def Air():
"""Return a :class:`.Solution` instance implementing the O/N/Ar portion of
reaction mechanism GRI-Mech 3.0. The initial composition is set to
that of air"""
return Solution(src="air.cti", id="air")
def Argon():
"""Return a :class:`.Solution` instance representing pure argon."""
return Solution(src="argon.cti", id="argon")