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
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>esys.finley Package — esys.escript 5.6 documentation</title>
<link rel="stylesheet" href="_static/classic.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/language_data.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="esys.modellib Package" href="esys.modellib.html" />
<link rel="prev" title="esys.escript Package" href="esys.escript.html" />
</head><body>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="esys.modellib.html" title="esys.modellib Package"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="esys.escript.html" title="esys.escript Package"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">esys.escript 5.6 documentation</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="module-esys.finley">
<span id="esys-finley-package"></span><h1>esys.finley Package<a class="headerlink" href="#module-esys.finley" title="Permalink to this headline">¶</a></h1>
<p>Our most general domain representation. Imports submodules into its namespace</p>
<div class="section" id="classes">
<h2>Classes<a class="headerlink" href="#classes" title="Permalink to this headline">¶</a></h2>
<ul class="simple">
<li><a class="reference internal" href="#esys.finley.FinleyDomain" title="esys.finley.FinleyDomain"><code class="xref py py-obj docutils literal notranslate"><span class="pre">FinleyDomain</span></code></a></li>
<li><a class="reference internal" href="#esys.finley.GMSHDesign" title="esys.finley.GMSHDesign"><code class="xref py py-obj docutils literal notranslate"><span class="pre">GMSHDesign</span></code></a></li>
</ul>
<dl class="class">
<dt id="esys.finley.FinleyDomain">
<em class="property">class </em><code class="descclassname">esys.finley.</code><code class="descname">FinleyDomain</code><a class="headerlink" href="#esys.finley.FinleyDomain" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">esys.escriptcore.escriptcpp.ContinuousDomain</span></code></p>
<p>A concrete class representing a domain. For more details, please consult the C++ documentation.</p>
<dl class="method">
<dt id="esys.finley.FinleyDomain.__init__">
<code class="descname">__init__</code><span class="sig-paren">(</span><em>(object)arg1</em>, <em>(FinleyDomain)arg2</em><span class="sig-paren">)</span> → None<a class="headerlink" href="#esys.finley.FinleyDomain.__init__" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="esys.finley.FinleyDomain.MPIBarrier">
<code class="descname">MPIBarrier</code><span class="sig-paren">(</span><em>(FinleyDomain)arg1</em><span class="sig-paren">)</span> → None :<a class="headerlink" href="#esys.finley.FinleyDomain.MPIBarrier" title="Permalink to this definition">¶</a></dt>
<dd><p>Wait until all processes have reached this point</p>
</dd></dl>
<dl class="method">
<dt id="esys.finley.FinleyDomain.addPDEToLumpedSystem">
<code class="descname">addPDEToLumpedSystem</code><span class="sig-paren">(</span><em>(FinleyDomain)arg1</em>, <em>(Data)arg2</em>, <em>(Data)arg3</em>, <em>(Data)mat</em>, <em>(Data)D</em>, <em>(bool)d</em><span class="sig-paren">)</span> → None :<a class="headerlink" href="#esys.finley.FinleyDomain.addPDEToLumpedSystem" title="Permalink to this definition">¶</a></dt>
<dd><p>adds a PDE onto the lumped stiffness matrix</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>mat</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">Data</span></code>) – </li>
<li><strong>D</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">Data</span></code>) – </li>
<li><strong>d</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">Data</span></code>) – </li>
<li><strong>useHRZ</strong> (<em>bool</em>) – </li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="esys.finley.FinleyDomain.addPDEToRHS">
<code class="descname">addPDEToRHS</code><span class="sig-paren">(</span><em>(FinleyDomain)arg1</em>, <em>(Data)arg2</em>, <em>(Data)rhs</em>, <em>(Data)X</em>, <em>(Data)Y</em>, <em>(Data)y</em>, <em>(Data)y_contact</em><span class="sig-paren">)</span> → None :<a class="headerlink" href="#esys.finley.FinleyDomain.addPDEToRHS" title="Permalink to this definition">¶</a></dt>
<dd><p>adds a PDE onto the stiffness matrix mat and a rhs</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>rhs</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">Data</span></code>) – </li>
<li><strong>X</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">Data</span></code>) – </li>
<li><strong>Y</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">Data</span></code>) – </li>
<li><strong>y</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">Data</span></code>) – </li>
<li><strong>y_contact</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">Data</span></code>) – </li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="esys.finley.FinleyDomain.addPDEToSystem">
<code class="descname">addPDEToSystem</code><span class="sig-paren">(</span><em>(FinleyDomain)arg1</em>, <em>(Operator)arg2</em>, <em>(Data)arg3</em>, <em>(Data)mat</em>, <em>(Data)rhs</em>, <em>(Data)A</em>, <em>(Data)B</em>, <em>(Data)C</em>, <em>(Data)D</em>, <em>(Data)X</em>, <em>(Data)Y</em>, <em>(Data)d</em>, <em>(Data)y</em>, <em>(Data)d_contact</em>, <em>(Data)y_contact</em><span class="sig-paren">)</span> → None :<a class="headerlink" href="#esys.finley.FinleyDomain.addPDEToSystem" title="Permalink to this definition">¶</a></dt>
<dd><p>adds a PDE onto the stiffness matrix mat and a rhs</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>mat</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">OperatorAdapter</span></code>) – </li>
<li><strong>rhs</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">Data</span></code>) – </li>
<li><strong>A</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">Data</span></code>) – </li>
<li><strong>B</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">Data</span></code>) – </li>
<li><strong>C</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">Data</span></code>) – </li>
<li><strong>D</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">Data</span></code>) – </li>
<li><strong>X</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">Data</span></code>) – </li>
<li><strong>Y</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">Data</span></code>) – </li>
<li><strong>d</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">Data</span></code>) – </li>
<li><strong>d_contact</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">Data</span></code>) – </li>
<li><strong>y_contact</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">Data</span></code>) – </li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="esys.finley.FinleyDomain.addPDEToTransportProblem">
<code class="descname">addPDEToTransportProblem</code><span class="sig-paren">(</span><em>(FinleyDomain)arg1</em>, <em>(TransportProblem)arg2</em>, <em>(Data)arg3</em>, <em>(Data)tp</em>, <em>(Data)source</em>, <em>(Data)M</em>, <em>(Data)A</em>, <em>(Data)B</em>, <em>(Data)C</em>, <em>(Data)D</em>, <em>(Data)X</em>, <em>(Data)Y</em>, <em>(Data)d</em>, <em>(Data)y</em>, <em>(Data)d_contact</em>, <em>(Data)y_contact</em><span class="sig-paren">)</span> → None :<a class="headerlink" href="#esys.finley.FinleyDomain.addPDEToTransportProblem" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>tp</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">AbstractTransportProblem</span></code>) – </li>
<li><strong>source</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">Data</span></code>) – </li>
<li><strong>M</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">Data</span></code>) – </li>
<li><strong>A</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">Data</span></code>) – </li>
<li><strong>B</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">Data</span></code>) – </li>
<li><strong>C</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">Data</span></code>) – </li>
<li><strong>D</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">Data</span></code>) – </li>
<li><strong>X</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">Data</span></code>) – </li>
<li><strong>Y</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">Data</span></code>) – </li>
<li><strong>d</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">Data</span></code>) – </li>
<li><strong>y</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">Data</span></code>) – </li>
<li><strong>d_contact</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">Data</span></code>) – </li>
<li><strong>y_contact</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">Data</span></code>) – </li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="esys.finley.FinleyDomain.dump">
<code class="descname">dump</code><span class="sig-paren">(</span><em>(FinleyDomain)arg1</em>, <em>(str)fileName</em><span class="sig-paren">)</span> → None :<a class="headerlink" href="#esys.finley.FinleyDomain.dump" title="Permalink to this definition">¶</a></dt>
<dd><p>dumps the mesh to a file with the given name.</p>
</dd></dl>
<dl class="method">
<dt id="esys.finley.FinleyDomain.getDataShape">
<code class="descname">getDataShape</code><span class="sig-paren">(</span><em>(FinleyDomain)arg1</em>, <em>(int)functionSpaceCode</em><span class="sig-paren">)</span> → object :<a class="headerlink" href="#esys.finley.FinleyDomain.getDataShape" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">a pair (dps, ns) where dps=the number of data points per sample, and ns=the number of samples</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><code class="docutils literal notranslate"><span class="pre">tuple</span></code></td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="esys.finley.FinleyDomain.getDescription">
<code class="descname">getDescription</code><span class="sig-paren">(</span><em>(FinleyDomain)arg1</em><span class="sig-paren">)</span> → str :<a class="headerlink" href="#esys.finley.FinleyDomain.getDescription" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">a description for this domain</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><code class="docutils literal notranslate"><span class="pre">string</span></code></td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="esys.finley.FinleyDomain.getDim">
<code class="descname">getDim</code><span class="sig-paren">(</span><em>(FinleyDomain)arg1</em><span class="sig-paren">)</span> → int :<a class="headerlink" href="#esys.finley.FinleyDomain.getDim" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><code class="docutils literal notranslate"><span class="pre">int</span></code></td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="esys.finley.FinleyDomain.getMPIRank">
<code class="descname">getMPIRank</code><span class="sig-paren">(</span><em>(FinleyDomain)arg1</em><span class="sig-paren">)</span> → int :<a class="headerlink" href="#esys.finley.FinleyDomain.getMPIRank" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">the rank of this process</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><code class="docutils literal notranslate"><span class="pre">int</span></code></td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="esys.finley.FinleyDomain.getMPISize">
<code class="descname">getMPISize</code><span class="sig-paren">(</span><em>(FinleyDomain)arg1</em><span class="sig-paren">)</span> → int :<a class="headerlink" href="#esys.finley.FinleyDomain.getMPISize" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">the number of processes used for this <code class="xref py py-obj docutils literal notranslate"><span class="pre">Domain</span></code></td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><code class="docutils literal notranslate"><span class="pre">int</span></code></td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="esys.finley.FinleyDomain.getNormal">
<code class="descname">getNormal</code><span class="sig-paren">(</span><em>(FinleyDomain)arg1</em><span class="sig-paren">)</span> → Data :<a class="headerlink" href="#esys.finley.FinleyDomain.getNormal" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">boundary normals at the quadrature point on the face elements</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Data</span></code></td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="esys.finley.FinleyDomain.getNumDataPointsGlobal">
<code class="descname">getNumDataPointsGlobal</code><span class="sig-paren">(</span><em>(FinleyDomain)arg1</em><span class="sig-paren">)</span> → int :<a class="headerlink" href="#esys.finley.FinleyDomain.getNumDataPointsGlobal" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">the number of data points summed across all MPI processes</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><code class="docutils literal notranslate"><span class="pre">int</span></code></td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="esys.finley.FinleyDomain.getSize">
<code class="descname">getSize</code><span class="sig-paren">(</span><em>(FinleyDomain)arg1</em><span class="sig-paren">)</span> → Data :<a class="headerlink" href="#esys.finley.FinleyDomain.getSize" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">the element size</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Data</span></code></td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="esys.finley.FinleyDomain.getStatus">
<code class="descname">getStatus</code><span class="sig-paren">(</span><em>(Domain)arg1</em><span class="sig-paren">)</span> → int :<a class="headerlink" href="#esys.finley.FinleyDomain.getStatus" title="Permalink to this definition">¶</a></dt>
<dd><p>The status of a domain changes whenever the domain is modified</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">int</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="esys.finley.FinleyDomain.getSystemMatrixTypeId">
<code class="descname">getSystemMatrixTypeId</code><span class="sig-paren">(</span><em>(FinleyDomain)arg1</em>, <em>(object)options</em><span class="sig-paren">)</span> → int :<a class="headerlink" href="#esys.finley.FinleyDomain.getSystemMatrixTypeId" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">the identifier of the matrix type to be used for the global stiffness matrix when particular solver options are used.</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><code class="docutils literal notranslate"><span class="pre">int</span></code></td>
</tr>
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>options</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">SolverBuddy</span></code>) – </td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="esys.finley.FinleyDomain.getTag">
<code class="descname">getTag</code><span class="sig-paren">(</span><em>(FinleyDomain)arg1</em>, <em>(str)name</em><span class="sig-paren">)</span> → int :<a class="headerlink" href="#esys.finley.FinleyDomain.getTag" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">tag id for <code class="docutils literal notranslate"><span class="pre">name</span></code></td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><code class="docutils literal notranslate"><span class="pre">string</span></code></td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="esys.finley.FinleyDomain.getTransportTypeId">
<code class="descname">getTransportTypeId</code><span class="sig-paren">(</span><em>(FinleyDomain)arg1</em>, <em>(int)solver</em>, <em>(int)preconditioner</em>, <em>(int)package</em>, <em>(bool)symmetry</em><span class="sig-paren">)</span> → int :<a class="headerlink" href="#esys.finley.FinleyDomain.getTransportTypeId" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">the identifier of the transport problem type to be used when a particular solver, preconditioner, package and symmetric matrix is used.</p>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><code class="docutils literal notranslate"><span class="pre">int</span></code></p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>solver</strong> (<code class="docutils literal notranslate"><span class="pre">int</span></code>) – </li>
<li><strong>preconditioner</strong> (<code class="docutils literal notranslate"><span class="pre">int</span></code>) – </li>
<li><strong>package</strong> (<code class="docutils literal notranslate"><span class="pre">int</span></code>) – </li>
<li><strong>symmetry</strong> (<code class="docutils literal notranslate"><span class="pre">int</span></code>) – </li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="esys.finley.FinleyDomain.getVTKElementType">
<code class="descname">getVTKElementType</code><span class="sig-paren">(</span><em>(FinleyDomain)arg1</em><span class="sig-paren">)</span> → int :<a class="headerlink" href="#esys.finley.FinleyDomain.getVTKElementType" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">returns the VTK code for this element type</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Data</span></code></td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="esys.finley.FinleyDomain.getX">
<code class="descname">getX</code><span class="sig-paren">(</span><em>(FinleyDomain)arg1</em><span class="sig-paren">)</span> → Data :<a class="headerlink" href="#esys.finley.FinleyDomain.getX" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">locations in the FEM nodes</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Data</span></code></td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="esys.finley.FinleyDomain.isValidTagName">
<code class="descname">isValidTagName</code><span class="sig-paren">(</span><em>(FinleyDomain)arg1</em>, <em>(str)name</em><span class="sig-paren">)</span> → bool :<a class="headerlink" href="#esys.finley.FinleyDomain.isValidTagName" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">True is <code class="docutils literal notranslate"><span class="pre">name</span></code> corresponds to a tag</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><code class="docutils literal notranslate"><span class="pre">bool</span></code></td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="esys.finley.FinleyDomain.newOperator">
<code class="descname">newOperator</code><span class="sig-paren">(</span><em>(FinleyDomain)arg1</em>, <em>(int)row_blocksize</em>, <em>(FunctionSpace)row_functionspace</em>, <em>(int)column_blocksize</em>, <em>(FunctionSpace)column_functionspace</em>, <em>(int)type</em><span class="sig-paren">)</span> → Operator :<a class="headerlink" href="#esys.finley.FinleyDomain.newOperator" title="Permalink to this definition">¶</a></dt>
<dd><p>creates a stiffness matrix and initializes it with zeros</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>row_blocksize</strong> (<code class="docutils literal notranslate"><span class="pre">int</span></code>) – </li>
<li><strong>row_functionspace</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">FunctionSpace</span></code>) – </li>
<li><strong>column_blocksize</strong> (<code class="docutils literal notranslate"><span class="pre">int</span></code>) – </li>
<li><strong>column_functionspace</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">FunctionSpace</span></code>) – </li>
<li><strong>type</strong> (<code class="docutils literal notranslate"><span class="pre">int</span></code>) – </li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="esys.finley.FinleyDomain.newTransportProblem">
<code class="descname">newTransportProblem</code><span class="sig-paren">(</span><em>(FinleyDomain)theta</em>, <em>(int)blocksize</em>, <em>(FunctionSpace)functionspace</em>, <em>(int)type</em><span class="sig-paren">)</span> → TransportProblem :<a class="headerlink" href="#esys.finley.FinleyDomain.newTransportProblem" title="Permalink to this definition">¶</a></dt>
<dd><p>creates a TransportProblem</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>theta</strong> (<code class="docutils literal notranslate"><span class="pre">float</span></code>) – </li>
<li><strong>blocksize</strong> (<code class="docutils literal notranslate"><span class="pre">int</span></code>) – </li>
<li><strong>functionspace</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">FunctionSpace</span></code>) – </li>
<li><strong>type</strong> (<code class="docutils literal notranslate"><span class="pre">int</span></code>) – </li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="esys.finley.FinleyDomain.onMasterProcessor">
<code class="descname">onMasterProcessor</code><span class="sig-paren">(</span><em>(FinleyDomain)arg1</em><span class="sig-paren">)</span> → bool :<a class="headerlink" href="#esys.finley.FinleyDomain.onMasterProcessor" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">True if this code is executing on the master process</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><code class="xref py py-obj docutils literal notranslate"><span class="pre">bool</span></code></td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="esys.finley.FinleyDomain.print_mesh_info">
<code class="descname">print_mesh_info</code><span class="sig-paren">(</span><em>(FinleyDomain)arg1</em><span class="optional">[</span>, <em>(bool)full=False</em><span class="optional">]</span><span class="sig-paren">)</span> → None :<a class="headerlink" href="#esys.finley.FinleyDomain.print_mesh_info" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>full</strong> (<code class="docutils literal notranslate"><span class="pre">bool</span></code>) – </td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="esys.finley.FinleyDomain.setTagMap">
<code class="descname">setTagMap</code><span class="sig-paren">(</span><em>(FinleyDomain)arg1</em>, <em>(str)name</em>, <em>(int)tag</em><span class="sig-paren">)</span> → None :<a class="headerlink" href="#esys.finley.FinleyDomain.setTagMap" title="Permalink to this definition">¶</a></dt>
<dd><p>Give a tag number a name.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>name</strong> (<code class="docutils literal notranslate"><span class="pre">string</span></code>) – Name for the tag</li>
<li><strong>tag</strong> (<code class="docutils literal notranslate"><span class="pre">int</span></code>) – numeric id</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Note:</th><td class="field-body"><p class="first last">Tag names must be unique within a domain</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="esys.finley.FinleyDomain.setX">
<code class="descname">setX</code><span class="sig-paren">(</span><em>(FinleyDomain)arg1</em>, <em>(Data)arg</em><span class="sig-paren">)</span> → None :<a class="headerlink" href="#esys.finley.FinleyDomain.setX" title="Permalink to this definition">¶</a></dt>
<dd><p>assigns new location to the domain</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>arg</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">Data</span></code>) – </td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="esys.finley.FinleyDomain.showTagNames">
<code class="descname">showTagNames</code><span class="sig-paren">(</span><em>(FinleyDomain)arg1</em><span class="sig-paren">)</span> → str :<a class="headerlink" href="#esys.finley.FinleyDomain.showTagNames" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">A space separated list of tag names</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><code class="docutils literal notranslate"><span class="pre">string</span></code></td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="esys.finley.FinleyDomain.supportsContactElements">
<code class="descname">supportsContactElements</code><span class="sig-paren">(</span><em>(Domain)arg1</em><span class="sig-paren">)</span> → bool :<a class="headerlink" href="#esys.finley.FinleyDomain.supportsContactElements" title="Permalink to this definition">¶</a></dt>
<dd><p>Does this domain support contact elements.</p>
</dd></dl>
<dl class="method">
<dt id="esys.finley.FinleyDomain.write">
<code class="descname">write</code><span class="sig-paren">(</span><em>(FinleyDomain)arg1</em>, <em>(str)filename</em><span class="sig-paren">)</span> → None :<a class="headerlink" href="#esys.finley.FinleyDomain.write" title="Permalink to this definition">¶</a></dt>
<dd><p>Write the current mesh to a file with the given name.</p>
</dd></dl>
</dd></dl>
<dl class="attribute">
<dt id="esys.finley.GMSHDesign">
<code class="descclassname">esys.finley.</code><code class="descname">GMSHDesign</code><a class="headerlink" href="#esys.finley.GMSHDesign" title="Permalink to this definition">¶</a></dt>
<dd><p>alias of <a class="reference internal" href="esys.pycad.gmsh.html#esys.pycad.gmsh.Design" title="esys.pycad.gmsh.Design"><code class="xref py py-class docutils literal notranslate"><span class="pre">esys.pycad.gmsh.Design</span></code></a></p>
</dd></dl>
</div>
<div class="section" id="functions">
<h2>Functions<a class="headerlink" href="#functions" title="Permalink to this headline">¶</a></h2>
<dl class="function">
<dt id="esys.finley.Brick">
<code class="descclassname">esys.finley.</code><code class="descname">Brick</code><span class="sig-paren">(</span><em>n0=1</em>, <em>n1=1</em>, <em>n2=1</em>, <em>order=1</em>, <em>l0=1.0</em>, <em>l1=1.0</em>, <em>l2=1.0</em>, <em>periodic0=0</em>, <em>periodic1=0</em>, <em>periodic2=0</em>, <em>integrationOrder=-1</em>, <em>reducedIntegrationOrder=-1</em>, <em>useElementsOnFace=1</em>, <em>useFullElementOrder=0</em>, <em>optimize=0</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.finley.Brick" title="Permalink to this definition">¶</a></dt>
<dd><dl class="docutils">
<dt>__Brick_driver( (list)params) -> Domain :</dt>
<dd><p class="first">Creates a rectangular mesh with n0 x n1 x n2 elements over the brick [0,l0] x [0,l1] x [0,l2].</p>
<table class="last docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">param n0:</th><td class="field-body">number of elements in direction 0</td>
</tr>
<tr class="field-even field"><th class="field-name">type n0:</th><td class="field-body"><code class="docutils literal notranslate"><span class="pre">int</span></code></td>
</tr>
<tr class="field-odd field"><th class="field-name">param n1:</th><td class="field-body">number of elements in direction 1</td>
</tr>
<tr class="field-even field"><th class="field-name">type n1:</th><td class="field-body"><code class="docutils literal notranslate"><span class="pre">int</span></code></td>
</tr>
<tr class="field-odd field"><th class="field-name">param n2:</th><td class="field-body">number of elements in direction 2</td>
</tr>
<tr class="field-even field"><th class="field-name">type n2:</th><td class="field-body"><code class="docutils literal notranslate"><span class="pre">int</span></code></td>
</tr>
<tr class="field-odd field"><th class="field-name">param order:</th><td class="field-body">=1, =-1 or =2 gives the order of shape function. If -1 macro elements of order 1 are used.</td>
</tr>
<tr class="field-even field"><th class="field-name">param l0:</th><td class="field-body">length of side 0</td>
</tr>
<tr class="field-odd field"><th class="field-name">type l0:</th><td class="field-body"><code class="docutils literal notranslate"><span class="pre">float</span></code></td>
</tr>
<tr class="field-even field"><th class="field-name">param l1:</th><td class="field-body">length of side 1</td>
</tr>
<tr class="field-odd field"><th class="field-name">type l1:</th><td class="field-body"><code class="docutils literal notranslate"><span class="pre">float</span></code></td>
</tr>
<tr class="field-even field"><th class="field-name">param l2:</th><td class="field-body">length of side 2</td>
</tr>
<tr class="field-odd field"><th class="field-name">type l2:</th><td class="field-body"><code class="docutils literal notranslate"><span class="pre">float</span></code></td>
</tr>
<tr class="field-even field"><th class="field-name" colspan="2">param periodic0:</th></tr>
<tr class="field-even field"><td> </td><td class="field-body">whether or not boundary conditions are periodic in direction 0</td>
</tr>
<tr class="field-odd field"><th class="field-name">type periodic0:</th><td class="field-body"><code class="docutils literal notranslate"><span class="pre">bool</span></code></td>
</tr>
<tr class="field-even field"><th class="field-name" colspan="2">param periodic1:</th></tr>
<tr class="field-even field"><td> </td><td class="field-body">whether or not boundary conditions are periodic in direction 1</td>
</tr>
<tr class="field-odd field"><th class="field-name">type periodic1:</th><td class="field-body"><code class="docutils literal notranslate"><span class="pre">bool</span></code></td>
</tr>
<tr class="field-even field"><th class="field-name" colspan="2">param periodic2:</th></tr>
<tr class="field-even field"><td> </td><td class="field-body">whether or not boundary conditions are periodic in direction 2</td>
</tr>
<tr class="field-odd field"><th class="field-name">type periodic2:</th><td class="field-body"><code class="docutils literal notranslate"><span class="pre">bool</span></code></td>
</tr>
<tr class="field-even field"><th class="field-name" colspan="2">param integrationOrder:</th></tr>
<tr class="field-even field"><td> </td><td class="field-body">order of the quadrature scheme. If integrationOrder<0 the integration order is selected independently.</td>
</tr>
<tr class="field-odd field"><th class="field-name" colspan="2">param reducedIntegrationOrder:</th></tr>
<tr class="field-odd field"><td> </td><td class="field-body">order of the quadrature scheme. If reducedIntegrationOrder<0 the integration order is selected independently.</td>
</tr>
<tr class="field-even field"><th class="field-name" colspan="2">param useElementsOnFace:</th></tr>
<tr class="field-even field"><td> </td><td class="field-body">whether or not to use elements on face</td>
</tr>
<tr class="field-odd field"><th class="field-name" colspan="2">type useElementsOnFace:</th></tr>
<tr class="field-odd field"><td> </td><td class="field-body"><code class="docutils literal notranslate"><span class="pre">int</span></code></td>
</tr>
<tr class="field-even field"><th class="field-name" colspan="2">param useFullElementOrder:</th></tr>
<tr class="field-even field"><td> </td><td class="field-body">Whether or not to use Hex27 elements</td>
</tr>
<tr class="field-odd field"><th class="field-name" colspan="2">type useFullElementOrder:</th></tr>
<tr class="field-odd field"><td> </td><td class="field-body"><code class="docutils literal notranslate"><span class="pre">bool</span></code></td>
</tr>
<tr class="field-even field"><th class="field-name">param optimize:</th><td class="field-body">Enable optimisation of node labels</td>
</tr>
<tr class="field-odd field"><th class="field-name">type optimize:</th><td class="field-body"><code class="docutils literal notranslate"><span class="pre">bool</span></code></td>
</tr>
</tbody>
</table>
</dd>
</dl>
</dd></dl>
<dl class="function">
<dt id="esys.finley.GetMeshFromFile">
<code class="descclassname">esys.finley.</code><code class="descname">GetMeshFromFile</code><span class="sig-paren">(</span><em>filename</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.finley.GetMeshFromFile" title="Permalink to this definition">¶</a></dt>
<dd><p>Reads a mesh from a file, determines the reader to use based on the file
extension. All cases require a filename and gmsh files require a number
of dimensions (it doesn’t hurt to pass this in all the time). Other
keyword args come from the underlying reader functions.</p>
</dd></dl>
<dl class="function">
<dt id="esys.finley.GlueFaces">
<code class="descclassname">esys.finley.</code><code class="descname">GlueFaces</code><span class="sig-paren">(</span><em>(list)meshList</em><span class="optional">[</span>, <em>(float)safetyFactor=0.2</em><span class="optional">[</span>, <em>(float)tolerance=1e-08</em><span class="optional">[</span>, <em>(bool)optimize=True</em><span class="optional">]</span><span class="optional">]</span><span class="optional">]</span><span class="sig-paren">)</span> → Domain :<a class="headerlink" href="#esys.finley.GlueFaces" title="Permalink to this definition">¶</a></dt>
<dd><p>Detects matching faces in the mesh, removes them from the mesh and joins the elements touched by the face elements.</p>
</dd></dl>
<dl class="function">
<dt id="esys.finley.JoinFaces">
<code class="descclassname">esys.finley.</code><code class="descname">JoinFaces</code><span class="sig-paren">(</span><em>(list)meshList</em><span class="optional">[</span>, <em>(float)safetyFactor=0.2</em><span class="optional">[</span>, <em>(float)tolerance=1e-08</em><span class="optional">[</span>, <em>(bool)optimize=True</em><span class="optional">]</span><span class="optional">]</span><span class="optional">]</span><span class="sig-paren">)</span> → Domain :<a class="headerlink" href="#esys.finley.JoinFaces" title="Permalink to this definition">¶</a></dt>
<dd><p>Detects matching faces in the mesh and replaces them by joint elements.</p>
</dd></dl>
<dl class="function">
<dt id="esys.finley.LoadMesh">
<code class="descclassname">esys.finley.</code><code class="descname">LoadMesh</code><span class="sig-paren">(</span><span class="optional">[</span><em>(str)fileName='file.nc'</em><span class="optional">]</span><span class="sig-paren">)</span> → Domain :<a class="headerlink" href="#esys.finley.LoadMesh" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="#esys.finley.FinleyDomain" title="esys.finley.FinleyDomain"><code class="xref py py-obj docutils literal notranslate"><span class="pre">FinleyDomain</span></code></a></td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="esys.finley.MakeDomain">
<code class="descclassname">esys.finley.</code><code class="descname">MakeDomain</code><span class="sig-paren">(</span><em>design</em>, <em>integrationOrder=-1</em>, <em>reducedIntegrationOrder=-1</em>, <em>optimizeLabeling=True</em>, <em>useMacroElements=False</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.finley.MakeDomain" title="Permalink to this definition">¶</a></dt>
<dd><p>Creates a Finley <code class="xref py py-obj docutils literal notranslate"><span class="pre">Domain</span></code> from a <code class="xref py py-obj docutils literal notranslate"><span class="pre">esys.pycad.design.Design</span></code> object.
Currently only gmsh is supported.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>design</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">esys.pycad.design.Design</span></code>) – the geometry</li>
<li><strong>integrationOrder</strong> (<code class="docutils literal notranslate"><span class="pre">int</span></code>) – integration order. If -1 the default is used.</li>
<li><strong>reducedIntegrationOrder</strong> (<code class="docutils literal notranslate"><span class="pre">int</span></code>) – reduced integration order. If -1 the
default is used.</li>
<li><strong>optimizeLabeling</strong> (<code class="docutils literal notranslate"><span class="pre">bool</span></code>) – if set the labeling of the mesh nodes is optimized</li>
<li><strong>useMacroElements</strong> (<code class="docutils literal notranslate"><span class="pre">bool</span></code>) – uses macro elements.</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">the Finley domain defined by the design</p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Domain</span></code></p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="esys.finley.Merge">
<code class="descclassname">esys.finley.</code><code class="descname">Merge</code><span class="sig-paren">(</span><em>(list)meshList</em><span class="sig-paren">)</span> → Domain :<a class="headerlink" href="#esys.finley.Merge" title="Permalink to this definition">¶</a></dt>
<dd><p>Merges a list of meshes into one mesh.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Domain</span></code></td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="esys.finley.ReadGmsh">
<code class="descclassname">esys.finley.</code><code class="descname">ReadGmsh</code><span class="sig-paren">(</span><em>fileName</em>, <em>numDim</em>, <em>integrationOrder=-1</em>, <em>reducedIntegrationOrder=-1</em>, <em>optimize=True</em>, <em>useMacroElements=False</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.finley.ReadGmsh" title="Permalink to this definition">¶</a></dt>
<dd><dl class="docutils">
<dt>__ReadGmsh_driver( (list)params) -> Domain :</dt>
<dd><p class="first">Read a gmsh mesh file</p>
<table class="last docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">rtype:</th><td class="field-body"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Domain</span></code></td>
</tr>
<tr class="field-even field"><th class="field-name">param fileName:</th><td class="field-body"></td>
</tr>
<tr class="field-odd field"><th class="field-name">type fileName:</th><td class="field-body"><code class="docutils literal notranslate"><span class="pre">string</span></code></td>
</tr>
<tr class="field-even field"><th class="field-name" colspan="2">param integrationOrder:</th></tr>
<tr class="field-even field"><td> </td><td class="field-body">order of the quadrature scheme. If <em>integrationOrder<0</em> the integration order is selected independently.</td>
</tr>
<tr class="field-odd field"><th class="field-name" colspan="2">type integrationOrder:</th></tr>
<tr class="field-odd field"><td> </td><td class="field-body"><code class="docutils literal notranslate"><span class="pre">int</span></code></td>
</tr>
<tr class="field-even field"><th class="field-name" colspan="2">param reducedIntegrationOrder:</th></tr>
<tr class="field-even field"><td> </td><td class="field-body">order of the quadrature scheme. If <em>reducedIntegrationOrder<0</em> the integration order is selected independently.</td>
</tr>
<tr class="field-odd field"><th class="field-name">param optimize:</th><td class="field-body">Enable optimisation of node labels</td>
</tr>
<tr class="field-even field"><th class="field-name">type optimize:</th><td class="field-body"><code class="docutils literal notranslate"><span class="pre">bool</span></code></td>
</tr>
<tr class="field-odd field"><th class="field-name" colspan="2">param useMacroElements:</th></tr>
<tr class="field-odd field"><td> </td><td class="field-body">Enable the usage of macro elements instead of second order elements.</td>
</tr>
<tr class="field-even field"><th class="field-name" colspan="2">type useMacroElements:</th></tr>
<tr class="field-even field"><td> </td><td class="field-body"><code class="docutils literal notranslate"><span class="pre">bool</span></code></td>
</tr>
</tbody>
</table>
</dd>
</dl>
</dd></dl>
<dl class="function">
<dt id="esys.finley.ReadMesh">
<code class="descclassname">esys.finley.</code><code class="descname">ReadMesh</code><span class="sig-paren">(</span><em>filename</em>, <em>integrationOrder=-1</em>, <em>reducedIntegrationOrder=-1</em>, <em>optimize=True</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.finley.ReadMesh" title="Permalink to this definition">¶</a></dt>
<dd><dl class="docutils">
<dt>__ReadMesh_driver( (list)params) -> Domain :</dt>
<dd><p class="first">Read a mesh from a file. For MPI parallel runs fan out the mesh to multiple processes.</p>
<table class="last docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">rtype:</th><td class="field-body"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Domain</span></code></td>
</tr>
<tr class="field-even field"><th class="field-name">param fileName:</th><td class="field-body"></td>
</tr>
<tr class="field-odd field"><th class="field-name">type fileName:</th><td class="field-body"><code class="docutils literal notranslate"><span class="pre">string</span></code></td>
</tr>
<tr class="field-even field"><th class="field-name" colspan="2">param integrationOrder:</th></tr>
<tr class="field-even field"><td> </td><td class="field-body">order of the quadrature scheme. If <em>integrationOrder<0</em> the integration order is selected independently.</td>
</tr>
<tr class="field-odd field"><th class="field-name" colspan="2">type integrationOrder:</th></tr>
<tr class="field-odd field"><td> </td><td class="field-body"><code class="docutils literal notranslate"><span class="pre">int</span></code></td>
</tr>
<tr class="field-even field"><th class="field-name" colspan="2">param reducedIntegrationOrder:</th></tr>
<tr class="field-even field"><td> </td><td class="field-body">order of the quadrature scheme. If <em>reducedIntegrationOrder<0</em> the integration order is selected independently.</td>
</tr>
<tr class="field-odd field"><th class="field-name">param optimize:</th><td class="field-body">Enable optimisation of node labels</td>
</tr>
<tr class="field-even field"><th class="field-name">type optimize:</th><td class="field-body"><code class="docutils literal notranslate"><span class="pre">bool</span></code></td>
</tr>
</tbody>
</table>
</dd>
</dl>
</dd></dl>
<dl class="function">
<dt id="esys.finley.Rectangle">
<code class="descclassname">esys.finley.</code><code class="descname">Rectangle</code><span class="sig-paren">(</span><em>n0=1</em>, <em>n1=1</em>, <em>order=1</em>, <em>l0=1.0</em>, <em>l1=1.0</em>, <em>periodic0=False</em>, <em>periodic1=False</em>, <em>integrationOrder=-1</em>, <em>reducedIntegrationOrder=-1</em>, <em>useElementsOnFace=None</em>, <em>useFullElementOrder=0</em>, <em>optimize=0</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.finley.Rectangle" title="Permalink to this definition">¶</a></dt>
<dd><dl class="docutils">
<dt>__Rectangle_driver( (list)args) -> Domain :</dt>
<dd><p class="first">Creates a rectangular mesh with n0 x n1 elements over the brick [0,l0] x [0,l1].</p>
<table class="last docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">param n0:</th><td class="field-body"></td>
</tr>
<tr class="field-even field"><th class="field-name">type n0:</th><td class="field-body"></td>
</tr>
<tr class="field-odd field"><th class="field-name">param n1:</th><td class="field-body"></td>
</tr>
<tr class="field-even field"><th class="field-name">type n1:</th><td class="field-body"></td>
</tr>
<tr class="field-odd field"><th class="field-name">param order:</th><td class="field-body">=1, =-1 or =2 gives the order of shape function. If -1 macro elements of order 1 are used.</td>
</tr>
<tr class="field-even field"><th class="field-name">param l0:</th><td class="field-body">length of side 0</td>
</tr>
<tr class="field-odd field"><th class="field-name">param l1:</th><td class="field-body"></td>
</tr>
<tr class="field-even field"><th class="field-name" colspan="2">param integrationOrder:</th></tr>
<tr class="field-even field"><td> </td><td class="field-body">order of the quadrature scheme. If integrationOrder<0 the integration order is selected independently.</td>
</tr>
<tr class="field-odd field"><th class="field-name" colspan="2">param reducedIntegrationOrder:</th></tr>
<tr class="field-odd field"><td> </td><td class="field-body">order of the quadrature scheme. If reducedIntegrationOrder<0 the integration order is selected independently.</td>
</tr>
<tr class="field-even field"><th class="field-name" colspan="2">param useElementsOnFace:</th></tr>
<tr class="field-even field"><td> </td><td class="field-body">whether or not to use elements on face</td>
</tr>
<tr class="field-odd field"><th class="field-name" colspan="2">type useElementsOnFace:</th></tr>
<tr class="field-odd field"><td> </td><td class="field-body"><code class="docutils literal notranslate"><span class="pre">int</span></code>:param periodic0: whether or not boundary conditions are periodic</td>
</tr>
<tr class="field-even field"><th class="field-name" colspan="2">param periodic1:</th></tr>
<tr class="field-even field"><td> </td><td class="field-body"></td>
</tr>
<tr class="field-odd field"><th class="field-name" colspan="2">param useFullElementOrder:</th></tr>
<tr class="field-odd field"><td> </td><td class="field-body">Whether or not to use Rec9 elements</td>
</tr>
<tr class="field-even field"><th class="field-name" colspan="2">type useFullElementOrder:</th></tr>
<tr class="field-even field"><td> </td><td class="field-body"><code class="docutils literal notranslate"><span class="pre">bool</span></code></td>
</tr>
<tr class="field-odd field"><th class="field-name">param optimize:</th><td class="field-body">Enable optimisation of node labels</td>
</tr>
<tr class="field-even field"><th class="field-name">type optimize:</th><td class="field-body"><code class="docutils literal notranslate"><span class="pre">bool</span></code></td>
</tr>
</tbody>
</table>
</dd>
</dl>
</dd></dl>
</div>
<div class="section" id="others">
<h2>Others<a class="headerlink" href="#others" title="Permalink to this headline">¶</a></h2>
</div>
<div class="section" id="packages">
<h2>Packages<a class="headerlink" href="#packages" title="Permalink to this headline">¶</a></h2>
<div class="toctree-wrapper compound">
</div>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h3><a href="index.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">esys.finley Package</a><ul>
<li><a class="reference internal" href="#classes">Classes</a></li>
<li><a class="reference internal" href="#functions">Functions</a></li>
<li><a class="reference internal" href="#others">Others</a></li>
<li><a class="reference internal" href="#packages">Packages</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="esys.escript.html"
title="previous chapter">esys.escript Package</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="esys.modellib.html"
title="next chapter">esys.modellib Package</a></p>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="esys.modellib.html" title="esys.modellib Package"
>next</a> |</li>
<li class="right" >
<a href="esys.escript.html" title="esys.escript Package"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">esys.escript 5.6 documentation</a> »</li>
</ul>
</div>
<div class="footer" role="contentinfo">
© Copyright 2012-2014, Author.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.8.4.
</div>
</body>
</html>
|
