Skip to content

Commit

Permalink
Improved docstring for gradient_squared method
Browse files Browse the repository at this point in the history
  • Loading branch information
david-zwicker committed May 23, 2024
1 parent 612c976 commit c2c3abc
Showing 1 changed file with 2 additions and 6 deletions.
8 changes: 2 additions & 6 deletions pde/fields/scalar.py
Original file line number Diff line number Diff line change
Expand Up @@ -227,12 +227,8 @@ def gradient_squared(
Optional vector field to which the result is written.
label (str, optional):
Name of the returned field
central (bool):
Determines whether a central difference approximation is used for the
gradient operator or not. If not, the squared gradient is calculated as
the mean of the squared values of the forward and backward derivatives,
which thus includes the value at a support point in the result at the
same point.
\**kwargs:
Forward to :meth:`~pde.fields.datafield_base.DataFieldBase.apply_operator`
Returns:
:class:`~pde.fields.scalar.ScalarField`: the squared gradient of the field
Expand Down

0 comments on commit c2c3abc

Please sign in to comment.