KelvinWave
==========

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

.. autoclass:: KelvinWave

   
   .. automethod:: __init__

   
   .. rubric:: Methods

   .. autosummary::
   
      ~KelvinWave.__init__
      ~KelvinWave.dot
      ~KelvinWave.fft
      ~KelvinWave.from_netcdf
      ~KelvinWave.has_nan
      ~KelvinWave.ifft
      ~KelvinWave.norm_l2
      ~KelvinWave.norm_of_diff
      ~KelvinWave.project
      ~KelvinWave.sync
      ~KelvinWave.to_netcdf
   
   

   
   
   .. rubric:: Attributes

   .. autosummary::
   
      ~KelvinWave.arr_dict
      ~KelvinWave.b
      ~KelvinWave.cfl
      ~KelvinWave.ekin
      ~KelvinWave.epot
      ~KelvinWave.etot
      ~KelvinWave.field_list
      ~KelvinWave.grid
      ~KelvinWave.linear_pot_vort
      ~KelvinWave.local_Ro
      ~KelvinWave.pot_vort
      ~KelvinWave.rel_vort
      ~KelvinWave.rel_vort_x
      ~KelvinWave.rel_vort_y
      ~KelvinWave.rel_vort_z
      ~KelvinWave.u
      ~KelvinWave.v
      ~KelvinWave.w
      ~KelvinWave.xr
      ~KelvinWave.xrs
   
   

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