Filtering inertia-gravity

From GHER

Revision as of 15:32, 25 May 2009 by Alex (Talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

A filter is developed that removes inertia-gravity waves from the initial conditions of the linear shallow-water equations.

These scripts implement the filtering procedure described in: "Filtering inertia-gravity waves from the initial conditions of the linear shallow-water equations" from Alexander Barth, Jean-Marie Beckers, Aida Alvera-Azcárate, Robert H. Weisberg, Ocean Modelling, 19: 204-218, 2007.

Contents

Download

The latest version of this program can be obtained at http://ocgmod1.marine.usf.edu/WF/WaveFilter-1.1.tar.gz This program is released under the terms of the GNU General Public License version 2 or later.

Requirements

The code is written for GNU Octave and for Matlab. If you don't have Matlab installed, I recommend you to use GNU Octave.

The code has been tested with Octave 2.9.12 and Matlab 2006a on Linux.

Octave users: make sure that Octave is compiled with sparse matrix support. The scripts won't probably work with Octave 2.1.x and older. Please use a more recent version of Octave.

Installation

Extract the archive and add the script directory to your path by:

addpath('/absolute/path/to/WaveFilter-1.1');

with obvious substitution. :-)

Testing

Run filter_test. You should see:

octave:1> filter_test
Testing filter_vort: OK
Testing filter_var:  OK

Documentation

See the paper: "Filtering inertia-gravity waves from the initial conditions of the linear shallow-water equations" from Alexander Barth, Jean-Marie Beckers, Aida Alvera-Azcárate, Robert H. Weisberg, Ocean Modelling, 19: 204-218, 2007. Specific documentation about the code can be found by typing "help filter_vort" and "help filter_var" in Octave or Matlab.

Changes log

version 1.0
Initial release. Support for curvilinear grids.
version 1.1
Several performance optimizations.

Troubleshooting

If you experience a problem with this code, you can contact me at abarth at marine dot usf dot edu or barth dot alexander at gmail dot com. Please provide me the following information:

  • the error message that you are seeing.
  • version of Octave or Matlab. If you use Octave, send me the output of "octave_config_info".
  • version of the WaveFilter package and if you got it from this web page.
  • operating system. If you use Linux, please specify your distribution.
  • if possible, a minimal list of steps that allows me to reproduce the error.
Personal tools