ScalarField
===========

.. currentmodule:: fridom.framework.scalar_field

.. autoclass:: ScalarField

   
   .. automethod:: __init__

   
   .. rubric:: Methods

   .. autosummary::
   
      ~ScalarField.__init__
      ~ScalarField.abs
      ~ScalarField.apply_water_mask
      ~ScalarField.conj
      ~ScalarField.cumulative_integral
      ~ScalarField.diff
      ~ScalarField.div
      ~ScalarField.dot
      ~ScalarField.extend
      ~ScalarField.fft
      ~ScalarField.from_netcdf
      ~ScalarField.from_xarray
      ~ScalarField.get_mesh
      ~ScalarField.grad
      ~ScalarField.has_nan
      ~ScalarField.ifft
      ~ScalarField.integrate
      ~ScalarField.interpolate
      ~ScalarField.laplacian
      ~ScalarField.max
      ~ScalarField.mean
      ~ScalarField.min
      ~ScalarField.norm_l2
      ~ScalarField.set_random
      ~ScalarField.sum
      ~ScalarField.sync
      ~ScalarField.to_netcdf
      ~ScalarField.unpad
   
   

   
   
   .. rubric:: Attributes

   .. autosummary::
   
      ~ScalarField.arr
      ~ScalarField.bc_types
      ~ScalarField.flags
      ~ScalarField.grid
      ~ScalarField.info
      ~ScalarField.is_constant
      ~ScalarField.is_spectral
      ~ScalarField.long_name
      ~ScalarField.mdata
      ~ScalarField.mset
      ~ScalarField.name
      ~ScalarField.nc_attrs
      ~ScalarField.position
      ~ScalarField.topo
      ~ScalarField.units
      ~ScalarField.value
      ~ScalarField.xr
      ~ScalarField.xrs
   
   

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