diff --git a/_sources/release_5_9_2.rst.txt b/_sources/release_5_9_2.rst.txt index 17fb1199e..dc70ee6b5 100644 --- a/_sources/release_5_9_2.rst.txt +++ b/_sources/release_5_9_2.rst.txt @@ -85,6 +85,19 @@ See `amrclaw diffs Changes to geoclaw ------------------ +The `setrun` parameter `rundata.fixed_grid_data` was removed from +`geoclaw/src/python/geoclaw/data.py` and is no longer available in `setrun`. +This old way of specifying fixed grid output has been deprecated for some +time in favor of `fgmax` and `fgout` grids, but some old `setrun.py` files +may still set :: + + fixedgrids = rundata.fixed_grid_data.fixedgrids + +and throw an error that can be fixed by deleting this line. +If items are appended to this list in your `setrun`, then these should be +converted to `fgmax` and/or `fgout` grids. + + The `setrun` parameter `runclaw.geo_data.sphere_source` was added to allow experimenting with the spherical source term that is currently missing from the default GeoClaw code, see :ref:`sphere_source`, which now includes a diff --git a/dev/.buildinfo b/dev/.buildinfo index 81751173c..889fc02cf 100644 --- a/dev/.buildinfo +++ b/dev/.buildinfo @@ -1,4 +1,4 @@ # Sphinx build info version 1 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. -config: 9bc24a18afe2fc865749e011fcedabb5 +config: 887f5e2c54ba2b2569b493a65a6f8422 tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/dev/.doctrees/ClawPlotAxes.doctree b/dev/.doctrees/ClawPlotAxes.doctree index d1689b60b..8ce9d6b30 100644 Binary files a/dev/.doctrees/ClawPlotAxes.doctree and b/dev/.doctrees/ClawPlotAxes.doctree differ diff --git a/dev/.doctrees/ClawPlotData.doctree b/dev/.doctrees/ClawPlotData.doctree index ec4379797..2d44b42ee 100644 Binary files a/dev/.doctrees/ClawPlotData.doctree and b/dev/.doctrees/ClawPlotData.doctree differ diff --git a/dev/.doctrees/ClawPlotFigure.doctree b/dev/.doctrees/ClawPlotFigure.doctree index bb12d1e85..c480b3981 100644 Binary files a/dev/.doctrees/ClawPlotFigure.doctree and b/dev/.doctrees/ClawPlotFigure.doctree differ diff --git a/dev/.doctrees/ClawPlotItem.doctree b/dev/.doctrees/ClawPlotItem.doctree index 257d775be..83b2e394b 100644 Binary files a/dev/.doctrees/ClawPlotItem.doctree and b/dev/.doctrees/ClawPlotItem.doctree differ diff --git a/dev/.doctrees/about.doctree b/dev/.doctrees/about.doctree index 60097215a..2b972622c 100644 Binary files a/dev/.doctrees/about.doctree and b/dev/.doctrees/about.doctree differ diff --git a/dev/.doctrees/adjoint.doctree b/dev/.doctrees/adjoint.doctree index 1ca6c8eb4..295086df5 100644 Binary files a/dev/.doctrees/adjoint.doctree and b/dev/.doctrees/adjoint.doctree differ diff --git a/dev/.doctrees/amr_algorithm.doctree b/dev/.doctrees/amr_algorithm.doctree index c7be69719..68c072cf7 100644 Binary files a/dev/.doctrees/amr_algorithm.doctree and b/dev/.doctrees/amr_algorithm.doctree differ diff --git a/dev/.doctrees/amrclaw.doctree b/dev/.doctrees/amrclaw.doctree index 84afc3030..4300dcb9c 100644 Binary files a/dev/.doctrees/amrclaw.doctree and b/dev/.doctrees/amrclaw.doctree differ diff --git a/dev/.doctrees/amrclaw1d.doctree b/dev/.doctrees/amrclaw1d.doctree index 899c76826..f3be5b457 100644 Binary files a/dev/.doctrees/amrclaw1d.doctree and b/dev/.doctrees/amrclaw1d.doctree differ diff --git a/dev/.doctrees/amrclaw_doxygen.doctree b/dev/.doctrees/amrclaw_doxygen.doctree index a02a63a15..f5214c68f 100644 Binary files a/dev/.doctrees/amrclaw_doxygen.doctree and b/dev/.doctrees/amrclaw_doxygen.doctree differ diff --git a/dev/.doctrees/amrclaw_flowcharts.doctree b/dev/.doctrees/amrclaw_flowcharts.doctree index 5ab207649..ed9d2de95 100644 Binary files a/dev/.doctrees/amrclaw_flowcharts.doctree and b/dev/.doctrees/amrclaw_flowcharts.doctree differ diff --git a/dev/.doctrees/application_documentation.doctree b/dev/.doctrees/application_documentation.doctree index 00fb5a3d6..2e6950812 100644 Binary files a/dev/.doctrees/application_documentation.doctree and b/dev/.doctrees/application_documentation.doctree differ diff --git a/dev/.doctrees/apps.doctree b/dev/.doctrees/apps.doctree index a4eb56ce0..b8904eee7 100644 Binary files a/dev/.doctrees/apps.doctree and b/dev/.doctrees/apps.doctree differ diff --git a/dev/.doctrees/aws.doctree b/dev/.doctrees/aws.doctree index a43e57e25..e7ff4071b 100644 Binary files a/dev/.doctrees/aws.doctree and b/dev/.doctrees/aws.doctree differ diff --git a/dev/.doctrees/b4run.doctree b/dev/.doctrees/b4run.doctree index 59afd88a4..30ad2e82e 100644 Binary files a/dev/.doctrees/b4run.doctree and b/dev/.doctrees/b4run.doctree differ diff --git a/dev/.doctrees/b4step_defaults.doctree b/dev/.doctrees/b4step_defaults.doctree index a667f622c..f47838bc6 100644 Binary files a/dev/.doctrees/b4step_defaults.doctree and b/dev/.doctrees/b4step_defaults.doctree differ diff --git a/dev/.doctrees/bc.doctree b/dev/.doctrees/bc.doctree index 308204283..326b4e01d 100644 Binary files a/dev/.doctrees/bc.doctree and b/dev/.doctrees/bc.doctree differ diff --git a/dev/.doctrees/biblio.doctree b/dev/.doctrees/biblio.doctree index 5d91942ed..c0daccb5d 100644 Binary files a/dev/.doctrees/biblio.doctree and b/dev/.doctrees/biblio.doctree differ diff --git a/dev/.doctrees/bouss1d.doctree b/dev/.doctrees/bouss1d.doctree index 2c9b9815d..1a2002dea 100644 Binary files a/dev/.doctrees/bouss1d.doctree and b/dev/.doctrees/bouss1d.doctree differ diff --git a/dev/.doctrees/bouss2d.doctree b/dev/.doctrees/bouss2d.doctree index a0869941d..9707ebf16 100644 Binary files a/dev/.doctrees/bouss2d.doctree and b/dev/.doctrees/bouss2d.doctree differ diff --git a/dev/.doctrees/changes_to_master.doctree b/dev/.doctrees/changes_to_master.doctree index 60831bdc2..08320601b 100644 Binary files a/dev/.doctrees/changes_to_master.doctree and b/dev/.doctrees/changes_to_master.doctree differ diff --git a/dev/.doctrees/claw43to46.doctree b/dev/.doctrees/claw43to46.doctree index 364e619e9..9bac2fcbb 100644 Binary files a/dev/.doctrees/claw43to46.doctree and b/dev/.doctrees/claw43to46.doctree differ diff --git a/dev/.doctrees/claw46to50.doctree b/dev/.doctrees/claw46to50.doctree index 7220fe99b..4ebd4c0cd 100644 Binary files a/dev/.doctrees/claw46to50.doctree and b/dev/.doctrees/claw46to50.doctree differ diff --git a/dev/.doctrees/claw4x.doctree b/dev/.doctrees/claw4x.doctree index 1e7994c66..a086f0c9b 100644 Binary files a/dev/.doctrees/claw4x.doctree and b/dev/.doctrees/claw4x.doctree differ diff --git a/dev/.doctrees/clawpack5.doctree b/dev/.doctrees/clawpack5.doctree index 87d94ef71..c415467e1 100644 Binary files a/dev/.doctrees/clawpack5.doctree and b/dev/.doctrees/clawpack5.doctree differ diff --git a/dev/.doctrees/clawpack_components.doctree b/dev/.doctrees/clawpack_components.doctree index 714b93597..99a2c7d17 100644 Binary files a/dev/.doctrees/clawpack_components.doctree and b/dev/.doctrees/clawpack_components.doctree differ diff --git a/dev/.doctrees/community.doctree b/dev/.doctrees/community.doctree index 8780c2657..19f57faee 100644 Binary files a/dev/.doctrees/community.doctree and b/dev/.doctrees/community.doctree differ diff --git a/dev/.doctrees/contents.doctree b/dev/.doctrees/contents.doctree index 22dc6ea39..8f775f84f 100644 Binary files a/dev/.doctrees/contents.doctree and b/dev/.doctrees/contents.doctree differ diff --git a/dev/.doctrees/contribute_apps.doctree b/dev/.doctrees/contribute_apps.doctree index ed40068a0..1dc74fafa 100644 Binary files a/dev/.doctrees/contribute_apps.doctree and b/dev/.doctrees/contribute_apps.doctree differ diff --git a/dev/.doctrees/current_data.doctree b/dev/.doctrees/current_data.doctree index 3072d56e9..f652cec5d 100644 Binary files a/dev/.doctrees/current_data.doctree and b/dev/.doctrees/current_data.doctree differ diff --git a/dev/.doctrees/developers.doctree b/dev/.doctrees/developers.doctree index b9b6f82ff..a1b604285 100644 Binary files a/dev/.doctrees/developers.doctree and b/dev/.doctrees/developers.doctree differ diff --git a/dev/.doctrees/docker_image.doctree b/dev/.doctrees/docker_image.doctree index 57753eaea..6908c10dd 100644 Binary files a/dev/.doctrees/docker_image.doctree and b/dev/.doctrees/docker_image.doctree differ diff --git a/dev/.doctrees/dtopotools_module.doctree b/dev/.doctrees/dtopotools_module.doctree index 3f9229363..46a28efdc 100644 Binary files a/dev/.doctrees/dtopotools_module.doctree and b/dev/.doctrees/dtopotools_module.doctree differ diff --git a/dev/.doctrees/environment.pickle b/dev/.doctrees/environment.pickle index aedd31a34..40d55b756 100644 Binary files a/dev/.doctrees/environment.pickle and b/dev/.doctrees/environment.pickle differ diff --git a/dev/.doctrees/f77_vs_f90.doctree b/dev/.doctrees/f77_vs_f90.doctree index 02208e124..64f393fb4 100644 Binary files a/dev/.doctrees/f77_vs_f90.doctree and b/dev/.doctrees/f77_vs_f90.doctree differ diff --git a/dev/.doctrees/fgmax.doctree b/dev/.doctrees/fgmax.doctree index df839cd82..28cd7f937 100644 Binary files a/dev/.doctrees/fgmax.doctree and b/dev/.doctrees/fgmax.doctree differ diff --git a/dev/.doctrees/fgmax_tools_module.doctree b/dev/.doctrees/fgmax_tools_module.doctree index 217d7609d..03dfaed20 100644 Binary files a/dev/.doctrees/fgmax_tools_module.doctree and b/dev/.doctrees/fgmax_tools_module.doctree differ diff --git a/dev/.doctrees/fgout.doctree b/dev/.doctrees/fgout.doctree index 0219cc42c..4631f1006 100644 Binary files a/dev/.doctrees/fgout.doctree and b/dev/.doctrees/fgout.doctree differ diff --git a/dev/.doctrees/fgout_tools_module.doctree b/dev/.doctrees/fgout_tools_module.doctree index c9e21f7fa..f5fff223c 100644 Binary files a/dev/.doctrees/fgout_tools_module.doctree and b/dev/.doctrees/fgout_tools_module.doctree differ diff --git a/dev/.doctrees/first_run.doctree b/dev/.doctrees/first_run.doctree index 6bd3d1d5b..dc1f0336a 100644 Binary files a/dev/.doctrees/first_run.doctree and b/dev/.doctrees/first_run.doctree differ diff --git a/dev/.doctrees/first_run_fortran.doctree b/dev/.doctrees/first_run_fortran.doctree index 1e05ecd3e..eea5481c2 100644 Binary files a/dev/.doctrees/first_run_fortran.doctree and b/dev/.doctrees/first_run_fortran.doctree differ diff --git a/dev/.doctrees/first_run_pyclaw.doctree b/dev/.doctrees/first_run_pyclaw.doctree index 527308bdf..da72296a2 100644 Binary files a/dev/.doctrees/first_run_pyclaw.doctree and b/dev/.doctrees/first_run_pyclaw.doctree differ diff --git a/dev/.doctrees/flagregions.doctree b/dev/.doctrees/flagregions.doctree index 7bf3afd13..301310a05 100644 Binary files a/dev/.doctrees/flagregions.doctree and b/dev/.doctrees/flagregions.doctree differ diff --git a/dev/.doctrees/force_dry.doctree b/dev/.doctrees/force_dry.doctree index 0c85b92e5..c7f458d56 100644 Binary files a/dev/.doctrees/force_dry.doctree and b/dev/.doctrees/force_dry.doctree differ diff --git a/dev/.doctrees/fortran.doctree b/dev/.doctrees/fortran.doctree index a65bf39ed..82f3b62bc 100644 Binary files a/dev/.doctrees/fortran.doctree and b/dev/.doctrees/fortran.doctree differ diff --git a/dev/.doctrees/fortran_compilers.doctree b/dev/.doctrees/fortran_compilers.doctree index 62d7b1c14..88fc6b827 100644 Binary files a/dev/.doctrees/fortran_compilers.doctree and b/dev/.doctrees/fortran_compilers.doctree differ diff --git a/dev/.doctrees/fvmbook.doctree b/dev/.doctrees/fvmbook.doctree index 31b67ffbc..f504db748 100644 Binary files a/dev/.doctrees/fvmbook.doctree and b/dev/.doctrees/fvmbook.doctree differ diff --git a/dev/.doctrees/galleries.doctree b/dev/.doctrees/galleries.doctree index e09c9c4fe..b3ad2d4c0 100644 Binary files a/dev/.doctrees/galleries.doctree and b/dev/.doctrees/galleries.doctree differ diff --git a/dev/.doctrees/gauges.doctree b/dev/.doctrees/gauges.doctree index df244419e..4c8eb9358 100644 Binary files a/dev/.doctrees/gauges.doctree and b/dev/.doctrees/gauges.doctree differ diff --git a/dev/.doctrees/geoclaw.doctree b/dev/.doctrees/geoclaw.doctree index 0e067a8d1..1434fbdf5 100644 Binary files a/dev/.doctrees/geoclaw.doctree and b/dev/.doctrees/geoclaw.doctree differ diff --git a/dev/.doctrees/geoclaw1d.doctree b/dev/.doctrees/geoclaw1d.doctree index 1ac1b6c90..a15646058 100644 Binary files a/dev/.doctrees/geoclaw1d.doctree and b/dev/.doctrees/geoclaw1d.doctree differ diff --git a/dev/.doctrees/geoclaw_started.doctree b/dev/.doctrees/geoclaw_started.doctree index 2022d682d..de8edc961 100644 Binary files a/dev/.doctrees/geoclaw_started.doctree and b/dev/.doctrees/geoclaw_started.doctree differ diff --git a/dev/.doctrees/geoclaw_util_module.doctree b/dev/.doctrees/geoclaw_util_module.doctree index 6b4c4cb80..47c93f2dd 100644 Binary files a/dev/.doctrees/geoclaw_util_module.doctree and b/dev/.doctrees/geoclaw_util_module.doctree differ diff --git a/dev/.doctrees/geohints.doctree b/dev/.doctrees/geohints.doctree index fb5af8c3f..fb2e81bec 100644 Binary files a/dev/.doctrees/geohints.doctree and b/dev/.doctrees/geohints.doctree differ diff --git a/dev/.doctrees/geoplot.doctree b/dev/.doctrees/geoplot.doctree index df5e01889..91cf8501c 100644 Binary files a/dev/.doctrees/geoplot.doctree and b/dev/.doctrees/geoplot.doctree differ diff --git a/dev/.doctrees/git_versions.doctree b/dev/.doctrees/git_versions.doctree index b631e95d6..c4d7847ff 100644 Binary files a/dev/.doctrees/git_versions.doctree and b/dev/.doctrees/git_versions.doctree differ diff --git a/dev/.doctrees/googleearth_plotting.doctree b/dev/.doctrees/googleearth_plotting.doctree index 174158c49..959e57912 100644 Binary files a/dev/.doctrees/googleearth_plotting.doctree and b/dev/.doctrees/googleearth_plotting.doctree differ diff --git a/dev/.doctrees/gpu.doctree b/dev/.doctrees/gpu.doctree index 347c89974..acb4e1b2c 100644 Binary files a/dev/.doctrees/gpu.doctree and b/dev/.doctrees/gpu.doctree differ diff --git a/dev/.doctrees/grid_registration.doctree b/dev/.doctrees/grid_registration.doctree index 456de84f7..c3dff823d 100644 Binary files a/dev/.doctrees/grid_registration.doctree and b/dev/.doctrees/grid_registration.doctree differ diff --git a/dev/.doctrees/howto_doc.doctree b/dev/.doctrees/howto_doc.doctree index 077510bb5..971710fa2 100644 Binary files a/dev/.doctrees/howto_doc.doctree and b/dev/.doctrees/howto_doc.doctree differ diff --git a/dev/.doctrees/howto_release.doctree b/dev/.doctrees/howto_release.doctree index 30a5a052c..e549401ee 100644 Binary files a/dev/.doctrees/howto_release.doctree and b/dev/.doctrees/howto_release.doctree differ diff --git a/dev/.doctrees/installing.doctree b/dev/.doctrees/installing.doctree index 2e93e2781..d8b668101 100644 Binary files a/dev/.doctrees/installing.doctree and b/dev/.doctrees/installing.doctree differ diff --git a/dev/.doctrees/installing_fortcodes.doctree b/dev/.doctrees/installing_fortcodes.doctree index 261764c91..d10ebcf3c 100644 Binary files a/dev/.doctrees/installing_fortcodes.doctree and b/dev/.doctrees/installing_fortcodes.doctree differ diff --git a/dev/.doctrees/installing_pip.doctree b/dev/.doctrees/installing_pip.doctree index f61985018..970042e04 100644 Binary files a/dev/.doctrees/installing_pip.doctree and b/dev/.doctrees/installing_pip.doctree differ diff --git a/dev/.doctrees/kmltools_module.doctree b/dev/.doctrees/kmltools_module.doctree index eb0d5858c..a56ca5867 100644 Binary files a/dev/.doctrees/kmltools_module.doctree and b/dev/.doctrees/kmltools_module.doctree differ diff --git a/dev/.doctrees/lagrangian_gauges.doctree b/dev/.doctrees/lagrangian_gauges.doctree index 1b5957517..a0374c8a0 100644 Binary files a/dev/.doctrees/lagrangian_gauges.doctree and b/dev/.doctrees/lagrangian_gauges.doctree differ diff --git a/dev/.doctrees/license.doctree b/dev/.doctrees/license.doctree index 5b49ca482..cab5febe8 100644 Binary files a/dev/.doctrees/license.doctree and b/dev/.doctrees/license.doctree differ diff --git a/dev/.doctrees/makefiles.doctree b/dev/.doctrees/makefiles.doctree index cad298801..9dced8c98 100644 Binary files a/dev/.doctrees/makefiles.doctree and b/dev/.doctrees/makefiles.doctree differ diff --git a/dev/.doctrees/makefiles_library.doctree b/dev/.doctrees/makefiles_library.doctree index a31a9747c..9ec815853 100644 Binary files a/dev/.doctrees/makefiles_library.doctree and b/dev/.doctrees/makefiles_library.doctree differ diff --git a/dev/.doctrees/manning.doctree b/dev/.doctrees/manning.doctree index 3cc8996f4..f96a03926 100644 Binary files a/dev/.doctrees/manning.doctree and b/dev/.doctrees/manning.doctree differ diff --git a/dev/.doctrees/mapc2p.doctree b/dev/.doctrees/mapc2p.doctree index ac5d728dc..1a781b643 100644 Binary files a/dev/.doctrees/mapc2p.doctree and b/dev/.doctrees/mapc2p.doctree differ diff --git a/dev/.doctrees/marching_front.doctree b/dev/.doctrees/marching_front.doctree index 210f56854..3ed7d1bef 100644 Binary files a/dev/.doctrees/marching_front.doctree and b/dev/.doctrees/marching_front.doctree differ diff --git a/dev/.doctrees/matlab_plotting.doctree b/dev/.doctrees/matlab_plotting.doctree index 678c7d5bc..b120f7cfd 100644 Binary files a/dev/.doctrees/matlab_plotting.doctree and b/dev/.doctrees/matlab_plotting.doctree differ diff --git a/dev/.doctrees/nearshore_interp.doctree b/dev/.doctrees/nearshore_interp.doctree index eaaaf9ff2..e49fca574 100644 Binary files a/dev/.doctrees/nearshore_interp.doctree and b/dev/.doctrees/nearshore_interp.doctree differ diff --git a/dev/.doctrees/netcdf.doctree b/dev/.doctrees/netcdf.doctree index 55273ccb9..edf5c988e 100644 Binary files a/dev/.doctrees/netcdf.doctree and b/dev/.doctrees/netcdf.doctree differ diff --git a/dev/.doctrees/newapp.doctree b/dev/.doctrees/newapp.doctree index e744c17d7..d8fb2abd1 100644 Binary files a/dev/.doctrees/newapp.doctree and b/dev/.doctrees/newapp.doctree differ diff --git a/dev/.doctrees/okada.doctree b/dev/.doctrees/okada.doctree index 4672a7751..733cfdb88 100644 Binary files a/dev/.doctrees/okada.doctree and b/dev/.doctrees/okada.doctree differ diff --git a/dev/.doctrees/openmp.doctree b/dev/.doctrees/openmp.doctree index 10e9bb5fc..47fe61362 100644 Binary files a/dev/.doctrees/openmp.doctree and b/dev/.doctrees/openmp.doctree differ diff --git a/dev/.doctrees/output_styles.doctree b/dev/.doctrees/output_styles.doctree index 5618ad4a8..367e0632b 100644 Binary files a/dev/.doctrees/output_styles.doctree and b/dev/.doctrees/output_styles.doctree differ diff --git a/dev/.doctrees/packages.doctree b/dev/.doctrees/packages.doctree index d5f5ef866..2793df56a 100644 Binary files a/dev/.doctrees/packages.doctree and b/dev/.doctrees/packages.doctree differ diff --git a/dev/.doctrees/photos.doctree b/dev/.doctrees/photos.doctree index b475b2736..e63d203d2 100644 Binary files a/dev/.doctrees/photos.doctree and b/dev/.doctrees/photos.doctree differ diff --git a/dev/.doctrees/plotexamples.doctree b/dev/.doctrees/plotexamples.doctree index ff80e9e12..c4c20c9b6 100644 Binary files a/dev/.doctrees/plotexamples.doctree and b/dev/.doctrees/plotexamples.doctree differ diff --git a/dev/.doctrees/plotting.doctree b/dev/.doctrees/plotting.doctree index bf4a81ab6..188dac0b9 100644 Binary files a/dev/.doctrees/plotting.doctree and b/dev/.doctrees/plotting.doctree differ diff --git a/dev/.doctrees/plotting_faq.doctree b/dev/.doctrees/plotting_faq.doctree index 68f41cbc2..b9f374cc0 100644 Binary files a/dev/.doctrees/plotting_faq.doctree and b/dev/.doctrees/plotting_faq.doctree differ diff --git a/dev/.doctrees/plotting_geoclaw.doctree b/dev/.doctrees/plotting_geoclaw.doctree index 915afd1bc..3a12227f7 100644 Binary files a/dev/.doctrees/plotting_geoclaw.doctree and b/dev/.doctrees/plotting_geoclaw.doctree differ diff --git a/dev/.doctrees/plotting_python.doctree b/dev/.doctrees/plotting_python.doctree index 90e36ccff..4c0b0d329 100644 Binary files a/dev/.doctrees/plotting_python.doctree and b/dev/.doctrees/plotting_python.doctree differ diff --git a/dev/.doctrees/prereqs.doctree b/dev/.doctrees/prereqs.doctree index 899609195..88f873ef0 100644 Binary files a/dev/.doctrees/prereqs.doctree and b/dev/.doctrees/prereqs.doctree differ diff --git a/dev/.doctrees/pyclaw/about.doctree b/dev/.doctrees/pyclaw/about.doctree index c5e3b20b3..760b4c820 100644 Binary files a/dev/.doctrees/pyclaw/about.doctree and b/dev/.doctrees/pyclaw/about.doctree differ diff --git a/dev/.doctrees/pyclaw/basics.doctree b/dev/.doctrees/pyclaw/basics.doctree index 4c1b913ee..7ecac35f8 100644 Binary files a/dev/.doctrees/pyclaw/basics.doctree and b/dev/.doctrees/pyclaw/basics.doctree differ diff --git a/dev/.doctrees/pyclaw/classes.doctree b/dev/.doctrees/pyclaw/classes.doctree index 3463bbaed..380ad1d57 100644 Binary files a/dev/.doctrees/pyclaw/classes.doctree and b/dev/.doctrees/pyclaw/classes.doctree differ diff --git a/dev/.doctrees/pyclaw/clawpack_and_pyclaw.doctree b/dev/.doctrees/pyclaw/clawpack_and_pyclaw.doctree index 29629b026..7949b5b69 100644 Binary files a/dev/.doctrees/pyclaw/clawpack_and_pyclaw.doctree and b/dev/.doctrees/pyclaw/clawpack_and_pyclaw.doctree differ diff --git a/dev/.doctrees/pyclaw/cloud.doctree b/dev/.doctrees/pyclaw/cloud.doctree index 463289fd2..9891739bd 100644 Binary files a/dev/.doctrees/pyclaw/cloud.doctree and b/dev/.doctrees/pyclaw/cloud.doctree differ diff --git a/dev/.doctrees/pyclaw/controller.doctree b/dev/.doctrees/pyclaw/controller.doctree index 891596a20..95364207a 100644 Binary files a/dev/.doctrees/pyclaw/controller.doctree and b/dev/.doctrees/pyclaw/controller.doctree differ diff --git a/dev/.doctrees/pyclaw/evolve/limiters.doctree b/dev/.doctrees/pyclaw/evolve/limiters.doctree index 0ecb8287d..8aef42cb5 100644 Binary files a/dev/.doctrees/pyclaw/evolve/limiters.doctree and b/dev/.doctrees/pyclaw/evolve/limiters.doctree differ diff --git a/dev/.doctrees/pyclaw/examples.doctree b/dev/.doctrees/pyclaw/examples.doctree index a7f7ca020..324a8e425 100644 Binary files a/dev/.doctrees/pyclaw/examples.doctree and b/dev/.doctrees/pyclaw/examples.doctree differ diff --git a/dev/.doctrees/pyclaw/geometry.doctree b/dev/.doctrees/pyclaw/geometry.doctree index e8ea45f98..eeb232bc2 100644 Binary files a/dev/.doctrees/pyclaw/geometry.doctree and b/dev/.doctrees/pyclaw/geometry.doctree differ diff --git a/dev/.doctrees/pyclaw/going_further.doctree b/dev/.doctrees/pyclaw/going_further.doctree index 6bbdd3e64..741134c6d 100644 Binary files a/dev/.doctrees/pyclaw/going_further.doctree and b/dev/.doctrees/pyclaw/going_further.doctree differ diff --git a/dev/.doctrees/pyclaw/index.doctree b/dev/.doctrees/pyclaw/index.doctree index a8b20d902..a91905ab3 100644 Binary files a/dev/.doctrees/pyclaw/index.doctree and b/dev/.doctrees/pyclaw/index.doctree differ diff --git a/dev/.doctrees/pyclaw/io.doctree b/dev/.doctrees/pyclaw/io.doctree index 3591d2826..bd96f51c8 100644 Binary files a/dev/.doctrees/pyclaw/io.doctree and b/dev/.doctrees/pyclaw/io.doctree differ diff --git a/dev/.doctrees/pyclaw/output.doctree b/dev/.doctrees/pyclaw/output.doctree index fcf88a90e..4db8986c7 100644 Binary files a/dev/.doctrees/pyclaw/output.doctree and b/dev/.doctrees/pyclaw/output.doctree differ diff --git a/dev/.doctrees/pyclaw/parallel.doctree b/dev/.doctrees/pyclaw/parallel.doctree index 5978a748c..9272f0c6b 100644 Binary files a/dev/.doctrees/pyclaw/parallel.doctree and b/dev/.doctrees/pyclaw/parallel.doctree differ diff --git a/dev/.doctrees/pyclaw/plotting.doctree b/dev/.doctrees/pyclaw/plotting.doctree index c90504543..b19b63de7 100644 Binary files a/dev/.doctrees/pyclaw/plotting.doctree and b/dev/.doctrees/pyclaw/plotting.doctree differ diff --git a/dev/.doctrees/pyclaw/problem.doctree b/dev/.doctrees/pyclaw/problem.doctree index 6ae059e81..1dfee31c1 100644 Binary files a/dev/.doctrees/pyclaw/problem.doctree and b/dev/.doctrees/pyclaw/problem.doctree differ diff --git a/dev/.doctrees/pyclaw/rp.doctree b/dev/.doctrees/pyclaw/rp.doctree index 8bf4cf3a0..76527a9b2 100644 Binary files a/dev/.doctrees/pyclaw/rp.doctree and b/dev/.doctrees/pyclaw/rp.doctree differ diff --git a/dev/.doctrees/pyclaw/solution.doctree b/dev/.doctrees/pyclaw/solution.doctree index bc21d9375..b63ef7f86 100644 Binary files a/dev/.doctrees/pyclaw/solution.doctree and b/dev/.doctrees/pyclaw/solution.doctree differ diff --git a/dev/.doctrees/pyclaw/solvers.doctree b/dev/.doctrees/pyclaw/solvers.doctree index 816a55f6d..745711b5d 100644 Binary files a/dev/.doctrees/pyclaw/solvers.doctree and b/dev/.doctrees/pyclaw/solvers.doctree differ diff --git a/dev/.doctrees/pyclaw/started.doctree b/dev/.doctrees/pyclaw/started.doctree index 5e6d36566..c793b671a 100644 Binary files a/dev/.doctrees/pyclaw/started.doctree and b/dev/.doctrees/pyclaw/started.doctree differ diff --git a/dev/.doctrees/pyclaw/state.doctree b/dev/.doctrees/pyclaw/state.doctree index 729dd7549..2913cf8a0 100644 Binary files a/dev/.doctrees/pyclaw/state.doctree and b/dev/.doctrees/pyclaw/state.doctree differ diff --git a/dev/.doctrees/pyclaw/troubleshooting.doctree b/dev/.doctrees/pyclaw/troubleshooting.doctree index 476b81d31..68c8e8d83 100644 Binary files a/dev/.doctrees/pyclaw/troubleshooting.doctree and b/dev/.doctrees/pyclaw/troubleshooting.doctree differ diff --git a/dev/.doctrees/pyclaw/tutorial.doctree b/dev/.doctrees/pyclaw/tutorial.doctree index 482ffaba0..f0e51b329 100644 Binary files a/dev/.doctrees/pyclaw/tutorial.doctree and b/dev/.doctrees/pyclaw/tutorial.doctree differ diff --git a/dev/.doctrees/pyclaw/util.doctree b/dev/.doctrees/pyclaw/util.doctree index 788878ebb..38b4d7ea2 100644 Binary files a/dev/.doctrees/pyclaw/util.doctree and b/dev/.doctrees/pyclaw/util.doctree differ diff --git a/dev/.doctrees/python.doctree b/dev/.doctrees/python.doctree index 60e54fdbf..f1e41bbb1 100644 Binary files a/dev/.doctrees/python.doctree and b/dev/.doctrees/python.doctree differ diff --git a/dev/.doctrees/python_path.doctree b/dev/.doctrees/python_path.doctree index 468200dc0..15173b818 100644 Binary files a/dev/.doctrees/python_path.doctree and b/dev/.doctrees/python_path.doctree differ diff --git a/dev/.doctrees/qinit_defaults.doctree b/dev/.doctrees/qinit_defaults.doctree index 09eceaf9a..c8a934443 100644 Binary files a/dev/.doctrees/qinit_defaults.doctree and b/dev/.doctrees/qinit_defaults.doctree differ diff --git a/dev/.doctrees/quick_surge.doctree b/dev/.doctrees/quick_surge.doctree index ee7db411a..069be6f63 100644 Binary files a/dev/.doctrees/quick_surge.doctree and b/dev/.doctrees/quick_surge.doctree differ diff --git a/dev/.doctrees/quick_tsunami.doctree b/dev/.doctrees/quick_tsunami.doctree index 65af2053a..bd82dad77 100644 Binary files a/dev/.doctrees/quick_tsunami.doctree and b/dev/.doctrees/quick_tsunami.doctree differ diff --git a/dev/.doctrees/refinement.doctree b/dev/.doctrees/refinement.doctree index 38cc06658..548b3dbf2 100644 Binary files a/dev/.doctrees/refinement.doctree and b/dev/.doctrees/refinement.doctree differ diff --git a/dev/.doctrees/regression.doctree b/dev/.doctrees/regression.doctree index 9a5990fc0..3db19d9ba 100644 Binary files a/dev/.doctrees/regression.doctree and b/dev/.doctrees/regression.doctree differ diff --git a/dev/.doctrees/release_5_0_0.doctree b/dev/.doctrees/release_5_0_0.doctree index 1d77798b6..0b55bdd05 100644 Binary files a/dev/.doctrees/release_5_0_0.doctree and b/dev/.doctrees/release_5_0_0.doctree differ diff --git a/dev/.doctrees/release_5_1_0.doctree b/dev/.doctrees/release_5_1_0.doctree index 1c386fbcb..e9d9b2cc2 100644 Binary files a/dev/.doctrees/release_5_1_0.doctree and b/dev/.doctrees/release_5_1_0.doctree differ diff --git a/dev/.doctrees/release_5_2_0.doctree b/dev/.doctrees/release_5_2_0.doctree index dc6fc0da3..f571915f1 100644 Binary files a/dev/.doctrees/release_5_2_0.doctree and b/dev/.doctrees/release_5_2_0.doctree differ diff --git a/dev/.doctrees/release_5_2_1.doctree b/dev/.doctrees/release_5_2_1.doctree index 5fc5dfe6d..c489fdb5e 100644 Binary files a/dev/.doctrees/release_5_2_1.doctree and b/dev/.doctrees/release_5_2_1.doctree differ diff --git a/dev/.doctrees/release_5_2_2.doctree b/dev/.doctrees/release_5_2_2.doctree index 0f2d3b666..34b4fd9bc 100644 Binary files a/dev/.doctrees/release_5_2_2.doctree and b/dev/.doctrees/release_5_2_2.doctree differ diff --git a/dev/.doctrees/release_5_3_0.doctree b/dev/.doctrees/release_5_3_0.doctree index c39bcfacc..2f3512efc 100644 Binary files a/dev/.doctrees/release_5_3_0.doctree and b/dev/.doctrees/release_5_3_0.doctree differ diff --git a/dev/.doctrees/release_5_3_1.doctree b/dev/.doctrees/release_5_3_1.doctree index 150e4de43..8d85e9bd1 100644 Binary files a/dev/.doctrees/release_5_3_1.doctree and b/dev/.doctrees/release_5_3_1.doctree differ diff --git a/dev/.doctrees/release_5_4_0.doctree b/dev/.doctrees/release_5_4_0.doctree index 00c145e47..05189e412 100644 Binary files a/dev/.doctrees/release_5_4_0.doctree and b/dev/.doctrees/release_5_4_0.doctree differ diff --git a/dev/.doctrees/release_5_4_1.doctree b/dev/.doctrees/release_5_4_1.doctree index c0a2fad09..3d90c2d58 100644 Binary files a/dev/.doctrees/release_5_4_1.doctree and b/dev/.doctrees/release_5_4_1.doctree differ diff --git a/dev/.doctrees/release_5_5_0.doctree b/dev/.doctrees/release_5_5_0.doctree index ec81fb913..eeb30e9bb 100644 Binary files a/dev/.doctrees/release_5_5_0.doctree and b/dev/.doctrees/release_5_5_0.doctree differ diff --git a/dev/.doctrees/release_5_6_0.doctree b/dev/.doctrees/release_5_6_0.doctree index 4d2de80f7..f910c4091 100644 Binary files a/dev/.doctrees/release_5_6_0.doctree and b/dev/.doctrees/release_5_6_0.doctree differ diff --git a/dev/.doctrees/release_5_6_1.doctree b/dev/.doctrees/release_5_6_1.doctree index 5c58b648f..c5ac14ba6 100644 Binary files a/dev/.doctrees/release_5_6_1.doctree and b/dev/.doctrees/release_5_6_1.doctree differ diff --git a/dev/.doctrees/release_5_7_0.doctree b/dev/.doctrees/release_5_7_0.doctree index 07c787dd3..6eba20b56 100644 Binary files a/dev/.doctrees/release_5_7_0.doctree and b/dev/.doctrees/release_5_7_0.doctree differ diff --git a/dev/.doctrees/release_5_7_1.doctree b/dev/.doctrees/release_5_7_1.doctree index 9a885a96e..e48f728b9 100644 Binary files a/dev/.doctrees/release_5_7_1.doctree and b/dev/.doctrees/release_5_7_1.doctree differ diff --git a/dev/.doctrees/release_5_8_0.doctree b/dev/.doctrees/release_5_8_0.doctree index 360bc1de2..64a9fadb3 100644 Binary files a/dev/.doctrees/release_5_8_0.doctree and b/dev/.doctrees/release_5_8_0.doctree differ diff --git a/dev/.doctrees/release_5_8_1.doctree b/dev/.doctrees/release_5_8_1.doctree index 478951444..5b6677169 100644 Binary files a/dev/.doctrees/release_5_8_1.doctree and b/dev/.doctrees/release_5_8_1.doctree differ diff --git a/dev/.doctrees/release_5_8_2.doctree b/dev/.doctrees/release_5_8_2.doctree index 59766cea9..ee99ed888 100644 Binary files a/dev/.doctrees/release_5_8_2.doctree and b/dev/.doctrees/release_5_8_2.doctree differ diff --git a/dev/.doctrees/release_5_9_0.doctree b/dev/.doctrees/release_5_9_0.doctree index 2964385fc..829dbd104 100644 Binary files a/dev/.doctrees/release_5_9_0.doctree and b/dev/.doctrees/release_5_9_0.doctree differ diff --git a/dev/.doctrees/release_5_9_1.doctree b/dev/.doctrees/release_5_9_1.doctree index 515275950..ce83ae156 100644 Binary files a/dev/.doctrees/release_5_9_1.doctree and b/dev/.doctrees/release_5_9_1.doctree differ diff --git a/dev/.doctrees/release_5_9_2.doctree b/dev/.doctrees/release_5_9_2.doctree index 811f5117e..1be7faa9c 100644 Binary files a/dev/.doctrees/release_5_9_2.doctree and b/dev/.doctrees/release_5_9_2.doctree differ diff --git a/dev/.doctrees/releases.doctree b/dev/.doctrees/releases.doctree index 81df5b2ba..51633c702 100644 Binary files a/dev/.doctrees/releases.doctree and b/dev/.doctrees/releases.doctree differ diff --git a/dev/.doctrees/restart.doctree b/dev/.doctrees/restart.doctree index 95e1f6f16..14360ef13 100644 Binary files a/dev/.doctrees/restart.doctree and b/dev/.doctrees/restart.doctree differ diff --git a/dev/.doctrees/riemann.doctree b/dev/.doctrees/riemann.doctree index e16b03d2e..81678df8c 100644 Binary files a/dev/.doctrees/riemann.doctree and b/dev/.doctrees/riemann.doctree differ diff --git a/dev/.doctrees/riemann/Shallow_water_Riemann_solvers.doctree b/dev/.doctrees/riemann/Shallow_water_Riemann_solvers.doctree index 30245015b..3f3943242 100644 Binary files a/dev/.doctrees/riemann/Shallow_water_Riemann_solvers.doctree and b/dev/.doctrees/riemann/Shallow_water_Riemann_solvers.doctree differ diff --git a/dev/.doctrees/ruled_rectangles.doctree b/dev/.doctrees/ruled_rectangles.doctree index 12c6c0275..ca0bc0f04 100644 Binary files a/dev/.doctrees/ruled_rectangles.doctree and b/dev/.doctrees/ruled_rectangles.doctree differ diff --git a/dev/.doctrees/sealevel.doctree b/dev/.doctrees/sealevel.doctree index 6dadd7fca..9861dd412 100644 Binary files a/dev/.doctrees/sealevel.doctree and b/dev/.doctrees/sealevel.doctree differ diff --git a/dev/.doctrees/set_eta_init.doctree b/dev/.doctrees/set_eta_init.doctree index bf285bceb..34b955c9d 100644 Binary files a/dev/.doctrees/set_eta_init.doctree and b/dev/.doctrees/set_eta_init.doctree differ diff --git a/dev/.doctrees/setaux_defaults.doctree b/dev/.doctrees/setaux_defaults.doctree index 177b6d4b9..0f268588d 100644 Binary files a/dev/.doctrees/setaux_defaults.doctree and b/dev/.doctrees/setaux_defaults.doctree differ diff --git a/dev/.doctrees/setenv.doctree b/dev/.doctrees/setenv.doctree index 81ef60ae4..23b441499 100644 Binary files a/dev/.doctrees/setenv.doctree and b/dev/.doctrees/setenv.doctree differ diff --git a/dev/.doctrees/setplot.doctree b/dev/.doctrees/setplot.doctree index 61b7d8fd7..a1329bbe1 100644 Binary files a/dev/.doctrees/setplot.doctree and b/dev/.doctrees/setplot.doctree differ diff --git a/dev/.doctrees/setrun.doctree b/dev/.doctrees/setrun.doctree index 8b1d715d3..513812703 100644 Binary files a/dev/.doctrees/setrun.doctree and b/dev/.doctrees/setrun.doctree differ diff --git a/dev/.doctrees/setrun_amrclaw.doctree b/dev/.doctrees/setrun_amrclaw.doctree index 103ad9123..158dad657 100644 Binary files a/dev/.doctrees/setrun_amrclaw.doctree and b/dev/.doctrees/setrun_amrclaw.doctree differ diff --git a/dev/.doctrees/setrun_amrclaw_sample.doctree b/dev/.doctrees/setrun_amrclaw_sample.doctree index e759edd7f..4beed2a4b 100644 Binary files a/dev/.doctrees/setrun_amrclaw_sample.doctree and b/dev/.doctrees/setrun_amrclaw_sample.doctree differ diff --git a/dev/.doctrees/setrun_geoclaw.doctree b/dev/.doctrees/setrun_geoclaw.doctree index 4382f996d..bdcf813f3 100644 Binary files a/dev/.doctrees/setrun_geoclaw.doctree and b/dev/.doctrees/setrun_geoclaw.doctree differ diff --git a/dev/.doctrees/setrun_sample.doctree b/dev/.doctrees/setrun_sample.doctree index 220bc1ff4..a69426c8d 100644 Binary files a/dev/.doctrees/setrun_sample.doctree and b/dev/.doctrees/setrun_sample.doctree differ diff --git a/dev/.doctrees/sharing.doctree b/dev/.doctrees/sharing.doctree index d86210e09..07b375348 100644 Binary files a/dev/.doctrees/sharing.doctree and b/dev/.doctrees/sharing.doctree differ diff --git a/dev/.doctrees/sphere_source.doctree b/dev/.doctrees/sphere_source.doctree index 884ab26ad..a0ffd75e4 100644 Binary files a/dev/.doctrees/sphere_source.doctree and b/dev/.doctrees/sphere_source.doctree differ diff --git a/dev/.doctrees/sphinxdoc.doctree b/dev/.doctrees/sphinxdoc.doctree index ebeb0abdf..6da6c5f32 100644 Binary files a/dev/.doctrees/sphinxdoc.doctree and b/dev/.doctrees/sphinxdoc.doctree differ diff --git a/dev/.doctrees/src1d_defaults.doctree b/dev/.doctrees/src1d_defaults.doctree index 1c6f8d804..3ede4ad9f 100644 Binary files a/dev/.doctrees/src1d_defaults.doctree and b/dev/.doctrees/src1d_defaults.doctree differ diff --git a/dev/.doctrees/src_defaults.doctree b/dev/.doctrees/src_defaults.doctree index 034748614..9a80df027 100644 Binary files a/dev/.doctrees/src_defaults.doctree and b/dev/.doctrees/src_defaults.doctree differ diff --git a/dev/.doctrees/storm_module.doctree b/dev/.doctrees/storm_module.doctree index 4a8f058c1..d1114a2ca 100644 Binary files a/dev/.doctrees/storm_module.doctree and b/dev/.doctrees/storm_module.doctree differ diff --git a/dev/.doctrees/surgedata.doctree b/dev/.doctrees/surgedata.doctree index e15f85b59..e26f9e6aa 100644 Binary files a/dev/.doctrees/surgedata.doctree and b/dev/.doctrees/surgedata.doctree differ diff --git a/dev/.doctrees/testing.doctree b/dev/.doctrees/testing.doctree index f75df1bde..5c9edaf42 100644 Binary files a/dev/.doctrees/testing.doctree and b/dev/.doctrees/testing.doctree differ diff --git a/dev/.doctrees/timing.doctree b/dev/.doctrees/timing.doctree index 3874c5454..ff77d6494 100644 Binary files a/dev/.doctrees/timing.doctree and b/dev/.doctrees/timing.doctree differ diff --git a/dev/.doctrees/topo.doctree b/dev/.doctrees/topo.doctree index 020359229..841276fa4 100644 Binary files a/dev/.doctrees/topo.doctree and b/dev/.doctrees/topo.doctree differ diff --git a/dev/.doctrees/topotools.doctree b/dev/.doctrees/topotools.doctree index 50927210b..429a1d48b 100644 Binary files a/dev/.doctrees/topotools.doctree and b/dev/.doctrees/topotools.doctree differ diff --git a/dev/.doctrees/topotools_module.doctree b/dev/.doctrees/topotools_module.doctree index 061e8fa24..4a51f7cd1 100644 Binary files a/dev/.doctrees/topotools_module.doctree and b/dev/.doctrees/topotools_module.doctree differ diff --git a/dev/.doctrees/trouble.doctree b/dev/.doctrees/trouble.doctree index 2c8a461b9..e23c8dd3a 100644 Binary files a/dev/.doctrees/trouble.doctree and b/dev/.doctrees/trouble.doctree differ diff --git a/dev/.doctrees/tsunamidata.doctree b/dev/.doctrees/tsunamidata.doctree index 5d7979470..eaae3b7e3 100644 Binary files a/dev/.doctrees/tsunamidata.doctree and b/dev/.doctrees/tsunamidata.doctree differ diff --git a/dev/.doctrees/user_routines.doctree b/dev/.doctrees/user_routines.doctree index 4a64384c5..fae105dc3 100644 Binary files a/dev/.doctrees/user_routines.doctree and b/dev/.doctrees/user_routines.doctree differ diff --git a/dev/.doctrees/visit_plotting.doctree b/dev/.doctrees/visit_plotting.doctree index 880fb163e..20e6bb5c0 100644 Binary files a/dev/.doctrees/visit_plotting.doctree and b/dev/.doctrees/visit_plotting.doctree differ diff --git a/dev/.doctrees/vm.doctree b/dev/.doctrees/vm.doctree index 5eb5c84a1..58f5f8f56 100644 Binary files a/dev/.doctrees/vm.doctree and b/dev/.doctrees/vm.doctree differ diff --git a/dev/.doctrees/wp_algorithms.doctree b/dev/.doctrees/wp_algorithms.doctree index 6236dd108..fb3f0a7f5 100644 Binary files a/dev/.doctrees/wp_algorithms.doctree and b/dev/.doctrees/wp_algorithms.doctree differ diff --git a/dev/ClawPlotItem.html b/dev/ClawPlotItem.html index 85201f949..fca8025d6 100644 --- a/dev/ClawPlotItem.html +++ b/dev/ClawPlotItem.html @@ -121,10 +121,12 @@

Attributes

If True, a colorbar is added to the plot.

+ +
+

Special attributes for plot_type = ‘2d_hillshade’

+
+
+hillshade_vertical_exaggeration : float
+

Vertical exaggeration for hillshade calulation. Default of 1.

+
+ +
+
+hillshade_azimuth_degree : float
+

Light source azimuth angle for hillshade calculation. Default +is 315 (light coming from the northwest). Valid values are +0-360 degrees clockwise from North. The default value is recommended +for proper interpretation by most people.

+
+ +
+
+hillshade_altitude_degree : float
+

Light source altitude angle from the horizon for hillshade +calculation. Default is 45. Valid values are 0-90.

+
+ +
+
+hillshade_latlon : bool
+

If True, correct the ratio between x and y units and z units +by 1/111200 to reflect that x and y units are degrees. +Default is False.

+
+
@@ -558,6 +593,7 @@

Table of Contents

  • Special attributes for plot_type = ‘2d_contour’
  • Special attributes for plot_type = ‘2d_pcolor’
  • Special attributes for plot_type = ‘2d_imshow’
    • +
  • Special attributes for plot_type = ‘2d_hillshade’
  • AMR Attributes
    • diff --git a/dev/_sources/ClawPlotItem.rst.txt b/dev/_sources/ClawPlotItem.rst.txt index 054f70138..a7b082073 100644 --- a/dev/_sources/ClawPlotItem.rst.txt +++ b/dev/_sources/ClawPlotItem.rst.txt @@ -34,11 +34,12 @@ The following attributes can be set by the user: symmetric, * '1d_fill_between' : 1d filled plot between two variable specified by the attributes *plot_var* and *fill_var2*. - + * '2d_imshow' : two dimentional raster plot * '2d_contour' : two dimensional contour plot, * '2d_pcolor' : two dimensional pcolor plot, * '2d_schlieren' : two dimensional Schlieren plot, * '2d_patch' : two dimensional plot of only the cell and/or patch edges, no data + * '2d_hillshade' : two dimensional hillshade plot. .. attribute:: outdir : str or None @@ -306,7 +307,30 @@ Special attributes for plot_type = '2d_imshow' If True, a colorbar is added to the plot. - +Special attributes for plot_type = '2d_hillshade' +------------------------------------------------- + +.. attribute:: hillshade_vertical_exaggeration : float + + Vertical exaggeration for hillshade calulation. Default of 1. + +.. attribute:: hillshade_azimuth_degree : float + + Light source azimuth angle for hillshade calculation. Default + is 315 (light coming from the northwest). Valid values are + 0-360 degrees clockwise from North. The default value is recommended + for proper interpretation by most people. + +.. attribute:: hillshade_altitude_degree : float + + Light source altitude angle from the horizon for hillshade + calculation. Default is 45. Valid values are 0-90. + +.. attribute:: hillshade_latlon : bool + + If True, correct the ratio between x and y units and z units + by 1/111200 to reflect that x and y units are degrees. + Default is False. .. _amr_attributes: diff --git a/dev/_sources/bouss1d.rst.txt b/dev/_sources/bouss1d.rst.txt index c9b707716..674bfd15c 100644 --- a/dev/_sources/bouss1d.rst.txt +++ b/dev/_sources/bouss1d.rst.txt @@ -20,36 +20,12 @@ equations contain higher order derivative terms and so they are no longer hyperbolic. The equations implemented include third-order derivatives with respect to `txx`. However, the implementations proceed by alternating steps with the shallow water equations and the solution of elliptic -equations that involve only second-order derivatives in `xx`. +equations that involve second-order derivatives in `xx` but no time derivatives. +In one space dimension, solving this equation requires solving a tridiagonal +linear system of equations in each time step. -.. _bouss1d_sgn: - -The SGN equations ------------------ - -The recommended set of equations to use are a modification of the -Serre-Green-Naghdi (SGN) equations with the addition of a parameter `alpha` -suggested by Bonneton et al. Both the 1d and 2d versions of these equations -and their GeoClaw implementation are discussed in [BergerLeVeque2023]_. -Setting `alpha = 1` gives the original SGN equations, but `alpha = 1.153` is -recommended since it gives a better approximation to the linear dispersion -relation of the Airy solution to the full 3d problem. - -.. _bouss1d_ms: - -The Madsen-Sorensen (MS) equations ----------------------------------- - -These equations also give a good approximation to the linear dispersion -relation of the Airy solution when the parameter `beta = 1/15` is used. -These equations were used in an earlier GeoClaw implementation known as -BoussClaw. These have been reimplemented in GeoClaw more recently, -including a 2d implementation that allows the use of AMR. However, -extensive tests with these equations have revealed some stability issues, -particularly in the case of AMR, which have also been reported by others. -The 1d MS implementation is included in GeoClaw but it is generally not -recommended except for those interested in comparing different formulations -and perhaps further investigating the stability issues. +See :ref:`bouss2d` and [BergerLeVeque2023]_ for more discussion +of the Boussinesq-type equations SGN and MS that are implemented in GeoClaw. .. _bouss1d_usage: @@ -100,21 +76,39 @@ setrun.py ^^^^^^^^^ -Some additional parameters must be added to `setrun.py`, typically set as -follows:: +To use the Boussinesq solvers, somewhere in the `setrun` function you +must include :: from clawpack.geoclaw.data import BoussData1D rundata.add_data(BoussData1D(),'bouss_data') - rundata.bouss_data.bouss = True - rundata.bouss_data.equations = 2 # for SGN (recommended, or 1 for MS) + +and then the following parameters can be adjusted (the values shown here +are the default values that will be used if you do not specify a value +directly):: + + rundata.bouss_data.equations = 2 # 0=SWE, 1=MS, 2=SGN rundata.bouss_data.deepBouss = 5. # depth (meters) to switch to SWE The `rundata.bouss_data` object has attributes: -- `bouss_equations` (int): Which equation set to use - (0 for SWE, 1 for MS, 2 for SGN). -- `bouss_min_depth` (float): water depth at which to switch from Boussinesq - to SWE. +- `bouss_equations`: The system of equations being solved. Setting this to 2 + gives the recommended SGN equations. + + The value `alpha = 1.153` recommended for SGN is + hardwired into `$CLAW/geoclaw/src/2d/bouss/bouss_module.f90`. To change + this value, you must modify this module. (See :ref:`makefiles_library` + for tips on modifying a library routine.) Similarly, if you set + `bouss_equations = 1` for the Madsen-Sorensen equations, the recommended + parameter value `B = 1/15` is set in `bouss_module.f90`. + + Setting `bouss_equations = 0` causes the code to revert to the shallow + water equations, useful for comparing dispersive and nondispersive results. + +- `bouss_min_depth`: The criterion used for switching from Boussinesq to SWE + in shallow water and onshore. If the original water depth `h` at time `t0` + is less than `bouss_min_depth` in a cell or any of its nearest neighbors, + then this cell is omitted from set of unknowns in the elliptic equation + solve and no dispersive correction terms are calculated for this cell. The latter parameter is needed because in very shallow water, and for modeling onshore inundation, the Boussinesq equations are not suitable. @@ -123,4 +117,4 @@ solving SWE near shore. Many different approaches have been used in the literature. So far we have only implemented the simplest common approach, which is to revert to SWE in any grid cell where the initial water depth (at the initial time) is less than `bouss_min_depth`. - +See :ref:`bouss2d_switch` for more discussion. diff --git a/dev/_sources/bouss2d.rst.txt b/dev/_sources/bouss2d.rst.txt index a7c049669..bce624ff9 100644 --- a/dev/_sources/bouss2d.rst.txt +++ b/dev/_sources/bouss2d.rst.txt @@ -4,7 +4,269 @@ Boussinesq solvers in Two Space Dimensions ********************************************* -To appear in a future release. +.. warning :: Not yet incorporated in clawpack master branch or releases. -See [BergerLeVeque2023]_. +As of Version 5.10.0 (?), GeoClaw supports two different sets of +dispersive Boussinesq-type equations that have been used in the literature +to better model wave propagation in situations where the wavelength is not +sufficiently long relative to the fluid depth for the shallow water +equation approximation to be accurate. The one-dimensional version of these +capabilities are described in :ref:`bouss1d`. +These Boussinesq equations are still depth-averaged equations, with the same +conserved quantities (fluid depth `h` and momenta `hu` and `hv` in 2D) as the +shallow water equations (SWE), but the +equations contain higher order derivative terms and so they are no longer +hyperbolic and require implicit methods for efficient solution with a +physically reasonable time step. This adds considerable complexity to the +code since adaptive mesh refinement (AMR) is still supported. + +The equations implemented include third-order derivatives +with respect to `txx`, `tyy`, and `txy`. +However, the implementations proceed by alternating +steps with the shallow water equations (SWE) and the solution of elliptic +equations that involve second order derivatives in `x` and `y` but no +time derivatives. + +In two space dimensions, solving this +elliptic equation requires solving a sparse +linear system of equations in each time step, at each refinement level when +AMR is being used. The structure of this system is complicated by the need +to include all grid cells from all patches at the same refinement level +in the linear system that is solved. Boundary conditions at the edge of +patches must be interpolated from coarser level solutions, in much the same +way that the boundaary conditions for `h`, `hu`, and `hv` are interpolated +when solving the SWE with AMR. Because the solution of the elliptic system +yields correction terms to the momenta (denoted here by `huc` and `hvc`), +when solving the Boussinesq equations the array `q` of state variables +is expanded to include these correction terms as well, and so the number of +equations and variables is 5 instead of 3. This change must be made in +`setrun.py`, along with other changes discussed below, in order to use +the Boussinesq solvers. + +Currently the only linear system solver supported for solving the large +sparse elliptic systems is `PETSc `_, +which can use MPI to solve these these systems. Using the Boussinesq solvers +requires these prerequesites, as discussed further in :ref:`bouss2d_prereqs`. + +See [BergerLeVeque2023]_ for more discussion of the equations solved and the +AMR strategy used. + +.. _bouss2d_eqns: + +Boussinesq-type dispersive equations +------------------------------------ + +The equations we solve are not the original depth-averaged dispersive +equations derived by Boussinesq, but for simplicity +in this documentation and the code, we refer to the +equations simply as "Boussinesq equations", following common practice. +Many variants of these equations have been derived and fine-tuned to +better match the dispersion relation of the linearized +`Airy wave theory `__ +and to incorporate variable bottom topography. + +Two variants are currently implement in GeoClaw, described below. + +.. _bouss2d_sgn: + +The SGN equations +----------------- + +The recommended set of equations to use are a modification of the +Serre-Green-Naghdi (SGN) equations with the addition of a parameter `alpha` +suggested by Bonneton et al. Both the 1D and 2D versions of these equations +and their GeoClaw implementation are discussed in [BergerLeVeque2023]_. +Setting `alpha = 1` gives the original SGN equations, but `alpha = 1.153` is +recommended since it gives a better approximation to the linear dispersion +relation of the Airy solution to the full 3d problem. + +.. _bouss2d_ms: + +The Madsen-Sorensen (MS) equations +---------------------------------- + +These equations also give a good approximation to the linear dispersion +relation of the Airy solution when the parameter `beta = 1/15` is used. +These equations were used in an earlier GeoClaw implementation known as +BoussClaw. *[Todo: add citations]* +These have been reimplemented in GeoClaw more recently, +including a 2d implementation that allows the use of AMR. However, +extensive tests with these equations have revealed some stability issues, +particularly in the case of AMR, which have also been reported by others. +The 1D MS implementation is included in GeoClaw but it is generally not +recommended except for those interested in comparing different formulations +and perhaps further investigating the stability issues. + +.. _bouss2d_usage: + +Using the 2d Boussinesq code +---------------------------- + +Provided the :ref:`bouss2d_prereqs` have been installed, switching from the +SWE to a Boussinesq solver in GeoClaw requires only minor changes to +`setrun.py` and the `Makefile`. + +See the files in `$CLAW/geoclaw/examples/bouss/radial_flat` for an example. + + +.. _bouss2d_setrun: + +setrun.py +^^^^^^^^^ + +As mentioned above, it is necessary to set:: + + clawdata.num_eqn = 5 + +instead of the usual value 3 used for SWE, since correction terms for the +momenta are also stored in the `q` arrays to facilitate interpolation to +ghost cells of finer level patches each time step. + +It is also necessary to set some parameters that are specific to the +Boussinesq solvers. Somewhere in the `setrun` function you must include :: + + from clawpack.geoclaw.data import BoussData + rundata.add_data(BoussData(),'bouss_data') + +and then the following parameters can be adjusted (the values shown here +are the default values that will be used if you do not specify a value +directly):: + + rundata.bouss_data.bouss_equations = 2 # 0=SWE, 1=MS, 2=SGN + rundata.bouss_data.bouss_min_level = 1 # coarsest level to apply bouss + rundata.bouss_data.bouss_max_level = 10 # finest level to apply bouss + rundata.bouss_data.bouss_min_depth = 10. # depth (meters) to switch to SWE + rundata.bouss_data.bouss_solver = 3 # 1=GMRES, 2=Pardiso, 3=PETSc + rundata.bouss_data.bouss_tstart = 0. # time to switch from SWE + +These parameters control: + +- `bouss_equations`: The system of equations being solved. Setting this to 2 + gives the recommended SGN equations. + + The value `alpha = 1.153` recommended for SGN is + hardwired into `$CLAW/geoclaw/src/2d/bouss/bouss_module.f90`. To change + this value, you must modify this module. (See :ref:`makefiles_library` + for tips on modifying a library routine.) Similarly, if you set + `bouss_equations = 1` for the Madsen-Sorensen equations, the recommended + parameter value `B = 1/15` is set in `bouss_module.f90`. + + Setting `bouss_equations = 0` causes the code to revert to the shallow + water equations, useful for comparing dispersive and nondispersive results. + +- `bouss_min_level`: The minimum AMR level on which Boussinesq correction + terms should be applied. In some cases it may be desirable to use the SWE + on the coarsest grids in the ocean while Boussinesq corrections are only + applied on fine levels near shore, for example. + +- `bouss_max_level`: The finest AMR level on which Boussinesq correction + terms should be applied. In some cases it may be desirable to use the SWE + only on coarser grids if the finest level grid only exists in very shallow + regions or onshore, where the the equations switch to SWE for inundation + modeling. Since much of the computational work is often on the finest level, + avoiding the Boussinesq terms altogether on these levels may be advantageous + in some situations. + +- `bouss_min_depth`: The criterion used for switching from Boussinesq to SWE + in shallow water and onshore. If the original water depth `h` at time `t0` + is less than `bouss_min_depth` in a cell or any of its nearest neighbors, + then this cell is omitted from set of unknowns in the elliptic equation + solve and no dispersive correction terms are calculated for this cell. + This is discussed further below in :ref:`bouss2d_switch`. + +- `bouss_solver`: What linear system solver to use. Currently only the value + 3 for `PETSc`_ is recognized. + +- `bouss_tstart`: The time `t` at which to start applying Boussinesq terms. + Normally you will want this to be less than or equal to `t0`, the starting + time of the calculation (which is usually but not always 0). However, + there are some cases in which the initial data results in extreme + motion in the first few time steps and it is necessary to get things going + with the SWE. For most applications this is not necessary and you need + only change this parameter if you have set `t0 < 0`. + +.. _bouss2d_makefile: + +Makefile +^^^^^^^^ + +You can copy the `Makefile` from +`$CLAW/geoclaw/examples/bouss/radial_flat/Makefile` and make any adjustments +needed. + +This `Makefile` reads in the standard Boussinesq solver file +`$CLAW/geoclaw/src/2d/bouss/Makefile.bouss`, which lists the Fortran modules +and source code files that are used by default from the library +`$CLAW/geoclaw/src/2d/bouss`, or from `$CLAW/amrclaw/src/2d` or +`$CLAW/geoclaw/src/2d/shallow` in the case of files that did not need to +be modified for the Boussinesq code. + +Two `Makefile` variables `PETSC_DIR` and `PETSC_ARCH` must be set (perhaps as +environment variables in the shell from which `make` is invoked). These are +described further below in :ref:`bouss2d_prereqs`. + +The `Makefile` should also include a line of the form:: + + PETSC_OPTIONS=-options_file $(CLAW)/geoclaw/examples/bouss/petscMPIoptions + +with a pointer to the file that sets various `PETSc` options. The file +`$CLAW/geoclaw/examples/bouss/petscMPIoptions` gives the options used in +the examples, which may be adequate for other problems too. +*[Todo: more description of options?]* + +In addition to a line of the form :: + + EXE = $(PWD)/xgeoclaw + +that specifies the name and location of the executable to be generated, the +`Makefile` should also contain a line of the form:: + + RUNEXE="${PETSC_DIR}/${PETSC_ARCH}/bin/mpiexec -n 6" + +This is the command that should be used in order to run the executable. +In other words, if you set `PETSC_DIR` and `PETSC_ARCH` as environment +variables, and the executable is named `xgeoclaw` as usual, then the command :: + + $PETSC_DIR/$PETSC_ARCH/bin/mpiexec -n 6 xgeoclaw + +given in the shell should run the executable (invoking MPI with 6 processes in +this example). If this does not work then one of the environment variables +may be set incorrectly to find the `mpiexec` command. + + +.. _bouss2d_prereqs: + +Prerequisites for the 2d Boussinesq code +---------------------------------------- + +Currently the only linear solver supported is `PETSc`, so this must be +installed, see ``__ for instructions +and also note the `PETSc prerequisites +`__. +Note that MPI, LAPACK, and the BLAS are required and will be installed as +part of installing PETSc. If you already have some of the prerequisites +installed, be sure to read `Configuring PETSc +`__ +before installing. + + +*[Todo: How to set `$PETSC_DIR` And `$PETSC_ARCH`]* + +See also the PETSc documentation page +`Environmental Variables $PETSC_DIR And $PETSC_ARCH `__ + +.. _bouss2d_switch: + +Wave breaking and switching to SWE +---------------------------------- + +The `bouss_min_depth` parameter is needed because in very shallow water, and for +modeling onshore inundation, the Boussinesq equations are not suitable. +So some criterion is needed to drop these correction terms and revert to +solving SWE near shore. Many different approaches have been used in the +literature. So far we have only implemented the simplest common approach, +which is to revert to SWE in any grid cell where the initial water depth (at +the initial time) is less than `bouss_min_depth`. + +*[Todo: Add more discussion.]* diff --git a/dev/_sources/release_5_9_2.rst.txt b/dev/_sources/release_5_9_2.rst.txt index 17fb1199e..dc70ee6b5 100644 --- a/dev/_sources/release_5_9_2.rst.txt +++ b/dev/_sources/release_5_9_2.rst.txt @@ -85,6 +85,19 @@ See `amrclaw diffs Changes to geoclaw ------------------ +The `setrun` parameter `rundata.fixed_grid_data` was removed from +`geoclaw/src/python/geoclaw/data.py` and is no longer available in `setrun`. +This old way of specifying fixed grid output has been deprecated for some +time in favor of `fgmax` and `fgout` grids, but some old `setrun.py` files +may still set :: + + fixedgrids = rundata.fixed_grid_data.fixedgrids + +and throw an error that can be fixed by deleting this line. +If items are appended to this list in your `setrun`, then these should be +converted to `fgmax` and/or `fgout` grids. + + The `setrun` parameter `runclaw.geo_data.sphere_source` was added to allow experimenting with the spherical source term that is currently missing from the default GeoClaw code, see :ref:`sphere_source`, which now includes a diff --git a/dev/bouss1d.html b/dev/bouss1d.html index a077f199b..1af4fa668 100644 --- a/dev/bouss1d.html +++ b/dev/bouss1d.html @@ -104,30 +104,11 @@

    Navigation

    hyperbolic. The equations implemented include third-order derivatives with respect to txx. However, the implementations proceed by alternating steps with the shallow water equations and the solution of elliptic -equations that involve only second-order derivatives in xx.

    -
    -

    The SGN equations

    -

    The recommended set of equations to use are a modification of the -Serre-Green-Naghdi (SGN) equations with the addition of a parameter alpha -suggested by Bonneton et al. Both the 1d and 2d versions of these equations -and their GeoClaw implementation are discussed in [BergerLeVeque2023]. -Setting alpha = 1 gives the original SGN equations, but alpha = 1.153 is -recommended since it gives a better approximation to the linear dispersion -relation of the Airy solution to the full 3d problem.

    -
    -
    -

    The Madsen-Sorensen (MS) equations

    -

    These equations also give a good approximation to the linear dispersion -relation of the Airy solution when the parameter beta = 1/15 is used. -These equations were used in an earlier GeoClaw implementation known as -BoussClaw. These have been reimplemented in GeoClaw more recently, -including a 2d implementation that allows the use of AMR. However, -extensive tests with these equations have revealed some stability issues, -particularly in the case of AMR, which have also been reported by others. -The 1d MS implementation is included in GeoClaw but it is generally not -recommended except for those interested in comparing different formulations -and perhaps further investigating the stability issues.

    -
    +equations that involve second-order derivatives in xx but no time derivatives. +In one space dimension, solving this equation requires solving a tridiagonal +linear system of equations in each time step.

    +

    See Boussinesq solvers in Two Space Dimensions and [BergerLeVeque2023] for more discussion +of the Boussinesq-type equations SGN and MS that are implemented in GeoClaw.

    Using the 1d Boussinesq code

    As in the 1d shallow water implementation, general mapped grids can be used, @@ -161,21 +142,37 @@

    Navigation

    setrun.py

    -

    Some additional parameters must be added to setrun.py, typically set as -follows:

    +

    To use the Boussinesq solvers, somewhere in the setrun function you +must include

    from clawpack.geoclaw.data import BoussData1D
 rundata.add_data(BoussData1D(),'bouss_data')
