WaterWaves1D.jl documentation

Overview

WaterWaves1D.jl is a Julia package providing a framework to study and compare several models for the propagation of unidimensional surface gravity waves (a.k.a. "water waves").

Several models are already implemented, including (but not limited to) the so-called water waves system, its truncated spectral expansion, the Green-Naghdi system, the Matsuno system, and so on. You may easily add your favorite one to the gang: see the how-to guide.

Installation

Enter the Pkg REPL by pressing ] from the Julia REPL.

(v1.8) pkg> add WaterWaves1D

Once installed, load the package with

julia> using WaterWaves1D

Quick start

A simple example is documented here. More advanced examples can be found in the package's examples and notebooks folders.

Developers

WaterWaves1D.jl is being developed by Vincent Duchêne and Pierre Navaro.

Documentation contents

• WaterWaves1D.jl documentation
• • Overview
  • Installation
  • Quick start
  • Developers
  • Documentation contents
• Background
• • Water waves
  • Models
  • • Shallow water models
    • Small steepness models
  • Mass, momentum, energy
  • Pseudospectral methods
• Problems
• How to...
• • build your model
  • build your initial data
  • build your time solver
  • access to and manage your data
  • plot your data
  • save and load your data
• Example
• • Set up the initial-value problem
  • Solve the initial-value problem
  • Generate graphics
• Plot recipes
• • Surface deformation and velocity
  • Differences
  • Fourier coefficients
  • Subplots
  • Interpolation
  • Plots at different times
  • Create animation
• Library (index)
• • Initial data
  • Models
  • Solvers
  • Structures
  • Tools
  • Load and save