module Idas_bbd:sig..end
Parallel band-block-diagonal preconditioners for IDAS (requires MPI).
typeparallel_bsession =(Nvector_parallel.data, Nvector_parallel.kind) Idas.Adjoint.bsession
Alias for sessions based on parallel nvectors.
typeparallel_preconditioner =(Nvector_parallel.data, Nvector_parallel.kind)
Idas.Adjoint.Spils.preconditioner
Alias for preconditioners based on parallel nvectors.
typebandwidths =Ida_bbd.bandwidths= {
|
mudq : |
(* | Upper half-bandwidth for the difference quotient Jacobian approximation. | *) |
|
mldq : |
(* | Lower half-bandwidth for the difference quotient Jacobian approximation. | *) |
|
mukeep : |
(* | Upper half-bandwidth for the retained banded approximate Jacobian block. | *) |
|
mlkeep : |
(* | Lower half-bandwidth for the retained banded approximate Jacobian block. | *) |
}
The bandwidths for the difference quotient Jacobian operation.
typelocal_fn =Nvector_parallel.data Idas.Adjoint.bresfn_args ->
Nvector_parallel.data -> unit
Functions that approximate backward residual functions using local computations only. They are passed the arguments:
args, the current values of forward and backward variables
and their derivatives, andresb, a vector for storing a local approximation to the backward
residual function $F_B(t, y, \dot{y}, y_B, \dot{y}_B)$ .The approximation is allowed to coincide with the actual backward residual function.
Raising Sundials.RecoverableFailure signals a recoverable error.
Other exceptions signal unrecoverable errors.
typecomm_fn =Nvector_parallel.data Idas.Adjoint.bresfn_args -> unit
Functions that perform the interprocess communication necessary
for the execution of Idas_bbd.local_fn.
args, the current values of forward and backward variables, and,resb, a vector for storing a local approximation to the backward
function $F_B(t, y, \dot{y}, y_B, \dot{y}_B)$ .Raising Sundials.RecoverableFailure signals a recoverable error.
Other exceptions signal unrecoverable errors.
val prec_left : ?dqrely:float ->
bandwidths ->
?comm:comm_fn ->
local_fn -> parallel_preconditionerLeft preconditioning using the Parallel Band-Block-Diagonal
module. The difference quotient operation is controlled by
?dqrely, which specifies the relative increment in components of
y, and Idas_bbd.bandwidths.
val reinit : parallel_bsession -> ?dqrely:float -> int -> int -> unitReinitializes some BBD preconditioner parameters.
In the call, reinit s ~dqrely:dqrely mudq mldq, dqrely is the relative
increment in the components of y, and mudq and mldq are, respectively,
the upper-half and lower-half bandwidths of the difference quotient
Jacobian approximation.
val get_work_space : parallel_bsession -> int * intReturns the sizes of the real and integer workspaces used by the BBD preconditioner.
real_size, integer_size)val get_num_gfn_evals : parallel_bsession -> intReturns the number of calls to the right-hand side function due to finite difference banded Jacobian approximation in the setup function.