-
-
Notifications
You must be signed in to change notification settings - Fork 42
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
7 changed files
with
187 additions
and
23 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| # PETSc.jl | ||
|
|
||
| This is a extension for importing solvers from PETSc.jl SNES into the SciML interface. Note | ||
| that these solvers do not come by default, and thus one needs to install the package before | ||
| using these solvers: | ||
|
|
||
| ```julia | ||
| using Pkg | ||
| Pkg.add("PETSc") | ||
| using PETSc, NonlinearSolve | ||
| ``` | ||
|
|
||
| ## Solver API | ||
|
|
||
| ```@docs | ||
| PETScSNES | ||
| ``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,85 @@ | ||
| module NonlinearSolvePETScExt | ||
|
|
||
| using FastClosures: @closure | ||
| using MPI: MPI | ||
| using NonlinearSolveBase: NonlinearSolveBase, get_tolerance | ||
| using NonlinearSolve: NonlinearSolve, PETScSNES | ||
| using PETSc: PETSc | ||
| using SciMLBase: SciMLBase, NonlinearProblem, ReturnCode | ||
|
|
||
| function SciMLBase.__solve( | ||
| prob::NonlinearProblem, alg::PETScSNES, args...; abstol = nothing, reltol = nothing, | ||
| maxiters = 1000, alias_u0::Bool = false, termination_condition = nothing, | ||
| show_trace::Val{ShT} = Val(false), kwargs...) where {ShT} | ||
| termination_condition === nothing || | ||
| error("`PETScSNES` does not support termination conditions!") | ||
|
|
||
| _f!, u0, resid = NonlinearSolve.__construct_extension_f(prob; alias_u0) | ||
| T = eltype(prob.u0) | ||
|
|
||
| if alg.petsclib === missing | ||
| petsclibidx = findfirst(PETSc.petsclibs) do petsclib | ||
| petsclib isa PETSc.PetscLibType{T} | ||
| end | ||
|
|
||
| if petsclibidx === nothing | ||
| error("No compatible PETSc library found for element type $(T). Pass in a \ | ||
| custom `petsclib` via `PETScSNES(; petsclib = <petsclib>, ....)`.") | ||
| end | ||
| petsclib = PETSc.petsclibs[petsclibidx] | ||
| else | ||
| petsclib = alg.petsclib | ||
| end | ||
| PETSc.initialized(petsclib) || PETSc.initialize(petsclib) | ||
|
|
||
| abstol = get_tolerance(abstol, T) | ||
| reltol = get_tolerance(reltol, T) | ||
|
|
||
| f! = @closure (cfx, cx, user_ctx) -> begin | ||
| fx = cfx isa Ptr{Nothing} ? PETSc.unsafe_localarray(T, cfx; read = false) : cfx | ||
| x = cx isa Ptr{Nothing} ? PETSc.unsafe_localarray(T, cx; write = false) : cx | ||
| _f!(fx, x) | ||
| Base.finalize(fx) | ||
| Base.finalize(x) | ||
| return | ||
| end | ||
|
|
||
| snes = PETSc.SNES{T}(petsclib, | ||
| alg.mpi_comm === missing ? MPI.COMM_SELF : alg.mpi_comm; | ||
| alg.snes_options..., snes_monitor = ShT, snes_rtol = reltol, | ||
| snes_atol = abstol, snes_max_it = maxiters) | ||
|
|
||
| if alg.autodiff === missing && prob.f.jac === nothing | ||
| _jac! = nothing | ||
| else | ||
| autodiff = alg.autodiff === missing ? nothing : alg.autodiff | ||
| _jac! = NonlinearSolve.__construct_extension_jac(prob, alg, u0, resid; autodiff) | ||
| end | ||
|
|
||
| PETSc.setfunction!(snes, f!, PETSc.VecSeq(zero(u0))) | ||
|
|
||
| if _jac! !== nothing # XXX: Sparsity Handling??? | ||
| PJ = PETSc.MatSeqDense(zeros(T, length(resid), length(u0))) | ||
| jac! = @closure (cx, J, _, user_ctx) -> begin | ||
| x = cx isa Ptr{Nothing} ? PETSc.unsafe_localarray(T, cx; write = false) : cx | ||
| _jac!(J, x) | ||
| Base.finalize(x) | ||
| PETSc.assemble(J) | ||
| return | ||
| end | ||
| PETSc.setjacobian!(snes, jac!, PJ, PJ) | ||
| end | ||
|
|
||
| res = PETSc.solve!(u0, snes) | ||
|
|
||
| _f!(resid, res) | ||
| u_ = prob.u0 isa Number ? res[1] : res | ||
| resid_ = prob.u0 isa Number ? resid[1] : resid | ||
|
|
||
| objective = maximum(abs, resid) | ||
| # XXX: Return Code from PETSc | ||
| retcode = ifelse(objective ≤ abstol, ReturnCode.Success, ReturnCode.Failure) | ||
| return SciMLBase.build_solution(prob, alg, u_, resid_; retcode, original = snes) | ||
| end | ||
|
|
||
| end |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters