From: Jiaqi Zhang Date: Thu, 24 Sep 2020 15:25:40 +0000 (-0400) Subject: complete the tables X-Git-Tag: v9.3.0-rc1~1060^2 X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=refs%2Fpull%2F10958%2Fhead;p=dealii.git complete the tables --- diff --git a/include/deal.II/base/time_stepping.h b/include/deal.II/base/time_stepping.h index e87dfe3988..c0a5096cd4 100644 --- a/include/deal.II/base/time_stepping.h +++ b/include/deal.II/base/time_stepping.h @@ -46,25 +46,66 @@ namespace TimeStepping * - Embedded explicit methods (see EmbeddedExplicitRungeKutta::initialize): * - HEUN_EULER (second order) * - BOGACKI_SHAMPINE (third order) - * - DOPRI: Dormand-Prince (fifth order; this is the method used by ode45 - * in MATLAB) + * - DOPRI (Dormand-Prince method, fifth order; this is the method used by + * ode45 in MATLAB) * - FEHLBERG (fifth order) - * - CASH_KARP (firth order) + * - CASH_KARP (fifth order) */ enum runge_kutta_method { + /** + * Forward Euler method, first order. + */ FORWARD_EULER, + /** + * Third order Runge-Kutta method. + */ RK_THIRD_ORDER, + /** + * Classical fourth order Runge-Kutta method. + */ RK_CLASSIC_FOURTH_ORDER, + /** + * Backward Euler method, first order. + */ BACKWARD_EULER, + /** + * Implicit midpoint method, second order. + */ IMPLICIT_MIDPOINT, + /** + * Crank-Nicolson method, second order. + */ CRANK_NICOLSON, + /** + * Two stage SDIRK method (short for "singly diagonally implicit + * Runge-Kutta"), second order. + */ SDIRK_TWO_STAGES, + /** + * Heun's method (improved Euler's method), second order. + */ HEUN_EULER, + /** + * Bogacki–Shampine method, third-order. + */ BOGACKI_SHAMPINE, + /** + * Dormand-Prince method, fifth order; this is the method used by + * ode45 in MATLAB. + */ DOPRI, + /** + * Fehlberg method, fifth order. + */ FEHLBERG, + /** + * Cash–Karp method, fifth order. + */ CASH_KARP, + /** + * Invalid. + */ invalid }; @@ -72,14 +113,21 @@ namespace TimeStepping /** * Reason for exiting evolve_one_time_step when using an embedded method: - * DELTA_T (the time step is in the valid range), MIN_DELTA_T (the time step - * was increased to the minimum acceptable time step), MAX_DELTA_T (the time - * step was reduced to the maximum acceptable time step). + * DELTA_T, MIN_DELTA_T, MAX_DELTA_T. */ enum embedded_runge_kutta_time_step { + /** + * The time step is in the valid range. + */ DELTA_T, + /** + * The time step was increased to the minimum acceptable time step. + */ MIN_DELTA_T, + /** + * The time step was reduced to the maximum acceptable time step. + */ MAX_DELTA_T };