CoherentEddy
============

.. currentmodule:: fridom.nonhydro.initial_conditions.coherent_eddy

.. autoclass:: CoherentEddy

   
   .. automethod:: __init__

   
   .. rubric:: Methods

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

   
   
   .. rubric:: Attributes

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

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