EquatorialWave
==============

.. currentmodule:: fridom.shallowwater.initial_conditions.equatorial_wave

.. autoclass:: EquatorialWave

   
   .. automethod:: __init__

   
   .. rubric:: Methods

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

   
   
   .. rubric:: Attributes

   .. autosummary::
   
      ~EquatorialWave.cfl
      ~EquatorialWave.ekin
      ~EquatorialWave.epot
      ~EquatorialWave.etot
      ~EquatorialWave.field_list
      ~EquatorialWave.fields
      ~EquatorialWave.grid
      ~EquatorialWave.info
      ~EquatorialWave.is_constant
      ~EquatorialWave.is_spectral
      ~EquatorialWave.local_rossby_number
      ~EquatorialWave.mset
      ~EquatorialWave.p
      ~EquatorialWave.pot_vort
      ~EquatorialWave.rel_vort
      ~EquatorialWave.spectral_ekin
      ~EquatorialWave.tracers
      ~EquatorialWave.u
      ~EquatorialWave.v
      ~EquatorialWave.vector_dim
      ~EquatorialWave.velocity
      ~EquatorialWave.xr
      ~EquatorialWave.xrs
   
   

   .. minigallery:: fridom.shallowwater.initial_conditions.EquatorialWave
      :add-heading: