fgmax_tools module for fixed grid output

This describes new tools added in Clawpack 5.2.1.

These tools are useful for working with fixed grid monitoring routines described in Fixed grid monitoring.

Documentation auto-generated from the module docstrings

fgmax_tools module: $CLAW/geoclaw/src/python/geoclaw/fgmax_tools.py

Tools to specify an fgmax grid for keeping track of maximum flow depth, etc. and to read in the fgmax output after doing a GeoClaw run.

class clawpack.geoclaw.fgmax_tools.FGmaxGrid

New class introduced in 5.2.1 to keep store information both about the fgmax input data and the output generated by a GeoClaw run.

read_input_data(input_file_name=None)

Read input data from a file like fgmax.txt that might have been created by write_input_data.

read_output(fgno=None, outdir=None)

Read the GeoClaw results on the fgmax grid numbered fgno.

write_input_data(input_file_name=None)

Write input data from a file like fgmax.txt that will be read in by GeoClaw as input data.

clawpack.geoclaw.fgmax_tools.adjust_fgmax_1d(x1_desired, x2_desired, x1_domain, dx)

Input:

• x1_desired, x2_desired: approximate desired limits of fgmax grid
• x1_domain: lower edge of computational domain
• dx: Mesh spacing on fine grid that fgmax grid should conform to

Output:

• x1_new, x2_new: limits to set so (x2-x1) is integer multiple of dx and points are at cell centers of computational grid
• npoints: number of points

class clawpack.geoclaw.fgmax_tools.fgmax_grid_parameters

Deprecated – use class FGmaxGrid

clawpack.geoclaw.fgmax_tools.make_fgmax(FG)

Deprecated – use FGmaxGrid.write_input_data