Skip to content

Commit 6f22b0c

Browse files
committed
Corrected the documentation with respect to Esolved.
1 parent cf0dc26 commit 6f22b0c

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

src/symbolic/StateSelection.jl

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -467,7 +467,7 @@ Return the sorted equation graph with selection of states and dummy states.
467467
- `ider1n1 `: Index vector, such that _residue[1:length(ider0n2)] = _der_x[ider0n2] - _x[ider1n1].
468468
- `ESorted `: Sorted equations (equations must be generated in the order ESorted[1],[2],..).
469469
- `ESolved `: If ESolved[i] > 0 then equation ESorted[i] is explicitly solved for variable ESolved[i].
470-
If ESolved[i] == 0, ESorted[i] is a residue equation.
470+
If ESolved[i] < 0, abs(ESolved[i]) is the index of the residue, so _residue[ abs(ESolved[i]) ] = residue of equation i.
471471
- `nc `: Number of residue constraints, so part that depends on (x,t) but not on der(x); 0 <= nc <= nx
472472
- `nmue `: Number of mue variables
473473
"""
@@ -538,7 +538,7 @@ Output arguments in sortedEquationGraph:
538538
- `ider1n1 `: Index vector, such that _residue[1:length(ider0n2)] = _der_x[ider0n2] - _x[ider1n1].
539539
- `ESorted `: Sorted equations (equations must be generated in the order ESorted[1],[2],..).
540540
- `ESolved `: If ESolved[i] > 0 then equation ESorted[i] is explicitly solved for variable ESolved[i].
541-
If ESolved[i] == 0, ESorted[i] is a residue equation.
541+
If ESolved[i] < 0, abs(ESolved[i]) is the index of the residue, so _residue[ abs(ESolved[i]) ] = residue of equation i.
542542
- `nc `: Number of residue constraints, so part that depends on (x,t) but not on der(x); 0 <= nc <= nx
543543
- `nmue `: Number of mue variables
544544
"""

0 commit comments

Comments
 (0)