From 32628f1e35b043db42bdf378d96805e03bac33f6 Mon Sep 17 00:00:00 2001 From: "Daniel R. Reynolds" Date: Tue, 21 Nov 2023 09:16:43 -0600 Subject: [PATCH] Minor cleanup, and reorganization of section order --- doc/cvode/examples/source/c_cuda.rst | 6 +- doc/cvode/examples/source/c_mpimanyvec.rst | 6 +- doc/cvode/examples/source/c_openmp.rst | 6 +- doc/cvode/examples/source/c_openmpdev.rst | 6 +- doc/cvode/examples/source/c_parallel.rst | 6 +- doc/cvode/examples/source/c_parallel_deep.rst | 6 +- doc/cvode/examples/source/c_parhyp.rst | 6 +- doc/cvode/examples/source/c_parhyp_deep.rst | 6 +- doc/cvode/examples/source/c_raja.rst | 6 +- doc/cvode/examples/source/c_serial.rst | 6 +- doc/cvode/examples/source/c_serial_deep.rst | 6 +- doc/cvode/examples/source/c_tests_deep.rst | 9 +- doc/cvode/examples/source/cpp_hypre.rst | 6 +- doc/cvode/examples/source/cpp_onemkl.rst | 6 +- doc/cvode/examples/source/cpp_parallel.rst | 6 +- doc/cvode/examples/source/cpp_serial.rst | 6 +- doc/cvode/examples/source/cpp_sycl.rst | 6 +- doc/cvode/examples/source/f2003_deep.rst | 6 +- doc/cvode/examples/source/f2003_parallel.rst | 6 +- doc/cvode/examples/source/f2003_serial.rst | 6 +- doc/cvode/examples/source/index.rst | 106 +++++++++--------- 21 files changed, 116 insertions(+), 113 deletions(-) diff --git a/doc/cvode/examples/source/c_cuda.rst b/doc/cvode/examples/source/c_cuda.rst index 95d65be728..4caba8a52c 100644 --- a/doc/cvode/examples/source/c_cuda.rst +++ b/doc/cvode/examples/source/c_cuda.rst @@ -17,9 +17,9 @@ .. _cuda_c: -==================================== -CUDA C example problems -==================================== +=============== +CUDA C Examples +=============== diff --git a/doc/cvode/examples/source/c_mpimanyvec.rst b/doc/cvode/examples/source/c_mpimanyvec.rst index 9631ad7ded..0938da7f87 100644 --- a/doc/cvode/examples/source/c_mpimanyvec.rst +++ b/doc/cvode/examples/source/c_mpimanyvec.rst @@ -16,9 +16,9 @@ .. _mpimanyvec_c: -=================================================== -Parallel MPIManyVector C example problems -=================================================== +================================= +Parallel MPIManyVector C Examples +================================= diff --git a/doc/cvode/examples/source/c_openmp.rst b/doc/cvode/examples/source/c_openmp.rst index 8cd303edeb..51286b0997 100644 --- a/doc/cvode/examples/source/c_openmp.rst +++ b/doc/cvode/examples/source/c_openmp.rst @@ -16,9 +16,9 @@ .. _openmp_c: -==================================== -OpenMP C example problems -==================================== +================= +OpenMP C Examples +================= diff --git a/doc/cvode/examples/source/c_openmpdev.rst b/doc/cvode/examples/source/c_openmpdev.rst index 34215906e3..87192a66ec 100644 --- a/doc/cvode/examples/source/c_openmpdev.rst +++ b/doc/cvode/examples/source/c_openmpdev.rst @@ -16,9 +16,9 @@ .. _openmpdev_c: -============================================ -OpenMP Device Offload C example problems -============================================ +================================ +OpenMP Device Offload C Examples +================================ diff --git a/doc/cvode/examples/source/c_parallel.rst b/doc/cvode/examples/source/c_parallel.rst index 73d51e05f9..6b15d8deed 100644 --- a/doc/cvode/examples/source/c_parallel.rst +++ b/doc/cvode/examples/source/c_parallel.rst @@ -16,9 +16,9 @@ .. _parallel_c: -==================================== -Parallel C example problems -==================================== +=================== +Parallel C Examples +=================== diff --git a/doc/cvode/examples/source/c_parallel_deep.rst b/doc/cvode/examples/source/c_parallel_deep.rst index 81ca1ba18e..4c339b111f 100644 --- a/doc/cvode/examples/source/c_parallel_deep.rst +++ b/doc/cvode/examples/source/c_parallel_deep.rst @@ -17,9 +17,9 @@ .. _parallel_deep_c: -==================================================== -Parallel C example problems -- Deep dive -==================================================== +============================ +Detailed Parallel C Examples +============================ diff --git a/doc/cvode/examples/source/c_parhyp.rst b/doc/cvode/examples/source/c_parhyp.rst index bb2858f122..0d548846a9 100644 --- a/doc/cvode/examples/source/c_parhyp.rst +++ b/doc/cvode/examples/source/c_parhyp.rst @@ -16,9 +16,9 @@ .. _parhyp_c: -==================================== -Parallel Hypre C example problems -==================================== +========================= +Parallel Hypre C Examples +========================= diff --git a/doc/cvode/examples/source/c_parhyp_deep.rst b/doc/cvode/examples/source/c_parhyp_deep.rst index 030fff5100..83b7e2f4ee 100644 --- a/doc/cvode/examples/source/c_parhyp_deep.rst +++ b/doc/cvode/examples/source/c_parhyp_deep.rst @@ -17,9 +17,9 @@ .. _parhyp_deep_c: -================================================== -Parallel HYPRE C example problems -- Deep dive -================================================== +================================== +Detailed Parallel HYPRE C Examples +================================== diff --git a/doc/cvode/examples/source/c_raja.rst b/doc/cvode/examples/source/c_raja.rst index d92c4377b2..96a02380b9 100644 --- a/doc/cvode/examples/source/c_raja.rst +++ b/doc/cvode/examples/source/c_raja.rst @@ -17,9 +17,9 @@ .. _raja_c: -==================================== -RAJA C example problems -==================================== +=============== +RAJA C Examples +=============== diff --git a/doc/cvode/examples/source/c_serial.rst b/doc/cvode/examples/source/c_serial.rst index 99a85170c4..e2978a2f25 100644 --- a/doc/cvode/examples/source/c_serial.rst +++ b/doc/cvode/examples/source/c_serial.rst @@ -17,9 +17,9 @@ .. _serial_c: -==================================== -Serial C example problems -==================================== +================= +Serial C Examples +================= diff --git a/doc/cvode/examples/source/c_serial_deep.rst b/doc/cvode/examples/source/c_serial_deep.rst index 38e6191bf3..d74b39f45a 100644 --- a/doc/cvode/examples/source/c_serial_deep.rst +++ b/doc/cvode/examples/source/c_serial_deep.rst @@ -17,9 +17,9 @@ .. _serial_deep_c: -============================================ -Serial C example problems -- Deep dive -============================================ +========================== +Detailed Serial C Examples +========================== diff --git a/doc/cvode/examples/source/c_tests_deep.rst b/doc/cvode/examples/source/c_tests_deep.rst index 282f6ffc59..9fae951dc8 100644 --- a/doc/cvode/examples/source/c_tests_deep.rst +++ b/doc/cvode/examples/source/c_tests_deep.rst @@ -17,9 +17,6 @@ .. _tests_deep_c: -========================================================= -C example problems -- Parallel tests -- Deep Dive -========================================================= - - - +========================= +Detailed C Parallel Tests +========================= diff --git a/doc/cvode/examples/source/cpp_hypre.rst b/doc/cvode/examples/source/cpp_hypre.rst index c4fd561a34..1e4a06ed2b 100644 --- a/doc/cvode/examples/source/cpp_hypre.rst +++ b/doc/cvode/examples/source/cpp_hypre.rst @@ -17,9 +17,9 @@ .. _hypre_cpp: -============================================ -Parallel Hypre C++ example problems -============================================ +=========================== +Parallel Hypre C++ Examples +=========================== .. _cv_heat2D_hypre_ls: diff --git a/doc/cvode/examples/source/cpp_onemkl.rst b/doc/cvode/examples/source/cpp_onemkl.rst index 52f7439592..013698ba23 100644 --- a/doc/cvode/examples/source/cpp_onemkl.rst +++ b/doc/cvode/examples/source/cpp_onemkl.rst @@ -17,9 +17,9 @@ .. _onemkl_cpp: -==================================== -OneMKL C++ example problems -==================================== +=================== +OneMKL C++ Examples +=================== .. _cvRoberts_blockdiag_onemkl: diff --git a/doc/cvode/examples/source/cpp_parallel.rst b/doc/cvode/examples/source/cpp_parallel.rst index 12073c0254..85e0d6d8ad 100644 --- a/doc/cvode/examples/source/cpp_parallel.rst +++ b/doc/cvode/examples/source/cpp_parallel.rst @@ -17,9 +17,9 @@ .. _parallel_cpp: -==================================== -Parallel C++ example problems -==================================== +===================== +Parallel C++ Examples +===================== diff --git a/doc/cvode/examples/source/cpp_serial.rst b/doc/cvode/examples/source/cpp_serial.rst index e31c9aae70..17e0d60d80 100644 --- a/doc/cvode/examples/source/cpp_serial.rst +++ b/doc/cvode/examples/source/cpp_serial.rst @@ -17,9 +17,9 @@ .. _serial_cpp: -==================================== -Serial C++ example problems -==================================== +=================== +Serial C++ Examples +=================== diff --git a/doc/cvode/examples/source/cpp_sycl.rst b/doc/cvode/examples/source/cpp_sycl.rst index 218fe3e5cf..999ecf2680 100644 --- a/doc/cvode/examples/source/cpp_sycl.rst +++ b/doc/cvode/examples/source/cpp_sycl.rst @@ -17,9 +17,9 @@ .. _sycl_cpp: -==================================== -SYCL C++ example problems -==================================== +================= +SYCL C++ Examples +================= .. _cvAdvDiff_kry_sycl: diff --git a/doc/cvode/examples/source/f2003_deep.rst b/doc/cvode/examples/source/f2003_deep.rst index 33544276aa..31af32f9df 100644 --- a/doc/cvode/examples/source/f2003_deep.rst +++ b/doc/cvode/examples/source/f2003_deep.rst @@ -17,9 +17,9 @@ .. _deep_f2003: -=================================================== -Fortran 2003 example problems -- Deep dive -=================================================== +============================== +Detailed Fortran 2003 Examples +============================== The Fortran example problem programs supplied with the CVODE package are all written in standard Fortran 2003 and use double precision diff --git a/doc/cvode/examples/source/f2003_parallel.rst b/doc/cvode/examples/source/f2003_parallel.rst index 9fbe96ae0b..2440b5ef69 100644 --- a/doc/cvode/examples/source/f2003_parallel.rst +++ b/doc/cvode/examples/source/f2003_parallel.rst @@ -17,9 +17,9 @@ .. _parallel_f2003: -========================================= -Parallel Fortran 2003 example problems -========================================= +============================== +Parallel Fortran 2003 Examples +============================== diff --git a/doc/cvode/examples/source/f2003_serial.rst b/doc/cvode/examples/source/f2003_serial.rst index c9b3bc373a..092115a3fe 100644 --- a/doc/cvode/examples/source/f2003_serial.rst +++ b/doc/cvode/examples/source/f2003_serial.rst @@ -17,9 +17,9 @@ .. _serial_f2003: -======================================= -Serial Fortran 2003 example problems -======================================= +============================ +Serial Fortran 2003 Examples +============================ diff --git a/doc/cvode/examples/source/index.rst b/doc/cvode/examples/source/index.rst index 489b97d3a3..5aea1815f3 100644 --- a/doc/cvode/examples/source/index.rst +++ b/doc/cvode/examples/source/index.rst @@ -31,11 +31,13 @@ Documentation of CVODE :cite:p:`cvode_ug`. It provides details, with listings, on many of the example programs supplied with the CVODE distribution package. -This document describes CVODE examples of the following types: serial -C examples, parallel C examples, an OpenMP example, and a *hypre* -example. With the exception of "demo"-type example files, the names of -all the examples are of the form ``[slv][PbName]_[ls]_[prec]_[p]``, -where +This document provides detailed descriptions of CVODE examples of the +following types: serial C examples, parallel C examples, an OpenMP +example, and a *hypre* example. Additionally, it provides high level +descriptions of all remaining CVODE examples. + +With the exception of "demo"-type example files, the names of all the +examples are of the form ``[slv][PbName]_[ls]_[prec]_[p]``, where * ``[slv]`` identifies the solver (for CVODE examples this is ``cv``; @@ -58,8 +60,45 @@ the problem that is most closely related to your own. We group these examples according to programming language (C, C++, Fortran 2003). + +Detailed examples +================= + +Deep dives into CVODE example problems written in C are listed below. + +.. cssclass:: table-bordered + +====================================== ======================== +Problem Example Type +====================================== ======================== +:ref:`deep_dive.cvRoberts_dns` serial +:ref:`deep_dive.cvAdvDiff_bnd` serial +:ref:`deep_dive.cvDiurnal_kry` serial +:ref:`deep_dive.cvAdvDiff_non_p` parallel +:ref:`deep_dive.cvDiurnal_kry_p` parallel +:ref:`deep_dive.cvDiurnal_kry_bbd_p` parallel +:ref:`deep_dive.cvAdvDiff_non_ph` HYPRE parallel +====================================== ======================== + + + +Deep dives into CVODE example problems written in Fortran 2003 are listed +below. + +.. cssclass:: table-bordered + +====================================== ================= +Problem Example Type +====================================== ================= +:ref:`deep_dive.cv_diurnal_kry` serial +:ref:`deep_dive.cv_diag_kry_bbd_p` parallel +====================================== ================= + + + + Tables of Examples -========================== +================== C Examples ----------- @@ -106,24 +145,6 @@ Problem Integrator Nonlinear Linear Siz :ref:`cvAdvDiff_kry_raja` BDF Newton SPGMR 50 RAJA N_Vector module, RHS, and Jacobian product routines ==================================== ============ ============ ========== ============= ========================================================= -C Examples Deep Dives ----------------------- - -Deep dives into CVODE example problems written in C are listed below. - -.. cssclass:: table-bordered - -====================================== ======================== -Problem Example Type -====================================== ======================== -:ref:`deep_dive.cvRoberts_dns` serial -:ref:`deep_dive.cvAdvDiff_bnd` serial -:ref:`deep_dive.cvDiurnal_kry` serial -:ref:`deep_dive.cvAdvDiff_non_p` parallel -:ref:`deep_dive.cvDiurnal_kry_p` parallel -:ref:`deep_dive.cvDiurnal_kry_bbd_p` parallel -:ref:`deep_dive.cvAdvDiff_non_ph` HYPRE parallel -====================================== ======================== C++ Examples ------------- @@ -173,32 +194,17 @@ Problem Integrator Nonlinear Linear Size :ref:`cv_diag_non_p` ADAMS Fixed-point 128 parallel MPI ================================= ========== =========== ====== ============= ================================================= -Fortran Deep Dives -------------------- - -Deep dives into CVODE example problems written in Fortran 2003 are listed -below. - -.. cssclass:: table-bordered - -====================================== ================= -Problem Example Type -====================================== ================= -:ref:`deep_dive.cv_diurnal_kry` serial -:ref:`deep_dive.cv_diag_kry_bbd_p` parallel -====================================== ================= Full Section List of Examples and Deep Dives ==================================================== -In the following sections, we give high-level descriptions of all CVODE examples, -as well as detailed descriptions ("deep dives") of some examples. We also give -our output files for each of these examples, but users should be cautioned that -their results may differ slightly from these. Differences in solution -values may differ within the tolerances, and differences in cumulative -counters, such as numbers of steps or Newton iterations, may differ -from one machine environment to another by as much as 10% to 20%. +The following sections provide the detailed "deep dive" examples, followed by the +high-level descriptions of all CVODE examples. For each example we show +our output files, but users should be cautioned that their results may differ +slightly from these. Differences in solution values may differ within the tolerances, +and differences in cumulative counters, such as numbers of steps or Newton iterations, +may differ from one machine environment to another by as much as 10% to 20%. In the descriptions below, we make frequent references to the CVODE User Document :cite:p:`cvode_ug`. All citations to specific sections @@ -220,6 +226,11 @@ otherwise. .. toctree:: :maxdepth: 1 + c_serial_deep + c_parallel_deep + c_parhyp_deep + c_tests_deep + f2003_deep c_serial c_openmp c_openmpdev @@ -228,10 +239,6 @@ otherwise. c_mpimanyvec c_cuda c_raja - c_serial_deep - c_parallel_deep - c_parhyp_deep - c_tests_deep cpp_serial cpp_parallel cpp_hypre @@ -239,7 +246,6 @@ otherwise. cpp_sycl f2003_serial f2003_parallel - f2003_deep References .. only:: html