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
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
|
<!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.downunder.dcresistivityforwardmodeling 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.downunder.domainbuilder Package" href="esys.downunder.domainbuilder.html" />
<link rel="prev" title="esys.downunder Package" href="esys.downunder.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.downunder.domainbuilder.html" title="esys.downunder.domainbuilder Package"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="esys.downunder.html" title="esys.downunder Package"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">esys.escript 5.6 documentation</a> »</li>
<li class="nav-item nav-item-1"><a href="esys.downunder.html" accesskey="U">esys.downunder Package</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="module-esys.downunder.dcresistivityforwardmodeling">
<span id="esys-downunder-dcresistivityforwardmodeling-package"></span><h1>esys.downunder.dcresistivityforwardmodeling Package<a class="headerlink" href="#module-esys.downunder.dcresistivityforwardmodeling" title="Permalink to this headline">¶</a></h1>
<ul class="simple">
<li></li>
</ul>
<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.downunder.dcresistivityforwardmodeling.DcResistivityForward" title="esys.downunder.dcresistivityforwardmodeling.DcResistivityForward"><code class="xref py py-obj docutils literal notranslate"><span class="pre">DcResistivityForward</span></code></a></li>
<li><a class="reference internal" href="#esys.downunder.dcresistivityforwardmodeling.DipoleDipoleSurvey" title="esys.downunder.dcresistivityforwardmodeling.DipoleDipoleSurvey"><code class="xref py py-obj docutils literal notranslate"><span class="pre">DipoleDipoleSurvey</span></code></a></li>
<li><a class="reference internal" href="#esys.downunder.dcresistivityforwardmodeling.LinearPDE" title="esys.downunder.dcresistivityforwardmodeling.LinearPDE"><code class="xref py py-obj docutils literal notranslate"><span class="pre">LinearPDE</span></code></a></li>
<li><a class="reference internal" href="#esys.downunder.dcresistivityforwardmodeling.Locator" title="esys.downunder.dcresistivityforwardmodeling.Locator"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Locator</span></code></a></li>
<li><a class="reference internal" href="#esys.downunder.dcresistivityforwardmodeling.PoleDipoleSurvey" title="esys.downunder.dcresistivityforwardmodeling.PoleDipoleSurvey"><code class="xref py py-obj docutils literal notranslate"><span class="pre">PoleDipoleSurvey</span></code></a></li>
<li><a class="reference internal" href="#esys.downunder.dcresistivityforwardmodeling.PolePoleSurvey" title="esys.downunder.dcresistivityforwardmodeling.PolePoleSurvey"><code class="xref py py-obj docutils literal notranslate"><span class="pre">PolePoleSurvey</span></code></a></li>
<li><a class="reference internal" href="#esys.downunder.dcresistivityforwardmodeling.SchlumbergerSurvey" title="esys.downunder.dcresistivityforwardmodeling.SchlumbergerSurvey"><code class="xref py py-obj docutils literal notranslate"><span class="pre">SchlumbergerSurvey</span></code></a></li>
<li><a class="reference internal" href="#esys.downunder.dcresistivityforwardmodeling.WennerSurvey" title="esys.downunder.dcresistivityforwardmodeling.WennerSurvey"><code class="xref py py-obj docutils literal notranslate"><span class="pre">WennerSurvey</span></code></a></li>
<li><a class="reference internal" href="#esys.downunder.dcresistivityforwardmodeling.xrange" title="esys.downunder.dcresistivityforwardmodeling.xrange"><code class="xref py py-obj docutils literal notranslate"><span class="pre">xrange</span></code></a></li>
</ul>
<dl class="class">
<dt id="esys.downunder.dcresistivityforwardmodeling.DcResistivityForward">
<em class="property">class </em><code class="descclassname">esys.downunder.dcresistivityforwardmodeling.</code><code class="descname">DcResistivityForward</code><a class="headerlink" href="#esys.downunder.dcresistivityforwardmodeling.DcResistivityForward" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
<p>This class allows for the solution of dc resistivity forward problems via
the calculation of a primary and secondary potential. Conductivity values
are to be provided for the primary problem which is a homogeneous half space
of a chosen conductivity and for the secondary problem which typically
varies it conductivity spatially across the domain. The primary potential
acts as a reference point typically based of some know reference conductivity
however any value will suffice. The primary potential is implemented to
avoid the use of dirac delta functions.</p>
<dl class="method">
<dt id="esys.downunder.dcresistivityforwardmodeling.DcResistivityForward.__init__">
<code class="descname">__init__</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.dcresistivityforwardmodeling.DcResistivityForward.__init__" title="Permalink to this definition">¶</a></dt>
<dd><p>This is a skeleton class for all the other forward modeling classes.</p>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.dcresistivityforwardmodeling.DcResistivityForward.checkBounds">
<code class="descname">checkBounds</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.dcresistivityforwardmodeling.DcResistivityForward.checkBounds" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="esys.downunder.dcresistivityforwardmodeling.DcResistivityForward.getApparentResistivity">
<code class="descname">getApparentResistivity</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.dcresistivityforwardmodeling.DcResistivityForward.getApparentResistivity" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="esys.downunder.dcresistivityforwardmodeling.DcResistivityForward.getElectrodes">
<code class="descname">getElectrodes</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.dcresistivityforwardmodeling.DcResistivityForward.getElectrodes" title="Permalink to this definition">¶</a></dt>
<dd><p>retuns the list of electrodes with locations</p>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.dcresistivityforwardmodeling.DcResistivityForward.getPotential">
<code class="descname">getPotential</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.dcresistivityforwardmodeling.DcResistivityForward.getPotential" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="esys.downunder.dcresistivityforwardmodeling.DipoleDipoleSurvey">
<em class="property">class </em><code class="descclassname">esys.downunder.dcresistivityforwardmodeling.</code><code class="descname">DipoleDipoleSurvey</code><span class="sig-paren">(</span><em>domain</em>, <em>primaryConductivity</em>, <em>secondaryConductivity</em>, <em>current</em>, <em>a</em>, <em>n</em>, <em>midPoint</em>, <em>directionVector</em>, <em>numElectrodes</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.dcresistivityforwardmodeling.DipoleDipoleSurvey" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#esys.downunder.dcresistivityforwardmodeling.DcResistivityForward" title="esys.downunder.dcresistivityforwardmodeling.DcResistivityForward"><code class="xref py py-class docutils literal notranslate"><span class="pre">esys.downunder.dcresistivityforwardmodeling.DcResistivityForward</span></code></a></p>
<p>DipoleDipoleSurvey forward modeling</p>
<dl class="method">
<dt id="esys.downunder.dcresistivityforwardmodeling.DipoleDipoleSurvey.__init__">
<code class="descname">__init__</code><span class="sig-paren">(</span><em>domain</em>, <em>primaryConductivity</em>, <em>secondaryConductivity</em>, <em>current</em>, <em>a</em>, <em>n</em>, <em>midPoint</em>, <em>directionVector</em>, <em>numElectrodes</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.dcresistivityforwardmodeling.DipoleDipoleSurvey.__init__" title="Permalink to this definition">¶</a></dt>
<dd><p>This is a skeleton class for all the other forward modeling classes.</p>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.dcresistivityforwardmodeling.DipoleDipoleSurvey.checkBounds">
<code class="descname">checkBounds</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.dcresistivityforwardmodeling.DipoleDipoleSurvey.checkBounds" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="esys.downunder.dcresistivityforwardmodeling.DipoleDipoleSurvey.getApparentResistivity">
<code class="descname">getApparentResistivity</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.dcresistivityforwardmodeling.DipoleDipoleSurvey.getApparentResistivity" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="esys.downunder.dcresistivityforwardmodeling.DipoleDipoleSurvey.getApparentResistivityPrimary">
<code class="descname">getApparentResistivityPrimary</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.dcresistivityforwardmodeling.DipoleDipoleSurvey.getApparentResistivityPrimary" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="esys.downunder.dcresistivityforwardmodeling.DipoleDipoleSurvey.getApparentResistivitySecondary">
<code class="descname">getApparentResistivitySecondary</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.dcresistivityforwardmodeling.DipoleDipoleSurvey.getApparentResistivitySecondary" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="esys.downunder.dcresistivityforwardmodeling.DipoleDipoleSurvey.getApparentResistivityTotal">
<code class="descname">getApparentResistivityTotal</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.dcresistivityforwardmodeling.DipoleDipoleSurvey.getApparentResistivityTotal" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="esys.downunder.dcresistivityforwardmodeling.DipoleDipoleSurvey.getElectrodes">
<code class="descname">getElectrodes</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.dcresistivityforwardmodeling.DipoleDipoleSurvey.getElectrodes" title="Permalink to this definition">¶</a></dt>
<dd><p>retuns the list of electrodes with locations</p>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.dcresistivityforwardmodeling.DipoleDipoleSurvey.getPotential">
<code class="descname">getPotential</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.dcresistivityforwardmodeling.DipoleDipoleSurvey.getPotential" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns 3 list each made up of a number of list containing primary, secondary and total
potentials diferences. Each of the lists contain a list for each value of n.</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="esys.downunder.dcresistivityforwardmodeling.LinearPDE">
<em class="property">class </em><code class="descclassname">esys.downunder.dcresistivityforwardmodeling.</code><code class="descname">LinearPDE</code><span class="sig-paren">(</span><em>domain</em>, <em>numEquations=None</em>, <em>numSolutions=None</em>, <em>isComplex=False</em>, <em>debug=False</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.dcresistivityforwardmodeling.LinearPDE" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">esys.escriptcore.linearPDEs.LinearProblem</span></code></p>
<p>This class is used to define a general linear, steady, second order PDE
for an unknown function <em>u</em> on a given domain defined through a
<code class="xref py py-obj docutils literal notranslate"><span class="pre">Domain</span></code> object.</p>
<p>For a single PDE having a solution with a single component the linear PDE
is defined in the following form:</p>
<p><em>-(grad(A[j,l]+A_reduced[j,l])*grad(u)[l]+(B[j]+B_reduced[j])u)[j]+(C[l]+C_reduced[l])*grad(u)[l]+(D+D_reduced)=-grad(X+X_reduced)[j,j]+(Y+Y_reduced)</em></p>
<p>where <em>grad(F)</em> denotes the spatial derivative of <em>F</em>. Einstein’s
summation convention, ie. summation over indexes appearing twice in a term
of a sum performed, is used.
The coefficients <em>A</em>, <em>B</em>, <em>C</em>, <em>D</em>, <em>X</em> and <em>Y</em> have to be specified
through <code class="xref py py-obj docutils literal notranslate"><span class="pre">Data</span></code> objects in <code class="xref py py-obj docutils literal notranslate"><span class="pre">Function</span></code> and
the coefficients <em>A_reduced</em>, <em>B_reduced</em>, <em>C_reduced</em>, <em>D_reduced</em>,
<em>X_reduced</em> and <em>Y_reduced</em> have to be specified through
<code class="xref py py-obj docutils literal notranslate"><span class="pre">Data</span></code> objects in <code class="xref py py-obj docutils literal notranslate"><span class="pre">ReducedFunction</span></code>.
It is also allowed to use objects that can be converted into such
<code class="xref py py-obj docutils literal notranslate"><span class="pre">Data</span></code> objects. <em>A</em> and <em>A_reduced</em> are rank two, <em>B</em>,
<em>C</em>, <em>X</em>, <em>B_reduced</em>, <em>C_reduced</em> and <em>X_reduced</em> are rank one and
<em>D</em>, <em>D_reduced</em>, <em>Y</em> and <em>Y_reduced</em> are scalar.</p>
<p>The following natural boundary conditions are considered:</p>
<p><em>n[j]*((A[i,j]+A_reduced[i,j])*grad(u)[l]+(B+B_reduced)[j]*u)+(d+d_reduced)*u=n[j]*(X[j]+X_reduced[j])+y</em></p>
<p>where <em>n</em> is the outer normal field. Notice that the coefficients <em>A</em>,
<em>A_reduced</em>, <em>B</em>, <em>B_reduced</em>, <em>X</em> and <em>X_reduced</em> are defined in the
PDE. The coefficients <em>d</em> and <em>y</em> are each a scalar in
<code class="xref py py-obj docutils literal notranslate"><span class="pre">FunctionOnBoundary</span></code> and the coefficients
<em>d_reduced</em> and <em>y_reduced</em> are each a scalar in
<code class="xref py py-obj docutils literal notranslate"><span class="pre">ReducedFunctionOnBoundary</span></code>.</p>
<p>Constraints for the solution prescribe the value of the solution at certain
locations in the domain. They have the form</p>
<p><em>u=r</em> where <em>q>0</em></p>
<p><em>r</em> and <em>q</em> are each scalar where <em>q</em> is the characteristic function
defining where the constraint is applied. The constraints override any
other condition set by the PDE or the boundary condition.</p>
<p>The PDE is symmetrical if</p>
<p><em>A[i,j]=A[j,i]</em> and <em>B[j]=C[j]</em> and <em>A_reduced[i,j]=A_reduced[j,i]</em>
and <em>B_reduced[j]=C_reduced[j]</em></p>
<p>For a system of PDEs and a solution with several components the PDE has the
form</p>
<p><em>-grad((A[i,j,k,l]+A_reduced[i,j,k,l])*grad(u[k])[l]+(B[i,j,k]+B_reduced[i,j,k])*u[k])[j]+(C[i,k,l]+C_reduced[i,k,l])*grad(u[k])[l]+(D[i,k]+D_reduced[i,k]*u[k] =-grad(X[i,j]+X_reduced[i,j])[j]+Y[i]+Y_reduced[i]</em></p>
<p><em>A</em> and <em>A_reduced</em> are of rank four, <em>B</em>, <em>B_reduced</em>, <em>C</em> and
<em>C_reduced</em> are each of rank three, <em>D</em>, <em>D_reduced</em>, <em>X_reduced</em> and
<em>X</em> are each of rank two and <em>Y</em> and <em>Y_reduced</em> are of rank one.
The natural boundary conditions take the form:</p>
<p><em>n[j]*((A[i,j,k,l]+A_reduced[i,j,k,l])*grad(u[k])[l]+(B[i,j,k]+B_reduced[i,j,k])*u[k])+(d[i,k]+d_reduced[i,k])*u[k]=n[j]*(X[i,j]+X_reduced[i,j])+y[i]+y_reduced[i]</em></p>
<p>The coefficient <em>d</em> is of rank two and <em>y</em> is of rank one both in
<code class="xref py py-obj docutils literal notranslate"><span class="pre">FunctionOnBoundary</span></code>. The coefficients
<em>d_reduced</em> is of rank two and <em>y_reduced</em> is of rank one both in
<code class="xref py py-obj docutils literal notranslate"><span class="pre">ReducedFunctionOnBoundary</span></code>.</p>
<p>Constraints take the form</p>
<p><em>u[i]=r[i]</em> where <em>q[i]>0</em></p>
<p><em>r</em> and <em>q</em> are each rank one. Notice that at some locations not
necessarily all components must have a constraint.</p>
<p>The system of PDEs is symmetrical if</p>
<blockquote>
<div><ul class="simple">
<li><em>A[i,j,k,l]=A[k,l,i,j]</em></li>
<li><em>A_reduced[i,j,k,l]=A_reduced[k,l,i,j]</em></li>
<li><em>B[i,j,k]=C[k,i,j]</em></li>
<li><em>B_reduced[i,j,k]=C_reduced[k,i,j]</em></li>
<li><em>D[i,k]=D[i,k]</em></li>
<li><em>D_reduced[i,k]=D_reduced[i,k]</em></li>
<li><em>d[i,k]=d[k,i]</em></li>
<li><em>d_reduced[i,k]=d_reduced[k,i]</em></li>
</ul>
</div></blockquote>
<p><a class="reference internal" href="#esys.downunder.dcresistivityforwardmodeling.LinearPDE" title="esys.downunder.dcresistivityforwardmodeling.LinearPDE"><code class="xref py py-obj docutils literal notranslate"><span class="pre">LinearPDE</span></code></a> also supports solution discontinuities over a contact region
in the domain. To specify the conditions across the discontinuity we are
using the generalised flux <em>J</em> which, in the case of a system of PDEs
and several components of the solution, is defined as</p>
<p><em>J[i,j]=(A[i,j,k,l]+A_reduced[[i,j,k,l])*grad(u[k])[l]+(B[i,j,k]+B_reduced[i,j,k])*u[k]-X[i,j]-X_reduced[i,j]</em></p>
<p>For the case of single solution component and single PDE <em>J</em> is defined as</p>
<p><em>J[j]=(A[i,j]+A_reduced[i,j])*grad(u)[j]+(B[i]+B_reduced[i])*u-X[i]-X_reduced[i]</em></p>
<p>In the context of discontinuities <em>n</em> denotes the normal on the
discontinuity pointing from side 0 towards side 1 calculated from
<code class="xref py py-obj docutils literal notranslate"><span class="pre">FunctionSpace.getNormal</span></code> of <code class="xref py py-obj docutils literal notranslate"><span class="pre">FunctionOnContactZero</span></code>.
For a system of PDEs the contact condition takes the form</p>
<p><em>n[j]*J0[i,j]=n[j]*J1[i,j]=(y_contact[i]+y_contact_reduced[i])- (d_contact[i,k]+d_contact_reduced[i,k])*jump(u)[k]</em></p>
<p>where <em>J0</em> and <em>J1</em> are the fluxes on side 0 and side 1 of the
discontinuity, respectively. <em>jump(u)</em>, which is the difference of the
solution at side 1 and at side 0, denotes the jump of <em>u</em> across
discontinuity along the normal calculated by <code class="xref py py-obj docutils literal notranslate"><span class="pre">jump</span></code>.
The coefficient <em>d_contact</em> is of rank two and <em>y_contact</em> is of rank one
both in <code class="xref py py-obj docutils literal notranslate"><span class="pre">FunctionOnContactZero</span></code> or
<code class="xref py py-obj docutils literal notranslate"><span class="pre">FunctionOnContactOne</span></code>.
The coefficient <em>d_contact_reduced</em> is of rank two and <em>y_contact_reduced</em>
is of rank one both in <code class="xref py py-obj docutils literal notranslate"><span class="pre">ReducedFunctionOnContactZero</span></code>
or <code class="xref py py-obj docutils literal notranslate"><span class="pre">ReducedFunctionOnContactOne</span></code>.
In case of a single PDE and a single component solution the contact
condition takes the form</p>
<p><em>n[j]*J0_{j}=n[j]*J1_{j}=(y_contact+y_contact_reduced)-(d_contact+y_contact_reduced)*jump(u)</em></p>
<p>In this case the coefficient <em>d_contact</em> and <em>y_contact</em> are each scalar
both in <code class="xref py py-obj docutils literal notranslate"><span class="pre">FunctionOnContactZero</span></code> or
<code class="xref py py-obj docutils literal notranslate"><span class="pre">FunctionOnContactOne</span></code> and the coefficient
<em>d_contact_reduced</em> and <em>y_contact_reduced</em> are each scalar both in
<code class="xref py py-obj docutils literal notranslate"><span class="pre">ReducedFunctionOnContactZero</span></code> or
<code class="xref py py-obj docutils literal notranslate"><span class="pre">ReducedFunctionOnContactOne</span></code>.</p>
<p>Typical usage:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">p</span> <span class="o">=</span> <span class="n">LinearPDE</span><span class="p">(</span><span class="n">dom</span><span class="p">)</span>
<span class="n">p</span><span class="o">.</span><span class="n">setValue</span><span class="p">(</span><span class="n">A</span><span class="o">=</span><span class="n">kronecker</span><span class="p">(</span><span class="n">dom</span><span class="p">),</span> <span class="n">D</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span> <span class="n">Y</span><span class="o">=</span><span class="mf">0.5</span><span class="p">)</span>
<span class="n">u</span> <span class="o">=</span> <span class="n">p</span><span class="o">.</span><span class="n">getSolution</span><span class="p">()</span>
</pre></div>
</div>
<dl class="method">
<dt id="esys.downunder.dcresistivityforwardmodeling.LinearPDE.__init__">
<code class="descname">__init__</code><span class="sig-paren">(</span><em>domain</em>, <em>numEquations=None</em>, <em>numSolutions=None</em>, <em>isComplex=False</em>, <em>debug=False</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.dcresistivityforwardmodeling.LinearPDE.__init__" title="Permalink to this definition">¶</a></dt>
<dd><p>Initializes a new linear PDE.</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>domain</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">Domain</span></code>) – domain of the PDE</li>
<li><strong>numEquations</strong> – number of equations. If <code class="docutils literal notranslate"><span class="pre">None</span></code> the number of
equations is extracted from the PDE coefficients.</li>
<li><strong>numSolutions</strong> – number of solution components. If <code class="docutils literal notranslate"><span class="pre">None</span></code> the number
of solution components is extracted from the PDE
coefficients.</li>
<li><strong>debug</strong> – if True debug information is printed</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.dcresistivityforwardmodeling.LinearPDE.addPDEToLumpedSystem">
<code class="descname">addPDEToLumpedSystem</code><span class="sig-paren">(</span><em>operator</em>, <em>a</em>, <em>b</em>, <em>c</em>, <em>hrz_lumping</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.dcresistivityforwardmodeling.LinearPDE.addPDEToLumpedSystem" title="Permalink to this definition">¶</a></dt>
<dd><p>adds a PDE to the lumped system, results depend on 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"><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>hrz_lumping</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">bool</span></code>) – </li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.dcresistivityforwardmodeling.LinearPDE.addPDEToRHS">
<code class="descname">addPDEToRHS</code><span class="sig-paren">(</span><em>righthandside</em>, <em>X</em>, <em>Y</em>, <em>y</em>, <em>y_contact</em>, <em>y_dirac</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.dcresistivityforwardmodeling.LinearPDE.addPDEToRHS" title="Permalink to this definition">¶</a></dt>
<dd><p>adds a PDE to the right hand side, results depend on 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"><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>righthandside</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>
<li><strong>y_dirac</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.downunder.dcresistivityforwardmodeling.LinearPDE.addPDEToSystem">
<code class="descname">addPDEToSystem</code><span class="sig-paren">(</span><em>operator</em>, <em>righthandside</em>, <em>A</em>, <em>B</em>, <em>C</em>, <em>D</em>, <em>X</em>, <em>Y</em>, <em>d</em>, <em>y</em>, <em>d_contact</em>, <em>y_contact</em>, <em>d_dirac</em>, <em>y_dirac</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.dcresistivityforwardmodeling.LinearPDE.addPDEToSystem" title="Permalink to this definition">¶</a></dt>
<dd><p>adds a PDE to the system, results depend on 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"><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>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>
<li><strong>d_dirac</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">Data</span></code>) – </li>
<li><strong>y_dirac</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.downunder.dcresistivityforwardmodeling.LinearPDE.addToRHS">
<code class="descname">addToRHS</code><span class="sig-paren">(</span><em>rhs</em>, <em>data</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.dcresistivityforwardmodeling.LinearPDE.addToRHS" title="Permalink to this definition">¶</a></dt>
<dd><p>adds a PDE to the right hand side, results depend on 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"><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>righthandside</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">Data</span></code>) – </li>
<li><strong>data</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">list</span></code>) – </li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.dcresistivityforwardmodeling.LinearPDE.addToSystem">
<code class="descname">addToSystem</code><span class="sig-paren">(</span><em>op</em>, <em>rhs</em>, <em>data</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.dcresistivityforwardmodeling.LinearPDE.addToSystem" title="Permalink to this definition">¶</a></dt>
<dd><p>adds a PDE to the system, results depend on 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"><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>data</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">list</span></code>) – </li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.dcresistivityforwardmodeling.LinearPDE.alteredCoefficient">
<code class="descname">alteredCoefficient</code><span class="sig-paren">(</span><em>name</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.dcresistivityforwardmodeling.LinearPDE.alteredCoefficient" title="Permalink to this definition">¶</a></dt>
<dd><p>Announces that coefficient <code class="docutils literal notranslate"><span class="pre">name</span></code> has been changed.</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>name</strong> (<code class="docutils literal notranslate"><span class="pre">string</span></code>) – name of the coefficient affected</td>
</tr>
<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><a class="reference internal" href="esys.escript.linearPDEs.html#esys.escript.linearPDEs.IllegalCoefficient" title="esys.escript.linearPDEs.IllegalCoefficient"><strong>IllegalCoefficient</strong></a> – if <code class="docutils literal notranslate"><span class="pre">name</span></code> is not a coefficient of the PDE</td>
</tr>
<tr class="field-odd field"><th class="field-name">Note:</th><td class="field-body">if <code class="docutils literal notranslate"><span class="pre">name</span></code> is q or r, the method will not trigger a rebuild of the
system as constraints are applied to the solved system.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.dcresistivityforwardmodeling.LinearPDE.checkReciprocalSymmetry">
<code class="descname">checkReciprocalSymmetry</code><span class="sig-paren">(</span><em>name0</em>, <em>name1</em>, <em>verbose=True</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.dcresistivityforwardmodeling.LinearPDE.checkReciprocalSymmetry" title="Permalink to this definition">¶</a></dt>
<dd><p>Tests two coefficients for reciprocal symmetry.</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>name0</strong> (<code class="docutils literal notranslate"><span class="pre">str</span></code>) – name of the first coefficient</li>
<li><strong>name1</strong> (<code class="docutils literal notranslate"><span class="pre">str</span></code>) – name of the second coefficient</li>
<li><strong>verbose</strong> (<code class="docutils literal notranslate"><span class="pre">bool</span></code>) – if set to True or not present a report on coefficients
which break the symmetry is printed</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">True if coefficients <code class="docutils literal notranslate"><span class="pre">name0</span></code> and <code class="docutils literal notranslate"><span class="pre">name1</span></code> are reciprocally
symmetric.</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="docutils literal notranslate"><span class="pre">bool</span></code></p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.dcresistivityforwardmodeling.LinearPDE.checkSymmetricTensor">
<code class="descname">checkSymmetricTensor</code><span class="sig-paren">(</span><em>name</em>, <em>verbose=True</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.dcresistivityforwardmodeling.LinearPDE.checkSymmetricTensor" title="Permalink to this definition">¶</a></dt>
<dd><p>Tests a coefficient for symmetry.</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">str</span></code>) – name of the coefficient</li>
<li><strong>verbose</strong> (<code class="docutils literal notranslate"><span class="pre">bool</span></code>) – if set to True or not present a report on coefficients
which break the symmetry is printed.</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">True if coefficient <code class="docutils literal notranslate"><span class="pre">name</span></code> is symmetric</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="docutils literal notranslate"><span class="pre">bool</span></code></p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.dcresistivityforwardmodeling.LinearPDE.checkSymmetry">
<code class="descname">checkSymmetry</code><span class="sig-paren">(</span><em>verbose=True</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.dcresistivityforwardmodeling.LinearPDE.checkSymmetry" title="Permalink to this definition">¶</a></dt>
<dd><p>Tests the PDE for symmetry.</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>verbose</strong> (<code class="docutils literal notranslate"><span class="pre">bool</span></code>) – if set to True or not present a report on coefficients
which break the symmetry is printed.</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">True if the PDE is symmetric</td>
</tr>
<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">bool</span></code></td>
</tr>
<tr class="field-even field"><th class="field-name">Note:</th><td class="field-body">This is a very expensive operation. It should be used for
degugging only! The symmetry flag is not altered.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.dcresistivityforwardmodeling.LinearPDE.createCoefficient">
<code class="descname">createCoefficient</code><span class="sig-paren">(</span><em>name</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.dcresistivityforwardmodeling.LinearPDE.createCoefficient" title="Permalink to this definition">¶</a></dt>
<dd><p>Creates a <code class="xref py py-obj docutils literal notranslate"><span class="pre">Data</span></code> object corresponding to coefficient
<code class="docutils literal notranslate"><span class="pre">name</span></code>.</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">Returns:</th><td class="field-body">the coefficient <code class="docutils literal notranslate"><span class="pre">name</span></code> initialized to 0</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>
<tr class="field-odd field"><th class="field-name">Raises:</th><td class="field-body"><a class="reference internal" href="esys.escript.linearPDEs.html#esys.escript.linearPDEs.IllegalCoefficient" title="esys.escript.linearPDEs.IllegalCoefficient"><strong>IllegalCoefficient</strong></a> – if <code class="docutils literal notranslate"><span class="pre">name</span></code> is not a coefficient of the PDE</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.dcresistivityforwardmodeling.LinearPDE.createOperator">
<code class="descname">createOperator</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.dcresistivityforwardmodeling.LinearPDE.createOperator" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns an instance of a new operator.</p>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.dcresistivityforwardmodeling.LinearPDE.createRightHandSide">
<code class="descname">createRightHandSide</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.dcresistivityforwardmodeling.LinearPDE.createRightHandSide" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns an instance of a new right hand side.</p>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.dcresistivityforwardmodeling.LinearPDE.createSolution">
<code class="descname">createSolution</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.dcresistivityforwardmodeling.LinearPDE.createSolution" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns an instance of a new solution.</p>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.dcresistivityforwardmodeling.LinearPDE.getCoefficient">
<code class="descname">getCoefficient</code><span class="sig-paren">(</span><em>name</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.dcresistivityforwardmodeling.LinearPDE.getCoefficient" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the value of the coefficient <code class="docutils literal notranslate"><span class="pre">name</span></code>.</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>name</strong> (<code class="docutils literal notranslate"><span class="pre">string</span></code>) – name of the coefficient requested</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">the value of the coefficient</td>
</tr>
<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">Data</span></code></td>
</tr>
<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><a class="reference internal" href="esys.escript.linearPDEs.html#esys.escript.linearPDEs.IllegalCoefficient" title="esys.escript.linearPDEs.IllegalCoefficient"><strong>IllegalCoefficient</strong></a> – if <code class="docutils literal notranslate"><span class="pre">name</span></code> is not a coefficient of the PDE</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.dcresistivityforwardmodeling.LinearPDE.getCurrentOperator">
<code class="descname">getCurrentOperator</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.dcresistivityforwardmodeling.LinearPDE.getCurrentOperator" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the operator in its current state.</p>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.dcresistivityforwardmodeling.LinearPDE.getCurrentRightHandSide">
<code class="descname">getCurrentRightHandSide</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.dcresistivityforwardmodeling.LinearPDE.getCurrentRightHandSide" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the right hand side in its current state.</p>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.dcresistivityforwardmodeling.LinearPDE.getCurrentSolution">
<code class="descname">getCurrentSolution</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.dcresistivityforwardmodeling.LinearPDE.getCurrentSolution" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the solution in its current state.</p>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.dcresistivityforwardmodeling.LinearPDE.getDim">
<code class="descname">getDim</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.dcresistivityforwardmodeling.LinearPDE.getDim" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the spatial dimension of the PDE.</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">Returns:</th><td class="field-body">the spatial dimension of the PDE 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">int</span></code></td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.dcresistivityforwardmodeling.LinearPDE.getDomain">
<code class="descname">getDomain</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.dcresistivityforwardmodeling.LinearPDE.getDomain" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the domain of the PDE.</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">Returns:</th><td class="field-body">the domain of the PDE</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">Domain</span></code></td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.dcresistivityforwardmodeling.LinearPDE.getDomainStatus">
<code class="descname">getDomainStatus</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.dcresistivityforwardmodeling.LinearPDE.getDomainStatus" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the status indicator of the domain</p>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.dcresistivityforwardmodeling.LinearPDE.getFlux">
<code class="descname">getFlux</code><span class="sig-paren">(</span><em>u=None</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.dcresistivityforwardmodeling.LinearPDE.getFlux" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the flux <em>J</em> for a given <em>u</em>.</p>
<p><em>J[i,j]=(A[i,j,k,l]+A_reduced[A[i,j,k,l]]*grad(u[k])[l]+(B[i,j,k]+B_reduced[i,j,k])u[k]-X[i,j]-X_reduced[i,j]</em></p>
<p>or</p>
<p><em>J[j]=(A[i,j]+A_reduced[i,j])*grad(u)[l]+(B[j]+B_reduced[j])u-X[j]-X_reduced[j]</em></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>u</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">Data</span></code> or None) – argument in the flux. If u is not present or equals <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code> the
current solution is used.</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">flux</td>
</tr>
<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">Data</span></code></td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.dcresistivityforwardmodeling.LinearPDE.getFunctionSpaceForCoefficient">
<code class="descname">getFunctionSpaceForCoefficient</code><span class="sig-paren">(</span><em>name</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.dcresistivityforwardmodeling.LinearPDE.getFunctionSpaceForCoefficient" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the <code class="xref py py-obj docutils literal notranslate"><span class="pre">FunctionSpace</span></code> to be used for
coefficient <code class="docutils literal notranslate"><span class="pre">name</span></code>.</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>name</strong> (<code class="docutils literal notranslate"><span class="pre">string</span></code>) – name of the coefficient enquired</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">the function space to be used for coefficient <code class="docutils literal notranslate"><span class="pre">name</span></code></td>
</tr>
<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">FunctionSpace</span></code></td>
</tr>
<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><a class="reference internal" href="esys.escript.linearPDEs.html#esys.escript.linearPDEs.IllegalCoefficient" title="esys.escript.linearPDEs.IllegalCoefficient"><strong>IllegalCoefficient</strong></a> – if <code class="docutils literal notranslate"><span class="pre">name</span></code> is not a coefficient of the PDE</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.dcresistivityforwardmodeling.LinearPDE.getFunctionSpaceForEquation">
<code class="descname">getFunctionSpaceForEquation</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.dcresistivityforwardmodeling.LinearPDE.getFunctionSpaceForEquation" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the <code class="xref py py-obj docutils literal notranslate"><span class="pre">FunctionSpace</span></code> used to discretize
the equation.</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">Returns:</th><td class="field-body">representation space of equation</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">FunctionSpace</span></code></td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.dcresistivityforwardmodeling.LinearPDE.getFunctionSpaceForSolution">
<code class="descname">getFunctionSpaceForSolution</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.dcresistivityforwardmodeling.LinearPDE.getFunctionSpaceForSolution" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the <code class="xref py py-obj docutils literal notranslate"><span class="pre">FunctionSpace</span></code> used to represent
the solution.</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">Returns:</th><td class="field-body">representation space of solution</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">FunctionSpace</span></code></td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.dcresistivityforwardmodeling.LinearPDE.getNumEquations">
<code class="descname">getNumEquations</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.dcresistivityforwardmodeling.LinearPDE.getNumEquations" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the number of equations.</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">Returns:</th><td class="field-body">the number of equations</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">Raises:</th><td class="field-body"><a class="reference internal" href="esys.escript.linearPDEs.html#esys.escript.linearPDEs.UndefinedPDEError" title="esys.escript.linearPDEs.UndefinedPDEError"><strong>UndefinedPDEError</strong></a> – if the number of equations is not specified yet</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.dcresistivityforwardmodeling.LinearPDE.getNumSolutions">
<code class="descname">getNumSolutions</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.dcresistivityforwardmodeling.LinearPDE.getNumSolutions" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the number of unknowns.</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">Returns:</th><td class="field-body">the number of unknowns</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">Raises:</th><td class="field-body"><a class="reference internal" href="esys.escript.linearPDEs.html#esys.escript.linearPDEs.UndefinedPDEError" title="esys.escript.linearPDEs.UndefinedPDEError"><strong>UndefinedPDEError</strong></a> – if the number of unknowns is not specified yet</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.dcresistivityforwardmodeling.LinearPDE.getOperator">
<code class="descname">getOperator</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.dcresistivityforwardmodeling.LinearPDE.getOperator" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the operator of the linear problem.</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">Returns:</th><td class="field-body">the operator of the problem</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.dcresistivityforwardmodeling.LinearPDE.getOperatorType">
<code class="descname">getOperatorType</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.dcresistivityforwardmodeling.LinearPDE.getOperatorType" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the current system type.</p>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.dcresistivityforwardmodeling.LinearPDE.getRequiredOperatorType">
<code class="descname">getRequiredOperatorType</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.dcresistivityforwardmodeling.LinearPDE.getRequiredOperatorType" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the system type which needs to be used by the current set up.</p>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.dcresistivityforwardmodeling.LinearPDE.getResidual">
<code class="descname">getResidual</code><span class="sig-paren">(</span><em>u=None</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.dcresistivityforwardmodeling.LinearPDE.getResidual" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the residual of u or the current solution if u is not present.</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>u</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">Data</span></code> or None) – argument in the residual calculation. It must be representable
in <code class="xref py py-obj docutils literal notranslate"><span class="pre">self.getFunctionSpaceForSolution()</span></code>. If u is not present
or equals <code class="docutils literal notranslate"><span class="pre">None</span></code> the current solution is used.</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">residual of u</td>
</tr>
<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">Data</span></code></td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.dcresistivityforwardmodeling.LinearPDE.getRightHandSide">
<code class="descname">getRightHandSide</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.dcresistivityforwardmodeling.LinearPDE.getRightHandSide" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the right hand side of the linear problem.</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">Returns:</th><td class="field-body">the right hand side of the problem</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.downunder.dcresistivityforwardmodeling.LinearPDE.getShapeOfCoefficient">
<code class="descname">getShapeOfCoefficient</code><span class="sig-paren">(</span><em>name</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.dcresistivityforwardmodeling.LinearPDE.getShapeOfCoefficient" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the shape of the coefficient <code class="docutils literal notranslate"><span class="pre">name</span></code>.</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>name</strong> (<code class="docutils literal notranslate"><span class="pre">string</span></code>) – name of the coefficient enquired</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">the shape of the coefficient <code class="docutils literal notranslate"><span class="pre">name</span></code></td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><code class="docutils literal notranslate"><span class="pre">tuple</span></code> of <code class="docutils literal notranslate"><span class="pre">int</span></code></td>
</tr>
<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><a class="reference internal" href="esys.escript.linearPDEs.html#esys.escript.linearPDEs.IllegalCoefficient" title="esys.escript.linearPDEs.IllegalCoefficient"><strong>IllegalCoefficient</strong></a> – if <code class="docutils literal notranslate"><span class="pre">name</span></code> is not a coefficient of the PDE</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.dcresistivityforwardmodeling.LinearPDE.getSolution">
<code class="descname">getSolution</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.dcresistivityforwardmodeling.LinearPDE.getSolution" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the solution of the PDE.</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">Returns:</th><td class="field-body">the solution</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.downunder.dcresistivityforwardmodeling.LinearPDE.getSolverOptions">
<code class="descname">getSolverOptions</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.dcresistivityforwardmodeling.LinearPDE.getSolverOptions" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the solver options</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">SolverOptions</span></code></td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.dcresistivityforwardmodeling.LinearPDE.getSystem">
<code class="descname">getSystem</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.dcresistivityforwardmodeling.LinearPDE.getSystem" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the operator and right hand side of the PDE.</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">Returns:</th><td class="field-body">the discrete version of the PDE</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> of <code class="xref py py-obj docutils literal notranslate"><span class="pre">Operator</span></code> and
<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.downunder.dcresistivityforwardmodeling.LinearPDE.getSystemStatus">
<code class="descname">getSystemStatus</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.dcresistivityforwardmodeling.LinearPDE.getSystemStatus" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the domain status used to build the current system</p>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.dcresistivityforwardmodeling.LinearPDE.hasCoefficient">
<code class="descname">hasCoefficient</code><span class="sig-paren">(</span><em>name</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.dcresistivityforwardmodeling.LinearPDE.hasCoefficient" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns True if <code class="docutils literal notranslate"><span class="pre">name</span></code> is the name of a coefficient.</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>name</strong> (<code class="docutils literal notranslate"><span class="pre">string</span></code>) – name of the coefficient enquired</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">True if <code class="docutils literal notranslate"><span class="pre">name</span></code> is the name of a coefficient of the general PDE,
False otherwise</td>
</tr>
<tr class="field-odd 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.downunder.dcresistivityforwardmodeling.LinearPDE.initializeSystem">
<code class="descname">initializeSystem</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.dcresistivityforwardmodeling.LinearPDE.initializeSystem" title="Permalink to this definition">¶</a></dt>
<dd><p>Resets the system clearing the operator, right hand side and solution.</p>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.dcresistivityforwardmodeling.LinearPDE.insertConstraint">
<code class="descname">insertConstraint</code><span class="sig-paren">(</span><em>rhs_only=False</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.dcresistivityforwardmodeling.LinearPDE.insertConstraint" title="Permalink to this definition">¶</a></dt>
<dd><p>Applies the constraints defined by q and r to the PDE.</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>rhs_only</strong> (<code class="docutils literal notranslate"><span class="pre">bool</span></code>) – if True only the right hand side is altered by the
constraint</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.dcresistivityforwardmodeling.LinearPDE.introduceCoefficients">
<code class="descname">introduceCoefficients</code><span class="sig-paren">(</span><em>**coeff</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.dcresistivityforwardmodeling.LinearPDE.introduceCoefficients" title="Permalink to this definition">¶</a></dt>
<dd><p>Introduces new coefficients into the problem.</p>
<p>Use:</p>
<p>p.introduceCoefficients(A=PDECoef(…), B=PDECoef(…))</p>
<p>to introduce the coefficients <em>A</em> and <em>B</em>.</p>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.dcresistivityforwardmodeling.LinearPDE.invalidateOperator">
<code class="descname">invalidateOperator</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.dcresistivityforwardmodeling.LinearPDE.invalidateOperator" title="Permalink to this definition">¶</a></dt>
<dd><p>Indicates the operator has to be rebuilt next time it is used.</p>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.dcresistivityforwardmodeling.LinearPDE.invalidateRightHandSide">
<code class="descname">invalidateRightHandSide</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.dcresistivityforwardmodeling.LinearPDE.invalidateRightHandSide" title="Permalink to this definition">¶</a></dt>
<dd><p>Indicates the right hand side has to be rebuilt next time it is used.</p>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.dcresistivityforwardmodeling.LinearPDE.invalidateSolution">
<code class="descname">invalidateSolution</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.dcresistivityforwardmodeling.LinearPDE.invalidateSolution" title="Permalink to this definition">¶</a></dt>
<dd><p>Indicates the PDE has to be resolved if the solution is requested.</p>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.dcresistivityforwardmodeling.LinearPDE.invalidateSystem">
<code class="descname">invalidateSystem</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.dcresistivityforwardmodeling.LinearPDE.invalidateSystem" title="Permalink to this definition">¶</a></dt>
<dd><p>Announces that everything has to be rebuilt.</p>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.dcresistivityforwardmodeling.LinearPDE.isComplex">
<code class="descname">isComplex</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.dcresistivityforwardmodeling.LinearPDE.isComplex" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns true if this is a complex-valued LinearProblem, false if
real-valued.</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="docutils literal notranslate"><span class="pre">bool</span></code></td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.dcresistivityforwardmodeling.LinearPDE.isHermitian">
<code class="descname">isHermitian</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.dcresistivityforwardmodeling.LinearPDE.isHermitian" title="Permalink to this definition">¶</a></dt>
<dd><p>Checks if the pde is indicated to be Hermitian.</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">Returns:</th><td class="field-body">True if a Hermitian PDE is indicated, False otherwise</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>
<tr class="field-odd field"><th class="field-name">Note:</th><td class="field-body">the method is equivalent to use getSolverOptions().isHermitian()</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.dcresistivityforwardmodeling.LinearPDE.isOperatorValid">
<code class="descname">isOperatorValid</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.dcresistivityforwardmodeling.LinearPDE.isOperatorValid" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns True if the operator is still valid.</p>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.dcresistivityforwardmodeling.LinearPDE.isRightHandSideValid">
<code class="descname">isRightHandSideValid</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.dcresistivityforwardmodeling.LinearPDE.isRightHandSideValid" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns True if the operator is still valid.</p>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.dcresistivityforwardmodeling.LinearPDE.isSolutionValid">
<code class="descname">isSolutionValid</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.dcresistivityforwardmodeling.LinearPDE.isSolutionValid" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns True if the solution is still valid.</p>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.dcresistivityforwardmodeling.LinearPDE.isSymmetric">
<code class="descname">isSymmetric</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.dcresistivityforwardmodeling.LinearPDE.isSymmetric" title="Permalink to this definition">¶</a></dt>
<dd><p>Checks if symmetry is indicated.</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">Returns:</th><td class="field-body">True if a symmetric PDE is indicated, False otherwise</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>
<tr class="field-odd field"><th class="field-name">Note:</th><td class="field-body">the method is equivalent to use getSolverOptions().isSymmetric()</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.dcresistivityforwardmodeling.LinearPDE.isSystemValid">
<code class="descname">isSystemValid</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.dcresistivityforwardmodeling.LinearPDE.isSystemValid" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns True if the system (including solution) is still vaild.</p>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.dcresistivityforwardmodeling.LinearPDE.isUsingLumping">
<code class="descname">isUsingLumping</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.dcresistivityforwardmodeling.LinearPDE.isUsingLumping" title="Permalink to this definition">¶</a></dt>
<dd><p>Checks if matrix lumping is the current solver method.</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">Returns:</th><td class="field-body">True if the current solver method is lumping</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.downunder.dcresistivityforwardmodeling.LinearPDE.preservePreconditioner">
<code class="descname">preservePreconditioner</code><span class="sig-paren">(</span><em>preserve=True</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.dcresistivityforwardmodeling.LinearPDE.preservePreconditioner" title="Permalink to this definition">¶</a></dt>
<dd><p>Notifies the PDE that the preconditioner should not be reset when
making changes to the operator.</p>
<p>Building the preconditioner data can be quite expensive (e.g. for
multigrid methods) so if it is known that changes to the operator are
going to be minor calling this method can speed up successive PDE
solves.</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">Note:</th><td class="field-body">Not all operator types support this.</td>
</tr>
<tr class="field-even field"><th class="field-name">Parameters:</th><td class="field-body"><strong>preserve</strong> (<code class="docutils literal notranslate"><span class="pre">bool</span></code>) – if True, preconditioner will be preserved, otherwise
it will be reset when making changes to the operator,
which is the default behaviour.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.dcresistivityforwardmodeling.LinearPDE.reduceEquationOrder">
<code class="descname">reduceEquationOrder</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.dcresistivityforwardmodeling.LinearPDE.reduceEquationOrder" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the status of order reduction for the equation.</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">Returns:</th><td class="field-body">True if reduced interpolation order is used for the
representation of the equation, False otherwise</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.downunder.dcresistivityforwardmodeling.LinearPDE.reduceSolutionOrder">
<code class="descname">reduceSolutionOrder</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.dcresistivityforwardmodeling.LinearPDE.reduceSolutionOrder" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the status of order reduction for the solution.</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">Returns:</th><td class="field-body">True if reduced interpolation order is used for the
representation of the solution, False otherwise</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.downunder.dcresistivityforwardmodeling.LinearPDE.resetAllCoefficients">
<code class="descname">resetAllCoefficients</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.dcresistivityforwardmodeling.LinearPDE.resetAllCoefficients" title="Permalink to this definition">¶</a></dt>
<dd><p>Resets all coefficients to their default values.</p>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.dcresistivityforwardmodeling.LinearPDE.resetOperator">
<code class="descname">resetOperator</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.dcresistivityforwardmodeling.LinearPDE.resetOperator" title="Permalink to this definition">¶</a></dt>
<dd><p>Makes sure that the operator is instantiated and returns it initialized
with zeros.</p>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.dcresistivityforwardmodeling.LinearPDE.resetRightHandSide">
<code class="descname">resetRightHandSide</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.dcresistivityforwardmodeling.LinearPDE.resetRightHandSide" title="Permalink to this definition">¶</a></dt>
<dd><p>Sets the right hand side to zero.</p>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.dcresistivityforwardmodeling.LinearPDE.resetRightHandSideCoefficients">
<code class="descname">resetRightHandSideCoefficients</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.dcresistivityforwardmodeling.LinearPDE.resetRightHandSideCoefficients" title="Permalink to this definition">¶</a></dt>
<dd><p>Resets all coefficients defining the right hand side</p>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.dcresistivityforwardmodeling.LinearPDE.resetSolution">
<code class="descname">resetSolution</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.dcresistivityforwardmodeling.LinearPDE.resetSolution" title="Permalink to this definition">¶</a></dt>
<dd><p>Sets the solution to zero.</p>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.dcresistivityforwardmodeling.LinearPDE.setDebug">
<code class="descname">setDebug</code><span class="sig-paren">(</span><em>flag</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.dcresistivityforwardmodeling.LinearPDE.setDebug" title="Permalink to this definition">¶</a></dt>
<dd><p>Switches debug output on if <code class="docutils literal notranslate"><span class="pre">flag</span></code> is True otherwise it is switched off.</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>flag</strong> (<code class="docutils literal notranslate"><span class="pre">bool</span></code>) – desired debug status</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.dcresistivityforwardmodeling.LinearPDE.setDebugOff">
<code class="descname">setDebugOff</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.dcresistivityforwardmodeling.LinearPDE.setDebugOff" title="Permalink to this definition">¶</a></dt>
<dd><p>Switches debug output off.</p>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.dcresistivityforwardmodeling.LinearPDE.setDebugOn">
<code class="descname">setDebugOn</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.dcresistivityforwardmodeling.LinearPDE.setDebugOn" title="Permalink to this definition">¶</a></dt>
<dd><p>Switches debug output on.</p>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.dcresistivityforwardmodeling.LinearPDE.setHermitian">
<code class="descname">setHermitian</code><span class="sig-paren">(</span><em>flag=False</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.dcresistivityforwardmodeling.LinearPDE.setHermitian" title="Permalink to this definition">¶</a></dt>
<dd><p>Sets the Hermitian flag to <code class="docutils literal notranslate"><span class="pre">flag</span></code>.</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>flag</strong> (<code class="docutils literal notranslate"><span class="pre">bool</span></code>) – If True, the Hermitian flag is set otherwise reset.</td>
</tr>
<tr class="field-even field"><th class="field-name">Note:</th><td class="field-body">The method overwrites the Hermitian flag set by the solver options</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.dcresistivityforwardmodeling.LinearPDE.setHermitianOff">
<code class="descname">setHermitianOff</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.dcresistivityforwardmodeling.LinearPDE.setHermitianOff" title="Permalink to this definition">¶</a></dt>
<dd><p>Clears the Hermitian flag.
:note: The method overwrites the Hermitian flag set by the solver options</p>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.dcresistivityforwardmodeling.LinearPDE.setHermitianOn">
<code class="descname">setHermitianOn</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.dcresistivityforwardmodeling.LinearPDE.setHermitianOn" title="Permalink to this definition">¶</a></dt>
<dd><p>Sets the Hermitian flag.
:note: The method overwrites the Hermitian flag set by the solver options</p>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.dcresistivityforwardmodeling.LinearPDE.setReducedOrderForEquationOff">
<code class="descname">setReducedOrderForEquationOff</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.dcresistivityforwardmodeling.LinearPDE.setReducedOrderForEquationOff" title="Permalink to this definition">¶</a></dt>
<dd><p>Switches reduced order off for equation representation.</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">Raises:</th><td class="field-body"><strong>RuntimeError</strong> – if order reduction is altered after a coefficient has
been set</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.dcresistivityforwardmodeling.LinearPDE.setReducedOrderForEquationOn">
<code class="descname">setReducedOrderForEquationOn</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.dcresistivityforwardmodeling.LinearPDE.setReducedOrderForEquationOn" title="Permalink to this definition">¶</a></dt>
<dd><p>Switches reduced order on for equation representation.</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">Raises:</th><td class="field-body"><strong>RuntimeError</strong> – if order reduction is altered after a coefficient has
been set</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.dcresistivityforwardmodeling.LinearPDE.setReducedOrderForEquationTo">
<code class="descname">setReducedOrderForEquationTo</code><span class="sig-paren">(</span><em>flag=False</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.dcresistivityforwardmodeling.LinearPDE.setReducedOrderForEquationTo" title="Permalink to this definition">¶</a></dt>
<dd><p>Sets order reduction state for equation representation according to flag.</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>flag</strong> (<code class="docutils literal notranslate"><span class="pre">bool</span></code>) – if flag is True, the order reduction is switched on for
equation representation, otherwise or if flag is not present
order reduction is switched off</td>
</tr>
<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><strong>RuntimeError</strong> – if order reduction is altered after a coefficient has
been set</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.dcresistivityforwardmodeling.LinearPDE.setReducedOrderForSolutionOff">
<code class="descname">setReducedOrderForSolutionOff</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.dcresistivityforwardmodeling.LinearPDE.setReducedOrderForSolutionOff" title="Permalink to this definition">¶</a></dt>
<dd><p>Switches reduced order off for solution representation</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">Raises:</th><td class="field-body"><strong>RuntimeError</strong> – if order reduction is altered after a coefficient has
been set.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.dcresistivityforwardmodeling.LinearPDE.setReducedOrderForSolutionOn">
<code class="descname">setReducedOrderForSolutionOn</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.dcresistivityforwardmodeling.LinearPDE.setReducedOrderForSolutionOn" title="Permalink to this definition">¶</a></dt>
<dd><p>Switches reduced order on for solution representation.</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">Raises:</th><td class="field-body"><strong>RuntimeError</strong> – if order reduction is altered after a coefficient has
been set</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.dcresistivityforwardmodeling.LinearPDE.setReducedOrderForSolutionTo">
<code class="descname">setReducedOrderForSolutionTo</code><span class="sig-paren">(</span><em>flag=False</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.dcresistivityforwardmodeling.LinearPDE.setReducedOrderForSolutionTo" title="Permalink to this definition">¶</a></dt>
<dd><p>Sets order reduction state for solution representation according to flag.</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>flag</strong> (<code class="docutils literal notranslate"><span class="pre">bool</span></code>) – if flag is True, the order reduction is switched on for
solution representation, otherwise or if flag is not present
order reduction is switched off</td>
</tr>
<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><strong>RuntimeError</strong> – if order reduction is altered after a coefficient has
been set</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.dcresistivityforwardmodeling.LinearPDE.setReducedOrderOff">
<code class="descname">setReducedOrderOff</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.dcresistivityforwardmodeling.LinearPDE.setReducedOrderOff" title="Permalink to this definition">¶</a></dt>
<dd><p>Switches reduced order off for solution and equation representation</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">Raises:</th><td class="field-body"><strong>RuntimeError</strong> – if order reduction is altered after a coefficient has
been set</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.dcresistivityforwardmodeling.LinearPDE.setReducedOrderOn">
<code class="descname">setReducedOrderOn</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.dcresistivityforwardmodeling.LinearPDE.setReducedOrderOn" title="Permalink to this definition">¶</a></dt>
<dd><p>Switches reduced order on for solution and equation representation.</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">Raises:</th><td class="field-body"><strong>RuntimeError</strong> – if order reduction is altered after a coefficient has
been set</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.dcresistivityforwardmodeling.LinearPDE.setReducedOrderTo">
<code class="descname">setReducedOrderTo</code><span class="sig-paren">(</span><em>flag=False</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.dcresistivityforwardmodeling.LinearPDE.setReducedOrderTo" title="Permalink to this definition">¶</a></dt>
<dd><p>Sets order reduction state for both solution and equation representation
according to flag.</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>flag</strong> (<code class="docutils literal notranslate"><span class="pre">bool</span></code>) – if True, the order reduction is switched on for both solution
and equation representation, otherwise or if flag is not
present order reduction is switched off</td>
</tr>
<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><strong>RuntimeError</strong> – if order reduction is altered after a coefficient has
been set</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.dcresistivityforwardmodeling.LinearPDE.setSolution">
<code class="descname">setSolution</code><span class="sig-paren">(</span><em>u</em>, <em>validate=True</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.dcresistivityforwardmodeling.LinearPDE.setSolution" title="Permalink to this definition">¶</a></dt>
<dd><p>Sets the solution assuming that makes the system valid with the tolrance
defined by the solver options</p>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.dcresistivityforwardmodeling.LinearPDE.setSolverOptions">
<code class="descname">setSolverOptions</code><span class="sig-paren">(</span><em>options=None</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.dcresistivityforwardmodeling.LinearPDE.setSolverOptions" title="Permalink to this definition">¶</a></dt>
<dd><p>Sets the solver options.</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>options</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">SolverOptions</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code>) – the new solver options. If equal <code class="docutils literal notranslate"><span class="pre">None</span></code>, the solver options are set to the default.</td>
</tr>
<tr class="field-even field"><th class="field-name">Note:</th><td class="field-body">The symmetry flag of options is overwritten by the symmetry flag of the <code class="xref py py-obj docutils literal notranslate"><span class="pre">LinearProblem</span></code>.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.dcresistivityforwardmodeling.LinearPDE.setSymmetry">
<code class="descname">setSymmetry</code><span class="sig-paren">(</span><em>flag=False</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.dcresistivityforwardmodeling.LinearPDE.setSymmetry" title="Permalink to this definition">¶</a></dt>
<dd><p>Sets the symmetry flag to <code class="docutils literal notranslate"><span class="pre">flag</span></code>.</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>flag</strong> (<code class="docutils literal notranslate"><span class="pre">bool</span></code>) – If True, the symmetry flag is set otherwise reset.</td>
</tr>
<tr class="field-even field"><th class="field-name">Note:</th><td class="field-body">The method overwrites the symmetry flag set by the solver options</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.dcresistivityforwardmodeling.LinearPDE.setSymmetryOff">
<code class="descname">setSymmetryOff</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.dcresistivityforwardmodeling.LinearPDE.setSymmetryOff" title="Permalink to this definition">¶</a></dt>
<dd><p>Clears the symmetry flag.
:note: The method overwrites the symmetry flag set by the solver options</p>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.dcresistivityforwardmodeling.LinearPDE.setSymmetryOn">
<code class="descname">setSymmetryOn</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.dcresistivityforwardmodeling.LinearPDE.setSymmetryOn" title="Permalink to this definition">¶</a></dt>
<dd><p>Sets the symmetry flag.
:note: The method overwrites the symmetry flag set by the solver options</p>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.dcresistivityforwardmodeling.LinearPDE.setSystemStatus">
<code class="descname">setSystemStatus</code><span class="sig-paren">(</span><em>status=None</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.dcresistivityforwardmodeling.LinearPDE.setSystemStatus" title="Permalink to this definition">¶</a></dt>
<dd><p>Sets the system status to <code class="docutils literal notranslate"><span class="pre">status</span></code> if <code class="docutils literal notranslate"><span class="pre">status</span></code> is not present the
current status of the domain is used.</p>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.dcresistivityforwardmodeling.LinearPDE.setValue">
<code class="descname">setValue</code><span class="sig-paren">(</span><em>**coefficients</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.dcresistivityforwardmodeling.LinearPDE.setValue" title="Permalink to this definition">¶</a></dt>
<dd><p>Sets new values to coefficients.</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>coefficients</strong> – new values assigned to coefficients</li>
<li><strong>A</strong> (any type that can be cast to a <code class="xref py py-obj docutils literal notranslate"><span class="pre">Data</span></code> object on
<code class="xref py py-obj docutils literal notranslate"><span class="pre">Function</span></code>) – value for coefficient <code class="docutils literal notranslate"><span class="pre">A</span></code></li>
<li><strong>A_reduced</strong> (any type that can be cast to a <code class="xref py py-obj docutils literal notranslate"><span class="pre">Data</span></code>
object on <code class="xref py py-obj docutils literal notranslate"><span class="pre">ReducedFunction</span></code>) – value for coefficient <code class="docutils literal notranslate"><span class="pre">A_reduced</span></code></li>
<li><strong>B</strong> (any type that can be cast to a <code class="xref py py-obj docutils literal notranslate"><span class="pre">Data</span></code> object on
<code class="xref py py-obj docutils literal notranslate"><span class="pre">Function</span></code>) – value for coefficient <code class="docutils literal notranslate"><span class="pre">B</span></code></li>
<li><strong>B_reduced</strong> (any type that can be cast to a <code class="xref py py-obj docutils literal notranslate"><span class="pre">Data</span></code>
object on <code class="xref py py-obj docutils literal notranslate"><span class="pre">ReducedFunction</span></code>) – value for coefficient <code class="docutils literal notranslate"><span class="pre">B_reduced</span></code></li>
<li><strong>C</strong> (any type that can be cast to a <code class="xref py py-obj docutils literal notranslate"><span class="pre">Data</span></code> object on
<code class="xref py py-obj docutils literal notranslate"><span class="pre">Function</span></code>) – value for coefficient <code class="docutils literal notranslate"><span class="pre">C</span></code></li>
<li><strong>C_reduced</strong> (any type that can be cast to a <code class="xref py py-obj docutils literal notranslate"><span class="pre">Data</span></code>
object on <code class="xref py py-obj docutils literal notranslate"><span class="pre">ReducedFunction</span></code>) – value for coefficient <code class="docutils literal notranslate"><span class="pre">C_reduced</span></code></li>
<li><strong>D</strong> (any type that can be cast to a <code class="xref py py-obj docutils literal notranslate"><span class="pre">Data</span></code> object on
<code class="xref py py-obj docutils literal notranslate"><span class="pre">Function</span></code>) – value for coefficient <code class="docutils literal notranslate"><span class="pre">D</span></code></li>
<li><strong>D_reduced</strong> (any type that can be cast to a <code class="xref py py-obj docutils literal notranslate"><span class="pre">Data</span></code>
object on <code class="xref py py-obj docutils literal notranslate"><span class="pre">ReducedFunction</span></code>) – value for coefficient <code class="docutils literal notranslate"><span class="pre">D_reduced</span></code></li>
<li><strong>X</strong> (any type that can be cast to a <code class="xref py py-obj docutils literal notranslate"><span class="pre">Data</span></code> object on
<code class="xref py py-obj docutils literal notranslate"><span class="pre">Function</span></code>) – value for coefficient <code class="docutils literal notranslate"><span class="pre">X</span></code></li>
<li><strong>X_reduced</strong> (any type that can be cast to a <code class="xref py py-obj docutils literal notranslate"><span class="pre">Data</span></code>
object on <code class="xref py py-obj docutils literal notranslate"><span class="pre">ReducedFunction</span></code>) – value for coefficient <code class="docutils literal notranslate"><span class="pre">X_reduced</span></code></li>
<li><strong>Y</strong> (any type that can be cast to a <code class="xref py py-obj docutils literal notranslate"><span class="pre">Data</span></code> object on
<code class="xref py py-obj docutils literal notranslate"><span class="pre">Function</span></code>) – value for coefficient <code class="docutils literal notranslate"><span class="pre">Y</span></code></li>
<li><strong>Y_reduced</strong> (any type that can be cast to a <code class="xref py py-obj docutils literal notranslate"><span class="pre">Data</span></code>
object on <code class="xref py py-obj docutils literal notranslate"><span class="pre">ReducedFunction</span></code>) – value for coefficient <code class="docutils literal notranslate"><span class="pre">Y_reduced</span></code></li>
<li><strong>d</strong> (any type that can be cast to a <code class="xref py py-obj docutils literal notranslate"><span class="pre">Data</span></code> object on
<code class="xref py py-obj docutils literal notranslate"><span class="pre">FunctionOnBoundary</span></code>) – value for coefficient <code class="docutils literal notranslate"><span class="pre">d</span></code></li>
<li><strong>d_reduced</strong> (any type that can be cast to a <code class="xref py py-obj docutils literal notranslate"><span class="pre">Data</span></code>
object on <code class="xref py py-obj docutils literal notranslate"><span class="pre">ReducedFunctionOnBoundary</span></code>) – value for coefficient <code class="docutils literal notranslate"><span class="pre">d_reduced</span></code></li>
<li><strong>y</strong> (any type that can be cast to a <code class="xref py py-obj docutils literal notranslate"><span class="pre">Data</span></code> object on
<code class="xref py py-obj docutils literal notranslate"><span class="pre">FunctionOnBoundary</span></code>) – value for coefficient <code class="docutils literal notranslate"><span class="pre">y</span></code></li>
<li><strong>d_contact</strong> (any type that can be cast to a <code class="xref py py-obj docutils literal notranslate"><span class="pre">Data</span></code>
object on <code class="xref py py-obj docutils literal notranslate"><span class="pre">FunctionOnContactOne</span></code>
or <code class="xref py py-obj docutils literal notranslate"><span class="pre">FunctionOnContactZero</span></code>) – value for coefficient <code class="docutils literal notranslate"><span class="pre">d_contact</span></code></li>
<li><strong>d_contact_reduced</strong> (any type that can be cast to a <code class="xref py py-obj docutils literal notranslate"><span class="pre">Data</span></code>
object on <code class="xref py py-obj docutils literal notranslate"><span class="pre">ReducedFunctionOnContactOne</span></code>
or <code class="xref py py-obj docutils literal notranslate"><span class="pre">ReducedFunctionOnContactZero</span></code>) – value for coefficient <code class="docutils literal notranslate"><span class="pre">d_contact_reduced</span></code></li>
<li><strong>y_contact</strong> (any type that can be cast to a <code class="xref py py-obj docutils literal notranslate"><span class="pre">Data</span></code>
object on <code class="xref py py-obj docutils literal notranslate"><span class="pre">FunctionOnContactOne</span></code>
or <code class="xref py py-obj docutils literal notranslate"><span class="pre">FunctionOnContactZero</span></code>) – value for coefficient <code class="docutils literal notranslate"><span class="pre">y_contact</span></code></li>
<li><strong>y_contact_reduced</strong> (any type that can be cast to a <code class="xref py py-obj docutils literal notranslate"><span class="pre">Data</span></code>
object on <code class="xref py py-obj docutils literal notranslate"><span class="pre">ReducedFunctionOnContactOne</span></code>
or <code class="xref py py-obj docutils literal notranslate"><span class="pre">ReducedFunctionOnContactZero</span></code>) – value for coefficient <code class="docutils literal notranslate"><span class="pre">y_contact_reduced</span></code></li>
<li><strong>d_dirac</strong> (any type that can be cast to a <code class="xref py py-obj docutils literal notranslate"><span class="pre">Data</span></code> object on <code class="xref py py-obj docutils literal notranslate"><span class="pre">DiracDeltaFunctions</span></code>) – value for coefficient <code class="docutils literal notranslate"><span class="pre">d_dirac</span></code></li>
<li><strong>y_dirac</strong> (any type that can be cast to a <code class="xref py py-obj docutils literal notranslate"><span class="pre">Data</span></code> object on <code class="xref py py-obj docutils literal notranslate"><span class="pre">DiracDeltaFunctions</span></code>) – value for coefficient <code class="docutils literal notranslate"><span class="pre">y_dirac</span></code></li>
<li><strong>r</strong> (any type that can be cast to a <code class="xref py py-obj docutils literal notranslate"><span class="pre">Data</span></code> object on
<code class="xref py py-obj docutils literal notranslate"><span class="pre">Solution</span></code> or <code class="xref py py-obj docutils literal notranslate"><span class="pre">ReducedSolution</span></code>
depending on whether reduced order is used for the solution) – values prescribed to the solution at the locations of
constraints</li>
<li><strong>q</strong> (any type that can be cast to a <code class="xref py py-obj docutils literal notranslate"><span class="pre">Data</span></code> object on
<code class="xref py py-obj docutils literal notranslate"><span class="pre">Solution</span></code> or <code class="xref py py-obj docutils literal notranslate"><span class="pre">ReducedSolution</span></code>
depending on whether reduced order is used for the
representation of the equation) – mask for location of constraints</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><p class="first last"><a class="reference internal" href="esys.escript.linearPDEs.html#esys.escript.linearPDEs.IllegalCoefficient" title="esys.escript.linearPDEs.IllegalCoefficient"><strong>IllegalCoefficient</strong></a> – if an unknown coefficient keyword is used</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.dcresistivityforwardmodeling.LinearPDE.shouldPreservePreconditioner">
<code class="descname">shouldPreservePreconditioner</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.dcresistivityforwardmodeling.LinearPDE.shouldPreservePreconditioner" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns true if the preconditioner / factorisation should be kept even
when resetting the operator.</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="docutils literal notranslate"><span class="pre">bool</span></code></td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.dcresistivityforwardmodeling.LinearPDE.trace">
<code class="descname">trace</code><span class="sig-paren">(</span><em>text</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.dcresistivityforwardmodeling.LinearPDE.trace" title="Permalink to this definition">¶</a></dt>
<dd><p>Prints the text message if debug mode is switched on.</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>text</strong> (<code class="docutils literal notranslate"><span class="pre">string</span></code>) – message to be printed</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.dcresistivityforwardmodeling.LinearPDE.validOperator">
<code class="descname">validOperator</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.dcresistivityforwardmodeling.LinearPDE.validOperator" title="Permalink to this definition">¶</a></dt>
<dd><p>Marks the operator as valid.</p>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.dcresistivityforwardmodeling.LinearPDE.validRightHandSide">
<code class="descname">validRightHandSide</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.dcresistivityforwardmodeling.LinearPDE.validRightHandSide" title="Permalink to this definition">¶</a></dt>
<dd><p>Marks the right hand side as valid.</p>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.dcresistivityforwardmodeling.LinearPDE.validSolution">
<code class="descname">validSolution</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.dcresistivityforwardmodeling.LinearPDE.validSolution" title="Permalink to this definition">¶</a></dt>
<dd><p>Marks the solution as valid.</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="esys.downunder.dcresistivityforwardmodeling.Locator">
<em class="property">class </em><code class="descclassname">esys.downunder.dcresistivityforwardmodeling.</code><code class="descname">Locator</code><span class="sig-paren">(</span><em>where</em>, <em>x=array([0.</em>, <em>0.</em>, <em>0.])</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.dcresistivityforwardmodeling.Locator" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
<p>Locator provides access to the values of data objects at a given spatial
coordinate x.</p>
<p>In fact, a Locator object finds the sample in the set of samples of a
given function space or domain which is closest to the given point x.</p>
<dl class="method">
<dt id="esys.downunder.dcresistivityforwardmodeling.Locator.__init__">
<code class="descname">__init__</code><span class="sig-paren">(</span><em>where</em>, <em>x=array([0.</em>, <em>0.</em>, <em>0.])</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.dcresistivityforwardmodeling.Locator.__init__" title="Permalink to this definition">¶</a></dt>
<dd><p>Initializes a Locator to access values in Data objects on the Doamin
or FunctionSpace for the sample point which is closest to the given
point x.</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>where</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">escript.FunctionSpace</span></code>) – function space</li>
<li><strong>x</strong> (<code class="docutils literal notranslate"><span class="pre">numpy.ndarray</span></code> or <code class="docutils literal notranslate"><span class="pre">list</span></code> of <code class="docutils literal notranslate"><span class="pre">numpy.ndarray</span></code>) – location(s) of the Locator</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.dcresistivityforwardmodeling.Locator.getFunctionSpace">
<code class="descname">getFunctionSpace</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.dcresistivityforwardmodeling.Locator.getFunctionSpace" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the function space of the Locator.</p>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.dcresistivityforwardmodeling.Locator.getId">
<code class="descname">getId</code><span class="sig-paren">(</span><em>item=None</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.dcresistivityforwardmodeling.Locator.getId" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the identifier of the location.</p>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.dcresistivityforwardmodeling.Locator.getValue">
<code class="descname">getValue</code><span class="sig-paren">(</span><em>data</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.dcresistivityforwardmodeling.Locator.getValue" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the value of <code class="docutils literal notranslate"><span class="pre">data</span></code> at the Locator if <code class="docutils literal notranslate"><span class="pre">data</span></code> is a <code class="xref py py-obj docutils literal notranslate"><span class="pre">Data</span></code>
object otherwise the object is returned.</p>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.dcresistivityforwardmodeling.Locator.getX">
<code class="descname">getX</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.dcresistivityforwardmodeling.Locator.getX" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the exact coordinates of the Locator.</p>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.dcresistivityforwardmodeling.Locator.setValue">
<code class="descname">setValue</code><span class="sig-paren">(</span><em>data</em>, <em>v</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.dcresistivityforwardmodeling.Locator.setValue" title="Permalink to this definition">¶</a></dt>
<dd><p>Sets the value of the <code class="docutils literal notranslate"><span class="pre">data</span></code> at the Locator.</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="esys.downunder.dcresistivityforwardmodeling.PoleDipoleSurvey">
<em class="property">class </em><code class="descclassname">esys.downunder.dcresistivityforwardmodeling.</code><code class="descname">PoleDipoleSurvey</code><span class="sig-paren">(</span><em>domain</em>, <em>primaryConductivity</em>, <em>secondaryConductivity</em>, <em>current</em>, <em>a</em>, <em>n</em>, <em>midPoint</em>, <em>directionVector</em>, <em>numElectrodes</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.dcresistivityforwardmodeling.PoleDipoleSurvey" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#esys.downunder.dcresistivityforwardmodeling.DcResistivityForward" title="esys.downunder.dcresistivityforwardmodeling.DcResistivityForward"><code class="xref py py-class docutils literal notranslate"><span class="pre">esys.downunder.dcresistivityforwardmodeling.DcResistivityForward</span></code></a></p>
<p>Forward model class for a poledipole setup</p>
<dl class="method">
<dt id="esys.downunder.dcresistivityforwardmodeling.PoleDipoleSurvey.__init__">
<code class="descname">__init__</code><span class="sig-paren">(</span><em>domain</em>, <em>primaryConductivity</em>, <em>secondaryConductivity</em>, <em>current</em>, <em>a</em>, <em>n</em>, <em>midPoint</em>, <em>directionVector</em>, <em>numElectrodes</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.dcresistivityforwardmodeling.PoleDipoleSurvey.__init__" 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>domain</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">Domain</span></code>) – domain of the model</li>
<li><strong>primaryConductivity</strong> (<em>data</em>) – preset primary conductivity data object</li>
<li><strong>secondaryConductivity</strong> (<em>data</em>) – preset secondary conductivity data object</li>
<li><strong>current</strong> (<em>float</em><em> or </em><em>int</em>) – amount of current to be injected at the current electrode</li>
<li><strong>a</strong> (<em>list</em>) – the spacing between current and potential electrodes</li>
<li><strong>n</strong> (<em>float</em><em> or </em><em>int</em>) – multiple of spacing between electrodes. typicaly interger</li>
<li><strong>midPoint</strong> – midPoint of the survey, as a list containing x,y coords</li>
<li><strong>directionVector</strong> – two element list specifying the direction the
survey should extend from the midpoint</li>
<li><strong>numElectrodes</strong> (<em>int</em>) – the number of electrodes to be used in the survey
must be a multiple of 2 for polepole survey:</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.dcresistivityforwardmodeling.PoleDipoleSurvey.checkBounds">
<code class="descname">checkBounds</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.dcresistivityforwardmodeling.PoleDipoleSurvey.checkBounds" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="esys.downunder.dcresistivityforwardmodeling.PoleDipoleSurvey.getApparentResistivity">
<code class="descname">getApparentResistivity</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.dcresistivityforwardmodeling.PoleDipoleSurvey.getApparentResistivity" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="esys.downunder.dcresistivityforwardmodeling.PoleDipoleSurvey.getApparentResistivityPrimary">
<code class="descname">getApparentResistivityPrimary</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.dcresistivityforwardmodeling.PoleDipoleSurvey.getApparentResistivityPrimary" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="esys.downunder.dcresistivityforwardmodeling.PoleDipoleSurvey.getApparentResistivitySecondary">
<code class="descname">getApparentResistivitySecondary</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.dcresistivityforwardmodeling.PoleDipoleSurvey.getApparentResistivitySecondary" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="esys.downunder.dcresistivityforwardmodeling.PoleDipoleSurvey.getApparentResistivityTotal">
<code class="descname">getApparentResistivityTotal</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.dcresistivityforwardmodeling.PoleDipoleSurvey.getApparentResistivityTotal" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="esys.downunder.dcresistivityforwardmodeling.PoleDipoleSurvey.getElectrodes">
<code class="descname">getElectrodes</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.dcresistivityforwardmodeling.PoleDipoleSurvey.getElectrodes" title="Permalink to this definition">¶</a></dt>
<dd><p>retuns the list of electrodes with locations</p>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.dcresistivityforwardmodeling.PoleDipoleSurvey.getPotential">
<code class="descname">getPotential</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.dcresistivityforwardmodeling.PoleDipoleSurvey.getPotential" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns 3 list each made up of a number of list containing primary, secondary and total
potentials diferences. Each of the lists contain a list for each value of n.</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="esys.downunder.dcresistivityforwardmodeling.PolePoleSurvey">
<em class="property">class </em><code class="descclassname">esys.downunder.dcresistivityforwardmodeling.</code><code class="descname">PolePoleSurvey</code><span class="sig-paren">(</span><em>domain</em>, <em>primaryConductivity</em>, <em>secondaryConductivity</em>, <em>current</em>, <em>a</em>, <em>midPoint</em>, <em>directionVector</em>, <em>numElectrodes</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.dcresistivityforwardmodeling.PolePoleSurvey" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#esys.downunder.dcresistivityforwardmodeling.DcResistivityForward" title="esys.downunder.dcresistivityforwardmodeling.DcResistivityForward"><code class="xref py py-class docutils literal notranslate"><span class="pre">esys.downunder.dcresistivityforwardmodeling.DcResistivityForward</span></code></a></p>
<p>Forward model class for a polepole setup</p>
<dl class="method">
<dt id="esys.downunder.dcresistivityforwardmodeling.PolePoleSurvey.__init__">
<code class="descname">__init__</code><span class="sig-paren">(</span><em>domain</em>, <em>primaryConductivity</em>, <em>secondaryConductivity</em>, <em>current</em>, <em>a</em>, <em>midPoint</em>, <em>directionVector</em>, <em>numElectrodes</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.dcresistivityforwardmodeling.PolePoleSurvey.__init__" 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>domain</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">Domain</span></code>) – domain of the model</li>
<li><strong>primaryConductivity</strong> (<em>data</em>) – preset primary conductivity data object</li>
<li><strong>secondaryConductivity</strong> (<em>data</em>) – preset secondary conductivity data object</li>
<li><strong>current</strong> (<em>float</em><em> or </em><em>int</em>) – amount of current to be injected at the current electrode</li>
<li><strong>a</strong> (<em>list</em>) – the spacing between current and potential electrodes</li>
<li><strong>midPoint</strong> – midPoint of the survey, as a list containing x,y coords</li>
<li><strong>directionVector</strong> – two element list specifying the direction the
survey should extend from the midpoint</li>
<li><strong>numElectrodes</strong> (<em>int</em>) – the number of electrodes to be used in the survey
must be a multiple of 2 for polepole survey:</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.dcresistivityforwardmodeling.PolePoleSurvey.checkBounds">
<code class="descname">checkBounds</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.dcresistivityforwardmodeling.PolePoleSurvey.checkBounds" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="esys.downunder.dcresistivityforwardmodeling.PolePoleSurvey.getApparentResistivity">
<code class="descname">getApparentResistivity</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.dcresistivityforwardmodeling.PolePoleSurvey.getApparentResistivity" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="esys.downunder.dcresistivityforwardmodeling.PolePoleSurvey.getApparentResistivityPrimary">
<code class="descname">getApparentResistivityPrimary</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.dcresistivityforwardmodeling.PolePoleSurvey.getApparentResistivityPrimary" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="esys.downunder.dcresistivityforwardmodeling.PolePoleSurvey.getApparentResistivitySecondary">
<code class="descname">getApparentResistivitySecondary</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.dcresistivityforwardmodeling.PolePoleSurvey.getApparentResistivitySecondary" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="esys.downunder.dcresistivityforwardmodeling.PolePoleSurvey.getApparentResistivityTotal">
<code class="descname">getApparentResistivityTotal</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.dcresistivityforwardmodeling.PolePoleSurvey.getApparentResistivityTotal" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="esys.downunder.dcresistivityforwardmodeling.PolePoleSurvey.getElectrodes">
<code class="descname">getElectrodes</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.dcresistivityforwardmodeling.PolePoleSurvey.getElectrodes" title="Permalink to this definition">¶</a></dt>
<dd><p>retuns the list of electrodes with locations</p>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.dcresistivityforwardmodeling.PolePoleSurvey.getPotential">
<code class="descname">getPotential</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.dcresistivityforwardmodeling.PolePoleSurvey.getPotential" title="Permalink to this definition">¶</a></dt>
<dd><p>returns a list containing 3 lists one for each the primary, secondary
and total potential.</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="esys.downunder.dcresistivityforwardmodeling.SchlumbergerSurvey">
<em class="property">class </em><code class="descclassname">esys.downunder.dcresistivityforwardmodeling.</code><code class="descname">SchlumbergerSurvey</code><span class="sig-paren">(</span><em>domain</em>, <em>primaryConductivity</em>, <em>secondaryConductivity</em>, <em>current</em>, <em>a</em>, <em>n</em>, <em>midPoint</em>, <em>directionVector</em>, <em>numElectrodes</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.dcresistivityforwardmodeling.SchlumbergerSurvey" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#esys.downunder.dcresistivityforwardmodeling.DcResistivityForward" title="esys.downunder.dcresistivityforwardmodeling.DcResistivityForward"><code class="xref py py-class docutils literal notranslate"><span class="pre">esys.downunder.dcresistivityforwardmodeling.DcResistivityForward</span></code></a></p>
<p>Schlumberger survey forward calculation</p>
<dl class="method">
<dt id="esys.downunder.dcresistivityforwardmodeling.SchlumbergerSurvey.__init__">
<code class="descname">__init__</code><span class="sig-paren">(</span><em>domain</em>, <em>primaryConductivity</em>, <em>secondaryConductivity</em>, <em>current</em>, <em>a</em>, <em>n</em>, <em>midPoint</em>, <em>directionVector</em>, <em>numElectrodes</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.dcresistivityforwardmodeling.SchlumbergerSurvey.__init__" title="Permalink to this definition">¶</a></dt>
<dd><p>This is a skeleton class for all the other forward modeling classes.</p>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.dcresistivityforwardmodeling.SchlumbergerSurvey.checkBounds">
<code class="descname">checkBounds</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.dcresistivityforwardmodeling.SchlumbergerSurvey.checkBounds" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="esys.downunder.dcresistivityforwardmodeling.SchlumbergerSurvey.getApparentResistivity">
<code class="descname">getApparentResistivity</code><span class="sig-paren">(</span><em>delPhiList</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.dcresistivityforwardmodeling.SchlumbergerSurvey.getApparentResistivity" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="esys.downunder.dcresistivityforwardmodeling.SchlumbergerSurvey.getElectrodeDict">
<code class="descname">getElectrodeDict</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.dcresistivityforwardmodeling.SchlumbergerSurvey.getElectrodeDict" title="Permalink to this definition">¶</a></dt>
<dd><p>retuns the electrode dictionary</p>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.dcresistivityforwardmodeling.SchlumbergerSurvey.getElectrodes">
<code class="descname">getElectrodes</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.dcresistivityforwardmodeling.SchlumbergerSurvey.getElectrodes" title="Permalink to this definition">¶</a></dt>
<dd><p>retuns the list of electrodes with locations</p>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.dcresistivityforwardmodeling.SchlumbergerSurvey.getPotential">
<code class="descname">getPotential</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.dcresistivityforwardmodeling.SchlumbergerSurvey.getPotential" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="esys.downunder.dcresistivityforwardmodeling.SchlumbergerSurvey.getPotentialAnalytic">
<code class="descname">getPotentialAnalytic</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.dcresistivityforwardmodeling.SchlumbergerSurvey.getPotentialAnalytic" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns 3 list each made up of a number of list containing primary, secondary and total
potentials diferences. Each of the lists contain a list for each value of n.</p>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.dcresistivityforwardmodeling.SchlumbergerSurvey.getPotentialNumeric">
<code class="descname">getPotentialNumeric</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.dcresistivityforwardmodeling.SchlumbergerSurvey.getPotentialNumeric" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns 3 list each made up of a number of list containing primary, secondary and total
potentials diferences. Each of the lists contain a list for each value of n.</p>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.dcresistivityforwardmodeling.SchlumbergerSurvey.getSourcesSamples">
<code class="descname">getSourcesSamples</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.dcresistivityforwardmodeling.SchlumbergerSurvey.getSourcesSamples" title="Permalink to this definition">¶</a></dt>
<dd><p>return a list of tuples of sample locations followed by a list of tuples
of source locations.</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="esys.downunder.dcresistivityforwardmodeling.WennerSurvey">
<em class="property">class </em><code class="descclassname">esys.downunder.dcresistivityforwardmodeling.</code><code class="descname">WennerSurvey</code><span class="sig-paren">(</span><em>domain</em>, <em>primaryConductivity</em>, <em>secondaryConductivity</em>, <em>current</em>, <em>a</em>, <em>midPoint</em>, <em>directionVector</em>, <em>numElectrodes</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.dcresistivityforwardmodeling.WennerSurvey" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#esys.downunder.dcresistivityforwardmodeling.DcResistivityForward" title="esys.downunder.dcresistivityforwardmodeling.DcResistivityForward"><code class="xref py py-class docutils literal notranslate"><span class="pre">esys.downunder.dcresistivityforwardmodeling.DcResistivityForward</span></code></a></p>
<p>WennerSurvey forward calculation</p>
<dl class="method">
<dt id="esys.downunder.dcresistivityforwardmodeling.WennerSurvey.__init__">
<code class="descname">__init__</code><span class="sig-paren">(</span><em>domain</em>, <em>primaryConductivity</em>, <em>secondaryConductivity</em>, <em>current</em>, <em>a</em>, <em>midPoint</em>, <em>directionVector</em>, <em>numElectrodes</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.dcresistivityforwardmodeling.WennerSurvey.__init__" 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>domain</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">Domain</span></code>) – domain of the model</li>
<li><strong>primaryConductivity</strong> (<code class="docutils literal notranslate"><span class="pre">data</span></code>) – preset primary conductivity data object</li>
<li><strong>secondaryConductivity</strong> (<code class="docutils literal notranslate"><span class="pre">data</span></code>) – preset secondary conductivity data object</li>
<li><strong>current</strong> (<code class="docutils literal notranslate"><span class="pre">float</span></code> or <code class="docutils literal notranslate"><span class="pre">int</span></code>) – amount of current to be injected at the current electrode</li>
<li><strong>a</strong> (<code class="docutils literal notranslate"><span class="pre">list</span></code>) – the spacing between current and potential electrodes</li>
<li><strong>midPoint</strong> – midPoint of the survey, as a list containing x,y coords</li>
<li><strong>directionVector</strong> – two element list specifying the direction the
survey should extend from the midpoint</li>
<li><strong>numElectrodes</strong> (<code class="docutils literal notranslate"><span class="pre">int</span></code>) – the number of electrodes to be used in the survey
must be a multiple of 2 for polepole survey</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.dcresistivityforwardmodeling.WennerSurvey.checkBounds">
<code class="descname">checkBounds</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.dcresistivityforwardmodeling.WennerSurvey.checkBounds" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="esys.downunder.dcresistivityforwardmodeling.WennerSurvey.getApparentResistivity">
<code class="descname">getApparentResistivity</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.dcresistivityforwardmodeling.WennerSurvey.getApparentResistivity" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="esys.downunder.dcresistivityforwardmodeling.WennerSurvey.getApparentResistivityPrimary">
<code class="descname">getApparentResistivityPrimary</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.dcresistivityforwardmodeling.WennerSurvey.getApparentResistivityPrimary" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="esys.downunder.dcresistivityforwardmodeling.WennerSurvey.getApparentResistivitySecondary">
<code class="descname">getApparentResistivitySecondary</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.dcresistivityforwardmodeling.WennerSurvey.getApparentResistivitySecondary" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="esys.downunder.dcresistivityforwardmodeling.WennerSurvey.getApparentResistivityTotal">
<code class="descname">getApparentResistivityTotal</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.dcresistivityforwardmodeling.WennerSurvey.getApparentResistivityTotal" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="esys.downunder.dcresistivityforwardmodeling.WennerSurvey.getElectrodes">
<code class="descname">getElectrodes</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.dcresistivityforwardmodeling.WennerSurvey.getElectrodes" title="Permalink to this definition">¶</a></dt>
<dd><p>retuns the list of electrodes with locations</p>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.dcresistivityforwardmodeling.WennerSurvey.getPotential">
<code class="descname">getPotential</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.dcresistivityforwardmodeling.WennerSurvey.getPotential" title="Permalink to this definition">¶</a></dt>
<dd><p>returns a list containing 3 lists one for each the primary, secondary
and total potential.</p>
</dd></dl>
</dd></dl>
<dl class="attribute">
<dt id="esys.downunder.dcresistivityforwardmodeling.xrange">
<code class="descclassname">esys.downunder.dcresistivityforwardmodeling.</code><code class="descname">xrange</code><a class="headerlink" href="#esys.downunder.dcresistivityforwardmodeling.xrange" title="Permalink to this definition">¶</a></dt>
<dd><p>alias of <code class="xref py py-class docutils literal notranslate"><span class="pre">builtins.range</span></code></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.downunder.dcresistivityforwardmodeling.saveSilo">
<code class="descclassname">esys.downunder.dcresistivityforwardmodeling.</code><code class="descname">saveSilo</code><span class="sig-paren">(</span><em>filename</em>, <em>domain=None</em>, <em>write_meshdata=False</em>, <em>time=0.0</em>, <em>cycle=0</em>, <em>**data</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.dcresistivityforwardmodeling.saveSilo" title="Permalink to this definition">¶</a></dt>
<dd><p>Writes <code class="xref py py-obj docutils literal notranslate"><span class="pre">Data</span></code> objects and their mesh to a file using the SILO file format.</p>
<p>Example:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">temp</span><span class="o">=</span><span class="n">Scalar</span><span class="p">(</span><span class="o">..</span><span class="p">)</span>
<span class="n">v</span><span class="o">=</span><span class="n">Vector</span><span class="p">(</span><span class="o">..</span><span class="p">)</span>
<span class="n">saveSilo</span><span class="p">(</span><span class="s2">"solution.silo"</span><span class="p">,</span> <span class="n">temperature</span><span class="o">=</span><span class="n">temp</span><span class="p">,</span> <span class="n">velocity</span><span class="o">=</span><span class="n">v</span><span class="p">)</span>
</pre></div>
</div>
<p><code class="docutils literal notranslate"><span class="pre">temp</span></code> and <code class="docutils literal notranslate"><span class="pre">v</span></code> are written to “solution.silo” where <code class="docutils literal notranslate"><span class="pre">temp</span></code> is named
“temperature” and <code class="docutils literal notranslate"><span class="pre">v</span></code> is named “velocity”.</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>filename</strong> (<code class="docutils literal notranslate"><span class="pre">str</span></code>) – name of the output file (‘.silo’ is added if required)</li>
<li><strong>domain</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">escript.Domain</span></code>) – domain of the <code class="xref py py-obj docutils literal notranslate"><span class="pre">Data</span></code> objects. If not specified, the domain
of the given <code class="xref py py-obj docutils literal notranslate"><span class="pre">Data</span></code> objects is used.</li>
<li><strong>write_meshdata</strong> (<code class="docutils literal notranslate"><span class="pre">bool</span></code>) – whether to save mesh-related data such as element
identifiers, ownership etc. This is mainly useful
for debugging.</li>
<li><strong>time</strong> (<code class="docutils literal notranslate"><span class="pre">float</span></code>) – the timestamp to save within the file</li>
<li><strong>cycle</strong> (<code class="docutils literal notranslate"><span class="pre">int</span></code>) – the cycle (or timestep) of the data</li>
<li><strong><name></strong> – writes the assigned value to the Silo file using <name> as
identifier</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Note:</th><td class="field-body"><p class="first last">All data objects have to be defined on the same domain but they may
be defined on separate <code class="xref py py-obj docutils literal notranslate"><span class="pre">FunctionSpace</span></code> s.</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
</div>
<div class="section" id="others">
<h2>Others<a class="headerlink" href="#others" title="Permalink to this headline">¶</a></h2>
<ul class="simple">
<li>pi</li>
</ul>
</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.downunder.dcresistivityforwardmodeling 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.downunder.html"
title="previous chapter">esys.downunder Package</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="esys.downunder.domainbuilder.html"
title="next chapter">esys.downunder.domainbuilder 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.downunder.domainbuilder.html" title="esys.downunder.domainbuilder Package"
>next</a> |</li>
<li class="right" >
<a href="esys.downunder.html" title="esys.downunder Package"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">esys.escript 5.6 documentation</a> »</li>
<li class="nav-item nav-item-1"><a href="esys.downunder.html" >esys.downunder Package</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>
|
