KelvinWave
==========

.. currentmodule:: fridom.nonhydro.initial_conditions.kelvin_wave

.. autoclass:: KelvinWave

   
   .. automethod:: __init__

   
   .. rubric:: Methods

   .. autosummary::
   
      ~KelvinWave.__init__
      ~KelvinWave.abs
      ~KelvinWave.apply_elementwise
      ~KelvinWave.apply_water_mask
      ~KelvinWave.conj
      ~KelvinWave.cumulative_integral
      ~KelvinWave.diff
      ~KelvinWave.div
      ~KelvinWave.dot
      ~KelvinWave.extend
      ~KelvinWave.fft
      ~KelvinWave.from_netcdf
      ~KelvinWave.from_xarray
      ~KelvinWave.grad
      ~KelvinWave.has_nan
      ~KelvinWave.ifft
      ~KelvinWave.integrate
      ~KelvinWave.laplacian
      ~KelvinWave.max
      ~KelvinWave.mean
      ~KelvinWave.min
      ~KelvinWave.norm_l2
      ~KelvinWave.norm_of_diff
      ~KelvinWave.project
      ~KelvinWave.set_random
      ~KelvinWave.sum
      ~KelvinWave.sync
      ~KelvinWave.to_netcdf
   
   

   
   
   .. rubric:: Attributes

   .. autosummary::
   
      ~KelvinWave.b
      ~KelvinWave.cfl
      ~KelvinWave.ekin
      ~KelvinWave.epot
      ~KelvinWave.etot
      ~KelvinWave.field_list
      ~KelvinWave.fields
      ~KelvinWave.grid
      ~KelvinWave.info
      ~KelvinWave.is_constant
      ~KelvinWave.is_spectral
      ~KelvinWave.linear_pot_vort
      ~KelvinWave.local_rossby_number
      ~KelvinWave.mset
      ~KelvinWave.pot_vort
      ~KelvinWave.rel_vort
      ~KelvinWave.rel_vort_x
      ~KelvinWave.rel_vort_y
      ~KelvinWave.rel_vort_z
      ~KelvinWave.tracers
      ~KelvinWave.u
      ~KelvinWave.v
      ~KelvinWave.vector_dim
      ~KelvinWave.velocity
      ~KelvinWave.w
      ~KelvinWave.xr
      ~KelvinWave.xrs
   
   

   .. minigallery:: fridom.nonhydro.initial_conditions.KelvinWave
      :add-heading: