VectorField
===========

.. currentmodule:: fridom.framework.vector_field

.. autoclass:: VectorField

   
   .. automethod:: __init__

   
   .. rubric:: Methods

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

   
   
   .. rubric:: Attributes

   .. autosummary::
   
      ~VectorField.field_list
      ~VectorField.fields
      ~VectorField.grid
      ~VectorField.info
      ~VectorField.is_constant
      ~VectorField.is_spectral
      ~VectorField.mset
      ~VectorField.vector_dim
      ~VectorField.xr
      ~VectorField.xrs
   
   

   .. minigallery:: fridom.framework.VectorField
      :add-heading: