-
Notifications
You must be signed in to change notification settings - Fork 0
/
geometries.html
643 lines (547 loc) · 46.8 KB
/
geometries.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
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
<!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>Geometry models — BattMo documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
</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" />
<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="tutorials.html">Getting started</a></li>
<li class="toctree-l1"><a class="reference internal" href="inputs.html">BattMo Li-ion battery API</a></li>
<li class="toctree-l1"><a class="reference internal" href="advancedtopics.html">Advanced topics</a></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"></a> »</li>
<li>Geometry models</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/geometries.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="module-Battery.BatteryGeometry">
<span id="geometry-models"></span><h1>Geometry models<a class="headerlink" href="#module-Battery.BatteryGeometry" title="Permalink to this headline"></a></h1>
<p>Description of the models that are used to setup the geometry</p>
<div class="section" id="base-class">
<h2>Base class<a class="headerlink" href="#base-class" title="Permalink to this headline"></a></h2>
<dl class="mat class">
<dt class="sig sig-object mat" id="Battery.BatteryGeometry.BatteryGenerator">
<em class="property"><span class="pre">class</span> </em><span class="sig-name descname"><span class="pre">BatteryGenerator</span></span><a class="headerlink" href="#Battery.BatteryGeometry.BatteryGenerator" title="Permalink to this definition"></a></dt>
<dd><p>Base class that add grids and coupling terms to a paramobj instance of BatteryInputParams (through method
updateBatteryInputParams)</p>
<p>This class goes through the whole grid setup and is meant to be used as a base class.</p>
<p>Example : <code class="xref mat mat-class docutils literal notranslate"><span class="pre">BatteryGenerator1D</span></code>, <code class="xref mat mat-class docutils literal notranslate"><span class="pre">BatteryGenerator2D</span></code>, <code class="xref mat mat-class docutils literal notranslate"><span class="pre">BatteryGenerator3D</span></code></p>
<dl class="mat attribute">
<dt class="sig sig-object mat" id="Battery.BatteryGeometry.BatteryGenerator.G">
<span class="sig-name descname"><span class="pre">G</span></span><a class="headerlink" href="#Battery.BatteryGeometry.BatteryGenerator.G" title="Permalink to this definition"></a></dt>
<dd><p>Global grid
It is stored here because is shared by many setup functions
It is setup by function setupBatteryGrid</p>
</dd></dl>
<dl class="mat method">
<dt class="sig sig-object mat" id="Battery.BatteryGeometry.BatteryGenerator.updateBatteryInputParams">
<span class="sig-name descname"><span class="pre">updateBatteryInputParams</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="pre">gen</span></em>, <em class="sig-param"><span class="pre">paramobj</span></em>, <em class="sig-param"><span class="pre">params</span></em><span class="sig-paren">)</span><a class="headerlink" href="#Battery.BatteryGeometry.BatteryGenerator.updateBatteryInputParams" title="Permalink to this definition"></a></dt>
<dd><p>this function is the main class function as it returns an updated paramobj object with grid structure</p>
</dd></dl>
<dl class="mat method">
<dt class="sig sig-object mat" id="Battery.BatteryGeometry.BatteryGenerator.setupBatteryInputParams">
<span class="sig-name descname"><span class="pre">setupBatteryInputParams</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="pre">gen</span></em>, <em class="sig-param"><span class="pre">paramobj</span></em>, <em class="sig-param"><span class="pre">params</span></em><span class="sig-paren">)</span><a class="headerlink" href="#Battery.BatteryGeometry.BatteryGenerator.setupBatteryInputParams" title="Permalink to this definition"></a></dt>
<dd><p>main function : add grid and coupling to paramobj structure</p>
</dd></dl>
<dl class="mat method">
<dt class="sig sig-object mat" id="Battery.BatteryGeometry.BatteryGenerator.setupGrid">
<span class="sig-name descname"><span class="pre">setupGrid</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="pre">gen</span></em>, <em class="sig-param"><span class="pre">paramobj</span></em>, <em class="sig-param"><span class="pre">params</span></em><span class="sig-paren">)</span><a class="headerlink" href="#Battery.BatteryGeometry.BatteryGenerator.setupGrid" title="Permalink to this definition"></a></dt>
<dd><p>paramobj is instance of BatteryInputParams
setup paramobj.G and update gen.G</p>
</dd></dl>
<dl class="mat method">
<dt class="sig sig-object mat" id="Battery.BatteryGeometry.BatteryGenerator.setupThermalModel">
<span class="sig-name descname"><span class="pre">setupThermalModel</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="pre">gen</span></em>, <em class="sig-param"><span class="pre">paramobj</span></em>, <em class="sig-param"><span class="pre">params</span></em><span class="sig-paren">)</span><a class="headerlink" href="#Battery.BatteryGeometry.BatteryGenerator.setupThermalModel" title="Permalink to this definition"></a></dt>
<dd><p>paramobj is instance of BatteryInputParams</p>
</dd></dl>
<dl class="mat method">
<dt class="sig sig-object mat" id="Battery.BatteryGeometry.BatteryGenerator.setupElectrolyte">
<span class="sig-name descname"><span class="pre">setupElectrolyte</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="pre">gen</span></em>, <em class="sig-param"><span class="pre">paramobj</span></em>, <em class="sig-param"><span class="pre">params</span></em><span class="sig-paren">)</span><a class="headerlink" href="#Battery.BatteryGeometry.BatteryGenerator.setupElectrolyte" title="Permalink to this definition"></a></dt>
<dd><p>paramobj is instance of ElectrolyteInputParams</p>
</dd></dl>
<dl class="mat method">
<dt class="sig sig-object mat" id="Battery.BatteryGeometry.BatteryGenerator.setupElectrolyteGrid">
<span class="sig-name descname"><span class="pre">setupElectrolyteGrid</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="pre">gen</span></em>, <em class="sig-param"><span class="pre">paramobj</span></em>, <em class="sig-param"><span class="pre">params</span></em><span class="sig-paren">)</span><a class="headerlink" href="#Battery.BatteryGeometry.BatteryGenerator.setupElectrolyteGrid" title="Permalink to this definition"></a></dt>
<dd><p>paramobj is instance of ElectrolyteInputParams
setup paramobj.G</p>
</dd></dl>
<dl class="mat method">
<dt class="sig sig-object mat" id="Battery.BatteryGeometry.BatteryGenerator.setupSeparatorGrid">
<span class="sig-name descname"><span class="pre">setupSeparatorGrid</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="pre">gen</span></em>, <em class="sig-param"><span class="pre">paramobj</span></em>, <em class="sig-param"><span class="pre">params</span></em><span class="sig-paren">)</span><a class="headerlink" href="#Battery.BatteryGeometry.BatteryGenerator.setupSeparatorGrid" title="Permalink to this definition"></a></dt>
<dd><p>paramobj is instance of SeparatorInputParams
setup paramobj.G</p>
</dd></dl>
<dl class="mat method">
<dt class="sig sig-object mat" id="Battery.BatteryGeometry.BatteryGenerator.setupElectrodes">
<span class="sig-name descname"><span class="pre">setupElectrodes</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="pre">gen</span></em>, <em class="sig-param"><span class="pre">paramobj</span></em>, <em class="sig-param"><span class="pre">params</span></em><span class="sig-paren">)</span><a class="headerlink" href="#Battery.BatteryGeometry.BatteryGenerator.setupElectrodes" title="Permalink to this definition"></a></dt>
<dd><p>paramobj is instance of BatteryInputParams</p>
</dd></dl>
<dl class="mat method">
<dt class="sig sig-object mat" id="Battery.BatteryGeometry.BatteryGenerator.setupElectrode">
<span class="sig-name descname"><span class="pre">setupElectrode</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="pre">gen</span></em>, <em class="sig-param"><span class="pre">paramobj</span></em>, <em class="sig-param"><span class="pre">params</span></em><span class="sig-paren">)</span><a class="headerlink" href="#Battery.BatteryGeometry.BatteryGenerator.setupElectrode" title="Permalink to this definition"></a></dt>
<dd><p>paramobj is instance of ElectrodeInputParams</p>
</dd></dl>
<dl class="mat method">
<dt class="sig sig-object mat" id="Battery.BatteryGeometry.BatteryGenerator.setupElectrodeGrid">
<span class="sig-name descname"><span class="pre">setupElectrodeGrid</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="pre">gen</span></em>, <em class="sig-param"><span class="pre">paramobj</span></em>, <em class="sig-param"><span class="pre">params</span></em><span class="sig-paren">)</span><a class="headerlink" href="#Battery.BatteryGeometry.BatteryGenerator.setupElectrodeGrid" title="Permalink to this definition"></a></dt>
<dd><p>paramobj is instance of ElectrodeInputParams
setup paramobj.G</p>
</dd></dl>
<dl class="mat method">
<dt class="sig sig-object mat" id="Battery.BatteryGeometry.BatteryGenerator.setupActiveMaterialGrid">
<span class="sig-name descname"><span class="pre">setupActiveMaterialGrid</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="pre">gen</span></em>, <em class="sig-param"><span class="pre">paramobj</span></em>, <em class="sig-param"><span class="pre">params</span></em><span class="sig-paren">)</span><a class="headerlink" href="#Battery.BatteryGeometry.BatteryGenerator.setupActiveMaterialGrid" title="Permalink to this definition"></a></dt>
<dd><p>paramobj is instance of ActiveMaterialInputParams
setup paramobj.G</p>
</dd></dl>
<dl class="mat method">
<dt class="sig sig-object mat" id="Battery.BatteryGeometry.BatteryGenerator.setupCurrentCollector">
<span class="sig-name descname"><span class="pre">setupCurrentCollector</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="pre">gen</span></em>, <em class="sig-param"><span class="pre">paramobj</span></em>, <em class="sig-param"><span class="pre">params</span></em><span class="sig-paren">)</span><a class="headerlink" href="#Battery.BatteryGeometry.BatteryGenerator.setupCurrentCollector" title="Permalink to this definition"></a></dt>
<dd><p>paramobj is instance of CurrentCollectorInputParams</p>
</dd></dl>
<dl class="mat method">
<dt class="sig sig-object mat" id="Battery.BatteryGeometry.BatteryGenerator.setupCurrentCollectorGrid">
<span class="sig-name descname"><span class="pre">setupCurrentCollectorGrid</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="pre">gen</span></em>, <em class="sig-param"><span class="pre">paramobj</span></em>, <em class="sig-param"><span class="pre">params</span></em><span class="sig-paren">)</span><a class="headerlink" href="#Battery.BatteryGeometry.BatteryGenerator.setupCurrentCollectorGrid" title="Permalink to this definition"></a></dt>
<dd><p>paramobj is instance of CurrentCollectorInputParams
setup paramobj.G</p>
</dd></dl>
<dl class="mat method">
<dt class="sig sig-object mat" id="Battery.BatteryGeometry.BatteryGenerator.setupElectrodeElectrolyteCoupTerm">
<span class="sig-name descname"><span class="pre">setupElectrodeElectrolyteCoupTerm</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="pre">gen</span></em>, <em class="sig-param"><span class="pre">paramobj</span></em>, <em class="sig-param"><span class="pre">params</span></em><span class="sig-paren">)</span><a class="headerlink" href="#Battery.BatteryGeometry.BatteryGenerator.setupElectrodeElectrolyteCoupTerm" title="Permalink to this definition"></a></dt>
<dd><p>paramobj is instance of BatteryInputParams
setup paramobj.couplingTerms</p>
</dd></dl>
<dl class="mat method">
<dt class="sig sig-object mat" id="Battery.BatteryGeometry.BatteryGenerator.setupCurrentCollectorActiveMaterialCoupTerm">
<span class="sig-name descname"><span class="pre">setupCurrentCollectorActiveMaterialCoupTerm</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="pre">gen</span></em>, <em class="sig-param"><span class="pre">paramobj</span></em>, <em class="sig-param"><span class="pre">params</span></em><span class="sig-paren">)</span><a class="headerlink" href="#Battery.BatteryGeometry.BatteryGenerator.setupCurrentCollectorActiveMaterialCoupTerm" title="Permalink to this definition"></a></dt>
<dd><p>paramobj is instance of ElectrodeInputParams
setup paramobj.couplingTerm</p>
</dd></dl>
<dl class="mat method">
<dt class="sig sig-object mat" id="Battery.BatteryGeometry.BatteryGenerator.setupCurrentCollectorBcCoupTerm">
<span class="sig-name descname"><span class="pre">setupCurrentCollectorBcCoupTerm</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="pre">gen</span></em>, <em class="sig-param"><span class="pre">paramobj</span></em>, <em class="sig-param"><span class="pre">params</span></em><span class="sig-paren">)</span><a class="headerlink" href="#Battery.BatteryGeometry.BatteryGenerator.setupCurrentCollectorBcCoupTerm" title="Permalink to this definition"></a></dt>
<dd><p>paramobj is instance of CurrentCollectorInputParams
setup paramobj.couplingTerm</p>
</dd></dl>
<dl class="mat method">
<dt class="sig sig-object mat" id="Battery.BatteryGeometry.BatteryGenerator.setupActiveMaterialBcCoupTerm">
<span class="sig-name descname"><span class="pre">setupActiveMaterialBcCoupTerm</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="pre">gen</span></em>, <em class="sig-param"><span class="pre">paramobj</span></em>, <em class="sig-param"><span class="pre">params</span></em><span class="sig-paren">)</span><a class="headerlink" href="#Battery.BatteryGeometry.BatteryGenerator.setupActiveMaterialBcCoupTerm" title="Permalink to this definition"></a></dt>
<dd><p>default setup</p>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="batterygenerator1d">
<h2>BatteryGenerator1D<a class="headerlink" href="#batterygenerator1d" title="Permalink to this headline"></a></h2>
<dl class="mat class">
<dt class="sig sig-object mat" id="Battery.BatteryGeometry.BatteryGenerator1D">
<em class="property"><span class="pre">class</span> </em><span class="sig-name descname"><span class="pre">BatteryGenerator1D</span></span><a class="headerlink" href="#Battery.BatteryGeometry.BatteryGenerator1D" title="Permalink to this definition"></a></dt>
<dd><p>setup 1D grid</p>
<dl class="mat attribute">
<dt class="sig sig-object mat" id="Battery.BatteryGeometry.BatteryGenerator1D.xlength">
<span class="sig-name descname"><span class="pre">xlength</span></span><a class="headerlink" href="#Battery.BatteryGeometry.BatteryGenerator1D.xlength" title="Permalink to this definition"></a></dt>
<dd><p>length of components in x direction - default values</p>
</dd></dl>
<dl class="mat attribute">
<dt class="sig sig-object mat" id="Battery.BatteryGeometry.BatteryGenerator1D.sepnx">
<span class="sig-name descname"><span class="pre">sepnx</span></span><a class="headerlink" href="#Battery.BatteryGeometry.BatteryGenerator1D.sepnx" title="Permalink to this definition"></a></dt>
<dd><p>discretization number for negative current collector - default value</p>
</dd></dl>
<dl class="mat attribute">
<dt class="sig sig-object mat" id="Battery.BatteryGeometry.BatteryGenerator1D.nenx">
<span class="sig-name descname"><span class="pre">nenx</span></span><a class="headerlink" href="#Battery.BatteryGeometry.BatteryGenerator1D.nenx" title="Permalink to this definition"></a></dt>
<dd><p>discretization number for negative active material - default value</p>
</dd></dl>
<dl class="mat attribute">
<dt class="sig sig-object mat" id="Battery.BatteryGeometry.BatteryGenerator1D.penx">
<span class="sig-name descname"><span class="pre">penx</span></span><a class="headerlink" href="#Battery.BatteryGeometry.BatteryGenerator1D.penx" title="Permalink to this definition"></a></dt>
<dd><p>discretization number for separator - default value</p>
</dd></dl>
<dl class="mat attribute">
<dt class="sig sig-object mat" id="Battery.BatteryGeometry.BatteryGenerator1D.nenr">
<span class="sig-name descname"><span class="pre">nenr</span></span><a class="headerlink" href="#Battery.BatteryGeometry.BatteryGenerator1D.nenr" title="Permalink to this definition"></a></dt>
<dd><p>discretization for solid diffusion - default value</p>
</dd></dl>
<dl class="mat attribute">
<dt class="sig sig-object mat" id="Battery.BatteryGeometry.BatteryGenerator1D.penr">
<span class="sig-name descname"><span class="pre">penr</span></span><a class="headerlink" href="#Battery.BatteryGeometry.BatteryGenerator1D.penr" title="Permalink to this definition"></a></dt>
<dd><p>discretization for solid diffusion - default value</p>
</dd></dl>
<dl class="mat attribute">
<dt class="sig sig-object mat" id="Battery.BatteryGeometry.BatteryGenerator1D.ccnenx">
<span class="sig-name descname"><span class="pre">ccnenx</span></span><a class="headerlink" href="#Battery.BatteryGeometry.BatteryGenerator1D.ccnenx" title="Permalink to this definition"></a></dt>
<dd><p>discretization number for positive current collector - default value</p>
</dd></dl>
<dl class="mat attribute">
<dt class="sig sig-object mat" id="Battery.BatteryGeometry.BatteryGenerator1D.ccpenx">
<span class="sig-name descname"><span class="pre">ccpenx</span></span><a class="headerlink" href="#Battery.BatteryGeometry.BatteryGenerator1D.ccpenx" title="Permalink to this definition"></a></dt>
<dd><p>discretization number for positive active material - default value</p>
</dd></dl>
<dl class="mat attribute">
<dt class="sig sig-object mat" id="Battery.BatteryGeometry.BatteryGenerator1D.fac">
<span class="sig-name descname"><span class="pre">fac</span></span><a class="headerlink" href="#Battery.BatteryGeometry.BatteryGenerator1D.fac" title="Permalink to this definition"></a></dt>
<dd><p>refinement factor (can be used to easily increase discretization refinement)
see applyResolutionFactors method</p>
</dd></dl>
<dl class="mat attribute">
<dt class="sig sig-object mat" id="Battery.BatteryGeometry.BatteryGenerator1D.include_current_collectors">
<span class="sig-name descname"><span class="pre">include_current_collectors</span></span><a class="headerlink" href="#Battery.BatteryGeometry.BatteryGenerator1D.include_current_collectors" title="Permalink to this definition"></a></dt>
<dd><p>flag : true if grid for current collectors should be included</p>
</dd></dl>
<dl class="mat method">
<dt class="sig sig-object mat" id="Battery.BatteryGeometry.BatteryGenerator1D.setupGrid">
<span class="sig-name descname"><span class="pre">setupGrid</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="pre">gen</span></em>, <em class="sig-param"><span class="pre">paramobj</span></em>, <em class="sig-param"><span class="pre">~</span></em><span class="sig-paren">)</span><a class="headerlink" href="#Battery.BatteryGeometry.BatteryGenerator1D.setupGrid" title="Permalink to this definition"></a></dt>
<dd><p>paramobj is instance of BatteryInputParams
setup paramobj.G</p>
</dd></dl>
<dl class="mat method">
<dt class="sig sig-object mat" id="Battery.BatteryGeometry.BatteryGenerator1D.setupThermalModel">
<span class="sig-name descname"><span class="pre">setupThermalModel</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="pre">gen</span></em>, <em class="sig-param"><span class="pre">paramobj</span></em>, <em class="sig-param"><span class="pre">params</span></em><span class="sig-paren">)</span><a class="headerlink" href="#Battery.BatteryGeometry.BatteryGenerator1D.setupThermalModel" title="Permalink to this definition"></a></dt>
<dd><p>paramobj is instance of BatteryInputParams</p>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="batterygenerator2d">
<h2>BatteryGenerator2D<a class="headerlink" href="#batterygenerator2d" title="Permalink to this headline"></a></h2>
<dl class="mat class">
<dt class="sig sig-object mat" id="Battery.BatteryGeometry.BatteryGenerator2D">
<em class="property"><span class="pre">class</span> </em><span class="sig-name descname"><span class="pre">BatteryGenerator2D</span></span><a class="headerlink" href="#Battery.BatteryGeometry.BatteryGenerator2D" title="Permalink to this definition"></a></dt>
<dd><p>Setup 2D grid</p>
<dl class="mat attribute">
<dt class="sig sig-object mat" id="Battery.BatteryGeometry.BatteryGenerator2D.xlength">
<span class="sig-name descname"><span class="pre">xlength</span></span><a class="headerlink" href="#Battery.BatteryGeometry.BatteryGenerator2D.xlength" title="Permalink to this definition"></a></dt>
<dd><p>length of components in x direction - default values</p>
</dd></dl>
<dl class="mat attribute">
<dt class="sig sig-object mat" id="Battery.BatteryGeometry.BatteryGenerator2D.ylength">
<span class="sig-name descname"><span class="pre">ylength</span></span><a class="headerlink" href="#Battery.BatteryGeometry.BatteryGenerator2D.ylength" title="Permalink to this definition"></a></dt>
<dd><p>length in y direction - default values</p>
</dd></dl>
<dl class="mat attribute">
<dt class="sig sig-object mat" id="Battery.BatteryGeometry.BatteryGenerator2D.ccnenx">
<span class="sig-name descname"><span class="pre">ccnenx</span></span><a class="headerlink" href="#Battery.BatteryGeometry.BatteryGenerator2D.ccnenx" title="Permalink to this definition"></a></dt>
<dd><p>discretization number for negative current collector - default value</p>
</dd></dl>
<dl class="mat attribute">
<dt class="sig sig-object mat" id="Battery.BatteryGeometry.BatteryGenerator2D.nenx">
<span class="sig-name descname"><span class="pre">nenx</span></span><a class="headerlink" href="#Battery.BatteryGeometry.BatteryGenerator2D.nenx" title="Permalink to this definition"></a></dt>
<dd><p>discretization number for negative active material - default value</p>
</dd></dl>
<dl class="mat attribute">
<dt class="sig sig-object mat" id="Battery.BatteryGeometry.BatteryGenerator2D.sepnx">
<span class="sig-name descname"><span class="pre">sepnx</span></span><a class="headerlink" href="#Battery.BatteryGeometry.BatteryGenerator2D.sepnx" title="Permalink to this definition"></a></dt>
<dd><p>discretization number for separator - default value</p>
</dd></dl>
<dl class="mat attribute">
<dt class="sig sig-object mat" id="Battery.BatteryGeometry.BatteryGenerator2D.penx">
<span class="sig-name descname"><span class="pre">penx</span></span><a class="headerlink" href="#Battery.BatteryGeometry.BatteryGenerator2D.penx" title="Permalink to this definition"></a></dt>
<dd><p>discretization number for positive active material - default value</p>
</dd></dl>
<dl class="mat attribute">
<dt class="sig sig-object mat" id="Battery.BatteryGeometry.BatteryGenerator2D.ccpenx">
<span class="sig-name descname"><span class="pre">ccpenx</span></span><a class="headerlink" href="#Battery.BatteryGeometry.BatteryGenerator2D.ccpenx" title="Permalink to this definition"></a></dt>
<dd><p>discretization number for positive current collector - default value</p>
</dd></dl>
<dl class="mat attribute">
<dt class="sig sig-object mat" id="Battery.BatteryGeometry.BatteryGenerator2D.ny">
<span class="sig-name descname"><span class="pre">ny</span></span><a class="headerlink" href="#Battery.BatteryGeometry.BatteryGenerator2D.ny" title="Permalink to this definition"></a></dt>
<dd><p>discretization number in y direction - default value</p>
</dd></dl>
<dl class="mat attribute">
<dt class="sig sig-object mat" id="Battery.BatteryGeometry.BatteryGenerator2D.include_current_collectors">
<span class="sig-name descname"><span class="pre">include_current_collectors</span></span><a class="headerlink" href="#Battery.BatteryGeometry.BatteryGenerator2D.include_current_collectors" title="Permalink to this definition"></a></dt>
<dd><p>flag: true if grid for current collectors should be included</p>
</dd></dl>
<dl class="mat attribute">
<dt class="sig sig-object mat" id="Battery.BatteryGeometry.BatteryGenerator2D.use_thermal">
<span class="sig-name descname"><span class="pre">use_thermal</span></span><a class="headerlink" href="#Battery.BatteryGeometry.BatteryGenerator2D.use_thermal" title="Permalink to this definition"></a></dt>
<dd><p>flag, true if grid for thermal model should be setup.</p>
</dd></dl>
<dl class="mat attribute">
<dt class="sig sig-object mat" id="Battery.BatteryGeometry.BatteryGenerator2D.externalHeatTransferCoefficientTab">
<span class="sig-name descname"><span class="pre">externalHeatTransferCoefficientTab</span></span><a class="headerlink" href="#Battery.BatteryGeometry.BatteryGenerator2D.externalHeatTransferCoefficientTab" title="Permalink to this definition"></a></dt>
<dd><p>heat transfer coefficient at tab boundary - default value</p>
</dd></dl>
<dl class="mat attribute">
<dt class="sig sig-object mat" id="Battery.BatteryGeometry.BatteryGenerator2D.externalHeatTransferCoefficient">
<span class="sig-name descname"><span class="pre">externalHeatTransferCoefficient</span></span><a class="headerlink" href="#Battery.BatteryGeometry.BatteryGenerator2D.externalHeatTransferCoefficient" title="Permalink to this definition"></a></dt>
<dd><p>heat transfer coefficient at boundary - default value</p>
</dd></dl>
<dl class="mat method">
<dt class="sig sig-object mat" id="Battery.BatteryGeometry.BatteryGenerator2D.setupElectrodes">
<span class="sig-name descname"><span class="pre">setupElectrodes</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="pre">gen</span></em>, <em class="sig-param"><span class="pre">paramobj</span></em>, <em class="sig-param"><span class="pre">params</span></em><span class="sig-paren">)</span><a class="headerlink" href="#Battery.BatteryGeometry.BatteryGenerator2D.setupElectrodes" title="Permalink to this definition"></a></dt>
<dd><p>setup grid and coupling term</p>
</dd></dl>
<dl class="mat method">
<dt class="sig sig-object mat" id="Battery.BatteryGeometry.BatteryGenerator2D.setupThermalModel">
<span class="sig-name descname"><span class="pre">setupThermalModel</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="pre">gen</span></em>, <em class="sig-param"><span class="pre">paramobj</span></em>, <em class="sig-param"><span class="pre">params</span></em><span class="sig-paren">)</span><a class="headerlink" href="#Battery.BatteryGeometry.BatteryGenerator2D.setupThermalModel" title="Permalink to this definition"></a></dt>
<dd><p>paramobj is instance of BatteryInputParams</p>
<p>We recover the external coupling terms</p>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="batterygenerator3d">
<h2>BatteryGenerator3D<a class="headerlink" href="#batterygenerator3d" title="Permalink to this headline"></a></h2>
<dl class="mat class">
<dt class="sig sig-object mat" id="Battery.BatteryGeometry.BatteryGenerator3D">
<em class="property"><span class="pre">class</span> </em><span class="sig-name descname"><span class="pre">BatteryGenerator3D</span></span><a class="headerlink" href="#Battery.BatteryGeometry.BatteryGenerator3D" title="Permalink to this definition"></a></dt>
<dd><p>Setup 3D grid with tab</p>
</dd></dl>
</div>
<div class="section" id="blockbatterygenerator">
<h2>BlockBatteryGenerator<a class="headerlink" href="#blockbatterygenerator" title="Permalink to this headline"></a></h2>
<dl class="mat class">
<dt class="sig sig-object mat" id="Battery.BatteryGeometry.BlockBatteryGenerator">
<em class="property"><span class="pre">class</span> </em><span class="sig-name descname"><span class="pre">BlockBatteryGenerator</span></span><a class="headerlink" href="#Battery.BatteryGeometry.BlockBatteryGenerator" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</div>
<div class="section" id="coincellbatterygenerator">
<h2>CoinCellBatteryGenerator<a class="headerlink" href="#coincellbatterygenerator" title="Permalink to this headline"></a></h2>
<dl class="mat class">
<dt class="sig sig-object mat" id="Battery.BatteryGeometry.CoinCellBatteryGenerator">
<em class="property"><span class="pre">class</span> </em><span class="sig-name descname"><span class="pre">CoinCellBatteryGenerator</span></span><a class="headerlink" href="#Battery.BatteryGeometry.CoinCellBatteryGenerator" title="Permalink to this definition"></a></dt>
<dd><dl class="mat attribute">
<dt class="sig sig-object mat" id="Battery.BatteryGeometry.CoinCellBatteryGenerator.compDims">
<span class="sig-name descname"><span class="pre">compDims</span></span><a class="headerlink" href="#Battery.BatteryGeometry.CoinCellBatteryGenerator.compDims" title="Permalink to this definition"></a></dt>
<dd><p>Design params for the components (electrodes, current collectors etc)</p>
</dd></dl>
<dl class="mat attribute">
<dt class="sig sig-object mat" id="Battery.BatteryGeometry.CoinCellBatteryGenerator.tagdict">
<span class="sig-name descname"><span class="pre">tagdict</span></span><a class="headerlink" href="#Battery.BatteryGeometry.CoinCellBatteryGenerator.tagdict" title="Permalink to this definition"></a></dt>
<dd><p>dictionary giving the component number</p>
</dd></dl>
<dl class="mat attribute">
<dt class="sig sig-object mat" id="Battery.BatteryGeometry.CoinCellBatteryGenerator.negativeExtCurrentFaces">
<span class="sig-name descname"><span class="pre">negativeExtCurrentFaces</span></span><a class="headerlink" href="#Battery.BatteryGeometry.CoinCellBatteryGenerator.negativeExtCurrentFaces" title="Permalink to this definition"></a></dt>
<dd><p>Heat parameters</p>
</dd></dl>
<dl class="mat method">
<dt class="sig sig-object mat" id="Battery.BatteryGeometry.CoinCellBatteryGenerator.setupElectrodes">
<span class="sig-name descname"><span class="pre">setupElectrodes</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="pre">gen</span></em>, <em class="sig-param"><span class="pre">paramobj</span></em>, <em class="sig-param"><span class="pre">params</span></em><span class="sig-paren">)</span><a class="headerlink" href="#Battery.BatteryGeometry.CoinCellBatteryGenerator.setupElectrodes" title="Permalink to this definition"></a></dt>
<dd><p>shorthands</p>
</dd></dl>
<dl class="mat method">
<dt class="sig sig-object mat" id="Battery.BatteryGeometry.CoinCellBatteryGenerator.setupCurrentCollectorBcCoupTerm">
<span class="sig-name descname"><span class="pre">setupCurrentCollectorBcCoupTerm</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="pre">gen</span></em>, <em class="sig-param"><span class="pre">paramobj</span></em>, <em class="sig-param"><span class="pre">params</span></em><span class="sig-paren">)</span><a class="headerlink" href="#Battery.BatteryGeometry.CoinCellBatteryGenerator.setupCurrentCollectorBcCoupTerm" title="Permalink to this definition"></a></dt>
<dd><p>paramobj is instance of CurrentCollectorInputParams</p>
</dd></dl>
<dl class="mat method">
<dt class="sig sig-object mat" id="Battery.BatteryGeometry.CoinCellBatteryGenerator.setupThermalModel">
<span class="sig-name descname"><span class="pre">setupThermalModel</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="pre">gen</span></em>, <em class="sig-param"><span class="pre">paramobj</span></em>, <em class="sig-param"><span class="pre">params</span></em><span class="sig-paren">)</span><a class="headerlink" href="#Battery.BatteryGeometry.CoinCellBatteryGenerator.setupThermalModel" title="Permalink to this definition"></a></dt>
<dd><p>paramobj is instance of BatteryInputParams</p>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="coincellsectorbatterygenerator">
<h2>CoinCellSectorBatteryGenerator<a class="headerlink" href="#coincellsectorbatterygenerator" title="Permalink to this headline"></a></h2>
<dl class="mat class">
<dt class="sig sig-object mat" id="Battery.BatteryGeometry.CoinCellSectorBatteryGenerator">
<em class="property"><span class="pre">class</span> </em><span class="sig-name descname"><span class="pre">CoinCellSectorBatteryGenerator</span></span><a class="headerlink" href="#Battery.BatteryGeometry.CoinCellSectorBatteryGenerator" title="Permalink to this definition"></a></dt>
<dd><dl class="mat attribute">
<dt class="sig sig-object mat" id="Battery.BatteryGeometry.CoinCellSectorBatteryGenerator.thickness">
<span class="sig-name descname"><span class="pre">thickness</span></span><a class="headerlink" href="#Battery.BatteryGeometry.CoinCellSectorBatteryGenerator.thickness" title="Permalink to this definition"></a></dt>
<dd><p>Design params</p>
</dd></dl>
<dl class="mat attribute">
<dt class="sig sig-object mat" id="Battery.BatteryGeometry.CoinCellSectorBatteryGenerator.angle">
<span class="sig-name descname"><span class="pre">angle</span></span><a class="headerlink" href="#Battery.BatteryGeometry.CoinCellSectorBatteryGenerator.angle" title="Permalink to this definition"></a></dt>
<dd><p>cell-valued vector giving component number (indexing is given by tagdict)</p>
</dd></dl>
<dl class="mat attribute">
<dt class="sig sig-object mat" id="Battery.BatteryGeometry.CoinCellSectorBatteryGenerator.tagdict">
<span class="sig-name descname"><span class="pre">tagdict</span></span><a class="headerlink" href="#Battery.BatteryGeometry.CoinCellSectorBatteryGenerator.tagdict" title="Permalink to this definition"></a></dt>
<dd><p>dictionary giving the component number</p>
</dd></dl>
<dl class="mat method">
<dt class="sig sig-object mat" id="Battery.BatteryGeometry.CoinCellSectorBatteryGenerator.setupElectrodes">
<span class="sig-name descname"><span class="pre">setupElectrodes</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="pre">gen</span></em>, <em class="sig-param"><span class="pre">paramobj</span></em>, <em class="sig-param"><span class="pre">params</span></em><span class="sig-paren">)</span><a class="headerlink" href="#Battery.BatteryGeometry.CoinCellSectorBatteryGenerator.setupElectrodes" title="Permalink to this definition"></a></dt>
<dd><p>shorthands</p>
</dd></dl>
<dl class="mat method">
<dt class="sig sig-object mat" id="Battery.BatteryGeometry.CoinCellSectorBatteryGenerator.setupCurrentCollectorBcCoupTerm">
<span class="sig-name descname"><span class="pre">setupCurrentCollectorBcCoupTerm</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="pre">gen</span></em>, <em class="sig-param"><span class="pre">paramobj</span></em>, <em class="sig-param"><span class="pre">params</span></em><span class="sig-paren">)</span><a class="headerlink" href="#Battery.BatteryGeometry.CoinCellSectorBatteryGenerator.setupCurrentCollectorBcCoupTerm" title="Permalink to this definition"></a></dt>
<dd><p>paramobj is instance of CurrentCollectorInputParams</p>
</dd></dl>
<dl class="mat method">
<dt class="sig sig-object mat" id="Battery.BatteryGeometry.CoinCellSectorBatteryGenerator.setupThermalModel">
<span class="sig-name descname"><span class="pre">setupThermalModel</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="pre">gen</span></em>, <em class="sig-param"><span class="pre">paramobj</span></em>, <em class="sig-param"><span class="pre">params</span></em><span class="sig-paren">)</span><a class="headerlink" href="#Battery.BatteryGeometry.CoinCellSectorBatteryGenerator.setupThermalModel" title="Permalink to this definition"></a></dt>
<dd><p>paramobj is instance of BatteryInputParams</p>
</dd></dl>
</dd></dl>
</div>
<div class="section" id="flatbatterygenerator">
<h2>FlatBatteryGenerator<a class="headerlink" href="#flatbatterygenerator" title="Permalink to this headline"></a></h2>
<dl class="mat class">
<dt class="sig sig-object mat" id="Battery.BatteryGeometry.FlatBatteryGenerator">
<em class="property"><span class="pre">class</span> </em><span class="sig-name descname"><span class="pre">FlatBatteryGenerator</span></span><a class="headerlink" href="#Battery.BatteryGeometry.FlatBatteryGenerator" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</div>
<div class="section" id="sectorbatterygenerator">
<h2>SectorBatteryGenerator<a class="headerlink" href="#sectorbatterygenerator" title="Permalink to this headline"></a></h2>
<dl class="mat class">
<dt class="sig sig-object mat" id="Battery.BatteryGeometry.SectorBatteryGenerator">
<em class="property"><span class="pre">class</span> </em><span class="sig-name descname"><span class="pre">SectorBatteryGenerator</span></span><a class="headerlink" href="#Battery.BatteryGeometry.SectorBatteryGenerator" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</div>
<div class="section" id="spiralbatterygenerator">
<h2>SpiralBatteryGenerator<a class="headerlink" href="#spiralbatterygenerator" title="Permalink to this headline"></a></h2>
<dl class="mat class">
<dt class="sig sig-object mat" id="Battery.BatteryGeometry.SpiralBatteryGenerator">
<em class="property"><span class="pre">class</span> </em><span class="sig-name descname"><span class="pre">SpiralBatteryGenerator</span></span><a class="headerlink" href="#Battery.BatteryGeometry.SpiralBatteryGenerator" title="Permalink to this definition"></a></dt>
<dd><p>Setup 3D grid with tab</p>
<dl class="mat attribute">
<dt class="sig sig-object mat" id="Battery.BatteryGeometry.SpiralBatteryGenerator.nwindings">
<span class="sig-name descname"><span class="pre">nwindings</span></span><a class="headerlink" href="#Battery.BatteryGeometry.SpiralBatteryGenerator.nwindings" title="Permalink to this definition"></a></dt>
<dd><p>number of windings in the spiral</p>
</dd></dl>
<dl class="mat attribute">
<dt class="sig sig-object mat" id="Battery.BatteryGeometry.SpiralBatteryGenerator.rInner">
<span class="sig-name descname"><span class="pre">rInner</span></span><a class="headerlink" href="#Battery.BatteryGeometry.SpiralBatteryGenerator.rInner" title="Permalink to this definition"></a></dt>
<dd><p>Inner Radius (for the empty space in the middle)</p>
</dd></dl>
<dl class="mat attribute">
<dt class="sig sig-object mat" id="Battery.BatteryGeometry.SpiralBatteryGenerator.widthDict">
<span class="sig-name descname"><span class="pre">widthDict</span></span><a class="headerlink" href="#Battery.BatteryGeometry.SpiralBatteryGenerator.widthDict" title="Permalink to this definition"></a></dt>
<dd><p>dictionary of widths for each component. The required key names for the dictionary are</p>
</dd></dl>
<dl class="mat attribute">
<dt class="sig sig-object mat" id="Battery.BatteryGeometry.SpiralBatteryGenerator.nrDict">
<span class="sig-name descname"><span class="pre">nrDict</span></span><a class="headerlink" href="#Battery.BatteryGeometry.SpiralBatteryGenerator.nrDict" title="Permalink to this definition"></a></dt>
<dd><ul class="simple">
<li><p>‘Separator’</p></li>
<li><p>‘NegativeActiveMaterial’</p></li>
<li><p>‘NegativeCurrentCollector’</p></li>
<li><p>‘PositiveActiveMaterial’</p></li>
<li><p>‘PositiveCurrentCollector’</p></li>
</ul>
</dd></dl>
<dl class="mat attribute">
<dt class="sig sig-object mat" id="Battery.BatteryGeometry.SpiralBatteryGenerator.L">
<span class="sig-name descname"><span class="pre">L</span></span><a class="headerlink" href="#Battery.BatteryGeometry.SpiralBatteryGenerator.L" title="Permalink to this definition"></a></dt>
<dd><p>length of the battery</p>
</dd></dl>
<dl class="mat attribute">
<dt class="sig sig-object mat" id="Battery.BatteryGeometry.SpiralBatteryGenerator.nas">
<span class="sig-name descname"><span class="pre">nas</span></span><a class="headerlink" href="#Battery.BatteryGeometry.SpiralBatteryGenerator.nas" title="Permalink to this definition"></a></dt>
<dd><p>number of cells in the angular direction</p>
</dd></dl>
<dl class="mat attribute">
<dt class="sig sig-object mat" id="Battery.BatteryGeometry.SpiralBatteryGenerator.nL">
<span class="sig-name descname"><span class="pre">nL</span></span><a class="headerlink" href="#Battery.BatteryGeometry.SpiralBatteryGenerator.nL" title="Permalink to this definition"></a></dt>
<dd><p>number of discretization cells in the longitudonal</p>
</dd></dl>
<dl class="mat attribute">
<dt class="sig sig-object mat" id="Battery.BatteryGeometry.SpiralBatteryGenerator.angleuniform">
<span class="sig-name descname"><span class="pre">angleuniform</span></span><a class="headerlink" href="#Battery.BatteryGeometry.SpiralBatteryGenerator.angleuniform" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="mat attribute">
<dt class="sig sig-object mat" id="Battery.BatteryGeometry.SpiralBatteryGenerator.tag">
<span class="sig-name descname"><span class="pre">tag</span></span><a class="headerlink" href="#Battery.BatteryGeometry.SpiralBatteryGenerator.tag" title="Permalink to this definition"></a></dt>
<dd><p>cell-valued vector giving component number (indexing is given by tagdict)</p>
</dd></dl>
<dl class="mat attribute">
<dt class="sig sig-object mat" id="Battery.BatteryGeometry.SpiralBatteryGenerator.tagdict">
<span class="sig-name descname"><span class="pre">tagdict</span></span><a class="headerlink" href="#Battery.BatteryGeometry.SpiralBatteryGenerator.tagdict" title="Permalink to this definition"></a></dt>
<dd><p>dictionary giving the component number</p>
</dd></dl>
<dl class="mat attribute">
<dt class="sig sig-object mat" id="Battery.BatteryGeometry.SpiralBatteryGenerator.tabparams">
<span class="sig-name descname"><span class="pre">tabparams</span></span><a class="headerlink" href="#Battery.BatteryGeometry.SpiralBatteryGenerator.tabparams" title="Permalink to this definition"></a></dt>
<dd><p>parameters for the tab on the positive current collector</p>
</dd></dl>
<dl class="mat attribute">
<dt class="sig sig-object mat" id="Battery.BatteryGeometry.SpiralBatteryGenerator.positiveExtCurrentFaces">
<span class="sig-name descname"><span class="pre">positiveExtCurrentFaces</span></span><a class="headerlink" href="#Battery.BatteryGeometry.SpiralBatteryGenerator.positiveExtCurrentFaces" title="Permalink to this definition"></a></dt>
<dd><p>computed tab width (due to discretization, we cannot enforce the tab widths)</p>
</dd></dl>
<dl class="mat attribute">
<dt class="sig sig-object mat" id="Battery.BatteryGeometry.SpiralBatteryGenerator.windingnumbers">
<span class="sig-name descname"><span class="pre">windingnumbers</span></span><a class="headerlink" href="#Battery.BatteryGeometry.SpiralBatteryGenerator.windingnumbers" title="Permalink to this definition"></a></dt>
<dd><p>for the tabs (implemented only for aligned tabs now)</p>
</dd></dl>
<dl class="mat method">
<dt class="sig sig-object mat" id="Battery.BatteryGeometry.SpiralBatteryGenerator.setupElectrodes">
<span class="sig-name descname"><span class="pre">setupElectrodes</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="pre">gen</span></em>, <em class="sig-param"><span class="pre">paramobj</span></em>, <em class="sig-param"><span class="pre">params</span></em><span class="sig-paren">)</span><a class="headerlink" href="#Battery.BatteryGeometry.SpiralBatteryGenerator.setupElectrodes" title="Permalink to this definition"></a></dt>
<dd><p>shorthands</p>
</dd></dl>
<dl class="mat method">
<dt class="sig sig-object mat" id="Battery.BatteryGeometry.SpiralBatteryGenerator.setupCurrentCollectorBcCoupTerm">
<span class="sig-name descname"><span class="pre">setupCurrentCollectorBcCoupTerm</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="pre">gen</span></em>, <em class="sig-param"><span class="pre">paramobj</span></em>, <em class="sig-param"><span class="pre">params</span></em><span class="sig-paren">)</span><a class="headerlink" href="#Battery.BatteryGeometry.SpiralBatteryGenerator.setupCurrentCollectorBcCoupTerm" title="Permalink to this definition"></a></dt>
<dd><p>paramobj is instance of CurrentCollectorInputParams</p>
</dd></dl>
<dl class="mat method">
<dt class="sig sig-object mat" id="Battery.BatteryGeometry.SpiralBatteryGenerator.setupThermalModel">
<span class="sig-name descname"><span class="pre">setupThermalModel</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="pre">gen</span></em>, <em class="sig-param"><span class="pre">paramobj</span></em>, <em class="sig-param"><span class="pre">params</span></em><span class="sig-paren">)</span><a class="headerlink" href="#Battery.BatteryGeometry.SpiralBatteryGenerator.setupThermalModel" title="Permalink to this definition"></a></dt>
<dd><p>paramobj is instance of BatteryInputParams</p>
<p>We recover the external coupling terms for the current collectors</p>
</dd></dl>
</dd></dl>
</div>
</div>
</div>
</div>
<footer>
<hr/>
<div role="contentinfo">
<p>© Copyright 2021, Simon Clark.</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>