1
+ <!DOCTYPE html>
2
+ < html prefix ="
3
+ og: http://ogp.me/ns# article: http://ogp.me/ns/article#
4
+ " lang ="en ">
5
+ < head >
6
+ < meta charset ="utf-8 ">
7
+ < meta name ="description " content ="API documentation for the Cantera 2.5.1 interfaces ">
8
+ < meta name ="viewport " content ="width=device-width, initial-scale=1 ">
9
+ < title > Cantera 2.5.1 Documentation | Cantera</ title >
10
+ < link rel ="stylesheet " href ="https://stackpath.bootstrapcdn.com/bootstrap/4.5.0/css/bootstrap.min.css " integrity ="sha384-9aIt2nRpC12Uk9gS9baDl411NQApFmC26EwAOH8WgZl5MYYxFfc+NcPb1dKGj7Sk " crossorigin ="anonymous ">
11
+ < link rel ="stylesheet " href ="https://cdnjs.cloudflare.com/ajax/libs/baguettebox.js/1.11.1/baguetteBox.min.css " integrity ="sha256-cLMYWYYutHkt+KpNqjg7NVkYSQ+E2VbrXsEvOqU7mL0= " crossorigin ="anonymous ">
12
+ < link href ="../../assets/css/rst.css " rel ="stylesheet " type ="text/css ">
13
+ < link href ="../../assets/css/code.css " rel ="stylesheet " type ="text/css ">
14
+ < link href ="../../assets/css/theme.css " rel ="stylesheet " type ="text/css ">
15
+ < link href ="../../assets/css/custom.css " rel ="stylesheet " type ="text/css ">
16
+ < link href ="../../assets/css/ipython.min.css " rel ="stylesheet " type ="text/css ">
17
+ < link href ="../../assets/css/nikola_ipython.css " rel ="stylesheet " type ="text/css ">
18
+ < meta name ="theme-color " content ="#5670d4 ">
19
+ < meta name ="generator " content ="Nikola (getnikola.com) ">
20
+ < link rel ="alternate " type ="application/rss+xml " title ="RSS " hreflang ="en " href ="../rss.xml ">
21
+ < link rel ="canonical " href ="https://cantera.org/documentation/ ">
22
+ < link rel ="icon " href ="../../assets/img/favicon.ico " sizes ="16x16 ">
23
+ <!--[if lt IE 9]><script src="https://html5shim.googlecode.com/svn/trunk/html5.js"></script><![endif]--> < meta name ="author " content ="Cantera Developers ">
24
+ < meta property ="og:site_name " content ="Cantera ">
25
+ < meta property ="og:title " content ="Cantera Documentation ">
26
+ < meta property ="og:url " content ="https://cantera.org/documentation/ ">
27
+ < meta property ="og:description " content ="API documentation for the Cantera interfaces ">
28
+ < meta property ="og:type " content ="article ">
29
+ < meta property ="article:published_time " content ="2018-06-09T13:57:46-04:00 ">
30
+ </ head >
31
+ < body >
32
+ < a href ="#content " class ="sr-only sr-only-focusable "> Skip to main content</ a >
33
+
34
+ <!-- Menubar -->
35
+
36
+ < nav class ="navbar navbar-expand-md static-top mb-4
37
+ navbar-light bg-light
38
+ "> < div class ="container ">
39
+ <!-- This keeps the margins nice -->
40
+ < a class ="navbar-brand " href ="https://cantera.org/ ">
41
+ < img src ="../../assets/img/cantera-logo.png " alt ="Cantera " id ="logo " class ="d-inline-block align-top "> </ a >
42
+ < button class ="navbar-toggler " type ="button " data-toggle ="collapse " data-target ="#bs-navbar " aria-controls ="bs-navbar " aria-expanded ="false " aria-label ="Toggle navigation ">
43
+ < span class ="navbar-toggler-icon "> </ span >
44
+ </ button >
45
+
46
+ < div class ="collapse navbar-collapse " id ="bs-navbar ">
47
+ < ul class ="navbar-nav ml-auto ">
48
+ < li class ="nav-item ">
49
+ < a href ="../install/index.html " class ="nav-link "> Install</ a >
50
+ </ li >
51
+ < li class ="nav-item ">
52
+ < a href ="../tutorials/index.html " class ="nav-link "> Tutorials</ a >
53
+ </ li >
54
+ < li class ="nav-item ">
55
+ < a href ="../examples/index.html " class ="nav-link "> Examples</ a >
56
+ </ li >
57
+ < li class ="nav-item ">
58
+ < a href ="../community.html " class ="nav-link "> Community</ a >
59
+ </ li >
60
+ < li class ="nav-item ">
61
+ < a href ="../science/index.html " class ="nav-link "> Science</ a >
62
+ </ li >
63
+ < li class ="nav-item ">
64
+ < a href ="# " class ="nav-link "> Documentation</ a >
65
+ </ li >
66
+ < li class ="nav-item ">
67
+ < a href ="../blog/index.html " class ="nav-link "> Blog</ a >
68
+
69
+
70
+ </ li >
71
+ </ ul >
72
+ < ul class ="navbar-nav navbar-right "> </ ul >
73
+ </ div >
74
+ <!-- /.navbar-collapse -->
75
+ </ div >
76
+ <!-- /.container -->
77
+ </ nav > <!-- End of Menubar --> < div class ="container " id ="content " role ="main ">
78
+ < div class ="body-content ">
79
+ <!--Body content-->
80
+
81
+ < article class ="post-text storypage " itemscope ="itemscope " itemtype ="http://schema.org/Article "> < div class ="e-content entry-content " itemprop ="articleBody text ">
82
+ < div class ="jumbotron ">
83
+ < h1 class ="display-3 " id ="documentation "> Documentation< a href ="#documentation " class ="headerlink " title ="Permalink to this heading "> ¶</ a > </ h1 >
84
+ < p class ="lead ">
85
+ Sometimes you just need a little more detail. You'll find documentation for
86
+ (almost) every function in Cantera right here. This is the documentation for
87
+ a deprecated release, Cantera 2.5.1. For other versions, see the links
88
+ at the bottom of the page.
89
+ </ p >
90
+
91
+ < div id ="searchbox " style ="display: inline-block " role ="search ">
92
+ < h3 > Search the documentation< a href ="#searchbox " class ="headerlink " title ="Permalink to this heading "> ¶</ a > </ h3 >
93
+ < div class ="searchformwrapper ">
94
+ < form class ="search " action ="sphinx/html/search.html " method ="get ">
95
+ < input type ="text " name ="q " size ="50 "> < input type ="submit " value ="Go "> < input type ="hidden " name ="check_keywords " value ="yes "> < input type ="hidden " name ="area " value ="default ">
96
+ </ form >
97
+ </ div >
98
+ </ div >
99
+ </ div >
100
+ < blockquote >
101
+ < div >
102
+ < div class ="admonition warning ">
103
+ < p class ="first admonition-title "> Warning</ p >
104
+ < p class ="last "> This documentation is for an old version of Cantera. You can find docs for newer
105
+ versions < a class ="reference external " href ="https://cantera.org/documentation "> here</ a > .</ p >
106
+ </ div >
107
+ </ div >
108
+ </ blockquote >
109
+ < div class ="row ">
110
+ < div class ="col-sm-6 ">
111
+ < div class ="card " id ="python-docs ">
112
+ < div class ="card-header section-card ">
113
+ Python
114
+ </ div >
115
+ < div class ="list-group list-group-flush ">
116
+ < a href ="sphinx/html/cython/importing.html " class ="list-group-item docs ">
117
+ Objects Representing Phases (< code > Solution</ code > s, < code > PureFluid</ code > s, < code > Interface</ code > s, etc.)
118
+ </ a >
119
+ < a href ="sphinx/html/cython/thermo.html " class ="list-group-item docs ">
120
+ Thermodynamic Properties (Temperature, pressure, energy, etc.)
121
+ </ a >
122
+ < a href ="sphinx/html/cython/kinetics.html " class ="list-group-item docs ">
123
+ Chemical Kinetics (Reactions, rates of progress, reaction path analysis, etc.)
124
+ </ a >
125
+ < a href ="sphinx/html/cython/transport.html " class ="list-group-item docs ">
126
+ Transport Properties (Diffusion, viscosity, thermal conductivity, etc.)
127
+ </ a >
128
+ < a href ="sphinx/html/cython/zerodim.html " class ="list-group-item docs ">
129
+ Zero-Dimensional Reactor Networks (< code > Reactor</ code > s, < code > IdealGasReactor</ code > s, < code > Wall</ code > s,
130
+ etc.)
131
+ </ a >
132
+ < a href ="sphinx/html/cython/onedim.html " class ="list-group-item docs ">
133
+ One-dimensional Reacting Flows (< code > FreeFlame</ code > s, < code > BurnerFlame</ code > s, Flow Domains, Boundaries,
134
+ etc.)
135
+ </ a >
136
+ < a href ="sphinx/html/cython/constants.html " class ="list-group-item docs ">
137
+ Physical Constants (Universal constants, built into Cantera for convenience)
138
+ </ a >
139
+ </ div >
140
+ </ div >
141
+ </ div >
142
+ < div class ="col-sm-6 ">
143
+ < div class ="card " id ="matlab-docs ">
144
+ < div class ="card-header section-card ">
145
+ Matlab
146
+ </ div >
147
+ < div class ="list-group list-group-flush ">
148
+ < a href ="sphinx/html/matlab/importing.html " class ="list-group-item docs ">
149
+ Objects Representing Phases (< code > Solution</ code > s, < code > PureFluid</ code > s, < code > Interface</ code > s, etc.)
150
+ </ a >
151
+ < a href ="sphinx/html/matlab/thermodynamics.html " class ="list-group-item docs ">
152
+ Thermodynamic Properties (Temperature, pressure, energy, etc.)
153
+ </ a >
154
+ < a href ="sphinx/html/matlab/kinetics.html " class ="list-group-item docs ">
155
+ Chemical Kinetics (Reactions, rates of progress, reaction path analysis, etc.)
156
+ </ a >
157
+ < a href ="sphinx/html/matlab/transport.html " class ="list-group-item docs ">
158
+ Transport Properties (Diffusion, viscosity, thermal conductivity, etc.)
159
+ </ a >
160
+ < a href ="sphinx/html/matlab/zero-dim.html " class ="list-group-item docs ">
161
+ Zero-Dimensional Reactor Networks (< code > Reactor</ code > s, < code > IdealGasReactor</ code > s, < code > Wall</ code > s,
162
+ etc.)
163
+ </ a >
164
+ < a href ="sphinx/html/matlab/one-dim.html " class ="list-group-item docs ">
165
+ One-dimensional Reacting Flows (< code > FreeFlame</ code > s, < code > BurnerFlame</ code > s, Flow Domains, Boundaries,
166
+ etc.)
167
+ </ a >
168
+ < a href ="sphinx/html/matlab/data.html " class ="list-group-item docs ">
169
+ Physical Constants (Universal constants, built into Cantera for convenience)
170
+ </ a >
171
+ < a href ="sphinx/html/matlab/utilities.html " class ="list-group-item docs ">
172
+ Utility functions (XML Parsers, conversion scripts, etc.)
173
+ </ a >
174
+ </ div >
175
+ </ div >
176
+ </ div >
177
+ </ div >
178
+
179
+ < div class ="row ">
180
+ < div class ="col-sm-6 ">
181
+ < div class ="card " id ="cxx-docs ">
182
+ < div class ="card-header section-card ">
183
+ C++
184
+ </ div >
185
+ < div class ="list-group list-group-flush ">
186
+ < a href ="doxygen/html/modules.html " class ="list-group-item docs "> List of Cantera Modules</ a >
187
+ < a href ="doxygen/html/classes.html " class ="list-group-item docs "> List of Cantera Classes</ a >
188
+ < a href ="doxygen/html/da/d58/deprecated.html " class ="list-group-item docs "> List of Deprecated
189
+ Functions and Classes</ a >
190
+ </ div >
191
+ </ div >
192
+ </ div >
193
+ < div class ="col-sm-6 ">
194
+ < div class ="card " id ="other-docs ">
195
+ < div class ="card-header section-card ">
196
+ Other Documentation
197
+ </ div >
198
+ < div class ="list-group list-group-flush ">
199
+ < a href ="sphinx/html/yaml/index.html " class ="list-group-item docs ">
200
+ YAML Input File API Reference
201
+ </ a >
202
+ < a href ="sphinx/html/cti/classes.html " class ="list-group-item docs ">
203
+ CTI Input File Class Reference < i > (Deprecated in Cantera 2.5)</ i >
204
+ </ a >
205
+ < a href ="../release_notes/v2.5.1.html " class ="list-group-item release-notes ">
206
+ Cantera 2.5.1 Release Notes
207
+ </ a >
208
+ </ div >
209
+ </ div >
210
+ </ div >
211
+ </ div >
212
+
213
+ </ div >
214
+ < p class ="text-center ">
215
+ < a href ="../index.html " class ="btn btn-lg btn-outline-primary "> Go Back to the Current
216
+ Documentation</ a >
217
+ </ p >
218
+
219
+ </ article > <!--End of body content--> < footer id ="footer "> < div class ="footer " role ="navigation ">
220
+ < div class ="navbar-text ">
221
+ < ul class ="footer-text ">
222
+ < li > < a href ="../index.html "> Home</ a > </ li >
223
+ < li > < a href ="../../community.html#citing-cantera "> Citing</ a > </ li >
224
+ < li > < a href ="../../install/index.html "> Install</ a > </ li >
225
+ < li > < a href ="../../tutorials/index.html "> Tutorials</ a > </ li >
226
+ < li > < a href ="../../examples/index.html "> Examples</ a > </ li >
227
+ < li > < a href ="../../community.html "> Community</ a > </ li >
228
+ < li > < a href ="../../science/index.html "> Science</ a > </ li >
229
+ < li > < a href ="# "> Documentation</ a > </ li >
230
+ < li > < a href ="../../blog/index.html "> Blog</ a > </ li >
231
+ </ ul >
232
+ </ div >
233
+ < p > Contents © 2022
< a href ="
mailto:[email protected] "
> Cantera Developers
</ a > - Powered by
< a href ="
https://getnikola.com "
rel ="
nofollow "
> Nikola
</ a > </ p >
234
+
235
+ </ div >
236
+ </ footer >
237
+ </ div >
238
+ </ div >
239
+
240
+ < script src ="https://code.jquery.com/jquery-3.5.1.min.js " integrity ="sha256-9/aliU8dGd2tb6OSsuzixeV4y/faTqgFtohetphbbj0= " crossorigin ="anonymous "> </ script > < script src ="https://cdnjs.cloudflare.com/ajax/libs/popper.js/1.16.1/umd/popper.min.js " integrity ="sha256-/ijcOLwFf26xEYAjW75FizKVo5tnTYiQddPZoLUHHZ8= " crossorigin ="anonymous "> </ script > < script src ="https://stackpath.bootstrapcdn.com/bootstrap/4.5.0/js/bootstrap.min.js " integrity ="sha384-OgVRvuATP1z7JjHLkuOU7Xw704+h835Lr+6QL9UvYjZE3Ipu6Tp75j7Bh/kR0JKI " crossorigin ="anonymous "> </ script > < script src ="https://cdnjs.cloudflare.com/ajax/libs/baguettebox.js/1.11.1/baguetteBox.min.js " integrity ="sha256-ULQV01VS9LCI2ePpLsmka+W0mawFpEA0rtxnezUj4A4= " crossorigin ="anonymous "> </ script > < script src ="../../assets/js/copybutton.js "> </ script > < script >
241
+ baguetteBox . run ( 'div#content' , {
242
+ ignoreClass : 'islink' ,
243
+ captions : function ( element ) {
244
+ return element . getElementsByTagName ( 'img' ) [ 0 ] . alt ;
245
+ } } ) ;
246
+ </ script >
247
+ </ body >
248
+ </ html >
0 commit comments