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
|
<!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.splitinversioncostfunctions 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.splitminimizers Package" href="esys.downunder.splitminimizers.html" />
<link rel="prev" title="esys.downunder.seismic Package" href="esys.downunder.seismic.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.splitminimizers.html" title="esys.downunder.splitminimizers Package"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="esys.downunder.seismic.html" title="esys.downunder.seismic 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.splitinversioncostfunctions">
<span id="esys-downunder-splitinversioncostfunctions-package"></span><h1>esys.downunder.splitinversioncostfunctions Package<a class="headerlink" href="#module-esys.downunder.splitinversioncostfunctions" 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.splitinversioncostfunctions.ArithmeticTuple" title="esys.downunder.splitinversioncostfunctions.ArithmeticTuple"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ArithmeticTuple</span></code></a></li>
<li><a class="reference internal" href="#esys.downunder.splitinversioncostfunctions.Data" title="esys.downunder.splitinversioncostfunctions.Data"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Data</span></code></a></li>
<li><a class="reference internal" href="#esys.downunder.splitinversioncostfunctions.ForwardModel" title="esys.downunder.splitinversioncostfunctions.ForwardModel"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ForwardModel</span></code></a></li>
<li><a class="reference internal" href="#esys.downunder.splitinversioncostfunctions.FunctionJob" title="esys.downunder.splitinversioncostfunctions.FunctionJob"><code class="xref py py-obj docutils literal notranslate"><span class="pre">FunctionJob</span></code></a></li>
<li><a class="reference internal" href="#esys.downunder.splitinversioncostfunctions.Job" title="esys.downunder.splitinversioncostfunctions.Job"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Job</span></code></a></li>
<li><a class="reference internal" href="#esys.downunder.splitinversioncostfunctions.Mapping" title="esys.downunder.splitinversioncostfunctions.Mapping"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Mapping</span></code></a></li>
<li><a class="reference internal" href="#esys.downunder.splitinversioncostfunctions.MeteredCostFunction" title="esys.downunder.splitinversioncostfunctions.MeteredCostFunction"><code class="xref py py-obj docutils literal notranslate"><span class="pre">MeteredCostFunction</span></code></a></li>
<li><a class="reference internal" href="#esys.downunder.splitinversioncostfunctions.SplitInversionCostFunction" title="esys.downunder.splitinversioncostfunctions.SplitInversionCostFunction"><code class="xref py py-obj docutils literal notranslate"><span class="pre">SplitInversionCostFunction</span></code></a></li>
</ul>
<dl class="class">
<dt id="esys.downunder.splitinversioncostfunctions.ArithmeticTuple">
<em class="property">class </em><code class="descclassname">esys.downunder.splitinversioncostfunctions.</code><code class="descname">ArithmeticTuple</code><span class="sig-paren">(</span><em>*args</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.splitinversioncostfunctions.ArithmeticTuple" 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>Tuple supporting inplace update x+=y and scaling x=a*y where <code class="docutils literal notranslate"><span class="pre">x,y</span></code> is an
ArithmeticTuple and <code class="docutils literal notranslate"><span class="pre">a</span></code> is a float.</p>
<p>Example of usage:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">esys.escript</span> <span class="k">import</span> <span class="n">Data</span>
<span class="kn">from</span> <span class="nn">numpy</span> <span class="k">import</span> <span class="n">array</span>
<span class="n">a</span><span class="o">=</span><span class="n">eData</span><span class="p">(</span><span class="o">...</span><span class="p">)</span>
<span class="n">b</span><span class="o">=</span><span class="n">array</span><span class="p">([</span><span class="mf">1.</span><span class="p">,</span><span class="mf">4.</span><span class="p">])</span>
<span class="n">x</span><span class="o">=</span><span class="n">ArithmeticTuple</span><span class="p">(</span><span class="n">a</span><span class="p">,</span><span class="n">b</span><span class="p">)</span>
<span class="n">y</span><span class="o">=</span><span class="mf">5.</span><span class="o">*</span><span class="n">x</span>
</pre></div>
</div>
<dl class="method">
<dt id="esys.downunder.splitinversioncostfunctions.ArithmeticTuple.__init__">
<code class="descname">__init__</code><span class="sig-paren">(</span><em>*args</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.splitinversioncostfunctions.ArithmeticTuple.__init__" title="Permalink to this definition">¶</a></dt>
<dd><p>Initializes object with elements <code class="docutils literal notranslate"><span class="pre">args</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>args</strong> – tuple of objects that support inplace add (x+=y) and
scaling (x=a*y)</td>
</tr>
</tbody>
</table>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="esys.downunder.splitinversioncostfunctions.Data">
<em class="property">class </em><code class="descclassname">esys.downunder.splitinversioncostfunctions.</code><code class="descname">Data</code><a class="headerlink" href="#esys.downunder.splitinversioncostfunctions.Data" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">Boost.Python.instance</span></code></p>
<p>Represents a collection of datapoints. It is used to store the values of a function. For more details please consult the c++ class documentation.</p>
<dl class="method">
<dt id="esys.downunder.splitinversioncostfunctions.Data.__init__">
<code class="descname">__init__</code><span class="sig-paren">(</span><em>(object)arg1</em><span class="sig-paren">)</span> → None<a class="headerlink" href="#esys.downunder.splitinversioncostfunctions.Data.__init__" title="Permalink to this definition">¶</a></dt>
<dd><p>__init__( (object)arg1, (object)value [, (object)p2 [, (object)p3 [, (object)p4]]]) -> None</p>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.splitinversioncostfunctions.Data.conjugate">
<code class="descname">conjugate</code><span class="sig-paren">(</span><em>(Data)arg1</em><span class="sig-paren">)</span> → Data<a class="headerlink" href="#esys.downunder.splitinversioncostfunctions.Data.conjugate" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="esys.downunder.splitinversioncostfunctions.Data.copy">
<code class="descname">copy</code><span class="sig-paren">(</span><em>(Data)arg1</em>, <em>(Data)other</em><span class="sig-paren">)</span> → None :<a class="headerlink" href="#esys.downunder.splitinversioncostfunctions.Data.copy" title="Permalink to this definition">¶</a></dt>
<dd><p>Make this object a copy of <code class="docutils literal notranslate"><span class="pre">other</span></code></p>
<blockquote>
<div><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">The two objects will act independently from now on. That is, changing <code class="docutils literal notranslate"><span class="pre">other</span></code> after this call will not change this object and vice versa.</td>
</tr>
</tbody>
</table>
</div></blockquote>
<dl class="docutils">
<dt>copy( (Data)arg1) -> Data :</dt>
<dd><table class="first last docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">note:</th><td class="field-body">In the no argument form, a new object will be returned which is an independent copy of this object.</td>
</tr>
</tbody>
</table>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.splitinversioncostfunctions.Data.copyWithMask">
<code class="descname">copyWithMask</code><span class="sig-paren">(</span><em>(Data)arg1</em>, <em>(Data)other</em>, <em>(Data)mask</em><span class="sig-paren">)</span> → None :<a class="headerlink" href="#esys.downunder.splitinversioncostfunctions.Data.copyWithMask" title="Permalink to this definition">¶</a></dt>
<dd><p>Selectively copy values from <code class="docutils literal notranslate"><span class="pre">other</span></code> <a class="reference internal" href="#esys.downunder.splitinversioncostfunctions.Data" title="esys.downunder.splitinversioncostfunctions.Data"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Data</span></code></a>.Datapoints which correspond to positive values in <code class="docutils literal notranslate"><span class="pre">mask</span></code> will be copied from <code class="docutils literal notranslate"><span class="pre">other</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"><ul class="first last simple">
<li><strong>other</strong> (<a class="reference internal" href="#esys.downunder.splitinversioncostfunctions.Data" title="esys.downunder.splitinversioncostfunctions.Data"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Data</span></code></a>) – source of values</li>
<li><strong>mask</strong> (Scalar <a class="reference internal" href="#esys.downunder.splitinversioncostfunctions.Data" title="esys.downunder.splitinversioncostfunctions.Data"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Data</span></code></a>) – </li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.splitinversioncostfunctions.Data.delay">
<code class="descname">delay</code><span class="sig-paren">(</span><em>(Data)arg1</em><span class="sig-paren">)</span> → Data :<a class="headerlink" href="#esys.downunder.splitinversioncostfunctions.Data.delay" title="Permalink to this definition">¶</a></dt>
<dd><p>Convert this object into lazy representation</p>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.splitinversioncostfunctions.Data.dump">
<code class="descname">dump</code><span class="sig-paren">(</span><em>(Data)arg1</em>, <em>(str)fileName</em><span class="sig-paren">)</span> → None :<a class="headerlink" href="#esys.downunder.splitinversioncostfunctions.Data.dump" title="Permalink to this definition">¶</a></dt>
<dd><p>Save the data as a netCDF file</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>fileName</strong> (<code class="docutils literal notranslate"><span class="pre">string</span></code>) – </td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.splitinversioncostfunctions.Data.expand">
<code class="descname">expand</code><span class="sig-paren">(</span><em>(Data)arg1</em><span class="sig-paren">)</span> → None :<a class="headerlink" href="#esys.downunder.splitinversioncostfunctions.Data.expand" title="Permalink to this definition">¶</a></dt>
<dd><p>Convert the data to expanded representation if it is not expanded already.</p>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.splitinversioncostfunctions.Data.getDomain">
<code class="descname">getDomain</code><span class="sig-paren">(</span><em>(Data)arg1</em><span class="sig-paren">)</span> → Domain :<a class="headerlink" href="#esys.downunder.splitinversioncostfunctions.Data.getDomain" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><code class="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.splitinversioncostfunctions.Data.getFunctionSpace">
<code class="descname">getFunctionSpace</code><span class="sig-paren">(</span><em>(Data)arg1</em><span class="sig-paren">)</span> → FunctionSpace :<a class="headerlink" href="#esys.downunder.splitinversioncostfunctions.Data.getFunctionSpace" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><code class="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.splitinversioncostfunctions.Data.getNumberOfDataPoints">
<code class="descname">getNumberOfDataPoints</code><span class="sig-paren">(</span><em>(Data)arg1</em><span class="sig-paren">)</span> → int :<a class="headerlink" href="#esys.downunder.splitinversioncostfunctions.Data.getNumberOfDataPoints" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><code class="docutils literal notranslate"><span class="pre">int</span></code></td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Number of datapoints in the object</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.splitinversioncostfunctions.Data.getRank">
<code class="descname">getRank</code><span class="sig-paren">(</span><em>(Data)arg1</em><span class="sig-paren">)</span> → int :<a class="headerlink" href="#esys.downunder.splitinversioncostfunctions.Data.getRank" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">the number of indices required to address a component of a datapoint</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">positive <code class="docutils literal notranslate"><span class="pre">int</span></code></td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.splitinversioncostfunctions.Data.getShape">
<code class="descname">getShape</code><span class="sig-paren">(</span><em>(Data)arg1</em><span class="sig-paren">)</span> → tuple :<a class="headerlink" href="#esys.downunder.splitinversioncostfunctions.Data.getShape" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the shape of the datapoints in this object as a python tuple. Scalar data has the shape <code class="docutils literal notranslate"><span class="pre">()</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">Return type:</th><td class="field-body"><code class="docutils literal notranslate"><span class="pre">tuple</span></code></td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.splitinversioncostfunctions.Data.getTagNumber">
<code class="descname">getTagNumber</code><span class="sig-paren">(</span><em>(Data)arg1</em>, <em>(int)dpno</em><span class="sig-paren">)</span> → int :<a class="headerlink" href="#esys.downunder.splitinversioncostfunctions.Data.getTagNumber" title="Permalink to this definition">¶</a></dt>
<dd><p>Return tag number for the specified datapoint</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">int</td>
</tr>
<tr class="field-even field"><th class="field-name">Parameters:</th><td class="field-body"><strong>dpno</strong> (<em>int</em>) – datapoint number</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.splitinversioncostfunctions.Data.getTupleForDataPoint">
<code class="descname">getTupleForDataPoint</code><span class="sig-paren">(</span><em>(Data)arg1</em>, <em>(int)dataPointNo</em><span class="sig-paren">)</span> → object :<a class="headerlink" href="#esys.downunder.splitinversioncostfunctions.Data.getTupleForDataPoint" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">Value of the specified datapoint</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><code class="docutils literal notranslate"><span class="pre">tuple</span></code></td>
</tr>
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>dataPointNo</strong> (<code class="docutils literal notranslate"><span class="pre">int</span></code>) – datapoint to access</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.splitinversioncostfunctions.Data.getTupleForGlobalDataPoint">
<code class="descname">getTupleForGlobalDataPoint</code><span class="sig-paren">(</span><em>(Data)arg1</em>, <em>(int)procNo</em>, <em>(int)dataPointNo</em><span class="sig-paren">)</span> → object :<a class="headerlink" href="#esys.downunder.splitinversioncostfunctions.Data.getTupleForGlobalDataPoint" title="Permalink to this definition">¶</a></dt>
<dd><p>Get a specific datapoint from a specific process</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"><p class="first"><code class="docutils literal notranslate"><span class="pre">tuple</span></code></p>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>procNo</strong> (positive <code class="docutils literal notranslate"><span class="pre">int</span></code>) – MPI rank of the process</li>
<li><strong>dataPointNo</strong> (<em>int</em>) – datapoint to access</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.splitinversioncostfunctions.Data.getX">
<code class="descname">getX</code><span class="sig-paren">(</span><em>(Data)arg1</em><span class="sig-paren">)</span> → Data :<a class="headerlink" href="#esys.downunder.splitinversioncostfunctions.Data.getX" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the spatial coordinates of the spatial nodes.
:rtype: <a class="reference internal" href="#esys.downunder.splitinversioncostfunctions.Data" title="esys.downunder.splitinversioncostfunctions.Data"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Data</span></code></a></p>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.splitinversioncostfunctions.Data.hasInf">
<code class="descname">hasInf</code><span class="sig-paren">(</span><em>(Data)arg1</em><span class="sig-paren">)</span> → bool :<a class="headerlink" href="#esys.downunder.splitinversioncostfunctions.Data.hasInf" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns return true if data contains +-Inf. [Note that for complex values, hasNaN and hasInf are not mutually exclusive.]</p>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.splitinversioncostfunctions.Data.hasNaN">
<code class="descname">hasNaN</code><span class="sig-paren">(</span><em>(Data)arg1</em><span class="sig-paren">)</span> → bool :<a class="headerlink" href="#esys.downunder.splitinversioncostfunctions.Data.hasNaN" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns return true if data contains NaN. [Note that for complex values, hasNaN and hasInf are not mutually exclusive.]</p>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.splitinversioncostfunctions.Data.imag">
<code class="descname">imag</code><span class="sig-paren">(</span><em>(Data)arg1</em><span class="sig-paren">)</span> → Data<a class="headerlink" href="#esys.downunder.splitinversioncostfunctions.Data.imag" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="esys.downunder.splitinversioncostfunctions.Data.internal_maxGlobalDataPoint">
<code class="descname">internal_maxGlobalDataPoint</code><span class="sig-paren">(</span><em>(Data)arg1</em><span class="sig-paren">)</span> → tuple :<a class="headerlink" href="#esys.downunder.splitinversioncostfunctions.Data.internal_maxGlobalDataPoint" title="Permalink to this definition">¶</a></dt>
<dd><p>Please consider using getSupLocator() from pdetools instead.</p>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.splitinversioncostfunctions.Data.internal_minGlobalDataPoint">
<code class="descname">internal_minGlobalDataPoint</code><span class="sig-paren">(</span><em>(Data)arg1</em><span class="sig-paren">)</span> → tuple :<a class="headerlink" href="#esys.downunder.splitinversioncostfunctions.Data.internal_minGlobalDataPoint" title="Permalink to this definition">¶</a></dt>
<dd><p>Please consider using getInfLocator() from pdetools instead.</p>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.splitinversioncostfunctions.Data.interpolate">
<code class="descname">interpolate</code><span class="sig-paren">(</span><em>(Data)arg1</em>, <em>(FunctionSpace)functionspace</em><span class="sig-paren">)</span> → Data :<a class="headerlink" href="#esys.downunder.splitinversioncostfunctions.Data.interpolate" title="Permalink to this definition">¶</a></dt>
<dd><p>Interpolate this object’s values into a new functionspace.</p>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.splitinversioncostfunctions.Data.interpolateTable">
<code class="descname">interpolateTable</code><span class="sig-paren">(</span><em>(Data)arg1</em>, <em>(object)table</em>, <em>(float)Amin</em>, <em>(float)Astep</em>, <em>(Data)B</em>, <em>(float)Bmin</em>, <em>(float)Bstep</em><span class="optional">[</span>, <em>(float)undef=1e+50</em><span class="optional">[</span>, <em>(bool)check_boundaries=False</em><span class="optional">]</span><span class="optional">]</span><span class="sig-paren">)</span> → Data :<a class="headerlink" href="#esys.downunder.splitinversioncostfunctions.Data.interpolateTable" title="Permalink to this definition">¶</a></dt>
<dd><dl class="docutils">
<dt>Creates a new Data object by interpolating using the source data (which are</dt>
<dd><p class="first">looked up in <code class="docutils literal notranslate"><span class="pre">table</span></code>)
<code class="docutils literal notranslate"><span class="pre">A</span></code> must be the outer dimension on the table</p>
<table class="last docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">param table:</th><td class="field-body">two dimensional collection of values</td>
</tr>
<tr class="field-even field"><th class="field-name">param Amin:</th><td class="field-body">The base of locations in table</td>
</tr>
<tr class="field-odd field"><th class="field-name">type Amin:</th><td class="field-body">float</td>
</tr>
<tr class="field-even field"><th class="field-name">param Astep:</th><td class="field-body">size of gap between each item in the table</td>
</tr>
<tr class="field-odd field"><th class="field-name">type Astep:</th><td class="field-body">float</td>
</tr>
<tr class="field-even field"><th class="field-name">param undef:</th><td class="field-body">upper bound on interpolated values</td>
</tr>
<tr class="field-odd field"><th class="field-name">type undef:</th><td class="field-body">float</td>
</tr>
<tr class="field-even field"><th class="field-name">param B:</th><td class="field-body">Scalar representing the second coordinate to be mapped into the table</td>
</tr>
<tr class="field-odd field"><th class="field-name">type B:</th><td class="field-body"><a class="reference internal" href="#esys.downunder.splitinversioncostfunctions.Data" title="esys.downunder.splitinversioncostfunctions.Data"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Data</span></code></a></td>
</tr>
<tr class="field-even field"><th class="field-name">param Bmin:</th><td class="field-body">The base of locations in table for 2nd dimension</td>
</tr>
<tr class="field-odd field"><th class="field-name">type Bmin:</th><td class="field-body">float</td>
</tr>
<tr class="field-even field"><th class="field-name">param Bstep:</th><td class="field-body">size of gap between each item in the table for 2nd dimension</td>
</tr>
<tr class="field-odd field"><th class="field-name">type Bstep:</th><td class="field-body">float</td>
</tr>
<tr class="field-even field"><th class="field-name" colspan="2">param check_boundaries:</th></tr>
<tr class="field-even field"><td> </td><td class="field-body">if true, then values outside the boundaries will be rejected. If false, then boundary values will be used.</td>
</tr>
<tr class="field-odd field"><th class="field-name" colspan="2">raise RuntimeError(DataException):</th></tr>
<tr class="field-odd field"><td> </td><td class="field-body">if the coordinates do not map into the table or if the interpolated value is above <code class="docutils literal notranslate"><span class="pre">undef</span></code></td>
</tr>
<tr class="field-even field"><th class="field-name">rtype:</th><td class="field-body"><a class="reference internal" href="#esys.downunder.splitinversioncostfunctions.Data" title="esys.downunder.splitinversioncostfunctions.Data"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Data</span></code></a></td>
</tr>
</tbody>
</table>
</dd>
</dl>
<p>interpolateTable( (Data)arg1, (object)table, (float)Amin, (float)Astep [, (float)undef=1e+50 [, (bool)check_boundaries=False]]) -> Data</p>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.splitinversioncostfunctions.Data.isComplex">
<code class="descname">isComplex</code><span class="sig-paren">(</span><em>(Data)arg1</em><span class="sig-paren">)</span> → bool :<a class="headerlink" href="#esys.downunder.splitinversioncostfunctions.Data.isComplex" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><code class="docutils literal notranslate"><span class="pre">bool</span></code></td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">True if this <code class="docutils literal notranslate"><span class="pre">Data</span></code> stores complex values.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.splitinversioncostfunctions.Data.isConstant">
<code class="descname">isConstant</code><span class="sig-paren">(</span><em>(Data)arg1</em><span class="sig-paren">)</span> → bool :<a class="headerlink" href="#esys.downunder.splitinversioncostfunctions.Data.isConstant" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><code class="docutils literal notranslate"><span class="pre">bool</span></code></td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">True if this <code class="docutils literal notranslate"><span class="pre">Data</span></code> is an instance of <code class="docutils literal notranslate"><span class="pre">DataConstant</span></code></td>
</tr>
<tr class="field-odd field"><th class="field-name">Note:</th><td class="field-body">This does not mean the data is immutable.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.splitinversioncostfunctions.Data.isEmpty">
<code class="descname">isEmpty</code><span class="sig-paren">(</span><em>(Data)arg1</em><span class="sig-paren">)</span> → bool :<a class="headerlink" href="#esys.downunder.splitinversioncostfunctions.Data.isEmpty" title="Permalink to this definition">¶</a></dt>
<dd><p>Is this object an instance of <code class="docutils literal notranslate"><span class="pre">DataEmpty</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">Return type:</th><td class="field-body"><code class="docutils literal notranslate"><span class="pre">bool</span></code></td>
</tr>
<tr class="field-even field"><th class="field-name">Note:</th><td class="field-body">This is not the same thing as asking if the object contains datapoints.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.splitinversioncostfunctions.Data.isExpanded">
<code class="descname">isExpanded</code><span class="sig-paren">(</span><em>(Data)arg1</em><span class="sig-paren">)</span> → bool :<a class="headerlink" href="#esys.downunder.splitinversioncostfunctions.Data.isExpanded" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><code class="docutils literal notranslate"><span class="pre">bool</span></code></td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">True if this <code class="docutils literal notranslate"><span class="pre">Data</span></code> is expanded.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.splitinversioncostfunctions.Data.isLazy">
<code class="descname">isLazy</code><span class="sig-paren">(</span><em>(Data)arg1</em><span class="sig-paren">)</span> → bool :<a class="headerlink" href="#esys.downunder.splitinversioncostfunctions.Data.isLazy" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><code class="docutils literal notranslate"><span class="pre">bool</span></code></td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">True if this <code class="docutils literal notranslate"><span class="pre">Data</span></code> is lazy.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.splitinversioncostfunctions.Data.isProtected">
<code class="descname">isProtected</code><span class="sig-paren">(</span><em>(Data)arg1</em><span class="sig-paren">)</span> → bool :<a class="headerlink" href="#esys.downunder.splitinversioncostfunctions.Data.isProtected" title="Permalink to this definition">¶</a></dt>
<dd><p>Can this instance be modified.
:rtype: <code class="docutils literal notranslate"><span class="pre">bool</span></code></p>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.splitinversioncostfunctions.Data.isReady">
<code class="descname">isReady</code><span class="sig-paren">(</span><em>(Data)arg1</em><span class="sig-paren">)</span> → bool :<a class="headerlink" href="#esys.downunder.splitinversioncostfunctions.Data.isReady" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><code class="docutils literal notranslate"><span class="pre">bool</span></code></td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">True if this <code class="docutils literal notranslate"><span class="pre">Data</span></code> is not lazy.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.splitinversioncostfunctions.Data.isTagged">
<code class="descname">isTagged</code><span class="sig-paren">(</span><em>(Data)arg1</em><span class="sig-paren">)</span> → bool :<a class="headerlink" href="#esys.downunder.splitinversioncostfunctions.Data.isTagged" title="Permalink to this definition">¶</a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><code class="docutils literal notranslate"><span class="pre">bool</span></code></td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">True if this <code class="docutils literal notranslate"><span class="pre">Data</span></code> is expanded.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.splitinversioncostfunctions.Data.nonuniformInterpolate">
<code class="descname">nonuniformInterpolate</code><span class="sig-paren">(</span><em>(Data)arg1</em>, <em>(object)in</em>, <em>(object)out</em>, <em>(bool)check_boundaries</em><span class="sig-paren">)</span> → Data :<a class="headerlink" href="#esys.downunder.splitinversioncostfunctions.Data.nonuniformInterpolate" title="Permalink to this definition">¶</a></dt>
<dd><p>1D interpolation with non equally spaced points</p>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.splitinversioncostfunctions.Data.nonuniformSlope">
<code class="descname">nonuniformSlope</code><span class="sig-paren">(</span><em>(Data)arg1</em>, <em>(object)in</em>, <em>(object)out</em>, <em>(bool)check_boundaries</em><span class="sig-paren">)</span> → Data :<a class="headerlink" href="#esys.downunder.splitinversioncostfunctions.Data.nonuniformSlope" title="Permalink to this definition">¶</a></dt>
<dd><p>1D interpolation of slope with non equally spaced points</p>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.splitinversioncostfunctions.Data.phase">
<code class="descname">phase</code><span class="sig-paren">(</span><em>(Data)arg1</em><span class="sig-paren">)</span> → Data<a class="headerlink" href="#esys.downunder.splitinversioncostfunctions.Data.phase" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="esys.downunder.splitinversioncostfunctions.Data.promote">
<code class="descname">promote</code><span class="sig-paren">(</span><em>(Data)arg1</em><span class="sig-paren">)</span> → None<a class="headerlink" href="#esys.downunder.splitinversioncostfunctions.Data.promote" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="esys.downunder.splitinversioncostfunctions.Data.real">
<code class="descname">real</code><span class="sig-paren">(</span><em>(Data)arg1</em><span class="sig-paren">)</span> → Data<a class="headerlink" href="#esys.downunder.splitinversioncostfunctions.Data.real" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="esys.downunder.splitinversioncostfunctions.Data.replaceInf">
<code class="descname">replaceInf</code><span class="sig-paren">(</span><em>(Data)arg1</em>, <em>(object)value</em><span class="sig-paren">)</span> → None :<a class="headerlink" href="#esys.downunder.splitinversioncostfunctions.Data.replaceInf" title="Permalink to this definition">¶</a></dt>
<dd><p>Replaces +-Inf values with value. [Note, for complex Data, both real and imaginary components are replaced even if only one part is Inf].</p>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.splitinversioncostfunctions.Data.replaceNaN">
<code class="descname">replaceNaN</code><span class="sig-paren">(</span><em>(Data)arg1</em>, <em>(object)value</em><span class="sig-paren">)</span> → None :<a class="headerlink" href="#esys.downunder.splitinversioncostfunctions.Data.replaceNaN" title="Permalink to this definition">¶</a></dt>
<dd><p>Replaces NaN values with value. [Note, for complex Data, both real and imaginary components are replaced even if only one part is NaN].</p>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.splitinversioncostfunctions.Data.resolve">
<code class="descname">resolve</code><span class="sig-paren">(</span><em>(Data)arg1</em><span class="sig-paren">)</span> → None :<a class="headerlink" href="#esys.downunder.splitinversioncostfunctions.Data.resolve" title="Permalink to this definition">¶</a></dt>
<dd><p>Convert the data to non-lazy representation.</p>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.splitinversioncostfunctions.Data.setProtection">
<code class="descname">setProtection</code><span class="sig-paren">(</span><em>(Data)arg1</em><span class="sig-paren">)</span> → None :<a class="headerlink" href="#esys.downunder.splitinversioncostfunctions.Data.setProtection" title="Permalink to this definition">¶</a></dt>
<dd><p>Disallow modifications to this data object</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">This method does not allow you to undo protection.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.splitinversioncostfunctions.Data.setTaggedValue">
<code class="descname">setTaggedValue</code><span class="sig-paren">(</span><em>(Data)arg1</em>, <em>(int)tagKey</em>, <em>(object)value</em><span class="sig-paren">)</span> → None :<a class="headerlink" href="#esys.downunder.splitinversioncostfunctions.Data.setTaggedValue" title="Permalink to this definition">¶</a></dt>
<dd><p>Set the value of tagged Data.</p>
<blockquote>
<div><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">param tagKey:</th><td class="field-body">tag to update</td>
</tr>
<tr class="field-even field"><th class="field-name">type tagKey:</th><td class="field-body"><code class="docutils literal notranslate"><span class="pre">int</span></code></td>
</tr>
</tbody>
</table>
</div></blockquote>
<dl class="docutils">
<dt>setTaggedValue( (Data)arg1, (str)name, (object)value) -> None :</dt>
<dd><table class="first last docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">param name:</th><td class="field-body">tag to update</td>
</tr>
<tr class="field-even field"><th class="field-name">type name:</th><td class="field-body"><code class="docutils literal notranslate"><span class="pre">string</span></code></td>
</tr>
<tr class="field-odd field"><th class="field-name">param value:</th><td class="field-body">value to set tagged data to</td>
</tr>
<tr class="field-even field"><th class="field-name">type value:</th><td class="field-body"><code class="docutils literal notranslate"><span class="pre">object</span></code> which acts like an array, <code class="docutils literal notranslate"><span class="pre">tuple</span></code> or <code class="docutils literal notranslate"><span class="pre">list</span></code></td>
</tr>
</tbody>
</table>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.splitinversioncostfunctions.Data.setToZero">
<code class="descname">setToZero</code><span class="sig-paren">(</span><em>(Data)arg1</em><span class="sig-paren">)</span> → None :<a class="headerlink" href="#esys.downunder.splitinversioncostfunctions.Data.setToZero" title="Permalink to this definition">¶</a></dt>
<dd><p>After this call the object will store values of the same shape as before but all components will be zero.</p>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.splitinversioncostfunctions.Data.setValueOfDataPoint">
<code class="descname">setValueOfDataPoint</code><span class="sig-paren">(</span><em>(Data)arg1</em>, <em>(int)dataPointNo</em>, <em>(object)value</em><span class="sig-paren">)</span> → None<a class="headerlink" href="#esys.downunder.splitinversioncostfunctions.Data.setValueOfDataPoint" title="Permalink to this definition">¶</a></dt>
<dd><p>setValueOfDataPoint( (Data)arg1, (int)arg2, (object)arg3) -> None</p>
<p>setValueOfDataPoint( (Data)arg1, (int)arg2, (float)arg3) -> None :</p>
<blockquote>
<div><p>Modify the value of a single datapoint.</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" colspan="2">param dataPointNo:</th></tr>
<tr class="field-odd field"><td> </td><td class="field-body"></td>
</tr>
<tr class="field-even field"><th class="field-name" colspan="2">type dataPointNo:</th></tr>
<tr class="field-even field"><td> </td><td class="field-body">int</td>
</tr>
<tr class="field-odd field"><th class="field-name">param value:</th><td class="field-body"></td>
</tr>
<tr class="field-even field"><th class="field-name">type value:</th><td class="field-body"><code class="docutils literal notranslate"><span class="pre">float</span></code> or an object which acts like an array, <code class="docutils literal notranslate"><span class="pre">tuple</span></code> or <code class="docutils literal notranslate"><span class="pre">list</span></code></td>
</tr>
<tr class="field-odd field"><th class="field-name">warning:</th><td class="field-body">Use of this operation is discouraged. It prevents some optimisations from operating.</td>
</tr>
</tbody>
</table>
</div></blockquote>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.splitinversioncostfunctions.Data.tag">
<code class="descname">tag</code><span class="sig-paren">(</span><em>(Data)arg1</em><span class="sig-paren">)</span> → None :<a class="headerlink" href="#esys.downunder.splitinversioncostfunctions.Data.tag" title="Permalink to this definition">¶</a></dt>
<dd><p>Convert data to tagged representation if it is not already tagged or expanded</p>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.splitinversioncostfunctions.Data.toListOfTuples">
<code class="descname">toListOfTuples</code><span class="sig-paren">(</span><em>(Data)arg1</em><span class="optional">[</span>, <em>(bool)scalarastuple=False</em><span class="optional">]</span><span class="sig-paren">)</span> → object :<a class="headerlink" href="#esys.downunder.splitinversioncostfunctions.Data.toListOfTuples" title="Permalink to this definition">¶</a></dt>
<dd><p>Return the datapoints of this object in a list. Each datapoint is stored as a tuple.</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>scalarastuple</strong> – if True, scalar data will be wrapped as a tuple. True => [(0), (1), (2)]; False => [0, 1, 2]</td>
</tr>
</tbody>
</table>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="esys.downunder.splitinversioncostfunctions.ForwardModel">
<em class="property">class </em><code class="descclassname">esys.downunder.splitinversioncostfunctions.</code><code class="descname">ForwardModel</code><a class="headerlink" href="#esys.downunder.splitinversioncostfunctions.ForwardModel" 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>An abstract forward model that can be plugged into a cost function.
Subclasses need to implement <a class="reference internal" href="#esys.downunder.splitinversioncostfunctions.ForwardModel.getDefect" title="esys.downunder.splitinversioncostfunctions.ForwardModel.getDefect"><code class="xref py py-obj docutils literal notranslate"><span class="pre">getDefect()</span></code></a>, <a class="reference internal" href="#esys.downunder.splitinversioncostfunctions.ForwardModel.getGradient" title="esys.downunder.splitinversioncostfunctions.ForwardModel.getGradient"><code class="xref py py-obj docutils literal notranslate"><span class="pre">getGradient()</span></code></a>, and possibly
<a class="reference internal" href="#esys.downunder.splitinversioncostfunctions.ForwardModel.getArguments" title="esys.downunder.splitinversioncostfunctions.ForwardModel.getArguments"><code class="xref py py-obj docutils literal notranslate"><span class="pre">getArguments()</span></code></a> and ‘getCoordinateTransformation’.</p>
<dl class="method">
<dt id="esys.downunder.splitinversioncostfunctions.ForwardModel.__init__">
<code class="descname">__init__</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.splitinversioncostfunctions.ForwardModel.__init__" title="Permalink to this definition">¶</a></dt>
<dd><p>Initialize self. See help(type(self)) for accurate signature.</p>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.splitinversioncostfunctions.ForwardModel.getArguments">
<code class="descname">getArguments</code><span class="sig-paren">(</span><em>x</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.splitinversioncostfunctions.ForwardModel.getArguments" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="esys.downunder.splitinversioncostfunctions.ForwardModel.getCoordinateTransformation">
<code class="descname">getCoordinateTransformation</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.splitinversioncostfunctions.ForwardModel.getCoordinateTransformation" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="esys.downunder.splitinversioncostfunctions.ForwardModel.getDefect">
<code class="descname">getDefect</code><span class="sig-paren">(</span><em>x</em>, <em>*args</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.splitinversioncostfunctions.ForwardModel.getDefect" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="esys.downunder.splitinversioncostfunctions.ForwardModel.getGradient">
<code class="descname">getGradient</code><span class="sig-paren">(</span><em>x</em>, <em>*args</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.splitinversioncostfunctions.ForwardModel.getGradient" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="esys.downunder.splitinversioncostfunctions.FunctionJob">
<em class="property">class </em><code class="descclassname">esys.downunder.splitinversioncostfunctions.</code><code class="descname">FunctionJob</code><span class="sig-paren">(</span><em>fn</em>, <em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.splitinversioncostfunctions.FunctionJob" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">esys.escriptcore.splitworld.Job</span></code></p>
<p>Takes a python function (with only self and keyword params) to be called as the work method</p>
<dl class="method">
<dt id="esys.downunder.splitinversioncostfunctions.FunctionJob.__init__">
<code class="descname">__init__</code><span class="sig-paren">(</span><em>fn</em>, <em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.splitinversioncostfunctions.FunctionJob.__init__" title="Permalink to this definition">¶</a></dt>
<dd><p>It ignores all of its parameters, except that, it requires the following as keyword arguments</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">Variables:</th><td class="field-body"><ul class="first last simple">
<li><a class="reference internal" href="esys.modellib.geometry.html#esys.modellib.geometry.DomainReader.domain" title="esys.modellib.geometry.DomainReader.domain"><strong>domain</strong></a> – Domain to be used as the basis for all <code class="docutils literal notranslate"><span class="pre">Data</span></code> and PDEs in this Job.</li>
<li><strong>jobid</strong> – sequence number of this job. The first job has id=1</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.splitinversioncostfunctions.FunctionJob.clearExports">
<code class="descname">clearExports</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.splitinversioncostfunctions.FunctionJob.clearExports" title="Permalink to this definition">¶</a></dt>
<dd><p>Remove exported values from the map</p>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.splitinversioncostfunctions.FunctionJob.clearImports">
<code class="descname">clearImports</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.splitinversioncostfunctions.FunctionJob.clearImports" title="Permalink to this definition">¶</a></dt>
<dd><p>Remove imported values from their map</p>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.splitinversioncostfunctions.FunctionJob.declareImport">
<code class="descname">declareImport</code><span class="sig-paren">(</span><em>name</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.splitinversioncostfunctions.FunctionJob.declareImport" title="Permalink to this definition">¶</a></dt>
<dd><p>Adds name to the list of imports</p>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.splitinversioncostfunctions.FunctionJob.exportValue">
<code class="descname">exportValue</code><span class="sig-paren">(</span><em>name</em>, <em>v</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.splitinversioncostfunctions.FunctionJob.exportValue" title="Permalink to this definition">¶</a></dt>
<dd><p>Make value v available to other Jobs under the label name.
name must have already been registered with the SplitWorld instance.
For use inside the work() 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">Variables:</th><td class="field-body"><ul class="first last simple">
<li><a class="reference internal" href="esys.downunder.apps.html#esys.downunder.apps.SolverOptions.name" title="esys.downunder.apps.SolverOptions.name"><strong>name</strong></a> – registered label for exported value</li>
<li><strong>v</strong> – value to be imported</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.splitinversioncostfunctions.FunctionJob.importValue">
<code class="descname">importValue</code><span class="sig-paren">(</span><em>name</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.splitinversioncostfunctions.FunctionJob.importValue" title="Permalink to this definition">¶</a></dt>
<dd><p>For use inside the work() 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">Variables:</th><td class="field-body"><a class="reference internal" href="esys.downunder.apps.html#esys.downunder.apps.SolverOptions.name" title="esys.downunder.apps.SolverOptions.name"><strong>name</strong></a> – label for imported value.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.splitinversioncostfunctions.FunctionJob.setImportValue">
<code class="descname">setImportValue</code><span class="sig-paren">(</span><em>name</em>, <em>v</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.splitinversioncostfunctions.FunctionJob.setImportValue" title="Permalink to this definition">¶</a></dt>
<dd><p>Use to make a value available to the job (ie called from outside the job)</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">Variables:</th><td class="field-body"><ul class="first last simple">
<li><a class="reference internal" href="esys.downunder.apps.html#esys.downunder.apps.SolverOptions.name" title="esys.downunder.apps.SolverOptions.name"><strong>name</strong></a> – label used to identify this import</li>
<li><strong>v</strong> – value to be imported</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.splitinversioncostfunctions.FunctionJob.work">
<code class="descname">work</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.splitinversioncostfunctions.FunctionJob.work" title="Permalink to this definition">¶</a></dt>
<dd><p>Need to be overloaded for the job to actually do anthing.
A return value of True indicates this job thinks it is done.
A return value of False indicates work still to be done</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="esys.downunder.splitinversioncostfunctions.Job">
<em class="property">class </em><code class="descclassname">esys.downunder.splitinversioncostfunctions.</code><code class="descname">Job</code><span class="sig-paren">(</span><em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.splitinversioncostfunctions.Job" 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>Describes a sequence of work to be carried out in a subworld.
The instances of this class used in the subworlds will
be constructed by the system.
To do specific work, this class should be subclassed and the work()
(and possibly __init__ methods overloaded).
The majority of the work done by the job will be in the <em>overloaded</em> work() method.
The work() method should retrieve values from the outside using importValue() and pass values to
the rest of the system using exportValue().
The rest of the methods should be considered off limits.</p>
<dl class="method">
<dt id="esys.downunder.splitinversioncostfunctions.Job.__init__">
<code class="descname">__init__</code><span class="sig-paren">(</span><em>*args</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.splitinversioncostfunctions.Job.__init__" title="Permalink to this definition">¶</a></dt>
<dd><p>It ignores all of its parameters, except that, it requires the following as keyword arguments</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">Variables:</th><td class="field-body"><ul class="first last simple">
<li><a class="reference internal" href="esys.modellib.geometry.html#esys.modellib.geometry.DomainReader.domain" title="esys.modellib.geometry.DomainReader.domain"><strong>domain</strong></a> – Domain to be used as the basis for all <code class="docutils literal notranslate"><span class="pre">Data</span></code> and PDEs in this Job.</li>
<li><strong>jobid</strong> – sequence number of this job. The first job has id=1</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.splitinversioncostfunctions.Job.clearExports">
<code class="descname">clearExports</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.splitinversioncostfunctions.Job.clearExports" title="Permalink to this definition">¶</a></dt>
<dd><p>Remove exported values from the map</p>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.splitinversioncostfunctions.Job.clearImports">
<code class="descname">clearImports</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.splitinversioncostfunctions.Job.clearImports" title="Permalink to this definition">¶</a></dt>
<dd><p>Remove imported values from their map</p>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.splitinversioncostfunctions.Job.declareImport">
<code class="descname">declareImport</code><span class="sig-paren">(</span><em>name</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.splitinversioncostfunctions.Job.declareImport" title="Permalink to this definition">¶</a></dt>
<dd><p>Adds name to the list of imports</p>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.splitinversioncostfunctions.Job.exportValue">
<code class="descname">exportValue</code><span class="sig-paren">(</span><em>name</em>, <em>v</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.splitinversioncostfunctions.Job.exportValue" title="Permalink to this definition">¶</a></dt>
<dd><p>Make value v available to other Jobs under the label name.
name must have already been registered with the SplitWorld instance.
For use inside the work() 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">Variables:</th><td class="field-body"><ul class="first last simple">
<li><a class="reference internal" href="esys.downunder.apps.html#esys.downunder.apps.SolverOptions.name" title="esys.downunder.apps.SolverOptions.name"><strong>name</strong></a> – registered label for exported value</li>
<li><strong>v</strong> – value to be imported</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.splitinversioncostfunctions.Job.importValue">
<code class="descname">importValue</code><span class="sig-paren">(</span><em>name</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.splitinversioncostfunctions.Job.importValue" title="Permalink to this definition">¶</a></dt>
<dd><p>For use inside the work() 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">Variables:</th><td class="field-body"><a class="reference internal" href="esys.downunder.apps.html#esys.downunder.apps.SolverOptions.name" title="esys.downunder.apps.SolverOptions.name"><strong>name</strong></a> – label for imported value.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.splitinversioncostfunctions.Job.setImportValue">
<code class="descname">setImportValue</code><span class="sig-paren">(</span><em>name</em>, <em>v</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.splitinversioncostfunctions.Job.setImportValue" title="Permalink to this definition">¶</a></dt>
<dd><p>Use to make a value available to the job (ie called from outside the job)</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">Variables:</th><td class="field-body"><ul class="first last simple">
<li><a class="reference internal" href="esys.downunder.apps.html#esys.downunder.apps.SolverOptions.name" title="esys.downunder.apps.SolverOptions.name"><strong>name</strong></a> – label used to identify this import</li>
<li><strong>v</strong> – value to be imported</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.splitinversioncostfunctions.Job.work">
<code class="descname">work</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.splitinversioncostfunctions.Job.work" title="Permalink to this definition">¶</a></dt>
<dd><p>Need to be overloaded for the job to actually do anthing.
A return value of True indicates this job thinks it is done.
A return value of False indicates work still to be done</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="esys.downunder.splitinversioncostfunctions.Mapping">
<em class="property">class </em><code class="descclassname">esys.downunder.splitinversioncostfunctions.</code><code class="descname">Mapping</code><span class="sig-paren">(</span><em>*args</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.splitinversioncostfunctions.Mapping" 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>An abstract mapping class to map level set functions <em>m</em> to physical
parameters <em>p</em>.</p>
<dl class="method">
<dt id="esys.downunder.splitinversioncostfunctions.Mapping.__init__">
<code class="descname">__init__</code><span class="sig-paren">(</span><em>*args</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.splitinversioncostfunctions.Mapping.__init__" title="Permalink to this definition">¶</a></dt>
<dd><p>Initialize self. See help(type(self)) for accurate signature.</p>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.splitinversioncostfunctions.Mapping.getDerivative">
<code class="descname">getDerivative</code><span class="sig-paren">(</span><em>m</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.splitinversioncostfunctions.Mapping.getDerivative" title="Permalink to this definition">¶</a></dt>
<dd><p>returns the value for the derivative of the mapping for m</p>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.splitinversioncostfunctions.Mapping.getInverse">
<code class="descname">getInverse</code><span class="sig-paren">(</span><em>s</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.splitinversioncostfunctions.Mapping.getInverse" title="Permalink to this definition">¶</a></dt>
<dd><p>returns the value of the inverse of the mapping for physical parameter p</p>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.splitinversioncostfunctions.Mapping.getTypicalDerivative">
<code class="descname">getTypicalDerivative</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.splitinversioncostfunctions.Mapping.getTypicalDerivative" title="Permalink to this definition">¶</a></dt>
<dd><p>returns a typical value for the derivative</p>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.splitinversioncostfunctions.Mapping.getValue">
<code class="descname">getValue</code><span class="sig-paren">(</span><em>m</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.splitinversioncostfunctions.Mapping.getValue" title="Permalink to this definition">¶</a></dt>
<dd><p>returns the value of the mapping for m</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="esys.downunder.splitinversioncostfunctions.MeteredCostFunction">
<em class="property">class </em><code class="descclassname">esys.downunder.splitinversioncostfunctions.</code><code class="descname">MeteredCostFunction</code><a class="headerlink" href="#esys.downunder.splitinversioncostfunctions.MeteredCostFunction" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">esys.downunder.costfunctions.CostFunction</span></code></p>
<p>This an intrumented version of the <code class="xref py py-obj docutils literal notranslate"><span class="pre">CostFunction</span></code> class. The function
calls update statistical information.
The actual work is done by the methods with corresponding name and a
leading underscore. These functions need to be overwritten for a particular
cost function implementation.</p>
<dl class="method">
<dt id="esys.downunder.splitinversioncostfunctions.MeteredCostFunction.__init__">
<code class="descname">__init__</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.splitinversioncostfunctions.MeteredCostFunction.__init__" title="Permalink to this definition">¶</a></dt>
<dd><p>the base constructor initializes the counters so subclasses should
ensure the super class constructor is called.</p>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.splitinversioncostfunctions.MeteredCostFunction.getArguments">
<code class="descname">getArguments</code><span class="sig-paren">(</span><em>x</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.splitinversioncostfunctions.MeteredCostFunction.getArguments" title="Permalink to this definition">¶</a></dt>
<dd><p>returns precalculated values that are shared in the calculation of
<em>f(x)</em> and <em>grad f(x)</em> and the Hessian operator</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">The tuple returned by this call will be passed back to this <code class="xref py py-obj docutils literal notranslate"><span class="pre">CostFunction</span></code> in other
calls(eg: <code class="docutils literal notranslate"><span class="pre">getGradient</span></code>). Its contents are not specified at this level because no code, other than the <code class="xref py py-obj docutils literal notranslate"><span class="pre">CostFunction</span></code>
which created it, will be interacting with it.
That is, the implementor can put whatever information they find useful in it.</p>
</div>
<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>x</strong> (<em>x-type</em>) – location of derivative</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><code class="docutils literal notranslate"><span class="pre">tuple</span></code></td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.splitinversioncostfunctions.MeteredCostFunction.getDualProduct">
<code class="descname">getDualProduct</code><span class="sig-paren">(</span><em>x</em>, <em>r</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.splitinversioncostfunctions.MeteredCostFunction.getDualProduct" title="Permalink to this definition">¶</a></dt>
<dd><p>returns the dual product of <code class="docutils literal notranslate"><span class="pre">x</span></code> and <code class="docutils literal notranslate"><span class="pre">r</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">Return type:</th><td class="field-body"><code class="docutils literal notranslate"><span class="pre">float</span></code></td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.splitinversioncostfunctions.MeteredCostFunction.getGradient">
<code class="descname">getGradient</code><span class="sig-paren">(</span><em>x</em>, <em>*args</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.splitinversioncostfunctions.MeteredCostFunction.getGradient" title="Permalink to this definition">¶</a></dt>
<dd><p>returns the gradient of <em>f</em> at <em>x</em> using the precalculated values for
<em>x</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"><ul class="first simple">
<li><strong>x</strong> (<em>x-type</em>) – location of derivative</li>
<li><strong>args</strong> – pre-calculated values for <code class="docutils literal notranslate"><span class="pre">x</span></code> from <a class="reference internal" href="#esys.downunder.splitinversioncostfunctions.MeteredCostFunction.getArguments" title="esys.downunder.splitinversioncostfunctions.MeteredCostFunction.getArguments"><code class="xref py py-obj docutils literal notranslate"><span class="pre">getArguments()</span></code></a></li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">r-type</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.splitinversioncostfunctions.MeteredCostFunction.getInverseHessianApproximation">
<code class="descname">getInverseHessianApproximation</code><span class="sig-paren">(</span><em>x</em>, <em>r</em>, <em>*args</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.splitinversioncostfunctions.MeteredCostFunction.getInverseHessianApproximation" title="Permalink to this definition">¶</a></dt>
<dd><p>returns an approximative evaluation <em>p</em> of the inverse of the Hessian
operator of the cost function for a given gradient <em>r</em> at a given
location <em>x</em>: <em>H(x) p = r</em></p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">In general it is assumed that the Hessian <em>H(x)</em> needs to be
calculate in each call for a new location <em>x</em>. However, the
solver may suggest that this is not required, typically when
the iteration is close to completeness.</p>
</div>
<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>x</strong> (<em>x-type</em>) – location of Hessian operator to be evaluated.</li>
<li><strong>r</strong> (<em>r-type</em>) – a given gradient</li>
<li><strong>args</strong> – pre-calculated values for <code class="docutils literal notranslate"><span class="pre">x</span></code> from <a class="reference internal" href="#esys.downunder.splitinversioncostfunctions.MeteredCostFunction.getArguments" title="esys.downunder.splitinversioncostfunctions.MeteredCostFunction.getArguments"><code class="xref py py-obj docutils literal notranslate"><span class="pre">getArguments()</span></code></a></li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">x-type</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.splitinversioncostfunctions.MeteredCostFunction.getNorm">
<code class="descname">getNorm</code><span class="sig-paren">(</span><em>x</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.splitinversioncostfunctions.MeteredCostFunction.getNorm" title="Permalink to this definition">¶</a></dt>
<dd><p>returns the norm of <code class="docutils literal notranslate"><span class="pre">x</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">Return type:</th><td class="field-body"><code class="docutils literal notranslate"><span class="pre">float</span></code></td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.splitinversioncostfunctions.MeteredCostFunction.getValue">
<code class="descname">getValue</code><span class="sig-paren">(</span><em>x</em>, <em>*args</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.splitinversioncostfunctions.MeteredCostFunction.getValue" title="Permalink to this definition">¶</a></dt>
<dd><p>returns the value <em>f(x)</em> using the precalculated values for <em>x</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>x</strong> (<em>x-type</em>) – a solution approximation</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">float</span></code></td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="attribute">
<dt id="esys.downunder.splitinversioncostfunctions.MeteredCostFunction.provides_inverse_Hessian_approximation">
<code class="descname">provides_inverse_Hessian_approximation</code><em class="property"> = False</em><a class="headerlink" href="#esys.downunder.splitinversioncostfunctions.MeteredCostFunction.provides_inverse_Hessian_approximation" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="esys.downunder.splitinversioncostfunctions.MeteredCostFunction.resetCounters">
<code class="descname">resetCounters</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.splitinversioncostfunctions.MeteredCostFunction.resetCounters" title="Permalink to this definition">¶</a></dt>
<dd><p>resets all statistical counters</p>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.splitinversioncostfunctions.MeteredCostFunction.updateHessian">
<code class="descname">updateHessian</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.splitinversioncostfunctions.MeteredCostFunction.updateHessian" title="Permalink to this definition">¶</a></dt>
<dd><p>notifies the class that the Hessian operator needs to be updated.
This method is called by the solver class.</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="esys.downunder.splitinversioncostfunctions.SplitInversionCostFunction">
<em class="property">class </em><code class="descclassname">esys.downunder.splitinversioncostfunctions.</code><code class="descname">SplitInversionCostFunction</code><span class="sig-paren">(</span><em>numLevelSets=None</em>, <em>numModels=None</em>, <em>numMappings=None</em>, <em>splitworld=None</em>, <em>worldsinit_fn=None</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.splitinversioncostfunctions.SplitInversionCostFunction" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">esys.downunder.costfunctions.MeteredCostFunction</span></code></p>
<p>Class to define cost function <em>J(m)</em> for inversion with one or more
forward models based on a multi-valued level set function <em>m</em>:</p>
<p><em>J(m) = J_reg(m) + sum_f mu_f * J_f(p)</em></p>
<p>where <em>J_reg(m)</em> is the regularization and cross gradient component of the
cost function applied to a level set function <em>m</em>, <em>J_f(p)</em> are the data
defect cost functions involving a physical forward model using the
physical parameter(s) <em>p</em> and <em>mu_f</em> is the trade-off factor for model f.</p>
<p>A forward model depends on a set of physical parameters <em>p</em> which are
constructed from components of the level set function <em>m</em> via mappings.</p>
<dl class="docutils">
<dt>Example 1 (single forward model):</dt>
<dd>m=Mapping()
f=ForwardModel()
J=InversionCostFunction(Regularization(), m, f)</dd>
<dt>Example 2 (two forward models on a single valued level set)</dt>
<dd><p class="first">m0=Mapping()
m1=Mapping()
f0=ForwardModel()
f1=ForwardModel()</p>
<p class="last">J=InversionCostFunction(Regularization(), mappings=[m0, m1], forward_models=[(f0, 0), (f1,1)])</p>
</dd>
<dt>Example 3 (two forward models on 2-valued level set)</dt>
<dd><p class="first">m0=Mapping()
m1=Mapping()
f0=ForwardModel()
f1=ForwardModel()</p>
<p class="last">J=InversionCostFunction(Regularization(self.numLevelSets=2), mappings=[(m0,0), (m1,0)], forward_models=[(f0, 0), (f1,1)])</p>
</dd>
</dl>
<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">If provides_inverse_Hessian_approximation is true, then the class
provides an approximative inverse of the Hessian operator.</td>
</tr>
</tbody>
</table>
<dl class="method">
<dt id="esys.downunder.splitinversioncostfunctions.SplitInversionCostFunction.__init__">
<code class="descname">__init__</code><span class="sig-paren">(</span><em>numLevelSets=None</em>, <em>numModels=None</em>, <em>numMappings=None</em>, <em>splitworld=None</em>, <em>worldsinit_fn=None</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.splitinversioncostfunctions.SplitInversionCostFunction.__init__" title="Permalink to this definition">¶</a></dt>
<dd><p>fill this in.</p>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.splitinversioncostfunctions.SplitInversionCostFunction.calculateGradient">
<code class="descname">calculateGradient</code><span class="sig-paren">(</span><em>vnames1</em>, <em>vnames2</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.splitinversioncostfunctions.SplitInversionCostFunction.calculateGradient" title="Permalink to this definition">¶</a></dt>
<dd><p>The gradient operation produces two components (designated (Y^,X) in the non-split version).
vnames1 gives the variable name(s) where the first component should be stored.
vnames2 gives the variable name(s) where the second component should be stored.</p>
</dd></dl>
<dl class="staticmethod">
<dt id="esys.downunder.splitinversioncostfunctions.SplitInversionCostFunction.calculatePropertiesHelper">
<em class="property">static </em><code class="descname">calculatePropertiesHelper</code><span class="sig-paren">(</span><em>self</em>, <em>m</em>, <em>mappings</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.splitinversioncostfunctions.SplitInversionCostFunction.calculatePropertiesHelper" title="Permalink to this definition">¶</a></dt>
<dd><p>returns a list of the physical properties from a given level set
function <em>m</em> using the mappings of the cost function.</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>m</strong> (<a class="reference internal" href="#esys.downunder.splitinversioncostfunctions.Data" title="esys.downunder.splitinversioncostfunctions.Data"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Data</span></code></a>) – level set function</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">list</span></code> of <a class="reference internal" href="#esys.downunder.splitinversioncostfunctions.Data" title="esys.downunder.splitinversioncostfunctions.Data"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Data</span></code></a></td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.splitinversioncostfunctions.SplitInversionCostFunction.calculateValue">
<code class="descname">calculateValue</code><span class="sig-paren">(</span><em>vname</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.splitinversioncostfunctions.SplitInversionCostFunction.calculateValue" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="esys.downunder.splitinversioncostfunctions.SplitInversionCostFunction.createLevelSetFunction">
<code class="descname">createLevelSetFunction</code><span class="sig-paren">(</span><em>*props</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.splitinversioncostfunctions.SplitInversionCostFunction.createLevelSetFunction" title="Permalink to this definition">¶</a></dt>
<dd><p>returns an instance of an object used to represent a level set function
initialized with zeros. Components can be overwritten by physical
properties <code class="xref py py-obj docutils literal notranslate"><span class="pre">props</span></code>. If present entries must correspond to the
<code class="xref py py-obj docutils literal notranslate"><span class="pre">mappings</span></code> arguments in the constructor. Use <code class="docutils literal notranslate"><span class="pre">None</span></code> for properties
for which no value is given.</p>
</dd></dl>
<dl class="staticmethod">
<dt id="esys.downunder.splitinversioncostfunctions.SplitInversionCostFunction.createLevelSetFunctionHelper">
<em class="property">static </em><code class="descname">createLevelSetFunctionHelper</code><span class="sig-paren">(</span><em>self</em>, <em>regularization</em>, <em>mappings</em>, <em>*props</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.splitinversioncostfunctions.SplitInversionCostFunction.createLevelSetFunctionHelper" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns an object (init-ed) with 0s.
Components can be overwritten by physical
properties <code class="xref py py-obj docutils literal notranslate"><span class="pre">props</span></code>. If present entries must correspond to the
<code class="xref py py-obj docutils literal notranslate"><span class="pre">mappings</span></code> arguments in the constructor. Use <code class="docutils literal notranslate"><span class="pre">None</span></code> for properties
for which no value is given.</p>
</dd></dl>
<dl class="staticmethod">
<dt id="esys.downunder.splitinversioncostfunctions.SplitInversionCostFunction.formatMappings">
<em class="property">static </em><code class="descname">formatMappings</code><span class="sig-paren">(</span><em>mappings</em>, <em>numLevelSets</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.splitinversioncostfunctions.SplitInversionCostFunction.formatMappings" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="staticmethod">
<dt id="esys.downunder.splitinversioncostfunctions.SplitInversionCostFunction.formatModels">
<em class="property">static </em><code class="descname">formatModels</code><span class="sig-paren">(</span><em>forward_models</em>, <em>numMappings</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.splitinversioncostfunctions.SplitInversionCostFunction.formatModels" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="esys.downunder.splitinversioncostfunctions.SplitInversionCostFunction.getArguments">
<code class="descname">getArguments</code><span class="sig-paren">(</span><em>x</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.splitinversioncostfunctions.SplitInversionCostFunction.getArguments" title="Permalink to this definition">¶</a></dt>
<dd><p>returns precalculated values that are shared in the calculation of
<em>f(x)</em> and <em>grad f(x)</em> and the Hessian operator</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">The tuple returned by this call will be passed back to this <code class="xref py py-obj docutils literal notranslate"><span class="pre">CostFunction</span></code> in other
calls(eg: <code class="docutils literal notranslate"><span class="pre">getGradient</span></code>). Its contents are not specified at this level because no code, other than the <code class="xref py py-obj docutils literal notranslate"><span class="pre">CostFunction</span></code>
which created it, will be interacting with it.
That is, the implementor can put whatever information they find useful in it.</p>
</div>
<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>x</strong> (<em>x-type</em>) – location of derivative</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><code class="docutils literal notranslate"><span class="pre">tuple</span></code></td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.splitinversioncostfunctions.SplitInversionCostFunction.getComponentValues">
<code class="descname">getComponentValues</code><span class="sig-paren">(</span><em>m</em>, <em>*args</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.splitinversioncostfunctions.SplitInversionCostFunction.getComponentValues" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="esys.downunder.splitinversioncostfunctions.SplitInversionCostFunction.getDomain">
<code class="descname">getDomain</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.splitinversioncostfunctions.SplitInversionCostFunction.getDomain" title="Permalink to this definition">¶</a></dt>
<dd><p>returns the domain of the cost function</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Domain</span></code></td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.splitinversioncostfunctions.SplitInversionCostFunction.getDualProduct">
<code class="descname">getDualProduct</code><span class="sig-paren">(</span><em>x</em>, <em>r</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.splitinversioncostfunctions.SplitInversionCostFunction.getDualProduct" title="Permalink to this definition">¶</a></dt>
<dd><p>returns the dual product of <code class="docutils literal notranslate"><span class="pre">x</span></code> and <code class="docutils literal notranslate"><span class="pre">r</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">Return type:</th><td class="field-body"><code class="docutils literal notranslate"><span class="pre">float</span></code></td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.splitinversioncostfunctions.SplitInversionCostFunction.getForwardModel">
<code class="descname">getForwardModel</code><span class="sig-paren">(</span><em>idx=None</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.splitinversioncostfunctions.SplitInversionCostFunction.getForwardModel" title="Permalink to this definition">¶</a></dt>
<dd><p>returns the <em>idx</em>-th forward model.</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>idx</strong> (<code class="docutils literal notranslate"><span class="pre">int</span></code>) – model index. If cost function contains one model only <code class="xref py py-obj docutils literal notranslate"><span class="pre">idx</span></code>
can be omitted.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.splitinversioncostfunctions.SplitInversionCostFunction.getGradient">
<code class="descname">getGradient</code><span class="sig-paren">(</span><em>x</em>, <em>*args</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.splitinversioncostfunctions.SplitInversionCostFunction.getGradient" title="Permalink to this definition">¶</a></dt>
<dd><p>returns the gradient of <em>f</em> at <em>x</em> using the precalculated values for
<em>x</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"><ul class="first simple">
<li><strong>x</strong> (<em>x-type</em>) – location of derivative</li>
<li><strong>args</strong> – pre-calculated values for <code class="docutils literal notranslate"><span class="pre">x</span></code> from <a class="reference internal" href="#esys.downunder.splitinversioncostfunctions.SplitInversionCostFunction.getArguments" title="esys.downunder.splitinversioncostfunctions.SplitInversionCostFunction.getArguments"><code class="xref py py-obj docutils literal notranslate"><span class="pre">getArguments()</span></code></a></li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">r-type</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.splitinversioncostfunctions.SplitInversionCostFunction.getInverseHessianApproximation">
<code class="descname">getInverseHessianApproximation</code><span class="sig-paren">(</span><em>x</em>, <em>r</em>, <em>*args</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.splitinversioncostfunctions.SplitInversionCostFunction.getInverseHessianApproximation" title="Permalink to this definition">¶</a></dt>
<dd><p>returns an approximative evaluation <em>p</em> of the inverse of the Hessian
operator of the cost function for a given gradient <em>r</em> at a given
location <em>x</em>: <em>H(x) p = r</em></p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">In general it is assumed that the Hessian <em>H(x)</em> needs to be
calculate in each call for a new location <em>x</em>. However, the
solver may suggest that this is not required, typically when
the iteration is close to completeness.</p>
</div>
<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>x</strong> (<em>x-type</em>) – location of Hessian operator to be evaluated.</li>
<li><strong>r</strong> (<em>r-type</em>) – a given gradient</li>
<li><strong>args</strong> – pre-calculated values for <code class="docutils literal notranslate"><span class="pre">x</span></code> from <a class="reference internal" href="#esys.downunder.splitinversioncostfunctions.SplitInversionCostFunction.getArguments" title="esys.downunder.splitinversioncostfunctions.SplitInversionCostFunction.getArguments"><code class="xref py py-obj docutils literal notranslate"><span class="pre">getArguments()</span></code></a></li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">x-type</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="staticmethod">
<dt id="esys.downunder.splitinversioncostfunctions.SplitInversionCostFunction.getModelArgs">
<em class="property">static </em><code class="descname">getModelArgs</code><span class="sig-paren">(</span><em>self</em>, <em>fwdmodels</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.splitinversioncostfunctions.SplitInversionCostFunction.getModelArgs" title="Permalink to this definition">¶</a></dt>
<dd><p>Attempts to import the arguments for forward models, if they are not available,
Computes and exports them</p>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.splitinversioncostfunctions.SplitInversionCostFunction.getNorm">
<code class="descname">getNorm</code><span class="sig-paren">(</span><em>x</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.splitinversioncostfunctions.SplitInversionCostFunction.getNorm" title="Permalink to this definition">¶</a></dt>
<dd><p>returns the norm of <code class="docutils literal notranslate"><span class="pre">x</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">Return type:</th><td class="field-body"><code class="docutils literal notranslate"><span class="pre">float</span></code></td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.splitinversioncostfunctions.SplitInversionCostFunction.getNumTradeOffFactors">
<code class="descname">getNumTradeOffFactors</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.splitinversioncostfunctions.SplitInversionCostFunction.getNumTradeOffFactors" title="Permalink to this definition">¶</a></dt>
<dd><p>returns the number of trade-off factors being used including the
trade-off factors used in the regularization component.</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">int</span></code></td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.splitinversioncostfunctions.SplitInversionCostFunction.getProperties">
<code class="descname">getProperties</code><span class="sig-paren">(</span><em>m</em>, <em>return_list=False</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.splitinversioncostfunctions.SplitInversionCostFunction.getProperties" title="Permalink to this definition">¶</a></dt>
<dd><p>returns a list of the physical properties from a given level set
function <em>m</em> using the mappings of the cost function.</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>m</strong> (<a class="reference internal" href="#esys.downunder.splitinversioncostfunctions.Data" title="esys.downunder.splitinversioncostfunctions.Data"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Data</span></code></a>) – level set function</li>
<li><strong>return_list</strong> (<code class="docutils literal notranslate"><span class="pre">bool</span></code>) – if <code class="docutils literal notranslate"><span class="pre">True</span></code> a list is returned.</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><code class="docutils literal notranslate"><span class="pre">list</span></code> of <a class="reference internal" href="#esys.downunder.splitinversioncostfunctions.Data" title="esys.downunder.splitinversioncostfunctions.Data"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Data</span></code></a></p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.splitinversioncostfunctions.SplitInversionCostFunction.getRegularization">
<code class="descname">getRegularization</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.splitinversioncostfunctions.SplitInversionCostFunction.getRegularization" title="Permalink to this definition">¶</a></dt>
<dd><p>returns the regularization</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">Regularization</span></code></td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.splitinversioncostfunctions.SplitInversionCostFunction.getTradeOffFactors">
<code class="descname">getTradeOffFactors</code><span class="sig-paren">(</span><em>mu=None</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.splitinversioncostfunctions.SplitInversionCostFunction.getTradeOffFactors" title="Permalink to this definition">¶</a></dt>
<dd><p>returns a list of the trade-off factors.</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">list</span></code> of <code class="docutils literal notranslate"><span class="pre">float</span></code></td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.splitinversioncostfunctions.SplitInversionCostFunction.getTradeOffFactorsModels">
<code class="descname">getTradeOffFactorsModels</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.splitinversioncostfunctions.SplitInversionCostFunction.getTradeOffFactorsModels" title="Permalink to this definition">¶</a></dt>
<dd><p>returns the trade-off factors for the forward models</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">float</span></code> or <code class="docutils literal notranslate"><span class="pre">list</span></code> of <code class="docutils literal notranslate"><span class="pre">float</span></code></td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.splitinversioncostfunctions.SplitInversionCostFunction.getValue">
<code class="descname">getValue</code><span class="sig-paren">(</span><em>x</em>, <em>*args</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.splitinversioncostfunctions.SplitInversionCostFunction.getValue" title="Permalink to this definition">¶</a></dt>
<dd><p>returns the value <em>f(x)</em> using the precalculated values for <em>x</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>x</strong> (<em>x-type</em>) – a solution approximation</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">float</span></code></td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="attribute">
<dt id="esys.downunder.splitinversioncostfunctions.SplitInversionCostFunction.provides_inverse_Hessian_approximation">
<code class="descname">provides_inverse_Hessian_approximation</code><em class="property"> = True</em><a class="headerlink" href="#esys.downunder.splitinversioncostfunctions.SplitInversionCostFunction.provides_inverse_Hessian_approximation" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="esys.downunder.splitinversioncostfunctions.SplitInversionCostFunction.resetCounters">
<code class="descname">resetCounters</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.splitinversioncostfunctions.SplitInversionCostFunction.resetCounters" title="Permalink to this definition">¶</a></dt>
<dd><p>resets all statistical counters</p>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.splitinversioncostfunctions.SplitInversionCostFunction.setPoint">
<code class="descname">setPoint</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.splitinversioncostfunctions.SplitInversionCostFunction.setPoint" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="esys.downunder.splitinversioncostfunctions.SplitInversionCostFunction.setTradeOffFactors">
<code class="descname">setTradeOffFactors</code><span class="sig-paren">(</span><em>mu=None</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.splitinversioncostfunctions.SplitInversionCostFunction.setTradeOffFactors" title="Permalink to this definition">¶</a></dt>
<dd><p>sets the trade-off factors for the forward model and regularization
terms.</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>mu</strong> (<code class="docutils literal notranslate"><span class="pre">list</span></code> of <code class="docutils literal notranslate"><span class="pre">float</span></code>) – list of trade-off factors.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.splitinversioncostfunctions.SplitInversionCostFunction.setTradeOffFactorsModels">
<code class="descname">setTradeOffFactorsModels</code><span class="sig-paren">(</span><em>mu=None</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.splitinversioncostfunctions.SplitInversionCostFunction.setTradeOffFactorsModels" title="Permalink to this definition">¶</a></dt>
<dd><p>sets the trade-off factors for the forward model components.</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>mu</strong> (<code class="docutils literal notranslate"><span class="pre">float</span></code> in case of a single model or a <code class="docutils literal notranslate"><span class="pre">list</span></code> of
<code class="docutils literal notranslate"><span class="pre">float</span></code> with the length of the number of models.) – list of the trade-off factors. If not present ones are used.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.splitinversioncostfunctions.SplitInversionCostFunction.setTradeOffFactorsRegularization">
<code class="descname">setTradeOffFactorsRegularization</code><span class="sig-paren">(</span><em>mu=None</em>, <em>mu_c=None</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.splitinversioncostfunctions.SplitInversionCostFunction.setTradeOffFactorsRegularization" title="Permalink to this definition">¶</a></dt>
<dd><p>sets the trade-off factors for the regularization component of the
cost function, see <code class="xref py py-obj docutils literal notranslate"><span class="pre">Regularization</span></code> for details.</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>mu</strong> – trade-off factors for the level-set variation part</li>
<li><strong>mu_c</strong> – trade-off factors for the cross gradient variation part</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="staticmethod">
<dt id="esys.downunder.splitinversioncostfunctions.SplitInversionCostFunction.subworld_setMu_model">
<em class="property">static </em><code class="descname">subworld_setMu_model</code><span class="sig-paren">(</span><em>self</em>, <em>**args</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.splitinversioncostfunctions.SplitInversionCostFunction.subworld_setMu_model" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="esys.downunder.splitinversioncostfunctions.SplitInversionCostFunction.updateHessian">
<code class="descname">updateHessian</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.splitinversioncostfunctions.SplitInversionCostFunction.updateHessian" title="Permalink to this definition">¶</a></dt>
<dd><p>notifies the class that the Hessian operator needs to be updated.</p>
</dd></dl>
<dl class="staticmethod">
<dt id="esys.downunder.splitinversioncostfunctions.SplitInversionCostFunction.update_point_helper">
<em class="property">static </em><code class="descname">update_point_helper</code><span class="sig-paren">(</span><em>self</em>, <em>newpoint</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.splitinversioncostfunctions.SplitInversionCostFunction.update_point_helper" title="Permalink to this definition">¶</a></dt>
<dd><p>Call within a subworld to set ‘current_point’ to newpoint
and update all the cached args info</p>
</dd></dl>
</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.splitinversioncostfunctions.inner">
<code class="descclassname">esys.downunder.splitinversioncostfunctions.</code><code class="descname">inner</code><span class="sig-paren">(</span><em>arg0</em>, <em>arg1</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.splitinversioncostfunctions.inner" title="Permalink to this definition">¶</a></dt>
<dd><p>Inner product of the two arguments. The inner product is defined as:</p>
<p><code class="xref py py-obj docutils literal notranslate"><span class="pre">out=Sigma_s</span> <span class="pre">arg0[s]*arg1[s]</span></code></p>
<p>where s runs through <code class="docutils literal notranslate"><span class="pre">arg0.Shape</span></code>.</p>
<p><code class="docutils literal notranslate"><span class="pre">arg0</span></code> and <code class="docutils literal notranslate"><span class="pre">arg1</span></code> must have the same shape.</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>arg0</strong> (<code class="docutils literal notranslate"><span class="pre">numpy.ndarray</span></code>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">escript.Data</span></code>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">Symbol</span></code>, <code class="docutils literal notranslate"><span class="pre">float</span></code>, <code class="docutils literal notranslate"><span class="pre">int</span></code>) – first argument</li>
<li><strong>arg1</strong> (<code class="docutils literal notranslate"><span class="pre">numpy.ndarray</span></code>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">escript.Data</span></code>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">Symbol</span></code>, <code class="docutils literal notranslate"><span class="pre">float</span></code>, <code class="docutils literal notranslate"><span class="pre">int</span></code>) – second argument</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">the inner product of <code class="docutils literal notranslate"><span class="pre">arg0</span></code> and <code class="docutils literal notranslate"><span class="pre">arg1</span></code> at each data point</p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first"><code class="docutils literal notranslate"><span class="pre">numpy.ndarray</span></code>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">escript.Data</span></code>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">Symbol</span></code>, <code class="docutils literal notranslate"><span class="pre">float</span></code>
depending on the input</p>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><p class="first last"><strong>ValueError</strong> – if the shapes of the arguments are not identical</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="esys.downunder.splitinversioncostfunctions.updateHessianWorker">
<code class="descclassname">esys.downunder.splitinversioncostfunctions.</code><code class="descname">updateHessianWorker</code><span class="sig-paren">(</span><em>self</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.splitinversioncostfunctions.updateHessianWorker" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</div>
<div class="section" id="others">
<h2>Others<a class="headerlink" href="#others" title="Permalink to this headline">¶</a></h2>
</div>
<div class="section" id="packages">
<h2>Packages<a class="headerlink" href="#packages" title="Permalink to this headline">¶</a></h2>
<div class="toctree-wrapper compound">
</div>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h3><a href="index.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">esys.downunder.splitinversioncostfunctions 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.seismic.html"
title="previous chapter">esys.downunder.seismic Package</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="esys.downunder.splitminimizers.html"
title="next chapter">esys.downunder.splitminimizers 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.splitminimizers.html" title="esys.downunder.splitminimizers Package"
>next</a> |</li>
<li class="right" >
<a href="esys.downunder.seismic.html" title="esys.downunder.seismic 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>
|
