SingleWave
==========

.. currentmodule:: fridom.nonhydro.initial_conditions.single_wave

.. autoclass:: SingleWave

   
   .. automethod:: __init__

   
   .. rubric:: Methods

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

   
   
   .. rubric:: Attributes

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

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