Skip to main content
Ctrl+K
FRIDOM - Documentation - Home
  • Installation
  • Getting Started
  • Tutorials
    • Using FRIDOM Models
      • The Grid and the Model Settings
      • Scalar Fields and Plotting
      • The State Vector and Initial Conditions
      • Running the Model
      • Modules Part 1: Understanding Modules
      • Saving model output
      • Modules Part 2: Creating Custom Modules
      • Generating animations
      • Time-stepping schemes
      • Submitting Simulations to a Computing Cluster
      • Parallelizing simulations
    • Creating Models
    • More Tutorials
      • Selecting the backend
      • Floating point precision
      • Logging
      • Building the Documentation
  • Gallery
    • Non-hydrostatic model examples
      • Barotropic Jet
      • Reflecting Wave Package
      • Internal Gravity Wave Maker
      • Convection and Closures
      • Multiple Wave Makers
      • Rayleigh-Taylor Instability
      • Rayleigh-Bénard Convection
      • Dancing Eddies
      • Single Internal Wave
      • Symmetric Instability
      • Tracers and Eddies
    • Shallow-water model examples
      • Barotropic Instability.
      • Equatorial Waves.
  • Fridom API
    • framework
      • exceptions
      • grid
        • cartesian
        • spectral
        • GridBase
        • DiffModule
        • InterpolationModule
        • DummyInterpolation
        • AxisPosition
        • Position
        • WaterMask
        • BCType
        • FFTPadding
      • domain_decomposition
        • DomainDecomposition
        • fridom.framework.domain_decomposition.domain_decomposition.get_default_domain_decomposition
        • SingleDecomposition
        • JaxDecomposition
      • utils
        • fridom.framework.utils.mpi.I_AM_MAIN_RANK
        • fridom.framework.utils.mpi.MPI_AVAILABLE
        • fridom.framework.utils.mpi.mpi_barrier
        • fridom.framework.utils.mpi.get_mpi_size
        • fridom.framework.utils.mpi.get_my_rank
        • fridom.framework.utils.printing.print_bar
        • fridom.framework.utils.printing.print_job_init_info
        • fridom.framework.utils.formatting.humanize_length
        • fridom.framework.utils.formatting.humanize_time
        • fridom.framework.utils.formatting.humanize_number
        • fridom.framework.utils.filesystem.chdir_to_submit_dir
        • fridom.framework.utils.filesystem.stdout_is_file
        • SliceableAttribute
        • fridom.framework.utils.array_ops.modify_array
        • fridom.framework.utils.array_ops.random_array
        • fridom.framework.utils.array_ops.array_is_constant
        • fridom.framework.utils.numpy_utils.to_numpy
        • fridom.framework.utils.numpy_utils.to_seconds
        • fridom.framework.utils.jax_utils.jaxjit
        • fridom.framework.utils.jax_utils.jaxify
        • fridom.framework.utils.jax_utils.inspect_jitted_function
        • fridom.framework.utils.jax_utils.free_memory
        • fridom.framework.utils.decorators.skip_on_doc_build
        • fridom.framework.utils.decorators.cache_figure
      • time_steppers
        • TimeStepper
        • AdamBashforth
        • RungeKutta
        • RKMethods
        • ButcherTableau
      • modules
        • animation
        • advection
        • closures
        • flux_functions
        • forcings
        • Counter
        • Module
        • fridom.framework.modules.module.module_method
        • ModuleContainer
        • ProgressBar
        • Ramper
        • RestartModule
        • NaNChecker
        • NetCDFWriter
        • ResetTendency
        • FigureSaver
      • projection
        • Projection
        • GeostrophicSpectral
        • WaveSpectral
        • DivergenceSpectral
        • GeostrophicTimeAverage
        • OptimalBalance
        • NNMD
      • timing_module
      • fridom.framework.configuration.config
      • fridom.framework.logger.log
      • ModelSettingsBase
      • FieldBase
      • FieldMetadata
      • ScalarField
      • VectorField
      • TensorField
      • ModelState
      • Model
      • Clock
      • TimingFormat
      • ClockTrigger
    • nonhydro
      • grid
        • cartesian
        • spectral
        • AxisPosition
        • Position
        • BCType
      • modules
        • advection
        • closures
        • pressure_solvers
        • advection
        • forcings
        • animation
        • LinearTendency
        • TendencyDivergence
        • PressureGradientTendency
        • MainTendency
        • Diagnostics
        • NaNChecker
        • NetCDFWriter
        • Ramper
        • RestartModule
        • ResetTendency
        • Module
        • fridom.framework.modules.module.module_method
        • FigureSaver
      • initial_conditions
        • SingleWave
        • KelvinWave
        • WavePackage
        • BarotropicJet
        • Jet
        • CoherentEddy
        • fridom.nonhydro.initial_conditions.geostrophic_spectra.geostrophic_energy_spectrum
        • RandomGeostrophicSpectra
      • time_steppers
        • TimeStepper
        • AdamBashforth
        • RungeKutta
        • RKMethods
        • ButcherTableau
      • utils
        • fridom.framework.utils.mpi.I_AM_MAIN_RANK
        • fridom.framework.utils.mpi.MPI_AVAILABLE
        • fridom.framework.utils.mpi.mpi_barrier
        • fridom.framework.utils.mpi.get_mpi_size
        • fridom.framework.utils.mpi.get_my_rank
        • fridom.framework.utils.printing.print_bar
        • fridom.framework.utils.printing.print_job_init_info
        • fridom.framework.utils.formatting.humanize_length
        • fridom.framework.utils.formatting.humanize_time
        • fridom.framework.utils.formatting.humanize_number
        • fridom.framework.utils.filesystem.chdir_to_submit_dir
        • fridom.framework.utils.filesystem.stdout_is_file
        • SliceableAttribute
        • fridom.framework.utils.array_ops.modify_array
        • fridom.framework.utils.array_ops.random_array
        • fridom.framework.utils.array_ops.array_is_constant
        • fridom.framework.utils.numpy_utils.to_numpy
        • fridom.framework.utils.numpy_utils.to_seconds
        • fridom.framework.utils.jax_utils.jaxjit
        • fridom.framework.utils.jax_utils.jaxify
        • fridom.framework.utils.jax_utils.inspect_jitted_function
        • fridom.framework.utils.jax_utils.free_memory
        • fridom.framework.utils.decorators.skip_on_doc_build
        • fridom.framework.utils.decorators.cache_figure
      • projection
        • Projection
        • GeostrophicSpectral
        • WaveSpectral
        • DivergenceSpectral
        • GeostrophicTimeAverage
        • OptimalBalance
        • NNMD
      • fridom.framework.configuration.config
      • fridom.framework.logger.log
      • ModelSettings
      • State
      • DiagnosticState
      • FieldMetadata
      • ScalarField
      • VectorField
      • TensorField
      • ModelState
      • Model
      • Clock
      • TimingFormat
      • ClockTrigger
    • shallowwater
      • exceptions
      • projection
        • Projection
        • GeostrophicSpectral
        • WaveSpectral
        • DivergenceSpectral
        • GeostrophicTimeAverage
        • OptimalBalance
        • NNMD
      • time_steppers
        • TimeStepper
        • AdamBashforth
        • RungeKutta
        • RKMethods
        • ButcherTableau
      • utils
        • fridom.framework.utils.mpi.I_AM_MAIN_RANK
        • fridom.framework.utils.mpi.MPI_AVAILABLE
        • fridom.framework.utils.mpi.mpi_barrier
        • fridom.framework.utils.mpi.get_mpi_size
        • fridom.framework.utils.mpi.get_my_rank
        • fridom.framework.utils.printing.print_bar
        • fridom.framework.utils.printing.print_job_init_info
        • fridom.framework.utils.formatting.humanize_length
        • fridom.framework.utils.formatting.humanize_time
        • fridom.framework.utils.formatting.humanize_number
        • fridom.framework.utils.filesystem.chdir_to_submit_dir
        • fridom.framework.utils.filesystem.stdout_is_file
        • SliceableAttribute
        • fridom.framework.utils.array_ops.modify_array
        • fridom.framework.utils.array_ops.random_array
        • fridom.framework.utils.array_ops.array_is_constant
        • fridom.framework.utils.numpy_utils.to_numpy
        • fridom.framework.utils.numpy_utils.to_seconds
        • fridom.framework.utils.jax_utils.jaxjit
        • fridom.framework.utils.jax_utils.jaxify
        • fridom.framework.utils.jax_utils.inspect_jitted_function
        • fridom.framework.utils.jax_utils.free_memory
        • fridom.framework.utils.decorators.skip_on_doc_build
        • fridom.framework.utils.decorators.cache_figure
      • grid
        • cartesian
        • spectral
        • AxisPosition
        • Position
        • BCType
      • modules
        • advection
        • closures
        • animation
        • MainTendency
        • LinearTendency
        • NaNChecker
        • NetCDFWriter
        • Ramper
        • RestartModule
        • ResetTendency
        • FigureSaver
      • initial_conditions
        • CoherentEddy
        • EquatorialWave
        • Jet
        • SingleWave
      • fridom.framework.configuration.config
      • fridom.framework.logger.log
      • ModelSettings
      • State
      • FieldMetadata
      • ScalarField
      • VectorField
      • TensorField
      • ModelState
      • Model
      • Clock
      • TimingFormat
      • ClockTrigger
  • .rst

Gallery

Contents

  • Non-hydrostatic model examples
  • Shallow-water model examples

Gallery#

Non-hydrostatic model examples#

Barotropic Jet

Barotropic Jet

Reflecting Wave Package

Reflecting Wave Package

Internal Gravity Wave Maker

Internal Gravity Wave Maker

Convection and Closures

Convection and Closures

Multiple Wave Makers

Multiple Wave Makers

Rayleigh-Taylor Instability

Rayleigh-Taylor Instability

Rayleigh-Bénard Convection

Rayleigh-Bénard Convection

Dancing Eddies

Dancing Eddies

Single Internal Wave

Single Internal Wave

Symmetric Instability

Symmetric Instability

Tracers and Eddies

Tracers and Eddies

Shallow-water model examples#

Barotropic Instability.

Barotropic Instability.

Equatorial Waves.

Equatorial Waves.

previous

Building the Documentation

next

Non-hydrostatic model examples

Contents
  • Non-hydrostatic model examples
  • Shallow-water model examples

By Silvano Rosenau

© Copyright 2023, Silvano Rosenau.