16#ifndef dealii_sundials_ida_h
17#define dealii_sundials_ida_h
21#ifdef DEAL_II_WITH_SUNDIALS
27# ifdef DEAL_II_WITH_PETSC
34# ifdef DEAL_II_SUNDIALS_WITH_IDAS
35# include <idas/idas.h>
43# include <boost/signals2.hpp>
45# include <nvector/nvector_serial.h>
46# include <sundials/sundials_config.h>
47# include <sundials/sundials_math.h>
480 template <
typename VectorType = Vector<
double>>
650 "Ignore algebraic terms for error computations",
652 "Indicate whether or not to suppress algebraic variables "
653 "in the local error test.");
657 static std::string ic_type_str =
"use_y_diff";
659 "Correction type at initial time",
661 "This is one of the following three options for the "
662 "initial condition calculation. \n"
663 " none: do not try to make initial conditions consistent. \n"
664 " use_y_diff: compute the algebraic components of y and differential\n"
665 " components of y_dot, given the differential components of y. \n"
666 " This option requires that the user specifies differential and \n"
667 " algebraic components in the function differential_components().\n"
668 " use_y_dot: compute all components of y, given y_dot.",
670 prm.
add_action(
"Correction type at initial time",
671 [&](
const std::string &value) {
672 if (value ==
"use_y_diff")
674 else if (value ==
"use_y_dot")
676 else if (value ==
"none")
682 static std::string reset_type_str =
"use_y_diff";
684 "Correction type after restart",
686 "This is one of the following three options for the "
687 "initial condition calculation. \n"
688 " none: do not try to make initial conditions consistent. \n"
689 " use_y_diff: compute the algebraic components of y and differential\n"
690 " components of y_dot, given the differential components of y. \n"
691 " This option requires that the user specifies differential and \n"
692 " algebraic components in the function differential_components().\n"
693 " use_y_dot: compute all components of y, given y_dot.",
695 prm.
add_action(
"Correction type after restart",
696 [&](
const std::string &value) {
697 if (value ==
"use_y_diff")
699 else if (value ==
"use_y_dot")
701 else if (value ==
"none")
709 "Factor to use when converting from the integrator tolerance to the linear solver tolerance",
867 solve_dae(VectorType &solution, VectorType &solution_dot);
891 reset(
const double t,
const double h, VectorType &y, VectorType &yp);
908 std::function<void(
const double t,
910 const VectorType &y_dot,
944 std::function<void(
const double t,
946 const VectorType &y_dot,
992 void(
const VectorType &rhs, VectorType &dst,
const double tolerance)>
1009 std::function<void(
const double t,
1010 const VectorType &sol,
1011 const VectorType &sol_dot,
1012 const unsigned int step_number)>
1038 std::function<
bool(
const double t, VectorType &sol, VectorType &sol_dot)>
1070 <<
"One of SUNDIALS IDA's internal functions "
1071 <<
"returned an error code: " << arg1
1072 <<
". Please consult SUNDIALS manual.");
1082 <<
"Please provide an implementation for the function \""
1103# if DEAL_II_SUNDIALS_VERSION_GTE(6, 0, 0)
1128# ifdef DEAL_II_WITH_PETSC
1129# ifdef PETSC_USE_COMPLEX
1130 static_assert(!std::is_same_v<VectorType, PETScWrappers::MPI::Vector>,
1131 "Sundials does not support complex scalar types, "
1132 "but PETSc is configured to use a complex scalar type!");
1134 static_assert(!std::is_same_v<VectorType, PETScWrappers::MPI::BlockVector>,
1135 "Sundials does not support complex scalar types, "
1136 "but PETSc is configured to use a complex scalar type!");
void add_parameter(const std::string &entry, ParameterType ¶meter, const std::string &documentation="", const Patterns::PatternBase &pattern= *Patterns::Tools::Convert< ParameterType >::to_pattern(), const bool has_to_be_set=false)
void enter_subsection(const std::string &subsection, const bool create_path_if_needed=true)
void add_action(const std::string &entry, const std::function< void(const std::string &value)> &action, const bool execute_action=true)
double relative_tolerance
InitialConditionCorrection ic_type
bool ignore_algebraic_terms_for_errors
void add_parameters(ParameterHandler &prm)
AdditionalData(const double initial_time=0.0, const double final_time=1.0, const double initial_step_size=1e-2, const double output_period=1e-1, const double minimum_step_size=1e-6, const unsigned int maximum_order=5, const unsigned int maximum_non_linear_iterations=10, const double ls_norm_factor=0, const double absolute_tolerance=1e-6, const double relative_tolerance=1e-5, const bool ignore_algebraic_terms_for_errors=true, const InitialConditionCorrection &ic_type=use_y_diff, const InitialConditionCorrection &reset_type=use_y_diff, const unsigned int maximum_non_linear_iterations_ic=5)
unsigned maximum_non_linear_iterations_ic
InitialConditionCorrection reset_type
unsigned int maximum_order
InitialConditionCorrection
unsigned int maximum_non_linear_iterations
double absolute_tolerance
std::function< void(const VectorType &rhs, VectorType &dst, const double tolerance)> solve_with_jacobian
unsigned int solve_dae(VectorType &solution, VectorType &solution_dot)
MPI_Comm mpi_communicator
std::function< void(const double t, const VectorType &y, const VectorType &y_dot, const double alpha)> setup_jacobian
void set_functions_to_trigger_an_assert()
const AdditionalData data
void reset(const double t, const double h, VectorType &y, VectorType &yp)
std::function< void(const double t, const VectorType &y, const VectorType &y_dot, VectorType &res)> residual
std::function< void(const double t, const VectorType &sol, const VectorType &sol_dot, const unsigned int step_number)> output_step
std::function< IndexSet()> differential_components
std::function< VectorType &()> get_local_tolerances
std::function< bool(const double t, VectorType &sol, VectorType &sol_dot)> solver_should_restart
GrowingVectorMemory< VectorType > mem
std::function< void(VectorType &)> reinit_vector
std::exception_ptr pending_exception
#define DEAL_II_NAMESPACE_OPEN
#define DEAL_II_NAMESPACE_CLOSE
static ::ExceptionBase & ExcIDAError(int arg1)
static ::ExceptionBase & ExcFunctionNotProvided(std::string arg1)
static ::ExceptionBase & ExcInternalError()
#define DeclException1(Exception1, type1, outsequence)
#define AssertThrow(cond, exc)