From 250f68aef209dac651351edbd1ef7ea55fbc838b Mon Sep 17 00:00:00 2001 From: yonatanwesen Date: Fri, 20 Oct 2023 12:50:00 -0400 Subject: [PATCH 1/3] added missing docs for pt --- src/pseudotransient.jl | 23 +++++++++++++++++++++-- 1 file changed, 21 insertions(+), 2 deletions(-) diff --git a/src/pseudotransient.jl b/src/pseudotransient.jl index debd4b3b9..8019030db 100644 --- a/src/pseudotransient.jl +++ b/src/pseudotransient.jl @@ -9,8 +9,27 @@ please see the paper: [Coffey, Todd S. and Kelley, C. T. and Keyes, David E. (20 SIAM Journal on Scientific Computing,25, 553-569.](https://doi.org/10.1137/S106482750241044X) ### Keyword Arguments - -- `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. + - `autodiff`: determines the backend used for the Jacobian. Note that this argument is + ignored if an analytical Jacobian is passed, as that will be used instead. Defaults to + `nothing` which means that a default is selected according to the problem specification! + Valid choices are types from ADTypes.jl. + - `concrete_jac`: whether to build a concrete Jacobian. If a Krylov-subspace method is used, + then the Jacobian will not be constructed and instead direct Jacobian-vector products + `J*v` are computed using forward-mode automatic differentiation or finite differencing + tricks (without ever constructing the Jacobian). However, if the Jacobian is still needed, + for example for a preconditioner, `concrete_jac = true` can be passed in order to force + the construction of the Jacobian. + - `linsolve`: the [LinearSolve.jl](https://github.com/SciML/LinearSolve.jl) used for the + linear solves within the Newton method. Defaults to `nothing`, which means it uses the + LinearSolve.jl default algorithm choice. For more information on available algorithm + choices, see the [LinearSolve.jl documentation](https://docs.sciml.ai/LinearSolve/stable/). + - `precs`: the choice of preconditioners for the linear solver. Defaults to using no + preconditioners. For more information on specifying preconditioners for LinearSolve + algorithms, consult the + [LinearSolve.jl documentation](https://docs.sciml.ai/LinearSolve/stable/). + + - `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. From b14a5cf8e28ca0a312ddca81fefb14c4648e6dcf Mon Sep 17 00:00:00 2001 From: yonatanwesen Date: Fri, 20 Oct 2023 12:52:06 -0400 Subject: [PATCH 2/3] remove empty line --- src/pseudotransient.jl | 1 - 1 file changed, 1 deletion(-) diff --git a/src/pseudotransient.jl b/src/pseudotransient.jl index 8019030db..b193a1f97 100644 --- a/src/pseudotransient.jl +++ b/src/pseudotransient.jl @@ -27,7 +27,6 @@ SIAM Journal on Scientific Computing,25, 553-569.](https://doi.org/10.1137/S1064 preconditioners. For more information on specifying preconditioners for LinearSolve algorithms, consult the [LinearSolve.jl documentation](https://docs.sciml.ai/LinearSolve/stable/). - - `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. From 36978477bab0d680832ced67a1daf207d88d769f Mon Sep 17 00:00:00 2001 From: Christopher Rackauckas Date: Fri, 20 Oct 2023 12:54:43 -0400 Subject: [PATCH 3/3] Update src/pseudotransient.jl --- src/pseudotransient.jl | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/pseudotransient.jl b/src/pseudotransient.jl index b193a1f97..8e70f2350 100644 --- a/src/pseudotransient.jl +++ b/src/pseudotransient.jl @@ -28,7 +28,7 @@ SIAM Journal on Scientific Computing,25, 553-569.](https://doi.org/10.1137/S1064 algorithms, consult the [LinearSolve.jl documentation](https://docs.sciml.ai/LinearSolve/stable/). - `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. + you are going to need more iterations to converge but it can be more stable.