-rundata.bouss_data.bouss = True
-rundata.bouss_data.equations = 2  # for SGN (recommended, or 1 for MS)
+
    +
    +

    and then the following parameters can be adjusted (the values shown here +are the default values that will be used if you do not specify a value +directly):

    +
    rundata.bouss_data.equations = 2   # 0=SWE, 1=MS, 2=SGN
 rundata.bouss_data.deepBouss = 5.  # depth (meters) to switch to SWE

    The rundata.bouss_data object has attributes:

    -
      -

    • bouss_equations (int): Which equation set to use -(0 for SWE, 1 for MS, 2 for SGN).

      • -

    • bouss_min_depth (float): water depth at which to switch from Boussinesq -to SWE.

      • +
        +

      • bouss_equations: The system of equations being solved. Setting this to 2 +gives the recommended SGN equations.

        +

        The value alpha = 1.153 recommended for SGN is +hardwired into $CLAW/geoclaw/src/2d/bouss/bouss_module.f90. To change +this value, you must modify this module. (See Library routines in Makefiles +for tips on modifying a library routine.) Similarly, if you set +bouss_equations = 1 for the Madsen-Sorensen equations, the recommended +parameter value B = 1/15 is set in bouss_module.f90.

        +

        Setting bouss_equations = 0 causes the code to revert to the shallow +water equations, useful for comparing dispersive and nondispersive results.

        +
        • +

      • bouss_min_depth: The criterion used for switching from Boussinesq to SWE +in shallow water and onshore. If the original water depth h at time t0 +is less than bouss_min_depth in a cell or any of its nearest neighbors, +then this cell is omitted from set of unknowns in the elliptic equation +solve and no dispersive correction terms are calculated for this cell.

      The latter parameter is needed because in very shallow water, and for modeling onshore inundation, the Boussinesq equations are not suitable. @@ -183,7 +180,8 @@

      Navigation

      solving SWE near shore. Many different approaches have been used in the literature. So far we have only implemented the simplest common approach, which is to revert to SWE in any grid cell where the initial water depth (at -the initial time) is less than bouss_min_depth.

      +the initial time) is less than bouss_min_depth. +See Wave breaking and switching to SWE for more discussion.

    @@ -204,8 +202,6 @@

    Version dev

    Table of Contents