Skip to content

Commit

Permalink
add bouss2d description and update bouss1d
Browse files Browse the repository at this point in the history
  • Loading branch information
rjleveque committed Dec 10, 2023
1 parent d62b755 commit 40963af
Show file tree
Hide file tree
Showing 725 changed files with 1,699 additions and 183 deletions.
13 changes: 13 additions & 0 deletions _sources/release_5_9_2.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion dev/.buildinfo
Original file line number Diff line number Diff line change
@@ -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
Binary file modified dev/.doctrees/ClawPlotAxes.doctree
Binary file not shown.
Binary file modified dev/.doctrees/ClawPlotData.doctree
Binary file not shown.
Binary file modified dev/.doctrees/ClawPlotFigure.doctree
Binary file not shown.
Binary file modified dev/.doctrees/ClawPlotItem.doctree
Binary file not shown.
Binary file modified dev/.doctrees/about.doctree
Binary file not shown.
Binary file modified dev/.doctrees/adjoint.doctree
Binary file not shown.
Binary file modified dev/.doctrees/amr_algorithm.doctree
Binary file not shown.
Binary file modified dev/.doctrees/amrclaw.doctree
Binary file not shown.
Binary file modified dev/.doctrees/amrclaw1d.doctree
Binary file not shown.
Binary file modified dev/.doctrees/amrclaw_doxygen.doctree
Binary file not shown.
Binary file modified dev/.doctrees/amrclaw_flowcharts.doctree
Binary file not shown.
Binary file modified dev/.doctrees/application_documentation.doctree
Binary file not shown.
Binary file modified dev/.doctrees/apps.doctree
Binary file not shown.
Binary file modified dev/.doctrees/aws.doctree
Binary file not shown.
Binary file modified dev/.doctrees/b4run.doctree
Binary file not shown.
Binary file modified dev/.doctrees/b4step_defaults.doctree
Binary file not shown.
Binary file modified dev/.doctrees/bc.doctree
Binary file not shown.
Binary file modified dev/.doctrees/biblio.doctree
Binary file not shown.
Binary file modified dev/.doctrees/bouss1d.doctree
Binary file not shown.
Binary file modified dev/.doctrees/bouss2d.doctree
Binary file not shown.
Binary file modified dev/.doctrees/changes_to_master.doctree
Binary file not shown.
Binary file modified dev/.doctrees/claw43to46.doctree
Binary file not shown.
Binary file modified dev/.doctrees/claw46to50.doctree
Binary file not shown.
Binary file modified dev/.doctrees/claw4x.doctree
Binary file not shown.
Binary file modified dev/.doctrees/clawpack5.doctree
Binary file not shown.
Binary file modified dev/.doctrees/clawpack_components.doctree
Binary file not shown.
Binary file modified dev/.doctrees/community.doctree
Binary file not shown.
Binary file modified dev/.doctrees/contents.doctree
Binary file not shown.
Binary file modified dev/.doctrees/contribute_apps.doctree
Binary file not shown.
Binary file modified dev/.doctrees/current_data.doctree
Binary file not shown.
Binary file modified dev/.doctrees/developers.doctree
Binary file not shown.
Binary file modified dev/.doctrees/docker_image.doctree
Binary file not shown.
Binary file modified dev/.doctrees/dtopotools_module.doctree
Binary file not shown.
Binary file modified dev/.doctrees/environment.pickle
Binary file not shown.
Binary file modified dev/.doctrees/f77_vs_f90.doctree
Binary file not shown.
Binary file modified dev/.doctrees/fgmax.doctree
Binary file not shown.
Binary file modified dev/.doctrees/fgmax_tools_module.doctree
Binary file not shown.
Binary file modified dev/.doctrees/fgout.doctree
Binary file not shown.
Binary file modified dev/.doctrees/fgout_tools_module.doctree
Binary file not shown.
Binary file modified dev/.doctrees/first_run.doctree
Binary file not shown.
Binary file modified dev/.doctrees/first_run_fortran.doctree
Binary file not shown.
Binary file modified dev/.doctrees/first_run_pyclaw.doctree
Binary file not shown.
Binary file modified dev/.doctrees/flagregions.doctree
Binary file not shown.
Binary file modified dev/.doctrees/force_dry.doctree
Binary file not shown.
Binary file modified dev/.doctrees/fortran.doctree
Binary file not shown.
Binary file modified dev/.doctrees/fortran_compilers.doctree
Binary file not shown.
Binary file modified dev/.doctrees/fvmbook.doctree
Binary file not shown.
Binary file modified dev/.doctrees/galleries.doctree
Binary file not shown.
Binary file modified dev/.doctrees/gauges.doctree
Binary file not shown.
Binary file modified dev/.doctrees/geoclaw.doctree
Binary file not shown.
Binary file modified dev/.doctrees/geoclaw1d.doctree
Binary file not shown.
Binary file modified dev/.doctrees/geoclaw_started.doctree
Binary file not shown.
Binary file modified dev/.doctrees/geoclaw_util_module.doctree
Binary file not shown.
Binary file modified dev/.doctrees/geohints.doctree
Binary file not shown.
Binary file modified dev/.doctrees/geoplot.doctree
Binary file not shown.
Binary file modified dev/.doctrees/git_versions.doctree
Binary file not shown.
Binary file modified dev/.doctrees/googleearth_plotting.doctree
Binary file not shown.
Binary file modified dev/.doctrees/gpu.doctree
Binary file not shown.
Binary file modified dev/.doctrees/grid_registration.doctree
Binary file not shown.
Binary file modified dev/.doctrees/howto_doc.doctree
Binary file not shown.
Binary file modified dev/.doctrees/howto_release.doctree
Binary file not shown.
Binary file modified dev/.doctrees/installing.doctree
Binary file not shown.
Binary file modified dev/.doctrees/installing_fortcodes.doctree
Binary file not shown.
Binary file modified dev/.doctrees/installing_pip.doctree
Binary file not shown.
Binary file modified dev/.doctrees/kmltools_module.doctree
Binary file not shown.
Binary file modified dev/.doctrees/lagrangian_gauges.doctree
Binary file not shown.
Binary file modified dev/.doctrees/license.doctree
Binary file not shown.
Binary file modified dev/.doctrees/makefiles.doctree
Binary file not shown.
Binary file modified dev/.doctrees/makefiles_library.doctree
Binary file not shown.
Binary file modified dev/.doctrees/manning.doctree
Binary file not shown.
Binary file modified dev/.doctrees/mapc2p.doctree
Binary file not shown.
Binary file modified dev/.doctrees/marching_front.doctree
Binary file not shown.
Binary file modified dev/.doctrees/matlab_plotting.doctree
Binary file not shown.
Binary file modified dev/.doctrees/nearshore_interp.doctree
Binary file not shown.
Binary file modified dev/.doctrees/netcdf.doctree
Binary file not shown.
Binary file modified dev/.doctrees/newapp.doctree
Binary file not shown.
Binary file modified dev/.doctrees/okada.doctree
Binary file not shown.
Binary file modified dev/.doctrees/openmp.doctree
Binary file not shown.
Binary file modified dev/.doctrees/output_styles.doctree
Binary file not shown.
Binary file modified dev/.doctrees/packages.doctree
Binary file not shown.
Binary file modified dev/.doctrees/photos.doctree
Binary file not shown.
Binary file modified dev/.doctrees/plotexamples.doctree
Binary file not shown.
Binary file modified dev/.doctrees/plotting.doctree
Binary file not shown.
Binary file modified dev/.doctrees/plotting_faq.doctree
Binary file not shown.
Binary file modified dev/.doctrees/plotting_geoclaw.doctree
Binary file not shown.
Binary file modified dev/.doctrees/plotting_python.doctree
Binary file not shown.
Binary file modified dev/.doctrees/prereqs.doctree
Binary file not shown.
Binary file modified dev/.doctrees/pyclaw/about.doctree
Binary file not shown.
Binary file modified dev/.doctrees/pyclaw/basics.doctree
Binary file not shown.
Binary file modified dev/.doctrees/pyclaw/classes.doctree
Binary file not shown.
Binary file modified dev/.doctrees/pyclaw/clawpack_and_pyclaw.doctree
Binary file not shown.
Binary file modified dev/.doctrees/pyclaw/cloud.doctree
Binary file not shown.
Binary file modified dev/.doctrees/pyclaw/controller.doctree
Binary file not shown.
Binary file modified dev/.doctrees/pyclaw/evolve/limiters.doctree
Binary file not shown.
Binary file modified dev/.doctrees/pyclaw/examples.doctree
Binary file not shown.
Binary file modified dev/.doctrees/pyclaw/geometry.doctree
Binary file not shown.
Binary file modified dev/.doctrees/pyclaw/going_further.doctree
Binary file not shown.
Binary file modified dev/.doctrees/pyclaw/index.doctree
Binary file not shown.
Binary file modified dev/.doctrees/pyclaw/io.doctree
Binary file not shown.
Binary file modified dev/.doctrees/pyclaw/output.doctree
Binary file not shown.
Binary file modified dev/.doctrees/pyclaw/parallel.doctree
Binary file not shown.
Binary file modified dev/.doctrees/pyclaw/plotting.doctree
Binary file not shown.
Binary file modified dev/.doctrees/pyclaw/problem.doctree
Binary file not shown.
Binary file modified dev/.doctrees/pyclaw/rp.doctree
Binary file not shown.
Binary file modified dev/.doctrees/pyclaw/solution.doctree
Binary file not shown.
Binary file modified dev/.doctrees/pyclaw/solvers.doctree
Binary file not shown.
Binary file modified dev/.doctrees/pyclaw/started.doctree
Binary file not shown.
Binary file modified dev/.doctrees/pyclaw/state.doctree
Binary file not shown.
Binary file modified dev/.doctrees/pyclaw/troubleshooting.doctree
Binary file not shown.
Binary file modified dev/.doctrees/pyclaw/tutorial.doctree
Binary file not shown.
Binary file modified dev/.doctrees/pyclaw/util.doctree
Binary file not shown.
Binary file modified dev/.doctrees/python.doctree
Binary file not shown.
Binary file modified dev/.doctrees/python_path.doctree
Binary file not shown.
Binary file modified dev/.doctrees/qinit_defaults.doctree
Binary file not shown.
Binary file modified dev/.doctrees/quick_surge.doctree
Binary file not shown.
Binary file modified dev/.doctrees/quick_tsunami.doctree
Binary file not shown.
Binary file modified dev/.doctrees/refinement.doctree
Binary file not shown.
Binary file modified dev/.doctrees/regression.doctree
Binary file not shown.
Binary file modified dev/.doctrees/release_5_0_0.doctree
Binary file not shown.
Binary file modified dev/.doctrees/release_5_1_0.doctree
Binary file not shown.
Binary file modified dev/.doctrees/release_5_2_0.doctree
Binary file not shown.
Binary file modified dev/.doctrees/release_5_2_1.doctree
Binary file not shown.
Binary file modified dev/.doctrees/release_5_2_2.doctree
Binary file not shown.
Binary file modified dev/.doctrees/release_5_3_0.doctree
Binary file not shown.
Binary file modified dev/.doctrees/release_5_3_1.doctree
Binary file not shown.
Binary file modified dev/.doctrees/release_5_4_0.doctree
Binary file not shown.
Binary file modified dev/.doctrees/release_5_4_1.doctree
Binary file not shown.
Binary file modified dev/.doctrees/release_5_5_0.doctree
Binary file not shown.
Binary file modified dev/.doctrees/release_5_6_0.doctree
Binary file not shown.
Binary file modified dev/.doctrees/release_5_6_1.doctree
Binary file not shown.
Binary file modified dev/.doctrees/release_5_7_0.doctree
Binary file not shown.
Binary file modified dev/.doctrees/release_5_7_1.doctree
Binary file not shown.
Binary file modified dev/.doctrees/release_5_8_0.doctree
Binary file not shown.
Binary file modified dev/.doctrees/release_5_8_1.doctree
Binary file not shown.
Binary file modified dev/.doctrees/release_5_8_2.doctree
Binary file not shown.
Binary file modified dev/.doctrees/release_5_9_0.doctree
Binary file not shown.
Binary file modified dev/.doctrees/release_5_9_1.doctree
Binary file not shown.
Binary file modified dev/.doctrees/release_5_9_2.doctree
Binary file not shown.
Binary file modified dev/.doctrees/releases.doctree
Binary file not shown.
Binary file modified dev/.doctrees/restart.doctree
Binary file not shown.
Binary file modified dev/.doctrees/riemann.doctree
Binary file not shown.
Binary file modified dev/.doctrees/riemann/Shallow_water_Riemann_solvers.doctree
Binary file not shown.
Binary file modified dev/.doctrees/ruled_rectangles.doctree
Binary file not shown.
Binary file modified dev/.doctrees/sealevel.doctree
Binary file not shown.
Binary file modified dev/.doctrees/set_eta_init.doctree
Binary file not shown.
Binary file modified dev/.doctrees/setaux_defaults.doctree
Binary file not shown.
Binary file modified dev/.doctrees/setenv.doctree
Binary file not shown.
Binary file modified dev/.doctrees/setplot.doctree
Binary file not shown.
Binary file modified dev/.doctrees/setrun.doctree
Binary file not shown.
Binary file modified dev/.doctrees/setrun_amrclaw.doctree
Binary file not shown.
Binary file modified dev/.doctrees/setrun_amrclaw_sample.doctree
Binary file not shown.
Binary file modified dev/.doctrees/setrun_geoclaw.doctree
Binary file not shown.
Binary file modified dev/.doctrees/setrun_sample.doctree
Binary file not shown.
Binary file modified dev/.doctrees/sharing.doctree
Binary file not shown.
Binary file modified dev/.doctrees/sphere_source.doctree
Binary file not shown.
Binary file modified dev/.doctrees/sphinxdoc.doctree
Binary file not shown.
Binary file modified dev/.doctrees/src1d_defaults.doctree
Binary file not shown.
Binary file modified dev/.doctrees/src_defaults.doctree
Binary file not shown.
Binary file modified dev/.doctrees/storm_module.doctree
Binary file not shown.
Binary file modified dev/.doctrees/surgedata.doctree
Binary file not shown.
Binary file modified dev/.doctrees/testing.doctree
Binary file not shown.
Binary file modified dev/.doctrees/timing.doctree
Binary file not shown.
Binary file modified dev/.doctrees/topo.doctree
Binary file not shown.
Binary file modified dev/.doctrees/topotools.doctree
Binary file not shown.
Binary file modified dev/.doctrees/topotools_module.doctree
Binary file not shown.
Binary file modified dev/.doctrees/trouble.doctree
Binary file not shown.
Binary file modified dev/.doctrees/tsunamidata.doctree
Binary file not shown.
Binary file modified dev/.doctrees/user_routines.doctree
Binary file not shown.
Binary file modified dev/.doctrees/visit_plotting.doctree
Binary file not shown.
Binary file modified dev/.doctrees/vm.doctree
Binary file not shown.
Binary file modified dev/.doctrees/wp_algorithms.doctree
Binary file not shown.
36 changes: 36 additions & 0 deletions dev/ClawPlotItem.html
Original file line number Diff line number Diff line change
Expand Up @@ -121,10 +121,12 @@ <h2>Attributes<a class="headerlink" href="#attributes" title="Permalink to this
symmetric,</p></li>
<li><p>‘1d_fill_between’ : 1d filled plot between two variable specified by
the attributes <em>plot_var</em> and <em>fill_var2</em>.</p></li>
<li><p>‘2d_imshow’ : two dimentional raster plot</p></li>
<li><p>‘2d_contour’ : two dimensional contour plot,</p></li>
<li><p>‘2d_pcolor’ : two dimensional pcolor plot,</p></li>
<li><p>‘2d_schlieren’ : two dimensional Schlieren plot,</p></li>
<li><p>‘2d_patch’ : two dimensional plot of only the cell and/or patch edges, no data</p></li>
<li><p>‘2d_hillshade’ : two dimensional hillshade plot.</p></li>
</ul>
</dd></dl>

