Skip to content

Commit 019e5e0

Browse files
committed
Additional explanation of small_constant in docstring
1 parent 10352b4 commit 019e5e0

2 files changed

Lines changed: 12 additions & 6 deletions

File tree

src/mprk.jl

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -134,7 +134,8 @@ You can optionally choose the linear solver to be used by passing an
134134
algorithm from [LinearSolve.jl](https://github.com/SciML/LinearSolve.jl)
135135
as keyword argument `linsolve`.
136136
You can also choose the parameter `small_constant` which is added to all Patankar-weight denominators
137-
to avoid divisions by zero.
137+
to avoid divisions by zero. You can pass a value explicitly, otherwise `small_constant` is set to
138+
`floatmin` of the floating point type used.
138139
139140
## References
140141
@@ -345,7 +346,8 @@ You can optionally choose the linear solver to be used by passing an
345346
algorithm from [LinearSolve.jl](https://github.com/SciML/LinearSolve.jl)
346347
as keyword argument `linsolve`.
347348
You can also choose the parameter `small_constant` which is added to all Patankar-weight denominators
348-
to avoid divisions by zero.
349+
to avoid divisions by zero. You can pass a value explicitly, otherwise `small_constant` is set to
350+
`floatmin` of the floating point type used.
349351
350352
## References
351353
@@ -726,7 +728,8 @@ You can optionally choose the linear solver to be used by passing an
726728
algorithm from [LinearSolve.jl](https://github.com/SciML/LinearSolve.jl)
727729
as keyword argument `linsolve`.
728730
You can also choose the parameter `small_constant` which is added to all Patankar-weight denominators
729-
to avoid divisions by zero.
731+
to avoid divisions by zero. You can pass a value explicitly, otherwise `small_constant` is set to
732+
`floatmin` of the floating point type used.
730733
731734
## References
732735
@@ -825,7 +828,8 @@ You can optionally choose the linear solver to be used by passing an
825828
algorithm from [LinearSolve.jl](https://github.com/SciML/LinearSolve.jl)
826829
as keyword argument `linsolve`.
827830
You can also choose the parameter `small_constant` which is added to all Patankar-weight denominators
828-
to avoid divisions by zero.
831+
to avoid divisions by zero. You can pass a value explicitly, otherwise `small_constant` is set to
832+
`floatmin` of the floating point type used.
829833
830834
## References
831835

src/sspmprk.jl

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,8 @@ You can optionally choose the linear solver to be used by passing an
2222
algorithm from [LinearSolve.jl](https://github.com/SciML/LinearSolve.jl)
2323
as keyword argument `linsolve`.
2424
You can also choose the parameter `small_constant` which is added to all Patankar-weight denominators
25-
to avoid divisions by zero.
25+
to avoid divisions by zero. You can pass a value explicitly, otherwise `small_constant` is set to
26+
`floatmin` of the floating point type used.
2627
2728
## References
2829
@@ -408,7 +409,8 @@ You can optionally choose the linear solver to be used by passing an
408409
algorithm from [LinearSolve.jl](https://github.com/SciML/LinearSolve.jl)
409410
as keyword argument `linsolve`.
410411
You can also choose the parameter `small_constant` which is added to all Patankar-weight denominators
411-
to avoid divisions by zero.
412+
to avoid divisions by zero. You can pass a value explicitly, otherwise `small_constant` is set to
413+
`floatmin` of the floating point type used.
412414
413415
## References
414416

0 commit comments

Comments
 (0)