Skip to content

Commit beec86c

Browse files
Steven-RobertsSteven-Roberts
committed
Fix broken links
1 parent 16ff93c commit beec86c

File tree

11 files changed

+24
-21
lines changed

11 files changed

+24
-21
lines changed

‎toolbox/+otp/+ascherlineardae/AscherLinearDAEProblem.m

+1-1
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@
5555
% The start and final time.
5656
% y0 : numeric(2, 1)
5757
% The initial condition.
58-
% parameters : AscherLinearDAEParameters
58+
% parameters : otp.ascherlineardae.AscherLinearDAEParameters
5959
% The parameters.
6060
obj@otp.Problem('Ascher Linear DAE', 2, timeSpan, y0, parameters);
6161
end

‎toolbox/+otp/+brusselator/BrusselatorProblem.m

+1-1
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@
5050
% The start and final time.
5151
% y0 : numeric(2, 1)
5252
% The initial conditions.
53-
% parameters : BrusselatorParameters
53+
% parameters : otp.brusselator.BrusselatorParameters
5454
% The parameters.
5555

5656
obj@otp.Problem('Brusselator', 2, timeSpan, y0, parameters);

‎toolbox/+otp/+cusp/CUSPProblem.m

+1-1
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@
8686
% The start and final time.
8787
% y0 : numeric(:, 1)
8888
% The initial conditions.
89-
% parameters : CUSPParameters
89+
% parameters : otp.cusp.CUSPParameters
9090
% The parameters.
9191

9292
obj@otp.Problem('CUSP', [], timeSpan, y0, parameters);

‎toolbox/+otp/+linear/LinearProblem.m

+1-1
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@
4848
% The start and final time.
4949
% y0 : numeric(:, 1)
5050
% The initial conditions.
51-
% parameters : LinearParameters
51+
% parameters : otp.linear.LinearParameters
5252
% The parameters.
5353

5454
obj@otp.Problem('Linear', [], timeSpan, y0, parameters);

‎toolbox/+otp/+lorenz63/Lorenz63Problem.m

+1-1
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@
4343
% The start and final time.
4444
% y0 : numeric(3, 1)
4545
% The initial conditions.
46-
% parameters : Lorenz63Parameters
46+
% parameters : otp.lorenz63.Lorenz63Parameters
4747
% The parameters.
4848

4949
obj@otp.Problem('Lorenz Equations', 3, timeSpan, y0, parameters);

‎toolbox/+otp/+lorenz96/Lorenz96Problem.m

+1-1
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@
4444
% The start and final time.
4545
% y0 : numeric(:, 1)
4646
% The initial conditions.
47-
% parameters : Lorenz96Parameters
47+
% parameters : otp.lorenz96.Lorenz96Parameters
4848
% The parameters.
4949

5050
obj@otp.Problem('Lorenz 96', [], timeSpan, y0, parameters);

‎toolbox/+otp/+oregonator/OregonatorProblem.m

+1-1
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@
5353
% The start and final time.
5454
% y0 : numeric(3, 1)
5555
% The initial conditions.
56-
% parameters : OregonatorParameters
56+
% parameters : otp.oregonator.OregonatorParameters
5757
% The parameters.
5858

5959
obj@otp.Problem('Oregonator', 3, timeSpan, y0, parameters);

‎toolbox/+otp/+protherorobinson/ProtheroRobinsonProblem.m

+1-1
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@
3535
% The start and final time.
3636
% y0 : numeric(:, 2)
3737
% The initial conditions.
38-
% parameters : ProtheroRobinsonParameters
38+
% parameters : otp.protherorobinson.ProtheroRobinsonParameters
3939
% The parameters.
4040

4141
obj@otp.Problem('Prothero–Robinson', [], timeSpan, y0, parameters);

