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
|
<!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.domainbuilder 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.seismic Package" href="esys.downunder.seismic.html" />
<link rel="prev" title="esys.downunder.dcresistivityforwardmodeling Package" href="esys.downunder.dcresistivityforwardmodeling.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.seismic.html" title="esys.downunder.seismic Package"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="esys.downunder.dcresistivityforwardmodeling.html" title="esys.downunder.dcresistivityforwardmodeling 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.domainbuilder">
<span id="esys-downunder-domainbuilder-package"></span><h1>esys.downunder.domainbuilder Package<a class="headerlink" href="#module-esys.downunder.domainbuilder" title="Permalink to this headline">¶</a></h1>
<p>Domain construction from survey data for inversions</p>
<div class="section" id="classes">
<h2>Classes<a class="headerlink" href="#classes" title="Permalink to this headline">¶</a></h2>
<ul class="simple">
<li><a class="reference internal" href="#esys.downunder.domainbuilder.CartesianReferenceSystem" title="esys.downunder.domainbuilder.CartesianReferenceSystem"><code class="xref py py-obj docutils literal notranslate"><span class="pre">CartesianReferenceSystem</span></code></a></li>
<li><a class="reference internal" href="#esys.downunder.domainbuilder.DataSource" title="esys.downunder.domainbuilder.DataSource"><code class="xref py py-obj docutils literal notranslate"><span class="pre">DataSource</span></code></a></li>
<li><a class="reference internal" href="#esys.downunder.domainbuilder.DomainBuilder" title="esys.downunder.domainbuilder.DomainBuilder"><code class="xref py py-obj docutils literal notranslate"><span class="pre">DomainBuilder</span></code></a></li>
<li><a class="reference internal" href="#esys.downunder.domainbuilder.ReferenceSystem" title="esys.downunder.domainbuilder.ReferenceSystem"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ReferenceSystem</span></code></a></li>
</ul>
<dl class="class">
<dt id="esys.downunder.domainbuilder.CartesianReferenceSystem">
<em class="property">class </em><code class="descclassname">esys.downunder.domainbuilder.</code><code class="descname">CartesianReferenceSystem</code><span class="sig-paren">(</span><em>name='CARTESIAN'</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.domainbuilder.CartesianReferenceSystem" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">esys.downunder.coordinates.ReferenceSystem</span></code></p>
<p>Identifies the Cartesian coordinate system</p>
<dl class="method">
<dt id="esys.downunder.domainbuilder.CartesianReferenceSystem.__init__">
<code class="descname">__init__</code><span class="sig-paren">(</span><em>name='CARTESIAN'</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.domainbuilder.CartesianReferenceSystem.__init__" title="Permalink to this definition">¶</a></dt>
<dd><p>set up Cartesian coordinate system</p>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.domainbuilder.CartesianReferenceSystem.createTransformation">
<code class="descname">createTransformation</code><span class="sig-paren">(</span><em>domain</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.domainbuilder.CartesianReferenceSystem.createTransformation" title="Permalink to this definition">¶</a></dt>
<dd><p>creates an appropriate coordinate transformation on a given domain</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>domain</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">esys.escript.AbstractDomain</span></code>) – domain of transformation</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><code class="xref py py-obj docutils literal notranslate"><span class="pre">SpatialCoordinateTransformation</span></code></td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.domainbuilder.CartesianReferenceSystem.getName">
<code class="descname">getName</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.domainbuilder.CartesianReferenceSystem.getName" title="Permalink to this definition">¶</a></dt>
<dd><p>returns the name of the reference system</p>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.domainbuilder.CartesianReferenceSystem.isCartesian">
<code class="descname">isCartesian</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.domainbuilder.CartesianReferenceSystem.isCartesian" title="Permalink to this definition">¶</a></dt>
<dd><p>returns if the reference system is Cartesian</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><code class="docutils literal notranslate"><span class="pre">bool</span></code></td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.domainbuilder.CartesianReferenceSystem.isTheSame">
<code class="descname">isTheSame</code><span class="sig-paren">(</span><em>other</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.domainbuilder.CartesianReferenceSystem.isTheSame" title="Permalink to this definition">¶</a></dt>
<dd><p>test if argument <code class="docutils literal notranslate"><span class="pre">other</span></code> defines the same reference system</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>other</strong> (<a class="reference internal" href="#esys.downunder.domainbuilder.ReferenceSystem" title="esys.downunder.domainbuilder.ReferenceSystem"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ReferenceSystem</span></code></a>) – a second reference system</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><code class="docutils literal notranslate"><span class="pre">True</span></code> if <code class="docutils literal notranslate"><span class="pre">other</span></code> is a <a class="reference internal" href="#esys.downunder.domainbuilder.CartesianReferenceSystem" title="esys.downunder.domainbuilder.CartesianReferenceSystem"><code class="xref py py-obj docutils literal notranslate"><span class="pre">CartesianReferenceSystem</span></code></a> instance.</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><code class="docutils literal notranslate"><span class="pre">bool</span></code></td>
</tr>
<tr class="field-even field"><th class="field-name">Note:</th><td class="field-body">every two <a class="reference internal" href="#esys.downunder.domainbuilder.CartesianReferenceSystem" title="esys.downunder.domainbuilder.CartesianReferenceSystem"><code class="xref py py-obj docutils literal notranslate"><span class="pre">CartesianReferenceSystem</span></code></a> instances are considered
as being the same.</td>
</tr>
</tbody>
</table>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="esys.downunder.domainbuilder.DataSource">
<em class="property">class </em><code class="descclassname">esys.downunder.domainbuilder.</code><code class="descname">DataSource</code><span class="sig-paren">(</span><em>reference_system=None</em>, <em>tags=[]</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.domainbuilder.DataSource" 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>A class that provides survey data for the inversion process.
This is an abstract base class that implements common functionality.
Methods to be overwritten by subclasses are marked as such.
This class assumes 2D data which is mapped to a slice of a 3D domain.
For other setups override the methods as required.</p>
<dl class="method">
<dt id="esys.downunder.domainbuilder.DataSource.__init__">
<code class="descname">__init__</code><span class="sig-paren">(</span><em>reference_system=None</em>, <em>tags=[]</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.domainbuilder.DataSource.__init__" title="Permalink to this definition">¶</a></dt>
<dd><p>Constructor. Sets some defaults and initializes logger.</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>tags</strong> (<code class="docutils literal notranslate"><span class="pre">list</span></code> of almost any type (typically <code class="xref py py-obj docutils literal notranslate"><span class="pre">str</span></code>)) – a list of tags associated with the data set.</li>
<li><strong>reference_system</strong> (<code class="docutils literal notranslate"><span class="pre">None</span></code> or <a class="reference internal" href="#esys.downunder.domainbuilder.ReferenceSystem" title="esys.downunder.domainbuilder.ReferenceSystem"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ReferenceSystem</span></code></a>) – the reference coordinate system</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="attribute">
<dt id="esys.downunder.domainbuilder.DataSource.ACOUSTIC">
<code class="descname">ACOUSTIC</code><em class="property"> = 2</em><a class="headerlink" href="#esys.downunder.domainbuilder.DataSource.ACOUSTIC" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="esys.downunder.domainbuilder.DataSource.GRAVITY">
<code class="descname">GRAVITY</code><em class="property"> = 0</em><a class="headerlink" href="#esys.downunder.domainbuilder.DataSource.GRAVITY" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="esys.downunder.domainbuilder.DataSource.MAGNETIC">
<code class="descname">MAGNETIC</code><em class="property"> = 1</em><a class="headerlink" href="#esys.downunder.domainbuilder.DataSource.MAGNETIC" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="esys.downunder.domainbuilder.DataSource.MT">
<code class="descname">MT</code><em class="property"> = 3</em><a class="headerlink" href="#esys.downunder.domainbuilder.DataSource.MT" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="esys.downunder.domainbuilder.DataSource.getDataExtents">
<code class="descname">getDataExtents</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.domainbuilder.DataSource.getDataExtents" title="Permalink to this definition">¶</a></dt>
<dd><p>returns a tuple of tuples <code class="docutils literal notranslate"><span class="pre">(</span> <span class="pre">(x0,</span> <span class="pre">y0),</span> <span class="pre">(nx,</span> <span class="pre">ny),</span> <span class="pre">(dx,</span> <span class="pre">dy)</span> <span class="pre">)</span></code>, where</p>
<ul class="simple">
<li><code class="docutils literal notranslate"><span class="pre">x0</span></code>, <code class="docutils literal notranslate"><span class="pre">y0</span></code> = coordinates of data origin</li>
<li><code class="docutils literal notranslate"><span class="pre">nx</span></code>, <code class="docutils literal notranslate"><span class="pre">ny</span></code> = number of data points in x and y</li>
<li><code class="docutils literal notranslate"><span class="pre">dx</span></code>, <code class="docutils literal notranslate"><span class="pre">dy</span></code> = spacing of data points in x and y</li>
</ul>
<p>This method must be implemented in subclasses.</p>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.domainbuilder.DataSource.getDataType">
<code class="descname">getDataType</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.domainbuilder.DataSource.getDataType" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the type of survey data managed by this source.
Subclasses must return <a class="reference internal" href="#esys.downunder.domainbuilder.DataSource.GRAVITY" title="esys.downunder.domainbuilder.DataSource.GRAVITY"><code class="xref py py-obj docutils literal notranslate"><span class="pre">GRAVITY</span></code></a> or <a class="reference internal" href="#esys.downunder.domainbuilder.DataSource.MAGNETIC" title="esys.downunder.domainbuilder.DataSource.MAGNETIC"><code class="xref py py-obj docutils literal notranslate"><span class="pre">MAGNETIC</span></code></a> or <a class="reference internal" href="#esys.downunder.domainbuilder.DataSource.ACOUSTIC" title="esys.downunder.domainbuilder.DataSource.ACOUSTIC"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ACOUSTIC</span></code></a> as appropriate.</p>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.domainbuilder.DataSource.getHeightScale">
<code class="descname">getHeightScale</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.domainbuilder.DataSource.getHeightScale" title="Permalink to this definition">¶</a></dt>
<dd><p>returns the height scale factor to convert from meters to the
appropriate units of the reference system used.</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.domainbuilder.DataSource.getReferenceSystem">
<code class="descname">getReferenceSystem</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.domainbuilder.DataSource.getReferenceSystem" title="Permalink to this definition">¶</a></dt>
<dd><p>returns the reference coordinate system</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"><a class="reference internal" href="#esys.downunder.domainbuilder.ReferenceSystem" title="esys.downunder.domainbuilder.ReferenceSystem"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ReferenceSystem</span></code></a></td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.domainbuilder.DataSource.getSubsamplingFactor">
<code class="descname">getSubsamplingFactor</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.domainbuilder.DataSource.getSubsamplingFactor" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the subsampling factor that was set via <a class="reference internal" href="#esys.downunder.domainbuilder.DataSource.setSubsamplingFactor" title="esys.downunder.domainbuilder.DataSource.setSubsamplingFactor"><code class="xref py py-obj docutils literal notranslate"><span class="pre">setSubsamplingFactor</span></code></a>
(see there).</p>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.domainbuilder.DataSource.getSurveyData">
<code class="descname">getSurveyData</code><span class="sig-paren">(</span><em>domain</em>, <em>origin</em>, <em>NE</em>, <em>spacing</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.domainbuilder.DataSource.getSurveyData" title="Permalink to this definition">¶</a></dt>
<dd><p>This method is called by the <a class="reference internal" href="#esys.downunder.domainbuilder.DomainBuilder" title="esys.downunder.domainbuilder.DomainBuilder"><code class="xref py py-obj docutils literal notranslate"><span class="pre">DomainBuilder</span></code></a> to retrieve the survey
data as <code class="xref py py-obj docutils literal notranslate"><span class="pre">Data</span></code> objects on the given domain.</p>
<p>Subclasses should return one or more <code class="xref py py-obj docutils literal notranslate"><span class="pre">Data</span></code> objects with survey data
interpolated on the given <code class="xref py py-obj docutils literal notranslate"><span class="pre">escript</span></code> domain. The exact return type
depends on the type of data.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>domain</strong> (<a class="reference internal" href="esys.escript.html#esys.escript.Domain" title="esys.escript.Domain"><code class="xref py py-obj docutils literal notranslate"><span class="pre">esys.escript.Domain</span></code></a>) – the escript domain to use</li>
<li><strong>origin</strong> (<code class="docutils literal notranslate"><span class="pre">tuple</span></code> or <code class="docutils literal notranslate"><span class="pre">list</span></code>) – the origin coordinates of the domain</li>
<li><strong>NE</strong> (<code class="docutils literal notranslate"><span class="pre">tuple</span></code> or <code class="docutils literal notranslate"><span class="pre">list</span></code>) – the number of domain elements in each dimension</li>
<li><strong>spacing</strong> (<code class="docutils literal notranslate"><span class="pre">tuple</span></code> or <code class="docutils literal notranslate"><span class="pre">list</span></code>) – the cell sizes (node spacing) in the domain</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.domainbuilder.DataSource.getTags">
<code class="descname">getTags</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.domainbuilder.DataSource.getTags" title="Permalink to this definition">¶</a></dt>
<dd><p>returns the list of tags</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></td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.domainbuilder.DataSource.getUtmZone">
<code class="descname">getUtmZone</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.domainbuilder.DataSource.getUtmZone" title="Permalink to this definition">¶</a></dt>
<dd><p>All data source coordinates are converted to UTM (Universal Transverse
Mercator) in order to have useful domain extents. Subclasses should
implement this method and return the UTM zone number of the projected
coordinates.</p>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.domainbuilder.DataSource.hasTag">
<code class="descname">hasTag</code><span class="sig-paren">(</span><em>tag</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.domainbuilder.DataSource.hasTag" title="Permalink to this definition">¶</a></dt>
<dd><p>returns true if the data set has tag <code class="docutils literal notranslate"><span class="pre">tag</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>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.domainbuilder.DataSource.setSubsamplingFactor">
<code class="descname">setSubsamplingFactor</code><span class="sig-paren">(</span><em>f</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.domainbuilder.DataSource.setSubsamplingFactor" title="Permalink to this definition">¶</a></dt>
<dd><p>Sets the data subsampling factor (default=1).</p>
<p>The factor is applied in all dimensions. For example a 2D dataset
with 300 x 150 data points will be reduced to 150 x 75 when a
subsampling factor of 2 is used.
This becomes important when adding data of varying resolution to
a <a class="reference internal" href="#esys.downunder.domainbuilder.DomainBuilder" title="esys.downunder.domainbuilder.DomainBuilder"><code class="xref py py-obj docutils literal notranslate"><span class="pre">DomainBuilder</span></code></a>.</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="esys.downunder.domainbuilder.DomainBuilder">
<em class="property">class </em><code class="descclassname">esys.downunder.domainbuilder.</code><code class="descname">DomainBuilder</code><span class="sig-paren">(</span><em>dim=3</em>, <em>reference_system=None</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.domainbuilder.DomainBuilder" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
<p>This class is responsible for constructing an escript Domain object with
suitable extents and resolution for survey data (<a class="reference internal" href="#esys.downunder.domainbuilder.DataSource" title="esys.downunder.domainbuilder.DataSource"><code class="xref py py-obj docutils literal notranslate"><span class="pre">DataSource</span></code></a> objects)
that are added to it.</p>
<p>The domain covers a region above and below the Earth surface. The
East-West direction is used as the x- or longitudinal or x[0] direction,
the North-South direction is used as the y- or latitudinal or x[1]
direction, the vertical direction is denoted by z or radial or x[2]
direction. The corresponding terms are used synonymously.</p>
<dl class="method">
<dt id="esys.downunder.domainbuilder.DomainBuilder.__init__">
<code class="descname">__init__</code><span class="sig-paren">(</span><em>dim=3</em>, <em>reference_system=None</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.domainbuilder.DomainBuilder.__init__" title="Permalink to this definition">¶</a></dt>
<dd><p>Constructor.</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>dim</strong> (<code class="docutils literal notranslate"><span class="pre">int</span></code>) – Dimensionality (2 or 3) of the target domain.
This has implications for the survey data than can be
added. By default a 3D domain is created.</li>
<li><strong>reference_system</strong> (<a class="reference internal" href="#esys.downunder.domainbuilder.ReferenceSystem" title="esys.downunder.domainbuilder.ReferenceSystem"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ReferenceSystem</span></code></a>) – reference coordinate system. By default the
Cartesian coordinate system is used.</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.domainbuilder.DomainBuilder.addSource">
<code class="descname">addSource</code><span class="sig-paren">(</span><em>source</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.domainbuilder.DomainBuilder.addSource" title="Permalink to this definition">¶</a></dt>
<dd><p>Adds a survey data provider to the domain builder.
An exception is raised if the domain has already been built.
An exception is also reported if the reference system used is
cartesian and the UTM zone of <code class="xref py py-obj docutils literal notranslate"><span class="pre">source</span></code> does not match the UTM zone of
sources already added to the domain builder (see Inversion Cookbook
for more information).
The dimensionality of the data source must be compatible with this
domain builder. That is, the dimensionality of the data must be one
less than the dimensionality of the domain (specified in the
constructor).</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>source</strong> (<a class="reference internal" href="#esys.downunder.domainbuilder.DataSource" title="esys.downunder.domainbuilder.DataSource"><code class="xref py py-obj docutils literal notranslate"><span class="pre">DataSource</span></code></a>) – The data source to be added. Its reference system needs
to match the reference system of the DomainBuilder.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.domainbuilder.DomainBuilder.fixDensityBelow">
<code class="descname">fixDensityBelow</code><span class="sig-paren">(</span><em>depth=None</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.domainbuilder.DomainBuilder.fixDensityBelow" title="Permalink to this definition">¶</a></dt>
<dd><p>Defines the depth below which the density anomaly is set to a given
value. If no value is given zero is assumed.</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>depth</strong> (<code class="docutils literal notranslate"><span class="pre">float</span></code>) – depth below which the density is fixed. If not set, no
constraint at depth is applied.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.domainbuilder.DomainBuilder.fixSusceptibilityBelow">
<code class="descname">fixSusceptibilityBelow</code><span class="sig-paren">(</span><em>depth=None</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.domainbuilder.DomainBuilder.fixSusceptibilityBelow" title="Permalink to this definition">¶</a></dt>
<dd><p>Defines the depth below which the susceptibility anomaly is set to a
given value. If no value is given zero is assumed.</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>depth</strong> (<code class="docutils literal notranslate"><span class="pre">float</span></code>) – depth below which the susceptibility is fixed. If not
set, no constraint at depth is applied.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.domainbuilder.DomainBuilder.fixVelocityBelow">
<code class="descname">fixVelocityBelow</code><span class="sig-paren">(</span><em>depth=None</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.domainbuilder.DomainBuilder.fixVelocityBelow" title="Permalink to this definition">¶</a></dt>
<dd><p>Defines the depth below which the velocity and Q index is set to a
given value. If no value is given zero is assumed.</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>depth</strong> (<code class="docutils literal notranslate"><span class="pre">float</span></code>) – depth below which the velocity is fixed. If not
set, no constraint at depth is applied.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.domainbuilder.DomainBuilder.getBackgroundMagneticFluxDensity">
<code class="descname">getBackgroundMagneticFluxDensity</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.domainbuilder.DomainBuilder.getBackgroundMagneticFluxDensity" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the background magnetic flux density.</p>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.domainbuilder.DomainBuilder.getDomain">
<code class="descname">getDomain</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.domainbuilder.DomainBuilder.getDomain" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns a domain that spans the data area plus padding.</p>
<p>The domain is created the first time this method is called,
subsequent calls return the same domain so anything that affects
the domain (such as padding) needs to be set beforehand.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">The escript domain for this data source</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="esys.escript.html#esys.escript.Domain" title="esys.escript.Domain"><code class="xref py py-obj docutils literal notranslate"><span class="pre">esys.escript.Domain</span></code></a></td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.domainbuilder.DomainBuilder.getGravitySurveys">
<code class="descname">getGravitySurveys</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.domainbuilder.DomainBuilder.getGravitySurveys" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns a list of gravity surveys, see <a class="reference internal" href="#esys.downunder.domainbuilder.DomainBuilder.getSurveys" title="esys.downunder.domainbuilder.DomainBuilder.getSurveys"><code class="xref py py-obj docutils literal notranslate"><span class="pre">getSurveys</span></code></a> for details.</p>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.domainbuilder.DomainBuilder.getMagneticSurveys">
<code class="descname">getMagneticSurveys</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.domainbuilder.DomainBuilder.getMagneticSurveys" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns a list of magnetic surveys, see <a class="reference internal" href="#esys.downunder.domainbuilder.DomainBuilder.getSurveys" title="esys.downunder.domainbuilder.DomainBuilder.getSurveys"><code class="xref py py-obj docutils literal notranslate"><span class="pre">getSurveys</span></code></a> for details.</p>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.domainbuilder.DomainBuilder.getReferenceSystem">
<code class="descname">getReferenceSystem</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.domainbuilder.DomainBuilder.getReferenceSystem" title="Permalink to this definition">¶</a></dt>
<dd><p>returns the reference coordinate system</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"><a class="reference internal" href="#esys.downunder.domainbuilder.ReferenceSystem" title="esys.downunder.domainbuilder.ReferenceSystem"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ReferenceSystem</span></code></a></td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.domainbuilder.DomainBuilder.getSetDensityMask">
<code class="descname">getSetDensityMask</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.domainbuilder.DomainBuilder.getSetDensityMask" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the density mask data object which is non-zero for cells
whose density value is fixed, zero otherwise.</p>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.domainbuilder.DomainBuilder.getSetSusceptibilityMask">
<code class="descname">getSetSusceptibilityMask</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.domainbuilder.DomainBuilder.getSetSusceptibilityMask" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the susceptibility mask data object which is non-zero for
cells whose susceptibility value is fixed, zero otherwise.</p>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.domainbuilder.DomainBuilder.getSurveys">
<code class="descname">getSurveys</code><span class="sig-paren">(</span><em>datatype</em>, <em>tags=None</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.domainbuilder.DomainBuilder.getSurveys" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns a list of <code class="xref py py-obj docutils literal notranslate"><span class="pre">Data</span></code> objects for all surveys of type <code class="xref py py-obj docutils literal notranslate"><span class="pre">datatype</span></code>
available to this domain builder. If a list of <code class="xref py py-obj docutils literal notranslate"><span class="pre">tags</span></code> is given
only data sources whose tag matches the tag list are returned.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">List of surveys which are tuples (anomaly,error).</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></td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.domainbuilder.DomainBuilder.getTags">
<code class="descname">getTags</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.domainbuilder.DomainBuilder.getTags" title="Permalink to this definition">¶</a></dt>
<dd><p>returns a list of all tags in use by the attached data sources.
The list may be empty.</p>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.domainbuilder.DomainBuilder.setBackgroundMagneticFluxDensity">
<code class="descname">setBackgroundMagneticFluxDensity</code><span class="sig-paren">(</span><em>B</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.domainbuilder.DomainBuilder.setBackgroundMagneticFluxDensity" title="Permalink to this definition">¶</a></dt>
<dd><p>Sets the background magnetic flux density B=(B_East, B_North, B_Vertical)</p>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.domainbuilder.DomainBuilder.setElementPadding">
<code class="descname">setElementPadding</code><span class="sig-paren">(</span><em>pad_x=None</em>, <em>pad_y=None</em>, <em>pad_lat=None</em>, <em>pad_lon=None</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.domainbuilder.DomainBuilder.setElementPadding" title="Permalink to this definition">¶</a></dt>
<dd><p>Sets the amount of padding around the dataset in number of elements
(cells).</p>
<p>When the domain is constructed <code class="xref py py-obj docutils literal notranslate"><span class="pre">pad_x</span></code> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">pad_y</span></code>) elements are added
on each side of the x- (y-) dimension. The arguments must be
non-negative.</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>pad_x</strong> (<code class="docutils literal notranslate"><span class="pre">int</span></code>) – Padding per side in x direction (default: no padding)</li>
<li><strong>pad_y</strong> (<code class="docutils literal notranslate"><span class="pre">int</span></code>) – Padding per side in y direction (default: no padding)</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Note:</th><td class="field-body"><p class="first last"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pad_y</span></code> is ignored for 2-dimensional datasets.</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.domainbuilder.DomainBuilder.setFractionalPadding">
<code class="descname">setFractionalPadding</code><span class="sig-paren">(</span><em>pad_x=None</em>, <em>pad_y=None</em>, <em>pad_lat=None</em>, <em>pad_lon=None</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.domainbuilder.DomainBuilder.setFractionalPadding" title="Permalink to this definition">¶</a></dt>
<dd><p>Sets the amount of padding around the dataset as a fraction of the
dataset side lengths.</p>
<p>For example, calling <code class="docutils literal notranslate"><span class="pre">setFractionalPadding(0.2,</span> <span class="pre">0.1)</span></code> with a data
source of size 10x20 will result in the padded data set size
14x24 (10*(1+2*0.2), 20*(1+2*0.1))</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>pad_x</strong> (<code class="docutils literal notranslate"><span class="pre">float</span></code>) – Padding per side in x direction (default: no padding)</li>
<li><strong>pad_y</strong> (<code class="docutils literal notranslate"><span class="pre">float</span></code>) – Padding per side in y direction (default: no padding)</li>
<li><strong>pad_lat</strong> (<code class="docutils literal notranslate"><span class="pre">float</span></code>) – Padding per side in latitudinal direction (default: no padding)</li>
<li><strong>pad_lon</strong> (<code class="docutils literal notranslate"><span class="pre">float</span></code>) – Padding per side in longitudinal direction (default: no padding)</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Note:</th><td class="field-body"><p class="first last"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pad_y</span></code> is ignored for 2-dimensional domains.</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.domainbuilder.DomainBuilder.setGeoPadding">
<code class="descname">setGeoPadding</code><span class="sig-paren">(</span><em>pad_lat=None</em>, <em>pad_lon=None</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.domainbuilder.DomainBuilder.setGeoPadding" title="Permalink to this definition">¶</a></dt>
<dd><p>Sets the amount of padding around the dataset in longitude and latitude.</p>
<p>The final domain size will be the extent in the latitudinal (in
longitudinal) direction of the dataset plus twice the value of
<code class="xref py py-obj docutils literal notranslate"><span class="pre">pad_lat</span></code> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">pad_lon</span></code>). The arguments must be non-negative.</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>pad_lat</strong> (<code class="docutils literal notranslate"><span class="pre">float</span></code> in units of degree) – Padding per side in latitudinal direction (default: 0)</li>
<li><strong>pad_lon</strong> (<code class="docutils literal notranslate"><span class="pre">float</span></code> in units of degree) – Padding per side in longitudinal direction (default: 0)</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Note:</th><td class="field-body"><p class="first"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pad_lon</span></code> is ignored for 2-dimensional domains.</p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Note:</th><td class="field-body"><p class="first last">this function can only be used if the reference system is not Cartesian</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.domainbuilder.DomainBuilder.setPadding">
<code class="descname">setPadding</code><span class="sig-paren">(</span><em>pad_x=None</em>, <em>pad_y=None</em>, <em>pad_lat=None</em>, <em>pad_lon=None</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.domainbuilder.DomainBuilder.setPadding" title="Permalink to this definition">¶</a></dt>
<dd><p>Sets the amount of padding around the dataset in absolute length units.</p>
<p>The final domain size will be the length in x (in y) of the dataset
plus twice the value of <code class="xref py py-obj docutils literal notranslate"><span class="pre">pad_x</span></code> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">pad_y</span></code>). The arguments must be
non-negative.</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>pad_x</strong> (<code class="docutils literal notranslate"><span class="pre">float</span></code> in units of length (meter)) – Padding per side in x direction (default: no padding)</li>
<li><strong>pad_y</strong> (<code class="docutils literal notranslate"><span class="pre">float</span></code> in units of length (meter)) – Padding per side in y direction (default: no padding)</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Note:</th><td class="field-body"><p class="first"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pad_y</span></code> is ignored for 2-dimensional domains.</p>
</td>
</tr>
<tr class="field-odd field"><th class="field-name">Note:</th><td class="field-body"><p class="first last">this function can only be used if the reference system is Cartesian</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.domainbuilder.DomainBuilder.setVerticalExtents">
<code class="descname">setVerticalExtents</code><span class="sig-paren">(</span><em>depth=40000.0</em>, <em>air_layer=10000.0</em>, <em>num_cells=25</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.domainbuilder.DomainBuilder.setVerticalExtents" title="Permalink to this definition">¶</a></dt>
<dd><p>This method sets the target domain parameters for the vertical
dimension.</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>depth</strong> (<code class="docutils literal notranslate"><span class="pre">float</span></code>) – Depth of the domain (in meters)</li>
<li><strong>air_layer</strong> (<code class="docutils literal notranslate"><span class="pre">float</span></code>) – Depth of the layer above sea level (in meters)</li>
<li><strong>num_cells</strong> (<code class="docutils literal notranslate"><span class="pre">int</span></code>) – Number of domain elements for the entire vertical
dimension</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="esys.downunder.domainbuilder.ReferenceSystem">
<em class="property">class </em><code class="descclassname">esys.downunder.domainbuilder.</code><code class="descname">ReferenceSystem</code><span class="sig-paren">(</span><em>name='none'</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.domainbuilder.ReferenceSystem" 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>Generic identifier for coordinate systems.</p>
<dl class="method">
<dt id="esys.downunder.domainbuilder.ReferenceSystem.__init__">
<code class="descname">__init__</code><span class="sig-paren">(</span><em>name='none'</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.domainbuilder.ReferenceSystem.__init__" title="Permalink to this definition">¶</a></dt>
<dd><p>initialization of reference system</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>name</strong> (<code class="docutils literal notranslate"><span class="pre">str</span></code>) – name of the reference system</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.domainbuilder.ReferenceSystem.createTransformation">
<code class="descname">createTransformation</code><span class="sig-paren">(</span><em>domain</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.domainbuilder.ReferenceSystem.createTransformation" title="Permalink to this definition">¶</a></dt>
<dd><p>creates an appropriate coordinate transformation on a given domain</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">needs to be overwritten by a particular reference system</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>domain</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">esys.escript.AbstractDomain</span></code>) – domain of transformation</td>
</tr>
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><code class="xref py py-obj docutils literal notranslate"><span class="pre">SpatialCoordinateTransformation</span></code></td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.domainbuilder.ReferenceSystem.getName">
<code class="descname">getName</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.domainbuilder.ReferenceSystem.getName" title="Permalink to this definition">¶</a></dt>
<dd><p>returns the name of the reference system</p>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.domainbuilder.ReferenceSystem.isCartesian">
<code class="descname">isCartesian</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.domainbuilder.ReferenceSystem.isCartesian" title="Permalink to this definition">¶</a></dt>
<dd><p>returns if the reference system is Cartesian</p>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">needs to be overwritten by a particular reference system</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">Return type:</th><td class="field-body"><code class="docutils literal notranslate"><span class="pre">bool</span></code></td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.domainbuilder.ReferenceSystem.isTheSame">
<code class="descname">isTheSame</code><span class="sig-paren">(</span><em>other</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.domainbuilder.ReferenceSystem.isTheSame" title="Permalink to this definition">¶</a></dt>
<dd><p>test if argument <code class="docutils literal notranslate"><span class="pre">other</span></code> defines the same reference system</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>other</strong> (<a class="reference internal" href="#esys.downunder.domainbuilder.ReferenceSystem" title="esys.downunder.domainbuilder.ReferenceSystem"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ReferenceSystem</span></code></a>) – a second reference system</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><code class="docutils literal notranslate"><span class="pre">True</span></code> if other defines the same reference system</td>
</tr>
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><code class="docutils literal notranslate"><span class="pre">bool</span></code></td>
</tr>
</tbody>
</table>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">needs to be overwritten by a particular reference system</p>
</div>
</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.domainbuilder.Brick">
<code class="descclassname">esys.downunder.domainbuilder.</code><code class="descname">Brick</code><span class="sig-paren">(</span><em>(float)n0</em>, <em>(float)n1</em>, <em>(float)n2</em><span class="optional">[</span>, <em>(object)l0=1.0</em><span class="optional">[</span>, <em>(object)l1=1.0</em><span class="optional">[</span>, <em>(object)l2=1.0</em><span class="optional">[</span>, <em>(int)d0=-1</em><span class="optional">[</span>, <em>(int)d1=-1</em><span class="optional">[</span>, <em>(int)d2=-1</em><span class="optional">[</span>, <em>(object)diracPoints=[]</em><span class="optional">[</span>, <em>(object)diracTags=[]</em><span class="optional">[</span>, <em>(SubWorld)escriptworld=None</em><span class="optional">]</span><span class="optional">]</span><span class="optional">]</span><span class="optional">]</span><span class="optional">]</span><span class="optional">]</span><span class="optional">]</span><span class="optional">]</span><span class="optional">]</span><span class="sig-paren">)</span> → Domain :<a class="headerlink" href="#esys.downunder.domainbuilder.Brick" title="Permalink to this definition">¶</a></dt>
<dd><p>Creates a hexagonal mesh with n0 x n1 x n2 elements over the brick [0,l0] x [0,l1] x [0,l2].</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>n0</strong> (<code class="docutils literal notranslate"><span class="pre">int</span></code>) – number of elements in direction 0</li>
<li><strong>n1</strong> (<code class="docutils literal notranslate"><span class="pre">int</span></code>) – number of elements in direction 1</li>
<li><strong>n2</strong> (<code class="docutils literal notranslate"><span class="pre">int</span></code>) – number of elements in direction 2</li>
<li><strong>l0</strong> (<code class="docutils literal notranslate"><span class="pre">float</span></code> or <code class="docutils literal notranslate"><span class="pre">tuple</span></code>) – length of side 0 or coordinate range of side 0</li>
<li><strong>l1</strong> (<code class="docutils literal notranslate"><span class="pre">float</span></code> or <code class="docutils literal notranslate"><span class="pre">tuple</span></code>) – length of side 1 or coordinate range of side 1</li>
<li><strong>l2</strong> (<code class="docutils literal notranslate"><span class="pre">float</span></code> or <code class="docutils literal notranslate"><span class="pre">tuple</span></code>) – length of side 2 or coordinate range of side 2</li>
<li><strong>d0</strong> (<code class="docutils literal notranslate"><span class="pre">int</span></code>) – number of subdivisions in direction 0</li>
<li><strong>d1</strong> (<code class="docutils literal notranslate"><span class="pre">int</span></code>) – number of subdivisions in direction 1</li>
<li><strong>d2</strong> (<code class="docutils literal notranslate"><span class="pre">int</span></code>) – number of subdivisions in direction 2</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="function">
<dt id="esys.downunder.domainbuilder.Rectangle">
<code class="descclassname">esys.downunder.domainbuilder.</code><code class="descname">Rectangle</code><span class="sig-paren">(</span><em>(float)n0</em>, <em>(float)n1</em><span class="optional">[</span>, <em>(object)l0=1.0</em><span class="optional">[</span>, <em>(object)l1=1.0</em><span class="optional">[</span>, <em>(int)d0=-1</em><span class="optional">[</span>, <em>(int)d1=-1</em><span class="optional">[</span>, <em>(object)diracPoints=[]</em><span class="optional">[</span>, <em>(object)diracTags=[]</em><span class="optional">[</span>, <em>(SubWorld)escriptworld=None</em><span class="optional">]</span><span class="optional">]</span><span class="optional">]</span><span class="optional">]</span><span class="optional">]</span><span class="optional">]</span><span class="optional">]</span><span class="sig-paren">)</span> → Domain :<a class="headerlink" href="#esys.downunder.domainbuilder.Rectangle" title="Permalink to this definition">¶</a></dt>
<dd><p>Creates a rectangular mesh with n0 x n1 elements over the rectangle [0,l0] x [0,l1].</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>n0</strong> (<code class="docutils literal notranslate"><span class="pre">int</span></code>) – number of elements in direction 0</li>
<li><strong>n1</strong> (<code class="docutils literal notranslate"><span class="pre">int</span></code>) – number of elements in direction 1</li>
<li><strong>l0</strong> (<code class="docutils literal notranslate"><span class="pre">float</span></code> or <code class="docutils literal notranslate"><span class="pre">tuple</span></code>) – length of side 0 or coordinate range of side 0</li>
<li><strong>l1</strong> (<code class="docutils literal notranslate"><span class="pre">float</span></code> or <code class="docutils literal notranslate"><span class="pre">tuple</span></code>) – length of side 1 or coordinate range of side 1</li>
<li><strong>d0</strong> (<code class="docutils literal notranslate"><span class="pre">int</span></code>) – number of subdivisions in direction 0</li>
<li><strong>d1</strong> (<code class="docutils literal notranslate"><span class="pre">int</span></code>) – number of subdivisions in direction 1</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
</div>
<div class="section" id="others">
<h2>Others<a class="headerlink" href="#others" title="Permalink to this headline">¶</a></h2>
<ul class="simple">
<li>HAVE_RIPLEY</li>
</ul>
</div>
<div class="section" id="packages">
<h2>Packages<a class="headerlink" href="#packages" title="Permalink to this headline">¶</a></h2>
<div class="toctree-wrapper compound">
</div>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h3><a href="index.html">Table of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">esys.downunder.domainbuilder 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.dcresistivityforwardmodeling.html"
title="previous chapter">esys.downunder.dcresistivityforwardmodeling Package</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="esys.downunder.seismic.html"
title="next chapter">esys.downunder.seismic 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.seismic.html" title="esys.downunder.seismic Package"
>next</a> |</li>
<li class="right" >
<a href="esys.downunder.dcresistivityforwardmodeling.html" title="esys.downunder.dcresistivityforwardmodeling 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>
|
