The Clawpack Homepage contains a general introduction to the Clawpack open source software project.
Full Table of Contents¶
This is the documentation for the latest version of Clawpack. For documentation corresponding to older versions see the list of past releases in the menu to the left. The future version refers to new documentation for features that have been merged into the master branch of a Clawpack repository, but have not yet been released. To use one of these features, see Installation instructions for developers.
What’s New?? For release notes, summaries of changes between releases, and links to all the Github commit logs, see Releases of Clawpack and release notes.
Overview and Getting Started¶
Examples and Applications¶
Classic, AMRClaw, and GeoClaw¶
Using the Fortran codes¶
General information that applies to Classic, AMRClaw, and GeoClaw.
- Testing your Fortran installation and running an example
- Fortran version
- Fortran Compilers
- Fortran 77 vs. Fortran 90 files
- User files required for the Fortran code
- Using OpenMP
- Timing Statistics
- Python Hints
- Clawpack Makefiles
- Library routines in Makefiles
- b4run function
- Application documentation
- Specifying classic run-time parameters in setrun.py
- Sample setrun.py module for classic Clawpack
- Boundary conditions
- Output data sytles and formats
- The mapc2p function
- Checkpointing and restarting
- Creating a new application directory
- Saving and sharing results
- Using the GPU version of Clawpack
AMRClaw: adaptive mesh refinement¶
- AMRClaw Description and Detailed Contents
- AMRClaw for 1d problems
- Specifying AMRClaw run-time parameters in setrun.py
- Sample setrun.py module for AMRClaw
- Adaptive mesh refinement (AMR) algorithms
- AMR refinement criteria
- Specifying flagregions for adaptive refinement
- Ruled Rectangles
- Guiding AMR with adjoint flagging
- Gauges
- Doxygen documentation of AMRClaw
- AMRClaw Flowcharts
GeoClaw: geophysical flows¶
- GeoClaw Description and Detailed Contents
- Getting started with GeoClaw
- Cautionary Hints on using GeoClaw
- Topography data
- Grid registration
- Python tools for working with topo and dtopo
- Specifying GeoClaw parameters in setrun.py
- Plotting routines for GeoClaw
- Visualizing GeoClaw results in Google Earth
- Quick start guide for tsunami modeling
- Quick start guide for storm surge modeling
- Earthquake sources: Fault slip and the Okada model
- Setting sea_level
- Set Eta Init – spatially varying initial surface elevation
- Lagrangian gauges for particle tracking
- Manning friction term
- Fixed grid output (fgout)
- Fixed grid monitoring (fgmax)
- Nearshore interpolation
- Some sources of tsunami data
- Sources for Storm Surge Data
- Marching Front algorithm
- Force Cells to be Dry Initially
- Source terms for shallow water on the sphere
- GeoClaw in One Space Dimension
- Boussinesq solvers in One Space Dimension
- Boussinesq solvers in Two Space Dimensions
PyClaw¶
Riemann¶
All Clawpack packages make use of the same collection of Riemann solvers.
See also the new book Riemann Problems and Jupyter Solutions (SIAM, 2020), which consists of a set of Jupyter notebooks illustrating the basic concepts of Riemann problems and approximate solvers.
VisClaw: Plotting and Visualization Tools¶
Migrating applications from older versions of Clawpack¶
If you are looking to run an application that was written for Clawpack 4.x, this may be helpful.
Developers’ resources¶
References¶
