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
|
<!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.seismic 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.splitinversioncostfunctions Package" href="esys.downunder.splitinversioncostfunctions.html" />
<link rel="prev" title="esys.downunder.domainbuilder Package" href="esys.downunder.domainbuilder.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.splitinversioncostfunctions.html" title="esys.downunder.splitinversioncostfunctions Package"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="esys.downunder.domainbuilder.html" title="esys.downunder.domainbuilder 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.seismic">
<span id="esys-downunder-seismic-package"></span><h1>esys.downunder.seismic Package<a class="headerlink" href="#module-esys.downunder.seismic" 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.seismic.HTIWave" title="esys.downunder.seismic.HTIWave"><code class="xref py py-obj docutils literal notranslate"><span class="pre">HTIWave</span></code></a></li>
<li><a class="reference internal" href="#esys.downunder.seismic.Ricker" title="esys.downunder.seismic.Ricker"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Ricker</span></code></a></li>
<li><a class="reference internal" href="#esys.downunder.seismic.SimpleSEGYWriter" title="esys.downunder.seismic.SimpleSEGYWriter"><code class="xref py py-obj docutils literal notranslate"><span class="pre">SimpleSEGYWriter</span></code></a></li>
<li><a class="reference internal" href="#esys.downunder.seismic.SonicHTIWave" title="esys.downunder.seismic.SonicHTIWave"><code class="xref py py-obj docutils literal notranslate"><span class="pre">SonicHTIWave</span></code></a></li>
<li><a class="reference internal" href="#esys.downunder.seismic.SonicWave" title="esys.downunder.seismic.SonicWave"><code class="xref py py-obj docutils literal notranslate"><span class="pre">SonicWave</span></code></a></li>
<li><a class="reference internal" href="#esys.downunder.seismic.TTIWave" title="esys.downunder.seismic.TTIWave"><code class="xref py py-obj docutils literal notranslate"><span class="pre">TTIWave</span></code></a></li>
<li><a class="reference internal" href="#esys.downunder.seismic.VTIWave" title="esys.downunder.seismic.VTIWave"><code class="xref py py-obj docutils literal notranslate"><span class="pre">VTIWave</span></code></a></li>
<li><a class="reference internal" href="#esys.downunder.seismic.WaveBase" title="esys.downunder.seismic.WaveBase"><code class="xref py py-obj docutils literal notranslate"><span class="pre">WaveBase</span></code></a></li>
<li><a class="reference internal" href="#esys.downunder.seismic.Wavelet" title="esys.downunder.seismic.Wavelet"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Wavelet</span></code></a></li>
</ul>
<dl class="class">
<dt id="esys.downunder.seismic.HTIWave">
<em class="property">class </em><code class="descclassname">esys.downunder.seismic.</code><code class="descname">HTIWave</code><span class="sig-paren">(</span><em>domain, v_p, v_s, wavelet, source_tag, source_vector=[1.0, 0.0, 0.0], eps=0.0, gamma=0.0, delta=0.0, rho=1.0, dt=None, u0=None, v0=None, absorption_zone=None, absorption_cut=0.01, lumping=True, disable_fast_assemblers=False</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.seismic.HTIWave" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#esys.downunder.seismic.WaveBase" title="esys.downunder.seismic.WaveBase"><code class="xref py py-class docutils literal notranslate"><span class="pre">esys.downunder.seismic.WaveBase</span></code></a></p>
<p>Solving the HTI wave equation (along the x_0 axis)</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">In case of a two dimensional domain a horizontal domain is considered, i.e. the depth component is dropped.</td>
</tr>
</tbody>
</table>
<dl class="method">
<dt id="esys.downunder.seismic.HTIWave.__init__">
<code class="descname">__init__</code><span class="sig-paren">(</span><em>domain, v_p, v_s, wavelet, source_tag, source_vector=[1.0, 0.0, 0.0], eps=0.0, gamma=0.0, delta=0.0, rho=1.0, dt=None, u0=None, v0=None, absorption_zone=None, absorption_cut=0.01, lumping=True, disable_fast_assemblers=False</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.seismic.HTIWave.__init__" title="Permalink to this definition">¶</a></dt>
<dd><p>initialize the VTI wave solver</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>domain</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">Domain</span></code>) – domain of the problem</li>
<li><strong>v_p</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">escript.Scalar</span></code>) – vertical p-velocity field</li>
<li><strong>v_s</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">escript.Scalar</span></code>) – vertical s-velocity field</li>
<li><strong>wavelet</strong> (<a class="reference internal" href="#esys.downunder.seismic.Wavelet" title="esys.downunder.seismic.Wavelet"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Wavelet</span></code></a>) – wavelet to describe the time evolution of source term</li>
<li><strong>source_tag</strong> (<em>'str'</em><em> or </em><em>'int'</em>) – tag of the source location</li>
<li><strong>source_vector</strong> – source orientation vector</li>
<li><strong>eps</strong> – first Thompsen parameter</li>
<li><strong>delta</strong> – second Thompsen parameter</li>
<li><strong>gamma</strong> – third Thompsen parameter</li>
<li><strong>rho</strong> – density</li>
<li><strong>dt</strong> – time step size. If not present a suitable time step size is calculated.</li>
<li><strong>u0</strong> – initial solution. If not present zero is used.</li>
<li><strong>v0</strong> – initial solution change rate. If not present zero is used.</li>
<li><strong>absorption_zone</strong> – thickness of absorption zone</li>
<li><strong>absorption_cut</strong> – boundary value of absorption decay factor</li>
<li><strong>lumping</strong> – if True mass matrix lumping is being used. This is accelerates the computing but introduces some diffusion.</li>
<li><strong>disable_fast_assemblers</strong> – if True, forces use of slower and more general PDE assemblers</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.seismic.HTIWave.getTimeStepSize">
<code class="descname">getTimeStepSize</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.seismic.HTIWave.getTimeStepSize" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="esys.downunder.seismic.HTIWave.setQ">
<code class="descname">setQ</code><span class="sig-paren">(</span><em>q</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.seismic.HTIWave.setQ" title="Permalink to this definition">¶</a></dt>
<dd><p>sets the PDE q value</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>q</strong> – the value to set</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.seismic.HTIWave.update">
<code class="descname">update</code><span class="sig-paren">(</span><em>t</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.seismic.HTIWave.update" title="Permalink to this definition">¶</a></dt>
<dd><p>returns the solution for the next time marker t which needs to greater than the time marker from the
previous call.</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="esys.downunder.seismic.Ricker">
<em class="property">class </em><code class="descclassname">esys.downunder.seismic.</code><code class="descname">Ricker</code><span class="sig-paren">(</span><em>f_dom=40</em>, <em>t_dom=None</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.seismic.Ricker" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#esys.downunder.seismic.Wavelet" title="esys.downunder.seismic.Wavelet"><code class="xref py py-class docutils literal notranslate"><span class="pre">esys.downunder.seismic.Wavelet</span></code></a></p>
<p>The Ricker Wavelet w=f(t)</p>
<dl class="method">
<dt id="esys.downunder.seismic.Ricker.__init__">
<code class="descname">__init__</code><span class="sig-paren">(</span><em>f_dom=40</em>, <em>t_dom=None</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.seismic.Ricker.__init__" title="Permalink to this definition">¶</a></dt>
<dd><p>Sets up a Ricker wavelet wih dominant frequence <code class="xref py py-obj docutils literal notranslate"><span class="pre">f_dom</span></code> and
center at time <code class="xref py py-obj docutils literal notranslate"><span class="pre">t_dom</span></code>. If <code class="xref py py-obj docutils literal notranslate"><span class="pre">t_dom</span></code> is not given an estimate
for suitable <code class="xref py py-obj docutils literal notranslate"><span class="pre">t_dom</span></code> is calculated so f(0)~0.</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">maximum frequence is about 2 x the dominant frequence.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.seismic.Ricker.getAcceleration">
<code class="descname">getAcceleration</code><span class="sig-paren">(</span><em>t</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.seismic.Ricker.getAcceleration" title="Permalink to this definition">¶</a></dt>
<dd><p>get the acceleration f’‘(t) at time <code class="xref py py-obj docutils literal notranslate"><span class="pre">t</span></code></p>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.seismic.Ricker.getCenter">
<code class="descname">getCenter</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.seismic.Ricker.getCenter" title="Permalink to this definition">¶</a></dt>
<dd><p>Return value of wavelet center</p>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.seismic.Ricker.getTimeScale">
<code class="descname">getTimeScale</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.seismic.Ricker.getTimeScale" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the time scale which is the inverse of the largest
frequence with a significant spectral component.</p>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.seismic.Ricker.getValue">
<code class="descname">getValue</code><span class="sig-paren">(</span><em>t</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.seismic.Ricker.getValue" title="Permalink to this definition">¶</a></dt>
<dd><p>get value of wavelet at time <code class="xref py py-obj docutils literal notranslate"><span class="pre">t</span></code></p>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.seismic.Ricker.getVelocity">
<code class="descname">getVelocity</code><span class="sig-paren">(</span><em>t</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.seismic.Ricker.getVelocity" title="Permalink to this definition">¶</a></dt>
<dd><p>get the velocity f’(t) at time <code class="xref py py-obj docutils literal notranslate"><span class="pre">t</span></code></p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="esys.downunder.seismic.SimpleSEGYWriter">
<em class="property">class </em><code class="descclassname">esys.downunder.seismic.</code><code class="descname">SimpleSEGYWriter</code><span class="sig-paren">(</span><em>receiver_group=None</em>, <em>source=0.0</em>, <em>sampling_interval=0.004</em>, <em>text='some seimic data'</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.seismic.SimpleSEGYWriter" 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 simple writer for 2D and 3D seismic lines, in particular for synthetic data</p>
<p>Typical 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">unitsSI</span> <span class="k">as</span> <span class="n">U</span>
<span class="n">sw</span><span class="o">=</span><span class="n">SimpleSEGYWriter</span><span class="p">([</span><span class="mf">0.</span><span class="p">,</span><span class="mi">100</span><span class="o">*</span><span class="n">U</span><span class="o">.</span><span class="n">m</span><span class="p">,</span><span class="mi">200</span><span class="o">*</span><span class="n">U</span><span class="p">,</span><span class="n">m</span><span class="p">,</span><span class="mf">300.</span><span class="p">],</span> <span class="n">source</span><span class="o">=</span><span class="mi">200</span><span class="o">*</span><span class="n">U</span><span class="o">.</span><span class="n">m</span><span class="p">,</span> <span class="n">sampling_interval</span><span class="o">=</span><span class="mi">4</span><span class="o">*</span><span class="n">U</span><span class="o">.</span><span class="n">msec</span><span class="p">)</span>
<span class="k">while</span> <span class="n">n</span> <span class="o"><</span> <span class="mi">10</span><span class="p">:</span>
<span class="n">sw</span><span class="o">.</span><span class="n">addRecord</span><span class="p">([</span><span class="n">i</span><span class="o">*</span><span class="mf">2.</span><span class="p">,</span> <span class="n">i</span><span class="o">*</span><span class="mf">0.67</span><span class="p">,</span> <span class="n">i</span><span class="o">**</span><span class="mi">2</span><span class="p">,</span> <span class="o">-</span><span class="n">i</span><span class="o">*</span><span class="mi">7</span><span class="p">])</span>
<span class="n">sw</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s1">'example.segy'</span><span class="p">)</span>
</pre></div>
</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 writer uses <code class="xref py py-obj docutils literal notranslate"><span class="pre">obspy</span></code></td>
</tr>
</tbody>
</table>
<dl class="method">
<dt id="esys.downunder.seismic.SimpleSEGYWriter.__init__">
<code class="descname">__init__</code><span class="sig-paren">(</span><em>receiver_group=None</em>, <em>source=0.0</em>, <em>sampling_interval=0.004</em>, <em>text='some seimic data'</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.seismic.SimpleSEGYWriter.__init__" title="Permalink to this definition">¶</a></dt>
<dd><p>initalize writer</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>receiver_group</strong> – list of receiver coordinates (in meters). For the 2D case a list of floats is given, for the 3D case a list of coordinate tuples
are given</li>
<li><strong>source</strong> – coordinates of the source (in meters). For the 2D case a single floats is given, for the 3D case a coordinate tuples</li>
<li><strong>sampling_interval</strong> – sample rate in seconds</li>
<li><strong>text</strong> – a text for the header file (e.g a description)</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="attribute">
<dt id="esys.downunder.seismic.SimpleSEGYWriter.COORDINATE_SCALE">
<code class="descname">COORDINATE_SCALE</code><em class="property"> = 1000.0</em><a class="headerlink" href="#esys.downunder.seismic.SimpleSEGYWriter.COORDINATE_SCALE" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="esys.downunder.seismic.SimpleSEGYWriter.addRecord">
<code class="descname">addRecord</code><span class="sig-paren">(</span><em>record</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.seismic.SimpleSEGYWriter.addRecord" title="Permalink to this definition">¶</a></dt>
<dd><p>Adds a record to the traces. A time difference of sample_interval between two records is assumed.
The record mast be a list of as many values as given receivers or a float if a single receiver is 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">Parameters:</th><td class="field-body"><strong>record</strong> – list of tracks to be added to the record.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.seismic.SimpleSEGYWriter.getSamplingInterval">
<code class="descname">getSamplingInterval</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.seismic.SimpleSEGYWriter.getSamplingInterval" title="Permalink to this definition">¶</a></dt>
<dd><p>returns the sampling interval in seconds.</p>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.seismic.SimpleSEGYWriter.obspy_available">
<code class="descname">obspy_available</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.seismic.SimpleSEGYWriter.obspy_available" title="Permalink to this definition">¶</a></dt>
<dd><p>for checking if the obspy module is available</p>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.seismic.SimpleSEGYWriter.write">
<code class="descname">write</code><span class="sig-paren">(</span><em>filename</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.seismic.SimpleSEGYWriter.write" title="Permalink to this definition">¶</a></dt>
<dd><p>writes to segy 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> – file name</td>
</tr>
<tr class="field-even field"><th class="field-name">Note:</th><td class="field-body">the function uses the <code class="xref py py-obj docutils literal notranslate"><span class="pre">obspy</span></code> module.</td>
</tr>
</tbody>
</table>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="esys.downunder.seismic.SonicHTIWave">
<em class="property">class </em><code class="descclassname">esys.downunder.seismic.</code><code class="descname">SonicHTIWave</code><span class="sig-paren">(</span><em>domain, v_p, wavelet, source_tag, source_vector=[1.0, 0.0], eps=0.0, delta=0.0, azimuth=0.0, dt=None, p0=None, v0=None, absorption_zone=300.0, absorption_cut=0.01, lumping=True</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.seismic.SonicHTIWave" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#esys.downunder.seismic.WaveBase" title="esys.downunder.seismic.WaveBase"><code class="xref py py-class docutils literal notranslate"><span class="pre">esys.downunder.seismic.WaveBase</span></code></a></p>
<p>Solving the HTI wave equation (along the x_0 axis) with azimuth (rotation around verticle axis)
under the assumption of zero shear wave velocities
The unknowns are the transversal (along x_0) and vertial stress (Q, P)</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">In case of a two dimensional domain the second spatial dimenion is depth.</td>
</tr>
</tbody>
</table>
<dl class="method">
<dt id="esys.downunder.seismic.SonicHTIWave.__init__">
<code class="descname">__init__</code><span class="sig-paren">(</span><em>domain, v_p, wavelet, source_tag, source_vector=[1.0, 0.0], eps=0.0, delta=0.0, azimuth=0.0, dt=None, p0=None, v0=None, absorption_zone=300.0, absorption_cut=0.01, lumping=True</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.seismic.SonicHTIWave.__init__" title="Permalink to this definition">¶</a></dt>
<dd><p>initialize the HTI wave solver</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>domain</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">Doamin</span></code>) – domain of the problem</li>
<li><strong>v_p</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">escript.Scalar</span></code>) – vertical p-velocity field</li>
<li><strong>v_s</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">escript.Scalar</span></code>) – vertical s-velocity field</li>
<li><strong>wavelet</strong> (<a class="reference internal" href="#esys.downunder.seismic.Wavelet" title="esys.downunder.seismic.Wavelet"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Wavelet</span></code></a>) – wavelet to describe the time evolution of source term</li>
<li><strong>source_tag</strong> (<em>'str'</em><em> or </em><em>'int'</em>) – tag of the source location</li>
<li><strong>source_vector</strong> – source orientation vector</li>
<li><strong>eps</strong> – first Thompsen parameter</li>
<li><strong>azimuth</strong> – azimuth (rotation around verticle axis)</li>
<li><strong>gamma</strong> – third Thompsen parameter</li>
<li><strong>rho</strong> – density</li>
<li><strong>dt</strong> – time step size. If not present a suitable time step size is calculated.</li>
<li><strong>p0</strong> – initial solution (Q(t=0), P(t=0)). If not present zero is used.</li>
<li><strong>v0</strong> – initial solution change rate. If not present zero is used.</li>
<li><strong>absorption_zone</strong> – thickness of absorption zone</li>
<li><strong>absorption_cut</strong> – boundary value of absorption decay factor</li>
<li><strong>lumping</strong> – if True mass matrix lumping is being used. This is accelerates the computing but introduces some diffusion.</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.seismic.SonicHTIWave.getTimeStepSize">
<code class="descname">getTimeStepSize</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.seismic.SonicHTIWave.getTimeStepSize" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="esys.downunder.seismic.SonicHTIWave.update">
<code class="descname">update</code><span class="sig-paren">(</span><em>t</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.seismic.SonicHTIWave.update" title="Permalink to this definition">¶</a></dt>
<dd><p>returns the solution for the next time marker t which needs to greater than the time marker from the
previous call.</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="esys.downunder.seismic.SonicWave">
<em class="property">class </em><code class="descclassname">esys.downunder.seismic.</code><code class="descname">SonicWave</code><span class="sig-paren">(</span><em>domain</em>, <em>v_p</em>, <em>wavelet</em>, <em>source_tag</em>, <em>dt=None</em>, <em>p0=None</em>, <em>p0_t=None</em>, <em>absorption_zone=300.0</em>, <em>absorption_cut=0.01</em>, <em>lumping=True</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.seismic.SonicWave" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#esys.downunder.seismic.WaveBase" title="esys.downunder.seismic.WaveBase"><code class="xref py py-class docutils literal notranslate"><span class="pre">esys.downunder.seismic.WaveBase</span></code></a></p>
<p>Solving the sonic wave equation</p>
<p><code class="xref py py-obj docutils literal notranslate"><span class="pre">p_tt</span> <span class="pre">=</span> <span class="pre">(v_p**2</span> <span class="pre">*</span> <span class="pre">p_i)_i</span>  <span class="pre">+</span> <span class="pre">f(t)</span> <span class="pre">*</span> <span class="pre">delta_s</span></code> where (p-) velocity v_p.</p>
<p>f(t) is wavelet acting at a point source term at positon s</p>
<dl class="method">
<dt id="esys.downunder.seismic.SonicWave.__init__">
<code class="descname">__init__</code><span class="sig-paren">(</span><em>domain</em>, <em>v_p</em>, <em>wavelet</em>, <em>source_tag</em>, <em>dt=None</em>, <em>p0=None</em>, <em>p0_t=None</em>, <em>absorption_zone=300.0</em>, <em>absorption_cut=0.01</em>, <em>lumping=True</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.seismic.SonicWave.__init__" title="Permalink to this definition">¶</a></dt>
<dd><p>initialize the sonic wave solver</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>domain</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">Domain</span></code>) – domain of the problem</li>
<li><strong>v_p</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">escript.Scalar</span></code>) – p-velocity field</li>
<li><strong>wavelet</strong> (<a class="reference internal" href="#esys.downunder.seismic.Wavelet" title="esys.downunder.seismic.Wavelet"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Wavelet</span></code></a>) – wavelet to describe the time evolution of source term</li>
<li><strong>source_tag</strong> (<em>'str'</em><em> or </em><em>'int'</em>) – tag of the source location</li>
<li><strong>dt</strong> – time step size. If not present a suitable time step size is calculated.</li>
<li><strong>p0</strong> – initial solution. If not present zero is used.</li>
<li><strong>p0_t</strong> – initial solution change rate. If not present zero is used.</li>
<li><strong>absorption_zone</strong> – thickness of absorption zone</li>
<li><strong>absorption_cut</strong> – boundary value of absorption decay factor</li>
<li><strong>lumping</strong> – if True mass matrix lumping is being used. This is accelerates the computing but introduces some diffusion.</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.seismic.SonicWave.getTimeStepSize">
<code class="descname">getTimeStepSize</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.seismic.SonicWave.getTimeStepSize" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="esys.downunder.seismic.SonicWave.update">
<code class="descname">update</code><span class="sig-paren">(</span><em>t</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.seismic.SonicWave.update" title="Permalink to this definition">¶</a></dt>
<dd><p>returns the solution for the next time marker t which needs to greater than the time marker from the
previous call.</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="esys.downunder.seismic.TTIWave">
<em class="property">class </em><code class="descclassname">esys.downunder.seismic.</code><code class="descname">TTIWave</code><span class="sig-paren">(</span><em>domain, v_p, v_s, wavelet, source_tag, source_vector=[0.0, 1.0], eps=0.0, delta=0.0, theta=0.0, rho=1.0, dt=None, u0=None, v0=None, absorption_zone=300.0, absorption_cut=0.01, lumping=True</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.seismic.TTIWave" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#esys.downunder.seismic.WaveBase" title="esys.downunder.seismic.WaveBase"><code class="xref py py-class docutils literal notranslate"><span class="pre">esys.downunder.seismic.WaveBase</span></code></a></p>
<p>Solving the 2D TTI wave equation with</p>
<p><code class="xref py py-obj docutils literal notranslate"><span class="pre">sigma_xx=</span> <span class="pre">c11*e_xx</span> <span class="pre">+</span> <span class="pre">c13*e_zz</span> <span class="pre">+</span> <span class="pre">c15*e_xz</span></code>
<code class="xref py py-obj docutils literal notranslate"><span class="pre">sigma_zz=</span> <span class="pre">c13*e_xx</span> <span class="pre">+</span> <span class="pre">c33*e_zz</span> <span class="pre">+</span> <span class="pre">c35*e_xz</span></code>
<code class="xref py py-obj docutils literal notranslate"><span class="pre">sigma_xz=</span> <span class="pre">c15*e_xx</span> <span class="pre">+</span> <span class="pre">c35*e_zz</span> <span class="pre">+</span> <span class="pre">c55*e_xz</span></code></p>
<p>the coefficients <code class="xref py py-obj docutils literal notranslate"><span class="pre">c11</span></code>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">c13</span></code>, etc are calculated from the tompsen parameters <code class="xref py py-obj docutils literal notranslate"><span class="pre">eps</span></code>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">delta</span></code> and the tilt <code class="xref py py-obj docutils literal notranslate"><span class="pre">theta</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">Note:</th><td class="field-body">currently only the 2D case is supported.</td>
</tr>
</tbody>
</table>
<dl class="method">
<dt id="esys.downunder.seismic.TTIWave.__init__">
<code class="descname">__init__</code><span class="sig-paren">(</span><em>domain, v_p, v_s, wavelet, source_tag, source_vector=[0.0, 1.0], eps=0.0, delta=0.0, theta=0.0, rho=1.0, dt=None, u0=None, v0=None, absorption_zone=300.0, absorption_cut=0.01, lumping=True</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.seismic.TTIWave.__init__" title="Permalink to this definition">¶</a></dt>
<dd><p>initialize the TTI wave solver</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>domain</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">Domain</span></code>) – domain of the problem</li>
<li><strong>v_p</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">escript.Scalar</span></code>) – vertical p-velocity field</li>
<li><strong>v_s</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">escript.Scalar</span></code>) – vertical s-velocity field</li>
<li><strong>wavelet</strong> (<a class="reference internal" href="#esys.downunder.seismic.Wavelet" title="esys.downunder.seismic.Wavelet"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Wavelet</span></code></a>) – wavelet to describe the time evolution of source term</li>
<li><strong>source_tag</strong> (<em>'str'</em><em> or </em><em>'int'</em>) – tag of the source location</li>
<li><strong>source_vector</strong> – source orientation vector</li>
<li><strong>eps</strong> – first Thompsen parameter</li>
<li><strong>delta</strong> – second Thompsen parameter</li>
<li><strong>theta</strong> – tilting (in Rad)</li>
<li><strong>rho</strong> – density</li>
<li><strong>dt</strong> – time step size. If not present a suitable time step size is calculated.</li>
<li><strong>u0</strong> – initial solution. If not present zero is used.</li>
<li><strong>v0</strong> – initial solution change rate. If not present zero is used.</li>
<li><strong>absorption_zone</strong> – thickness of absorption zone</li>
<li><strong>absorption_cut</strong> – boundary value of absorption decay factor</li>
<li><strong>lumping</strong> – if True mass matrix lumping is being used. This is accelerates the computing but introduces some diffusion.</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.seismic.TTIWave.getTimeStepSize">
<code class="descname">getTimeStepSize</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.seismic.TTIWave.getTimeStepSize" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="esys.downunder.seismic.TTIWave.update">
<code class="descname">update</code><span class="sig-paren">(</span><em>t</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.seismic.TTIWave.update" title="Permalink to this definition">¶</a></dt>
<dd><p>returns the solution for the next time marker t which needs to greater than the time marker from the
previous call.</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="esys.downunder.seismic.VTIWave">
<em class="property">class </em><code class="descclassname">esys.downunder.seismic.</code><code class="descname">VTIWave</code><span class="sig-paren">(</span><em>domain, v_p, v_s, wavelet, source_tag, source_vector=[0.0, 0.0, 1.0], eps=0.0, gamma=0.0, delta=0.0, rho=1.0, dt=None, u0=None, v0=None, absorption_zone=None, absorption_cut=0.01, lumping=True, disable_fast_assemblers=False</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.seismic.VTIWave" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <a class="reference internal" href="#esys.downunder.seismic.WaveBase" title="esys.downunder.seismic.WaveBase"><code class="xref py py-class docutils literal notranslate"><span class="pre">esys.downunder.seismic.WaveBase</span></code></a></p>
<p>Solving the VTI wave equation</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Note:</th><td class="field-body">In case of a two dimensional domain the second spatial dimenion is depth.</td>
</tr>
</tbody>
</table>
<dl class="method">
<dt id="esys.downunder.seismic.VTIWave.__init__">
<code class="descname">__init__</code><span class="sig-paren">(</span><em>domain, v_p, v_s, wavelet, source_tag, source_vector=[0.0, 0.0, 1.0], eps=0.0, gamma=0.0, delta=0.0, rho=1.0, dt=None, u0=None, v0=None, absorption_zone=None, absorption_cut=0.01, lumping=True, disable_fast_assemblers=False</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.seismic.VTIWave.__init__" title="Permalink to this definition">¶</a></dt>
<dd><p>initialize the VTI wave solver</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>domain</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">Domain</span></code>) – domain of the problem</li>
<li><strong>v_p</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">escript.Scalar</span></code>) – vertical p-velocity field</li>
<li><strong>v_s</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">escript.Scalar</span></code>) – vertical s-velocity field</li>
<li><strong>wavelet</strong> (<a class="reference internal" href="#esys.downunder.seismic.Wavelet" title="esys.downunder.seismic.Wavelet"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Wavelet</span></code></a>) – wavelet to describe the time evolution of source term</li>
<li><strong>source_tag</strong> (<em>'str'</em><em> or </em><em>'int'</em>) – tag of the source location</li>
<li><strong>source_vector</strong> – source orientation vector</li>
<li><strong>eps</strong> – first Thompsen parameter</li>
<li><strong>delta</strong> – second Thompsen parameter</li>
<li><strong>gamma</strong> – third Thompsen parameter</li>
<li><strong>rho</strong> – density</li>
<li><strong>dt</strong> – time step size. If not present a suitable time step size is calculated.</li>
<li><strong>u0</strong> – initial solution. If not present zero is used.</li>
<li><strong>v0</strong> – initial solution change rate. If not present zero is used.</li>
<li><strong>absorption_zone</strong> – thickness of absorption zone</li>
<li><strong>absorption_cut</strong> – boundary value of absorption decay factor</li>
<li><strong>lumping</strong> – if True mass matrix lumping is being used. This is accelerates the computing but introduces some diffusion.</li>
<li><strong>disable_fast_assemblers</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">boolean</span></code>) – if True, forces use of slower and more general PDE assemblers</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.seismic.VTIWave.getTimeStepSize">
<code class="descname">getTimeStepSize</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.seismic.VTIWave.getTimeStepSize" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="esys.downunder.seismic.VTIWave.setQ">
<code class="descname">setQ</code><span class="sig-paren">(</span><em>q</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.seismic.VTIWave.setQ" title="Permalink to this definition">¶</a></dt>
<dd><p>sets the PDE q value</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>q</strong> – the value to set</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.seismic.VTIWave.update">
<code class="descname">update</code><span class="sig-paren">(</span><em>t</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.seismic.VTIWave.update" title="Permalink to this definition">¶</a></dt>
<dd><p>returns the solution for the next time marker t which needs to greater than the time marker from the
previous call.</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="esys.downunder.seismic.WaveBase">
<em class="property">class </em><code class="descclassname">esys.downunder.seismic.</code><code class="descname">WaveBase</code><span class="sig-paren">(</span><em>dt</em>, <em>u0</em>, <em>v0</em>, <em>t0=0.0</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.seismic.WaveBase" 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>Base for wave propagation using the Verlet scheme.</p>
<blockquote>
<div><code class="docutils literal notranslate"><span class="pre">u_tt</span> <span class="pre">=</span> <span class="pre">A(t,u),</span> <span class="pre">u(t=t0)=u0,</span> <span class="pre">u_t(t=t0)=v0</span></code></div></blockquote>
<p>with a given acceleration force as function of time.</p>
<p>a_n=A(t_{n-1})
v_n=v_{n-1} + dt * a_n
u_n=u_{n-1} + dt * v_n</p>
<dl class="method">
<dt id="esys.downunder.seismic.WaveBase.__init__">
<code class="descname">__init__</code><span class="sig-paren">(</span><em>dt</em>, <em>u0</em>, <em>v0</em>, <em>t0=0.0</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.seismic.WaveBase.__init__" title="Permalink to this definition">¶</a></dt>
<dd><p>set up the wave base</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>dt</strong> – time step size (need to be sufficiently small)</li>
<li><strong>u0</strong> – initial value</li>
<li><strong>v0</strong> – initial velocity</li>
<li><strong>t0</strong> – initial time</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="esys.downunder.seismic.WaveBase.getTimeStepSize">
<code class="descname">getTimeStepSize</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.seismic.WaveBase.getTimeStepSize" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="esys.downunder.seismic.WaveBase.update">
<code class="descname">update</code><span class="sig-paren">(</span><em>t</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.seismic.WaveBase.update" title="Permalink to this definition">¶</a></dt>
<dd><p>returns the solution for the next time marker t which needs to greater than the time marker from the
previous call.</p>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="esys.downunder.seismic.Wavelet">
<em class="property">class </em><code class="descclassname">esys.downunder.seismic.</code><code class="descname">Wavelet</code><a class="headerlink" href="#esys.downunder.seismic.Wavelet" 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>place holder for source wavelet</p>
<dl class="method">
<dt id="esys.downunder.seismic.Wavelet.__init__">
<code class="descname">__init__</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.seismic.Wavelet.__init__" title="Permalink to this definition">¶</a></dt>
<dd><p>Initialize self. See help(type(self)) for accurate signature.</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.seismic.createAbsorptionLayerFunction">
<code class="descclassname">esys.downunder.seismic.</code><code class="descname">createAbsorptionLayerFunction</code><span class="sig-paren">(</span><em>x</em>, <em>absorption_zone=300.0</em>, <em>absorption_cut=0.01</em>, <em>top_absorption=False</em><span class="sig-paren">)</span><a class="headerlink" href="#esys.downunder.seismic.createAbsorptionLayerFunction" title="Permalink to this definition">¶</a></dt>
<dd><p>Creates a distribution which is one in the interior of the domain of <code class="xref py py-obj docutils literal notranslate"><span class="pre">x</span></code>
and is falling down to the value ‘absorption_cut’ over a margin of thickness ‘absorption_zone’
toward each boundary except the top of the domain.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
<li><strong>x</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">escript.Data</span></code>) – location of points in the domain</li>
<li><strong>absorption_zone</strong> – thickness of the absorption zone</li>
<li><strong>absorption_cut</strong> – value of decay function on domain boundary</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">function on ‘x’ which is one in the iterior and decays to almost zero over a margin
toward the boundary.</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
</div>
<div class="section" id="others">
<h2>Others<a class="headerlink" href="#others" title="Permalink to this headline">¶</a></h2>
<ul class="simple">
<li>OBSPY_AVAILABLE</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.seismic 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.domainbuilder.html"
title="previous chapter">esys.downunder.domainbuilder Package</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="esys.downunder.splitinversioncostfunctions.html"
title="next chapter">esys.downunder.splitinversioncostfunctions 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.splitinversioncostfunctions.html" title="esys.downunder.splitinversioncostfunctions Package"
>next</a> |</li>
<li class="right" >
<a href="esys.downunder.domainbuilder.html" title="esys.downunder.domainbuilder 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>
|
