Mercurial > octave
diff libinterp/corefcn/stream-euler.cc @ 31594:a3d8915b9f87 stable
doc: more DOCSTRING changes ahead of 8.1 release.
* ordschur.cc, stream-euler.cc, ov-class.cc, ov-classdef.cc, uigetfile.m,
uiputfile.m, memory.m, compare_plot_demos.m, html_compare_plot_demos.m:
More DOCSTRING changes ahead of 8.1 release.
author | Rik <rik@octave.org> |
---|---|
date | Tue, 29 Nov 2022 18:40:56 -0800 |
parents | 32d2b6604a9f |
children | e88a07dec498 |
line wrap: on
line diff
--- a/libinterp/corefcn/stream-euler.cc Tue Nov 29 15:58:49 2022 -0800 +++ b/libinterp/corefcn/stream-euler.cc Tue Nov 29 18:40:56 2022 -0800 @@ -507,7 +507,7 @@ DEFUN (__streameuler2d__, args, , doc: /* -*- texinfo -*- @deftypefn {} {@var{output} =} __streameuler2d__ (@var{U}, @var{V}, @var{TX}, @var{TY}, @var{ZETA}, @var{XI}, @var{H}, @var{MAXNVERTS}) -Calculates the streamline in a vector field @code{[@var{U}, @var{V}]} starting +Calculate the streamline in a vector field @code{[@var{U}, @var{V}]} starting from a seed point at position @code{[@var{ZETA}, @var{XI}]}. The integrator used is Heun's Scheme. The step size can be controlled by @var{H}. The Jacobian matrix can be defined for each grid cell by @@ -522,7 +522,7 @@ DEFUN (__streameuler3d__, args, , doc: /* -*- texinfo -*- @deftypefn {} {@var{output} =} __streameuler3d__ (@var{U}, @var{V}, @var{W}, @var{TX}, @var{TY}, @var{TZ}, @var{ZETA}, @var{XI}, @var{RHO}, @var{H}, @var{MAXNVERTS}) -Calculates the streamline in a vector field @code{[@var{U}, @var{V}, @var{W}]} +Calculate the streamline in a vector field @code{[@var{U}, @var{V}, @var{W}]} starting from a seed point at position @code{[@var{ZETA}, @var{XI}, @var{RHO}]}. The integrator used is Heun's Scheme. The step size can be controlled by @var{H}. The Jacobian matrix can