WavePackage
===========

.. currentmodule:: fridom.nonhydro.initial_conditions.wave_package

.. autoclass:: WavePackage

   
   .. automethod:: __init__

   
   .. rubric:: Methods

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

   
   
   .. rubric:: Attributes

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

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