State
=====

.. currentmodule:: fridom.shallowwater

.. autoclass:: State

   
   .. automethod:: __init__

   
   .. rubric:: Methods

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

   
   
   .. rubric:: Attributes

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

   .. minigallery:: fridom.shallowwater.State
      :add-heading: