From: Wolfgang Bangerth Date: Tue, 25 May 2021 17:00:01 +0000 (-0600) Subject: Unify internal names of SUNDIALS ARKODE interfaces. X-Git-Tag: v9.4.0-rc1~1334^2 X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=14f5854b7070d1b7ca22e7c277107bfc6c85384b;p=dealii.git Unify internal names of SUNDIALS ARKODE interfaces. As previously done for the KINSOL interfaces, this patch avoids the t_arkode_ prefix and instead uses _callback as suffix. I don't quite know where the t_ prefix comes from, but it sounds like jargon that may be present in the SUNDIALS internal documentation but that a typical reader of our code would not know about. Since these are all internal functions of deal.II, we can rename them freely. In particular, because they are in anonymous namespaces, we can re-use the same names already in use in the KINSOL interfaces. --- diff --git a/source/sundials/arkode.cc b/source/sundials/arkode.cc index bb3d81893b..149200e00a 100644 --- a/source/sundials/arkode.cc +++ b/source/sundials/arkode.cc @@ -67,7 +67,7 @@ namespace SUNDIALS { template int - t_arkode_explicit_function(realtype tt, + explicit_function_callback(realtype tt, N_Vector yy, N_Vector yp, void * user_data) @@ -86,7 +86,7 @@ namespace SUNDIALS template int - t_arkode_implicit_function(realtype tt, + implicit_function_callback(realtype tt, N_Vector yy, N_Vector yp, void * user_data) @@ -106,7 +106,7 @@ namespace SUNDIALS # if DEAL_II_SUNDIALS_VERSION_LT(4, 0, 0) template int - t_arkode_setup_jacobian(ARKodeMem arkode_mem, + setup_jacobian_callback(ARKodeMem arkode_mem, int convfail, N_Vector ypred, N_Vector fpred, @@ -142,13 +142,13 @@ namespace SUNDIALS template int - t_arkode_solve_jacobian(ARKodeMem arkode_mem, - N_Vector b, + solve_with_jacobian_callback(ARKodeMem arkode_mem, + N_Vector b, # if DEAL_II_SUNDIALS_VERSION_LT(3, 0, 0) - N_Vector, + N_Vector, # endif - N_Vector ycur, - N_Vector fcur) + N_Vector ycur, + N_Vector fcur) { Assert(arkode_mem->ark_user_data != nullptr, ExcInternalError()); ARKode &solver = @@ -176,7 +176,10 @@ namespace SUNDIALS template int - t_arkode_setup_mass(ARKodeMem arkode_mem, N_Vector, N_Vector, N_Vector) + setup_mass_matrix_callback(ARKodeMem arkode_mem, + N_Vector, + N_Vector, + N_Vector) { Assert(arkode_mem->ark_user_data != nullptr, ExcInternalError()); ARKode &solver = @@ -189,12 +192,12 @@ namespace SUNDIALS template int - t_arkode_solve_mass(ARKodeMem arkode_mem, + solve_with_mass_matrix_callback(ARKodeMem arkode_mem, # if DEAL_II_SUNDIALS_VERSION_LT(3, 0, 0) - N_Vector b, - N_Vector + N_Vector b, + N_Vector # else - N_Vector b + N_Vector b # endif ) { @@ -215,13 +218,13 @@ namespace SUNDIALS template int - t_arkode_jac_times_vec_function(N_Vector v, - N_Vector Jv, - realtype t, - N_Vector y, - N_Vector fy, - void * user_data, - N_Vector) + jacobian_times_vector_callback(N_Vector v, + N_Vector Jv, + realtype t, + N_Vector y, + N_Vector fy, + void * user_data, + N_Vector) { Assert(user_data != nullptr, ExcInternalError()); ARKode &solver = @@ -240,10 +243,10 @@ namespace SUNDIALS template int - t_arkode_jac_times_setup_function(realtype t, - N_Vector y, - N_Vector fy, - void * user_data) + jacobian_times_vector_setup_callback(realtype t, + N_Vector y, + N_Vector fy, + void * user_data) { Assert(user_data != nullptr, ExcInternalError()); ARKode &solver = @@ -259,7 +262,7 @@ namespace SUNDIALS template int - t_arkode_prec_solve_function(realtype t, + solve_with_jacobian_callback(realtype t, N_Vector y, N_Vector fy, N_Vector r, @@ -287,13 +290,13 @@ namespace SUNDIALS template int - t_arkode_prec_setup_function(realtype t, - N_Vector y, - N_Vector fy, - booleantype jok, - booleantype *jcurPtr, - realtype gamma, - void * user_data) + jacobian_solver_setup_callback(realtype t, + N_Vector y, + N_Vector fy, + booleantype jok, + booleantype *jcurPtr, + realtype gamma, + void * user_data) { Assert(user_data != nullptr, ExcInternalError()); ARKode &solver = @@ -310,10 +313,10 @@ namespace SUNDIALS template int - t_arkode_mass_times_vec_function(N_Vector v, - N_Vector Mv, - realtype t, - void * mtimes_data) + mass_matrix_times_vector_callback(N_Vector v, + N_Vector Mv, + realtype t, + void * mtimes_data) { Assert(mtimes_data != nullptr, ExcInternalError()); ARKode &solver = @@ -329,7 +332,7 @@ namespace SUNDIALS template int - t_arkode_mass_times_setup_function(realtype t, void *mtimes_data) + mass_matrix_times_vector_setup_callback(realtype t, void *mtimes_data) { Assert(mtimes_data != nullptr, ExcInternalError()); ARKode &solver = @@ -342,12 +345,12 @@ namespace SUNDIALS template int - t_arkode_mass_prec_solve_function(realtype t, - N_Vector r, - N_Vector z, - realtype delta, - int lr, - void * user_data) + solve_with_mass_matrix_callback(realtype t, + N_Vector r, + N_Vector z, + realtype delta, + int lr, + void * user_data) { Assert(user_data != nullptr, ExcInternalError()); ARKode &solver = @@ -363,7 +366,7 @@ namespace SUNDIALS template int - t_arkode_mass_prec_setup_function(realtype t, void *user_data) + mass_matrix_solver_setup_callback(realtype t, void *user_data) { Assert(user_data != nullptr, ExcInternalError()); ARKode &solver = @@ -524,8 +527,8 @@ namespace SUNDIALS status = ARKodeInit( arkode_mem, - explicit_function ? &t_arkode_explicit_function : nullptr, - implicit_function ? &t_arkode_implicit_function : nullptr, + explicit_function ? &explicit_function_callback : nullptr, + implicit_function ? &implicit_function_callback : nullptr, current_time, initial_condition_nvector); AssertARKode(status); @@ -573,10 +576,10 @@ namespace SUNDIALS } - ARKode_mem->ark_lsolve = t_arkode_solve_jacobian; + ARKode_mem->ark_lsolve = solve_with_jacobian_callback; if (setup_jacobian) { - ARKode_mem->ark_lsetup = t_arkode_setup_jacobian; + ARKode_mem->ark_lsetup = setup_jacobian_callback; # if DEAL_II_SUNDIALS_VERSION_LT(3, 0, 0) ARKode_mem->ark_setupNonNull = true; # endif @@ -592,11 +595,11 @@ namespace SUNDIALS if (solve_mass_system) { - ARKode_mem->ark_msolve = t_arkode_solve_mass; + ARKode_mem->ark_msolve = solve_with_mass_matrix_callback; if (setup_mass) { - ARKode_mem->ark_msetup = t_arkode_setup_mass; + ARKode_mem->ark_msetup = setup_mass_matrix_callback; # if DEAL_II_SUNDIALS_VERSION_LT(3, 0, 0) ARKode_mem->ark_MassSetupNonNull = true; # endif @@ -633,8 +636,8 @@ namespace SUNDIALS ExcFunctionNotProvided("explicit_function || implicit_function")); arkode_mem = ARKStepCreate( - explicit_function ? &t_arkode_explicit_function : nullptr, - implicit_function ? &t_arkode_implicit_function : nullptr, + explicit_function ? &explicit_function_callback : nullptr, + implicit_function ? &implicit_function_callback : nullptr, current_time, initial_condition_nvector); @@ -713,21 +716,21 @@ namespace SUNDIALS } status = ARKStepSetLinearSolver(arkode_mem, sun_linear_solver, nullptr); AssertARKode(status); - status = - ARKStepSetJacTimes(arkode_mem, - jacobian_times_setup ? - t_arkode_jac_times_setup_function : - nullptr, - t_arkode_jac_times_vec_function); + status = ARKStepSetJacTimes( + arkode_mem, + jacobian_times_setup ? + jacobian_times_vector_setup_callback : + nullptr, + jacobian_times_vector_callback); AssertARKode(status); if (jacobian_preconditioner_solve) { status = ARKStepSetPreconditioner( arkode_mem, jacobian_preconditioner_setup ? - t_arkode_prec_setup_function : + jacobian_solver_setup_callback : nullptr, - t_arkode_prec_solve_function); + solve_with_jacobian_callback); AssertARKode(status); } if (data.implicit_function_is_linear) @@ -788,13 +791,13 @@ namespace SUNDIALS nullptr, mass_time_dependent); AssertARKode(status); - status = - ARKStepSetMassTimes(arkode_mem, - mass_times_setup ? - t_arkode_mass_times_setup_function : - nullptr, - t_arkode_mass_times_vec_function, - this); + status = ARKStepSetMassTimes( + arkode_mem, + mass_times_setup ? + mass_matrix_times_vector_setup_callback : + nullptr, + mass_matrix_times_vector_callback, + this); AssertARKode(status); if (mass_preconditioner_solve) @@ -802,9 +805,9 @@ namespace SUNDIALS status = ARKStepSetMassPreconditioner( arkode_mem, mass_preconditioner_setup ? - t_arkode_mass_prec_setup_function : + mass_matrix_solver_setup_callback : nullptr, - t_arkode_mass_prec_solve_function); + solve_with_mass_matrix_callback); AssertARKode(status); } }