Expand Down Expand Up @@ -442,6 +444,39 @@ <h3>Special attributes for plot_type = ‘2d_imshow’<a class="headerlink" href
<dd><p>If True, a colorbar is added to the plot.</p>
</dd></dl>

</section>
<section id="special-attributes-for-plot-type-2d-hillshade">
<h3>Special attributes for plot_type = ‘2d_hillshade’<a class="headerlink" href="#special-attributes-for-plot-type-2d-hillshade" title="Permalink to this heading"></a></h3>
<dl class="py attribute">
<dt class="sig sig-object py">
<span class="sig-name descname"><span class="pre">hillshade_vertical_exaggeration</span> <span class="pre">:</span> <span class="pre">float</span></span></dt>
<dd><p>Vertical exaggeration for hillshade calulation. Default of 1.</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py">
<span class="sig-name descname"><span class="pre">hillshade_azimuth_degree</span> <span class="pre">:</span> <span class="pre">float</span></span></dt>
<dd><p>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.</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py">
<span class="sig-name descname"><span class="pre">hillshade_altitude_degree</span> <span class="pre">:</span> <span class="pre">float</span></span></dt>
<dd><p>Light source altitude angle from the horizon for hillshade
calculation. Default is 45. Valid values are 0-90.</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py">
<span class="sig-name descname"><span class="pre">hillshade_latlon</span> <span class="pre">:</span> <span class="pre">bool</span></span></dt>
<dd><p>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.</p>
</dd></dl>

</section>
</section>
<section id="amr-attributes">
Expand Down Expand Up @@ -558,6 +593,7 @@ <h3><a href="contents.html">Table of Contents</a></h3>
<li><a class="reference internal" href="#special-attributes-for-plot-type-2d-contour">Special attributes for plot_type = ‘2d_contour’</a></li>
<li><a class="reference internal" href="#special-attributes-for-plot-type-2d-pcolor">Special attributes for plot_type = ‘2d_pcolor’</a></li>
<li><a class="reference internal" href="#special-attributes-for-plot-type-2d-imshow">Special attributes for plot_type = ‘2d_imshow’</a></li>
<li><a class="reference internal" href="#special-attributes-for-plot-type-2d-hillshade">Special attributes for plot_type = ‘2d_hillshade’</a></li>
</ul>
</li>
<li><a class="reference internal" href="#amr-attributes">AMR Attributes</a></li>
Expand Down
28 changes: 26 additions & 2 deletions dev/_sources/ClawPlotItem.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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:

Expand Down
70 changes: 32 additions & 38 deletions dev/_sources/bouss1d.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down Expand Up @@ -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.
Expand All @@ -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.
Loading

0 comments on commit 40963af

Please sign in to comment.