GeezerVison is showing github.com — clawpack.github.com/dtopotools.html at master · clawpack/clawpack.github.com

Expand file tree

dtopotools.html

Copy path

More file actions

Latest commit

History

246 lines (228 loc) · 10.2 KB

dtopotools.html

Copy path

File metadata and controls

246 lines (228 loc) · 10.2 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

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

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"

"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<head>

<title>dtopotools module for moving topography — Clawpack 5.2.0 documentation</title>

var DOCUMENTATION_OPTIONS = {

URL_ROOT: './',

VERSION: '5.2.0',

COLLAPSE_INDEX: false,

FILE_SUFFIX: '.html',

HAS_SOURCE: true

};

</script>

</head>

<body>

<h1><a href="http://clawpack.org/">Clawpack-5</a></h1>

<nav>

<ul>

<li>

</li>

<li>

<a href="installing.html">Install</a>

</li>

<li>

<a class="" href="galleries.html">Gallery</a>

</li>

<li>

<a class="active" href="https://groups.google.com/forum/#!forum/claw-users">Support</a>

</li>

<li>

<a class="active" href="http://github.com/organizations/clawpack">Source</a>

</li>

<li>

<a class="" href="developers.html">Develop</a>

</li>

</ul>

</nav>

</section>

</div>

<h3>Navigation</h3>

<ul>

<a href="genindex.html" title="General Index"

accesskey="I">index</a></li>

<a href="py-modindex.html" title="Python Module Index"

>modules</a> |</li>

<a href="setrun_geoclaw.html" title="Specifying GeoClaw parameters in setrun.py"

accesskey="N">next</a> |</li>

<a href="topotools.html" title="Topography tools in the topotools module"

accesskey="P">previous</a> |</li>

<li><a href="contents.html">Clawpack 5.2.0 documentation</a> »</li>

</ul>

</div>

<span id="dtopotools-module-for-moving-topography"></span><span id="dtopotools-module"></span><h1>dtopotools module for moving topography<a class="headerlink" href="#module-clawpack.geoclaw.dtopotools" title="Permalink to this headline">¶</a></h1>

<p>GeoClaw dtopotools Module</p>

<p>Module provides several functions for dealing with changes to topography (usually

due to earthquakes) including reading sub-fault specifications, writing out

dtopo files, and calculating Okada based deformations.</p>

<tr class="field-odd field"><th class="field-name">Classes:</th><td class="field-body"><p class="first">DTopography

SubFault

Fault

UCSBFault

CSVFault

SiftFault

SegmentedPlaneFault</p>

</td>

</tr>

<tr class="field-even field"><th class="field-name">Functions:</th><td class="field-body"></td>

</tr>

<li>List functions and classes in this docstring?</li>

<li>This file contains both the older dtopo functionality and a new class, should

merge as much functionality into the class as possible ensuring nothing is

left behind.</li>

<li>Refactor Okada functionality</li>

</ul>

</td>

</tr>

</tbody>

</table>

<em class="property">class </em><tt class="descclassname">clawpack.geoclaw.dtopotools.</tt><tt class="descname">DTopography</tt><big>(</big><em>path=None</em>, <em>dtopo_type=None</em><big>)</big><a class="headerlink" href="#clawpack.geoclaw.dtopotools.DTopography" title="Permalink to this definition">¶</a></dt>

<dd><p>Basic object representing moving topography</p>

<dd><p>Interpolate dz_list to specified time t and return deformation dz.</p>

</dd></dl>

<dd><p>Return max(abs(dz)) over all dz in self.dz_list, the maximum

surface deformation for this dtopo.</p>

</dd></dl>

<tt class="descname">plot_dz_colors</tt><big>(</big><em>t</em>, <em>axes=None</em>, <em>cmax_dz=None</em>, <em>dz_interval=None</em>, <em>fig_kwargs={}</em><big>)</big><a class="headerlink" href="#clawpack.geoclaw.dtopotools.DTopography.plot_dz_colors" title="Permalink to this definition">¶</a></dt>

<dd><p>Interpolate dz_list to specified time t and then call module function

plot_dz_colors.</p>

</dd></dl>

<tt class="descname">plot_dz_contours</tt><big>(</big><em>t</em>, <em>dz_interval=0.5</em>, <em>axes=None</em>, <em>fig_kwargs={}</em><big>)</big><a class="headerlink" href="#clawpack.geoclaw.dtopotools.DTopography.plot_dz_contours" title="Permalink to this definition">¶</a></dt>

<dd><p>Interpolate dz_list to specified time t and then call module function

plot_dz_contours.</p>

</dd></dl>

<tt class="descname">read</tt><big>(</big><em>path=None</em>, <em>dtopo_type=None</em>, <em>verbose=False</em><big>)</big><a class="headerlink" href="#clawpack.geoclaw.dtopotools.DTopography.read" title="Permalink to this definition">¶</a></dt>

<dd><p>Read in a dtopo file and use to set attributes of this object.</p>

<tr class="field-odd field"><th class="field-name">Input:</th><td class="field-body"><ul class="first last">

<li><p class="first"><em>path</em> (path) - Path to existing dtopo file to read in.</p>

</li>

<dt><em>dtopo_type</em> (int) - Type of topography file to read. Default is 3</dt>

<dd><p class="first last">if not specified or apparent from file extension.</p>

</dd>

</dl>

</li>

</ul>

</td>

</tr>

</tbody>

</table>

</dd></dl>

<tt class="descname">write</tt><big>(</big><em>path=None</em>, <em>dtopo_type=None</em><big>)</big><a class="headerlink" href="#clawpack.geoclaw.dtopotools.DTopography.write" title="Permalink to this definition">¶</a></dt>

<dd><p>Write out subfault resulting dtopo to file at <em>path</em>.</p>

<tr class="field-odd field"><th class="field-name">Input:</th><td class="field-body"><ul class="first last simple">

<li><em>path</em> (path) - Path to the output file to written to.</li>

<li><em>dtopo_type</em> (int) - Type of topography file to write out. Default

is 3.</li>

</ul>

</td>

</tr>

</tbody>

</table>

</dd></dl>

</div>

</a>

<h2>Version 5.2.0</h2>

</p><h3>Related Topics</h3>

<ul>

<li><a href="contents.html">Documentation overview</a><ul>

<li>Previous: <a href="topotools.html" title="previous chapter">Topography tools in the <em>topotools</em> module</a></li>

<li>Next: <a href="setrun_geoclaw.html" title="next chapter">Specifying GeoClaw parameters in <cite>setrun.py</cite></a></li>

</ul></li>

</ul>

<li><a href="_sources/dtopotools.txt"

rel="nofollow">Show Source</a></li>

</ul>

<h3>Quick search</h3>

</form>

Enter search terms or a module, class or function name.

</p>

</div>

</div>

</div>

Created using <a href="http://sphinx.pocoo.org/">Sphinx</a>.

</div>

</body>

</html>