-
Notifications
You must be signed in to change notification settings - Fork 0
/
py-modindex.html
406 lines (382 loc) · 35.3 KB
/
py-modindex.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Python Module Index — BattMo documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/sphinx_collapse.css" type="text/css" />
<link rel="stylesheet" href="_static/css/custom.css" type="text/css" />
<link rel="shortcut icon" href="_static/battmologo.ico"/>
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script src="_static/jquery.js?v=5d32c60e"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="_static/documentation_options.js?v=5929fcd5"></script>
<script src="_static/doctools.js?v=888ff710"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<script>
DOCUMENTATION_OPTIONS.COLLAPSE_INDEX = true;
</script>
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home">
BattMo
<img src="_static/battmologo.png" class="logo" alt="Logo"/>
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<ul>
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="basicusage.html">Basic Usage</a><ul>
<li class="toctree-l2"><a class="reference internal" href="basicusage.html#a-first-battmo-model">A First <strong>BattMo</strong> Model</a><ul>
<li class="toctree-l3"><a class="reference internal" href="basicusage.html#define-parameters">Define Parameters</a></li>
<li class="toctree-l3"><a class="reference internal" href="basicusage.html#run-simulation">Run Simulation</a></li>
<li class="toctree-l3"><a class="reference internal" href="basicusage.html#show-the-dashboard">Show the Dashboard</a></li>
<li class="toctree-l3"><a class="reference internal" href="basicusage.html#explore-the-output">Explore the Output</a></li>
<li class="toctree-l3"><a class="reference internal" href="basicusage.html#explore-the-grid">Explore the Grid</a></li>
<li class="toctree-l3"><a class="reference internal" href="basicusage.html#explore-the-states">Explore the States</a></li>
<li class="toctree-l3"><a class="reference internal" href="basicusage.html#plot-a-result">Plot a Result</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="basicusage.html#change-control-parameters">Change Control Parameters</a></li>
<li class="toctree-l2"><a class="reference internal" href="basicusage.html#change-structural-parameters">Change Structural Parameters</a></li>
<li class="toctree-l2"><a class="reference internal" href="basicusage.html#change-material-parameters">Change Material Parameters</a></li>
<li class="toctree-l2"><a class="reference internal" href="basicusage.html#next-steps">Next Steps</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="intermediate.html">Intermediate usage</a><ul>
<li class="toctree-l2"><a class="reference internal" href="intermediate.html#pseudo-four-dimensional-p4d-model">Pseudo-Four-Dimensional (P4D) Model</a><ul>
<li class="toctree-l3"><a class="reference internal" href="intermediate.html#define-parameters">Define Parameters</a></li>
<li class="toctree-l3"><a class="reference internal" href="intermediate.html#run-simulation">Run Simulation</a></li>
<li class="toctree-l3"><a class="reference internal" href="intermediate.html#visualize-results">Visualize Results</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="intermediate.html#direct-insertion-using-parsebattmojson">Direct insertion using <code class="code docutils literal notranslate"><span class="pre">parseBattmoJson</span></code></a><ul>
<li class="toctree-l3"><a class="reference internal" href="intermediate.html#merge-function-using-mergejsonstructs">Merge function using <code class="code docutils literal notranslate"><span class="pre">mergeJsonStructs</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="advancedtopics.html">Advanced Usage</a><ul>
<li class="toctree-l2"><a class="reference internal" href="modelinitialisation.html">Model initialisation</a><ul>
<li class="toctree-l3"><a class="reference internal" href="modelinitialisation.html#how-to-initialise-the-model">How to initialise the model</a></li>
<li class="toctree-l3"><a class="reference internal" href="modelinitialisation.html#calculating-intial-concentration">Calculating intial concentration</a></li>
<li class="toctree-l3"><a class="reference internal" href="modelinitialisation.html#calculating-initial-potential">Calculating initial potential</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="thermal.html">Thermal Simulation</a></li>
<li class="toctree-l2"><a class="reference internal" href="controlinput.html">Control models</a><ul>
<li class="toctree-l3"><a class="reference internal" href="controlinput.html#base-control-model">Base Control Model</a><ul>
<li class="toctree-l4"><a class="reference internal" href="controlinput.html#Utilities.ControlModelInputParams"><code class="docutils literal notranslate"><span class="pre">ControlModelInputParams</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="controlinput.html#ieswitch-control">IESwitch Control</a><ul>
<li class="toctree-l4"><a class="reference internal" href="controlinput.html#Utilities.CCDischargeControlModelInputParams"><code class="docutils literal notranslate"><span class="pre">CCDischargeControlModelInputParams</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="controlinput.html#constant-current-constant-voltage-control">Constant Current Constant Voltage Control</a><ul>
<li class="toctree-l4"><a class="reference internal" href="controlinput.html#Utilities.CcCvControlModelInputParams"><code class="docutils literal notranslate"><span class="pre">CcCvControlModelInputParams</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="controlinput.html#constant-voltage">Constant Voltage</a><ul>
<li class="toctree-l4"><a class="reference internal" href="controlinput.html#Utilities.CvControlModelInputParams"><code class="docutils literal notranslate"><span class="pre">CvControlModelInputParams</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="controlinput.html#constant-current">Constant Current</a><ul>
<li class="toctree-l4"><a class="reference internal" href="controlinput.html#Utilities.CcControlModelInputParams"><code class="docutils literal notranslate"><span class="pre">CcControlModelInputParams</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="optimisation.html">Optimisation</a></li>
<li class="toctree-l2"><a class="reference internal" href="parsets.html">Parameter sets</a><ul>
<li class="toctree-l3"><a class="reference internal" href="parsets.html#chen-2020">Chen 2020</a></li>
<li class="toctree-l3"><a class="reference internal" href="parsets.html#safari-2009">Safari 2009</a></li>
<li class="toctree-l3"><a class="reference internal" href="parsets.html#xu-2015">Xu 2015</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="architecture.html">BattMo Model Architecture</a><ul>
<li class="toctree-l2"><a class="reference internal" href="batteryinput.html">Battery cell</a><ul>
<li class="toctree-l3"><a class="reference internal" href="batteryinput.html#BatteryInputParams"><code class="docutils literal notranslate"><span class="pre">BatteryInputParams</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="batteryinput.html#BatteryInputParams.NegativeElectrode"><code class="docutils literal notranslate"><span class="pre">BatteryInputParams.NegativeElectrode</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="batteryinput.html#BatteryInputParams.PositiveElectrode"><code class="docutils literal notranslate"><span class="pre">BatteryInputParams.PositiveElectrode</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="batteryinput.html#BatteryInputParams.Electrolyte"><code class="docutils literal notranslate"><span class="pre">BatteryInputParams.Electrolyte</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="batteryinput.html#BatteryInputParams.Separator"><code class="docutils literal notranslate"><span class="pre">BatteryInputParams.Separator</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="batteryinput.html#BatteryInputParams.ThermalModel"><code class="docutils literal notranslate"><span class="pre">BatteryInputParams.ThermalModel</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="batteryinput.html#BatteryInputParams.Control"><code class="docutils literal notranslate"><span class="pre">BatteryInputParams.Control</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="batteryinput.html#electrode">Electrode</a><ul>
<li class="toctree-l3"><a class="reference internal" href="batteryinput.html#ElectrodeInputParams"><code class="docutils literal notranslate"><span class="pre">ElectrodeInputParams</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="batteryinput.html#ElectrodeInputParams.Coating"><code class="docutils literal notranslate"><span class="pre">ElectrodeInputParams.Coating</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="batteryinput.html#ElectrodeInputParams.CurrentCollector"><code class="docutils literal notranslate"><span class="pre">ElectrodeInputParams.CurrentCollector</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="batteryinput.html#coating">Coating</a><ul>
<li class="toctree-l3"><a class="reference internal" href="batteryinput.html#CoatingInputParams"><code class="docutils literal notranslate"><span class="pre">CoatingInputParams</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="batteryinput.html#CoatingInputParams.ActiveMaterial"><code class="docutils literal notranslate"><span class="pre">CoatingInputParams.ActiveMaterial</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="batteryinput.html#CoatingInputParams.Binder"><code class="docutils literal notranslate"><span class="pre">CoatingInputParams.Binder</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="batteryinput.html#CoatingInputParams.ConductingAdditive"><code class="docutils literal notranslate"><span class="pre">CoatingInputParams.ConductingAdditive</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="batteryinput.html#active-material">Active Material</a><ul>
<li class="toctree-l3"><a class="reference internal" href="batteryinput.html#ActiveMaterialInputParams"><code class="docutils literal notranslate"><span class="pre">ActiveMaterialInputParams</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="batteryinput.html#ActiveMaterialInputParams.Interface"><code class="docutils literal notranslate"><span class="pre">ActiveMaterialInputParams.Interface</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="batteryinput.html#ActiveMaterialInputParams.SolidDiffusion"><code class="docutils literal notranslate"><span class="pre">ActiveMaterialInputParams.SolidDiffusion</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="batteryinput.html#ActiveMaterialInputParams.electronicConductivity"><code class="docutils literal notranslate"><span class="pre">ActiveMaterialInputParams.electronicConductivity</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="batteryinput.html#ActiveMaterialInputParams.density"><code class="docutils literal notranslate"><span class="pre">ActiveMaterialInputParams.density</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="batteryinput.html#ActiveMaterialInputParams.massFraction"><code class="docutils literal notranslate"><span class="pre">ActiveMaterialInputParams.massFraction</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="batteryinput.html#ActiveMaterialInputParams.thermalConductivity"><code class="docutils literal notranslate"><span class="pre">ActiveMaterialInputParams.thermalConductivity</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="batteryinput.html#ActiveMaterialInputParams.specificHeatCapacity"><code class="docutils literal notranslate"><span class="pre">ActiveMaterialInputParams.specificHeatCapacity</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="batteryinput.html#ActiveMaterialInputParams.diffusionModelType"><code class="docutils literal notranslate"><span class="pre">ActiveMaterialInputParams.diffusionModelType</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="batteryinput.html#binder">Binder</a><ul>
<li class="toctree-l3"><a class="reference internal" href="batteryinput.html#BinderInputParams"><code class="docutils literal notranslate"><span class="pre">BinderInputParams</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="batteryinput.html#BinderInputParams.electronicConductivity"><code class="docutils literal notranslate"><span class="pre">BinderInputParams.electronicConductivity</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="batteryinput.html#BinderInputParams.density"><code class="docutils literal notranslate"><span class="pre">BinderInputParams.density</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="batteryinput.html#BinderInputParams.massFraction"><code class="docutils literal notranslate"><span class="pre">BinderInputParams.massFraction</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="batteryinput.html#BinderInputParams.thermalConductivity"><code class="docutils literal notranslate"><span class="pre">BinderInputParams.thermalConductivity</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="batteryinput.html#BinderInputParams.specificHeatCapacity"><code class="docutils literal notranslate"><span class="pre">BinderInputParams.specificHeatCapacity</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="batteryinput.html#conducting-additive">Conducting Additive</a><ul>
<li class="toctree-l3"><a class="reference internal" href="batteryinput.html#ConductingAdditiveInputParams"><code class="docutils literal notranslate"><span class="pre">ConductingAdditiveInputParams</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="batteryinput.html#ConductingAdditiveInputParams.electronicConductivity"><code class="docutils literal notranslate"><span class="pre">ConductingAdditiveInputParams.electronicConductivity</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="batteryinput.html#ConductingAdditiveInputParams.density"><code class="docutils literal notranslate"><span class="pre">ConductingAdditiveInputParams.density</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="batteryinput.html#ConductingAdditiveInputParams.massFraction"><code class="docutils literal notranslate"><span class="pre">ConductingAdditiveInputParams.massFraction</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="batteryinput.html#ConductingAdditiveInputParams.thermalConductivity"><code class="docutils literal notranslate"><span class="pre">ConductingAdditiveInputParams.thermalConductivity</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="batteryinput.html#ConductingAdditiveInputParams.specificHeatCapacity"><code class="docutils literal notranslate"><span class="pre">ConductingAdditiveInputParams.specificHeatCapacity</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="batteryinput.html#interface">Interface</a><ul>
<li class="toctree-l3"><a class="reference internal" href="batteryinput.html#InterfaceInputParams"><code class="docutils literal notranslate"><span class="pre">InterfaceInputParams</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="batteryinput.html#InterfaceInputParams.saturationConcentration"><code class="docutils literal notranslate"><span class="pre">InterfaceInputParams.saturationConcentration</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="batteryinput.html#InterfaceInputParams.numberOfElectronsTransferred"><code class="docutils literal notranslate"><span class="pre">InterfaceInputParams.numberOfElectronsTransferred</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="batteryinput.html#InterfaceInputParams.volumeFraction"><code class="docutils literal notranslate"><span class="pre">InterfaceInputParams.volumeFraction</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="batteryinput.html#InterfaceInputParams.volumetricSurfaceArea"><code class="docutils literal notranslate"><span class="pre">InterfaceInputParams.volumetricSurfaceArea</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="batteryinput.html#InterfaceInputParams.activationEnergyOfReaction"><code class="docutils literal notranslate"><span class="pre">InterfaceInputParams.activationEnergyOfReaction</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="batteryinput.html#InterfaceInputParams.reactionRateConstant"><code class="docutils literal notranslate"><span class="pre">InterfaceInputParams.reactionRateConstant</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="batteryinput.html#InterfaceInputParams.exchangeCurrentDensity"><code class="docutils literal notranslate"><span class="pre">InterfaceInputParams.exchangeCurrentDensity</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="batteryinput.html#InterfaceInputParams.guestStoichiometry100"><code class="docutils literal notranslate"><span class="pre">InterfaceInputParams.guestStoichiometry100</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="batteryinput.html#InterfaceInputParams.guestStoichiometry0"><code class="docutils literal notranslate"><span class="pre">InterfaceInputParams.guestStoichiometry0</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="batteryinput.html#InterfaceInputParams.density"><code class="docutils literal notranslate"><span class="pre">InterfaceInputParams.density</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="batteryinput.html#InterfaceInputParams.openCircuitPotential"><code class="docutils literal notranslate"><span class="pre">InterfaceInputParams.openCircuitPotential</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="batteryinput.html#InterfaceInputParams.chargeTransferCoefficient"><code class="docutils literal notranslate"><span class="pre">InterfaceInputParams.chargeTransferCoefficient</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="batteryinput.html#solid-diffusion-models">Solid Diffusion Models</a><ul>
<li class="toctree-l3"><a class="reference internal" href="batteryinput.html#SolidDiffusionModelInputParams"><code class="docutils literal notranslate"><span class="pre">SolidDiffusionModelInputParams</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="batteryinput.html#SolidDiffusionModelInputParams.particleRadius"><code class="docutils literal notranslate"><span class="pre">SolidDiffusionModelInputParams.particleRadius</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="batteryinput.html#SolidDiffusionModelInputParams.activationEnergyOfDiffusion"><code class="docutils literal notranslate"><span class="pre">SolidDiffusionModelInputParams.activationEnergyOfDiffusion</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="batteryinput.html#SolidDiffusionModelInputParams.referenceDiffusionCoefficient"><code class="docutils literal notranslate"><span class="pre">SolidDiffusionModelInputParams.referenceDiffusionCoefficient</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="batteryinput.html#SolidDiffusionModelInputParams.volumetricSurfaceArea"><code class="docutils literal notranslate"><span class="pre">SolidDiffusionModelInputParams.volumetricSurfaceArea</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="batteryinput.html#FullSolidDiffusionModelInputParams"><code class="docutils literal notranslate"><span class="pre">FullSolidDiffusionModelInputParams</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="batteryinput.html#FullSolidDiffusionModelInputParams.diffusionCoefficient"><code class="docutils literal notranslate"><span class="pre">FullSolidDiffusionModelInputParams.diffusionCoefficient</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="batteryinput.html#FullSolidDiffusionModelInputParams.saturationConcentration"><code class="docutils literal notranslate"><span class="pre">FullSolidDiffusionModelInputParams.saturationConcentration</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="batteryinput.html#FullSolidDiffusionModelInputParams.guestStoichiometry100"><code class="docutils literal notranslate"><span class="pre">FullSolidDiffusionModelInputParams.guestStoichiometry100</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="batteryinput.html#FullSolidDiffusionModelInputParams.guestStoichiometry0"><code class="docutils literal notranslate"><span class="pre">FullSolidDiffusionModelInputParams.guestStoichiometry0</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="batteryinput.html#SimplifiedSolidDiffusionModelInputParams"><code class="docutils literal notranslate"><span class="pre">SimplifiedSolidDiffusionModelInputParams</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="batteryinput.html#electrolyte">Electrolyte</a><ul>
<li class="toctree-l3"><a class="reference internal" href="batteryinput.html#ElectrolyteInputParams"><code class="docutils literal notranslate"><span class="pre">ElectrolyteInputParams</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="batteryinput.html#ElectrolyteInputParams.density"><code class="docutils literal notranslate"><span class="pre">ElectrolyteInputParams.density</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="batteryinput.html#ElectrolyteInputParams.ionicConductivity"><code class="docutils literal notranslate"><span class="pre">ElectrolyteInputParams.ionicConductivity</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="batteryinput.html#ElectrolyteInputParams.diffusionCoefficient"><code class="docutils literal notranslate"><span class="pre">ElectrolyteInputParams.diffusionCoefficient</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="batteryinput.html#ElectrolyteInputParams.bruggemanCoefficient"><code class="docutils literal notranslate"><span class="pre">ElectrolyteInputParams.bruggemanCoefficient</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="batteryinput.html#ElectrolyteInputParams.thermalConductivity"><code class="docutils literal notranslate"><span class="pre">ElectrolyteInputParams.thermalConductivity</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="batteryinput.html#ElectrolyteInputParams.specificHeatCapacity"><code class="docutils literal notranslate"><span class="pre">ElectrolyteInputParams.specificHeatCapacity</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="batteryinput.html#current-collector">Current Collector</a><ul>
<li class="toctree-l3"><a class="reference internal" href="batteryinput.html#CurrentCollectorInputParams"><code class="docutils literal notranslate"><span class="pre">CurrentCollectorInputParams</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="batteryinput.html#CurrentCollectorInputParams.thermalConductivity"><code class="docutils literal notranslate"><span class="pre">CurrentCollectorInputParams.thermalConductivity</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="batteryinput.html#CurrentCollectorInputParams.specificHeatCapacity"><code class="docutils literal notranslate"><span class="pre">CurrentCollectorInputParams.specificHeatCapacity</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="batteryinput.html#CurrentCollectorInputParams.density"><code class="docutils literal notranslate"><span class="pre">CurrentCollectorInputParams.density</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="batteryinput.html#electronic-component">Electronic Component</a><ul>
<li class="toctree-l3"><a class="reference internal" href="batteryinput.html#ElectronicComponentInputParams"><code class="docutils literal notranslate"><span class="pre">ElectronicComponentInputParams</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="batteryinput.html#ElectronicComponentInputParams.electronicConductivity"><code class="docutils literal notranslate"><span class="pre">ElectronicComponentInputParams.electronicConductivity</span></code></a></li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="json.html">JSON input specification</a><ul>
<li class="toctree-l2"><a class="reference internal" href="json.html#material-parameters">Material Parameters</a><ul>
<li class="toctree-l3"><a class="reference internal" href="json.html#electrolyte">Electrolyte</a></li>
<li class="toctree-l3"><a class="reference internal" href="json.html#electrode">Electrode</a></li>
<li class="toctree-l3"><a class="reference internal" href="json.html#coating">Coating</a></li>
<li class="toctree-l3"><a class="reference internal" href="json.html#interface">Interface</a></li>
<li class="toctree-l3"><a class="reference internal" href="json.html#solid-diffusion">Solid Diffusion</a></li>
<li class="toctree-l3"><a class="reference internal" href="json.html#current-collector">Current Collector</a></li>
<li class="toctree-l3"><a class="reference internal" href="json.html#separator">Separator</a></li>
<li class="toctree-l3"><a class="reference internal" href="json.html#thermal-model">Thermal Model</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="json.html#geometry-setup">Geometry Setup</a></li>
<li class="toctree-l2"><a class="reference internal" href="json.html#simulation-control-parameters">Simulation Control Parameters</a></li>
<li class="toctree-l2"><a class="reference internal" href="json.html#time-stepping-parameters">Time Stepping Parameters</a></li>
<li class="toctree-l2"><a class="reference internal" href="json.html#solver-parameters">Solver Parameters</a></li>
<li class="toctree-l2"><a class="reference internal" href="json.html#output-parameters">Output Parameters</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="geometryinput.html">Battery Geometries</a><ul>
<li class="toctree-l2"><a class="reference internal" href="geometryinput.html#batterygeneratorp2d">BatteryGeneratorP2D</a><ul>
<li class="toctree-l3"><a class="reference internal" href="geometryinput.html#BatteryGeneratorP2D"><code class="docutils literal notranslate"><span class="pre">BatteryGeneratorP2D</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="geometryinput.html#batterygeneratorp3d">BatteryGeneratorP3D</a><ul>
<li class="toctree-l3"><a class="reference internal" href="geometryinput.html#BatteryGeneratorP3D"><code class="docutils literal notranslate"><span class="pre">BatteryGeneratorP3D</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="geometryinput.html#batterygeneratorp4d">BatteryGeneratorP4D</a><ul>
<li class="toctree-l3"><a class="reference internal" href="geometryinput.html#BatteryGeneratorP4D"><code class="docutils literal notranslate"><span class="pre">BatteryGeneratorP4D</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="geometryinput.html#spiralbatterygenerator">SpiralBatteryGenerator</a><ul>
<li class="toctree-l3"><a class="reference internal" href="geometryinput.html#SpiralBatteryGenerator"><code class="docutils literal notranslate"><span class="pre">SpiralBatteryGenerator</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="geometryinput.html#coincellbatterygenerator">CoinCellBatteryGenerator</a><ul>
<li class="toctree-l3"><a class="reference internal" href="geometryinput.html#CoinCellBatteryGenerator"><code class="docutils literal notranslate"><span class="pre">CoinCellBatteryGenerator</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="geometryinput.html#blockbatterygenerator">BlockBatteryGenerator</a></li>
<li class="toctree-l2"><a class="reference internal" href="geometryinput.html#coincellsectorbatterygenerator">CoinCellSectorBatteryGenerator</a></li>
<li class="toctree-l2"><a class="reference internal" href="geometryinput.html#flatbatterygenerator">FlatBatteryGenerator</a></li>
<li class="toctree-l2"><a class="reference internal" href="geometryinput.html#sectorbatterygenerator">SectorBatteryGenerator</a></li>
<li class="toctree-l2"><a class="reference internal" href="geometryinput.html#base-class">Base class</a><ul>
<li class="toctree-l3"><a class="reference internal" href="geometryinput.html#BatteryGenerator"><code class="docutils literal notranslate"><span class="pre">BatteryGenerator</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="juliabridge.html">Julia bridge</a><ul>
<li class="toctree-l2"><a class="reference internal" href="juliabridge.html#introduction">Introduction</a></li>
<li class="toctree-l2"><a class="reference internal" href="juliabridge.html#setup-and-use">Setup and Use</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="gui.html">BattMo GUI</a></li>
<li class="toctree-l1"><a class="reference internal" href="publishedExamples/runElectrolyser.html">Electrolyser simulation</a><ul>
<li class="toctree-l2"><a class="reference internal" href="publishedExamples/runElectrolyser.html#load-mrst-modules">Load MRST modules</a></li>
<li class="toctree-l2"><a class="reference internal" href="publishedExamples/runElectrolyser.html#setup-input">Setup input</a></li>
<li class="toctree-l2"><a class="reference internal" href="publishedExamples/runElectrolyser.html#setup-model">Setup model</a></li>
<li class="toctree-l2"><a class="reference internal" href="publishedExamples/runElectrolyser.html#setup-the-initial-condition">Setup the initial condition</a></li>
<li class="toctree-l2"><a class="reference internal" href="publishedExamples/runElectrolyser.html#setup-the-schedule-with-the-time-discretization">Setup the schedule with the time discretization</a></li>
<li class="toctree-l2"><a class="reference internal" href="publishedExamples/runElectrolyser.html#setup-the-non-linear-solver">Setup the non-linear solver</a></li>
<li class="toctree-l2"><a class="reference internal" href="publishedExamples/runElectrolyser.html#run-the-simulation">Run the simulation</a></li>
<li class="toctree-l2"><a class="reference internal" href="publishedExamples/runElectrolyser.html#visualize-the-results">Visualize the results</a></li>
<li class="toctree-l2"><a class="reference internal" href="publishedExamples/runElectrolyser.html#ph-distribution-plot">pH distribution plot</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="seealso.html">See Also</a><ul>
<li class="toctree-l2"><a class="reference internal" href="mrst.html">MRST</a><ul>
<li class="toctree-l3"><a class="reference internal" href="mrst.html#id1">Visualization Tutorial</a></li>
<li class="toctree-l3"><a class="reference internal" href="mrst.html#id2">Grid Factory Tutorial</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="fair.html">FAIR Data</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="bibliography.html">References</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">BattMo</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item active">Python Module Index</li>
<li class="wy-breadcrumbs-aside">
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<h1>Python Module Index</h1>
<div class="modindex-jumpbox">
<a href="#cap-u"><strong>u</strong></a>
</div>
<table class="indextable modindextable">
<tr class="pcap"><td></td><td> </td><td></td></tr>
<tr class="cap" id="cap-u"><td></td><td>
<strong>u</strong></td><td></td></tr>
<tr>
<td></td>
<td>
<a href="controlinput.html#module-Utilities"><code class="xref">Utilities</code></a></td><td>
<em></em></td></tr>
</table>
</div>
</div>
<footer>
<hr/>
<div role="contentinfo">
<p>© Copyright 2021-2023.</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>