Skip to content

Commit 01b067a

Browse files
Merge pull request #256 from yonatanwesen/yd/finish-docs
Finished docs for PseudoTransient
2 parents 9f92ea6 + 3697847 commit 01b067a

File tree

1 file changed

+20
-2
lines changed

1 file changed

+20
-2
lines changed

src/pseudotransient.jl

Lines changed: 20 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,26 @@ please see the paper: [Coffey, Todd S. and Kelley, C. T. and Keyes, David E. (20
99
SIAM Journal on Scientific Computing,25, 553-569.](https://doi.org/10.1137/S106482750241044X)
1010
1111
### Keyword Arguments
12-
13-
- `alpha_initial` : the initial pseudo time step. it defaults to 1e-3. If it is small, you are going to need more iterations to converge.
12+
- `autodiff`: determines the backend used for the Jacobian. Note that this argument is
13+
ignored if an analytical Jacobian is passed, as that will be used instead. Defaults to
14+
`nothing` which means that a default is selected according to the problem specification!
15+
Valid choices are types from ADTypes.jl.
16+
- `concrete_jac`: whether to build a concrete Jacobian. If a Krylov-subspace method is used,
17+
then the Jacobian will not be constructed and instead direct Jacobian-vector products
18+
`J*v` are computed using forward-mode automatic differentiation or finite differencing
19+
tricks (without ever constructing the Jacobian). However, if the Jacobian is still needed,
20+
for example for a preconditioner, `concrete_jac = true` can be passed in order to force
21+
the construction of the Jacobian.
22+
- `linsolve`: the [LinearSolve.jl](https://github.com/SciML/LinearSolve.jl) used for the
23+
linear solves within the Newton method. Defaults to `nothing`, which means it uses the
24+
LinearSolve.jl default algorithm choice. For more information on available algorithm
25+
choices, see the [LinearSolve.jl documentation](https://docs.sciml.ai/LinearSolve/stable/).
26+
- `precs`: the choice of preconditioners for the linear solver. Defaults to using no
27+
preconditioners. For more information on specifying preconditioners for LinearSolve
28+
algorithms, consult the
29+
[LinearSolve.jl documentation](https://docs.sciml.ai/LinearSolve/stable/).
30+
- `alpha_initial` : the initial pseudo time step. it defaults to 1e-3. If it is small,
31+
you are going to need more iterations to converge but it can be more stable.
1432
1533
1634

0 commit comments

Comments
 (0)