‎toolbox/+otp/+robertson/+presets/ROBER.m

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
classdef ROBER < otp.robertson.RobertsonProblem
2-
% The Robertson configuration from :cite:p:`HW96` (p. 144). This differs from :class:`Canonical` only in the time
3-
% span which is extended to $[0, 10^{11}]$. This presents a challenge for numerical integrators to preserve solution
4-
% positivity.
2+
% The Robertson configuration from :cite:p:`HW96` (p. 144). This differs from
3+
% :class:`otp.robertson.presets.Canonical` only in the time span which is extended to $[0, 10^{11}]$. This presents
4+
% a challenge for numerical integrators to preserve solution positivity.
55

66
methods
77
function obj = ROBER

‎toolbox/+otp/+robertson/RobertsonProblem.m

+1-1
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@
5656
% The start and final time.
5757
% y0 : numeric(3, 1)
5858
% The initial conditions.
59-
% parameters : RobertsonParameters
59+
% parameters : otp.robertson.RobertsonParameters
6060
% The parameters.
6161

6262
obj@otp.Problem('Robertson', 3, timeSpan, y0, parameters);

‎toolbox/+otp/RHS.m

+12-9
Original file line numberDiff line numberDiff line change
@@ -48,8 +48,8 @@
4848
% t : numeric
4949
% The time at which $f$ is evaluated.
5050
% y : numeric(:, 1) or numeric(:, :)
51-
% The state at which $f$ is evaluated. If :attr:`Vectorized` is ``'on'``, it can be a matrix where each
52-
% column is a state.
51+
% The state at which $f$ is evaluated. If :attr:`otp.RHS.Vectorized` is ``'on'``, it can be a matrix where
52+
% each column is a state.
5353
%
5454
% Returns
5555
% -------
@@ -255,7 +255,8 @@
255255
% $\sum_{j,k} \frac{\partial^2 f_i(t, y; p)}{\partial y_j \partial y_k} u_j v_k$.
256256
HessianVectorProduct
257257

258-
% The action of a vector on the partial derivative of :attr:`JacobianAdjointVectorProduct` with respect to $y$.
258+
% The action of a vector on the partial derivative of :attr:`otp.RHS.JacobianAdjointVectorProduct` with respect
259+
% to $y$.
259260
%
260261
% If set, it is a function handle with the following signature:
261262
%
@@ -277,16 +278,18 @@
277278
end
278279

279280
properties (Dependent)
280-
% A dependent property which returns :attr:`Jacobian` if it is a matrix and ``[]`` if it is a function handle.
281+
% A dependent property which returns :attr:`otp.RHS.Jacobian` if it is a matrix and ``[]`` if it is a function
282+
% handle.
281283
JacobianMatrix
282284

283-
% A dependent property which wraps :attr:`Jacobian` in a function handle if necessary.
285+
% A dependent property which wraps :attr:`otp.RHS.Jacobian` in a function handle if necessary.
284286
JacobianFunction
285287

286-
% A dependent property which returns :attr:`Mass` if it is a matrix and ``[]`` if it is a function handle.
288+
% A dependent property which returns :attr:`otp.RHS.Mass` if it is a matrix and ``[]`` if it is a function
289+
% handle.
287290
MassMatrix
288291

289-
% A dependent property which wraps :attr:`Mass` in a function handle if necessary.
292+
% A dependent property which wraps :attr:`otp.RHS.Mass` in a function handle if necessary.
290293
MassFunction
291294
end
292295

@@ -304,8 +307,8 @@
304307
%
305308
% Warning
306309
% -------
307-
% In Octave, the value for :attr:`Vectorized` is ignored because it is not used by built in solvers and
308-
% causes an error for ``ode15s``.
310+
% In Octave, the value for :attr:`otp.RHS.Vectorized` is ignored because it is not used by built in solvers
311+
% and causes an error for ``ode15s``.
309312

310313
obj.F = F;
311314
if mod(nargin, 2) == 0

0 commit comments

Comments
 (0)