Maintenance: Remove F77 interface examples (#367)

Remove F77 interface examples from `develop` branch. Once this PR is merged, a new `archive` branch can be created for easy reference until #302 is merged and the `archive` branch can be deleted. --------- Co-authored-by: Cody Balos <[email protected]>
LLNL · Dec 18, 2023 · 0cd9adc · 0cd9adc
1 parent 311fac2
commit 0cd9adc
Show file tree

Hide file tree

Showing 91 changed files with 130 additions and 14,847 deletions.
diff --git a/doc/arkode/examples/source/index.rst b/doc/arkode/examples/source/index.rst
@@ -45,7 +45,7 @@ B598130 from `Lawrence Livermore National Laboratory
 
 Along with the ARKode solver, we have created a suite of example
 problems demonstrating its usage on applications written in C, C++ and
-Fortran 77 and Fortran 90.  These examples demonstrate a large variety
+Fortran.  These examples demonstrate a large variety
 of ARKode solver options, including explicit, implicit and ImEx
 solvers, root-finding, Newton and fixed-point nonlinear solvers,
 direct and iterative linear solvers, adaptive resize capabilities, and
@@ -60,8 +60,7 @@ The following tables summarize the salient features of each of the
 example problems in this document.  Each example is designed to be
 relatively self-contained, so that you need only study and/or emulate
 the problem that is most closely related to your own.  We group these
-examples according to programming language (C, C++, Fortran 77,
-Fortran 90). 
+examples according to programming language (C, C++, Fortran).
 
 
 ARKode example problems written in C are summarized in the table
@@ -106,35 +105,36 @@ Problem                  Integrator  Nonlinear    Linear  Size           Extras
 =======================  ==========  ===========  ======  =============  =================================
 
 
-ARKode example problems written in Fortran 77 are summarized in the table
-below, and are further described in the chapters :ref:`serial_f77` and
-:ref:`parallel_f77`. 
+..
+   ARKode example problems written in Fortran 77 are summarized in the table
+   below, and are further described in the chapters :ref:`serial_f77` and
+   :ref:`parallel_f77`.
 
-.. cssclass:: table-bordered
+   .. cssclass:: table-bordered
 
-==========================   ==========  ===========  ======  =============  =================================
-Problem                      Integrator  Nonlinear    Linear  Size           Extras
-==========================   ==========  ===========  ======  =============  =================================
-:ref:`fark_diurnal_kry_bp`   DIRK        Newton       SPGMR   10             banded preconditioner
-:ref:`fark_roberts_dnsL`     DIRK        Newton       Dense   3              LAPACK dense solver, rootfinding
-:ref:`fark_diag_kry_bbd_p`   DIRK        Newton       SPGMR   10*NProcs      parallel BBD preconditioner
-:ref:`fark_diag_non_p`       ERK         N.A.         N.A.    10*NProcs      parallel
-==========================   ==========  ===========  ======  =============  =================================
+   ==========================   ==========  ===========  ======  =============  =================================
+   Problem                      Integrator  Nonlinear    Linear  Size           Extras
+   ==========================   ==========  ===========  ======  =============  =================================
+   :ref:`fark_diurnal_kry_bp`   DIRK        Newton       SPGMR   10             banded preconditioner
+   :ref:`fark_roberts_dnsL`     DIRK        Newton       Dense   3              LAPACK dense solver, rootfinding
+   :ref:`fark_diag_kry_bbd_p`   DIRK        Newton       SPGMR   10*NProcs      parallel BBD preconditioner
+   :ref:`fark_diag_non_p`       ERK         N.A.         N.A.    10*NProcs      parallel
+   ==========================   ==========  ===========  ======  =============  =================================
 
 
-ARKode example problems written in Fortran 90 are summarized in the table
-below, and are further described in the chapters :ref:`serial_f90` and
-:ref:`parallel_f90`. 
+   ARKode example problems written in Fortran 90 are summarized in the table
+   below, and are further described in the chapters :ref:`serial_f90` and
+   :ref:`parallel_f90`.
 
-.. cssclass:: table-bordered
+   .. cssclass:: table-bordered
 
-==========================  ==========  =========  ======  =============  ===============================================
-Problem                     Integrator  Nonlinear  Linear  Size           Extras
-==========================  ==========  =========  ======  =============  ===============================================
-:ref:`ark_bruss`            ARK         Newton     Dense   3              
-:ref:`ark_bruss1D_FEM_klu`  DIRK        Newton     KLU     3N             finite-element, :math:`M\ne I`, sparse matrices
-:ref:`fark_heat2D`          DIRK        Newton     PCG     :math:`nx*ny`  parallel
-==========================  ==========  =========  ======  =============  ===============================================
+   ==========================  ==========  =========  ======  =============  ===============================================
+   Problem                     Integrator  Nonlinear  Linear  Size           Extras
+   ==========================  ==========  =========  ======  =============  ===============================================
+   :ref:`ark_bruss`            ARK         Newton     Dense   3
+   :ref:`ark_bruss1D_FEM_klu`  DIRK        Newton     KLU     3N             finite-element, :math:`M\ne I`, sparse matrices
+   :ref:`fark_heat2D`          DIRK        Newton     PCG     :math:`nx*ny`  parallel
+   ==========================  ==========  =========  ======  =============  ===============================================
 
 
 
@@ -154,14 +154,14 @@ Problem                     Integrator  Nonlinear  Linear  Size           Extras
    c_parhyp
    cpp_serial
    cpp_parallel
-   f77_serial
-   f77_parallel
-   f90_serial
-   f90_parallel
-   References           
-
+   References
+..
+  Remove F77 interface examples
+  f77_serial
+  f77_parallel
+  f90_serial
+  f90_parallel
+
 .. only:: html
 
    * :ref:`search`
-
-
diff --git a/doc/cvode/Makefile b/doc/cvode/Makefile
@@ -22,7 +22,9 @@ cv_ex_intro.tex \
 cv_ex_serial.tex \
 cv_ex_parallel.tex \
 cv_ex_parhyp.tex \
-cv_ex_fortran.tex \
 cv_ex_tests.tex
 
+# Remove F77 example text
+# cv_ex_fortran.tex \
+
 include ../Makefile.in
diff --git a/doc/cvode/cv_ex_codes.tex b/doc/cvode/cv_ex_codes.tex
@@ -30,14 +30,12 @@ \section{Listing of cvDiurnal\_kry\_bbd\_p.c}\label{s:cvDiurnal_bbd_p_c}
 
 %% Fortran examples
 
-\lstset{language=[77]Fortran}
-
-\newpage
-\section{Listing of fcvDiurnal\_kry.f}\label{s:fcvDiurnal_f}
-\includeCode{../../examples/cvode/fcmix_serial/fcvDiurnal_kry.f}
-
-\newpage
-\section{Listing of fcvDiag\_kry\_bbd\_p.f}\label{s:fcvDiag_bbd_p_f}
-\includeCode{../../examples/cvode/fcmix_parallel/fcvDiag_kry_bbd_p.f}
+%% \lstset{language=[77]Fortran}
 
+%% \newpage
+%% \section{Listing of fcvDiurnal\_kry.f}\label{s:fcvDiurnal_f}
+%% \includeCode{../../examples/cvode/fcmix_serial/fcvDiurnal_kry.f}
 
+%% \newpage
+%% \section{Listing of fcvDiag\_kry\_bbd\_p.f}\label{s:fcvDiag_bbd_p_f}
+%% \includeCode{../../examples/cvode/fcmix_parallel/fcvDiag_kry_bbd_p.f}
diff --git a/doc/cvode/cv_ex_intro.tex b/doc/cvode/cv_ex_intro.tex
@@ -7,9 +7,9 @@ \section{Introduction}\label{s:ex_intro}
 listings, on the example programs supplied with the {\cvode} distribution
 package.
 
-The {\cvode} distribution contains examples of six types: serial
-{\CC} examples, parallel {\CC} examples, serial and parallel {\F}
-examples, an OpenMP example, and a {\hypre} example.
+The {\cvode} distribution contains examples of the following types: serial
+{\CC} examples, parallel {\CC} examples, an OpenMP example, and a {\hypre}
+example.
 %%
 With the exception of ''demo''-type example files, the names of all the examples
 distributed with {\sundials} are of the form \verb![slv][PbName]_[ls]_[prec]_[p]!,
@@ -159,28 +159,28 @@ \section{Introduction}\label{s:ex_intro}
 \id{cvAdvDiff\_non\_p} but with {\hypre} vectors instead of
 {\sundials} parallel vectors.
 
-\vspace{0.2in}\noindent
-As part of the {\fcvode} module, in the directories
-{\em srcdir}\id{/examples/cvode/fcmix\_serial} and
-{\em srcdir}\id{/examples/cvode/fcmix\_parallel}, are the following examples for
-the {\F}-{\CC} interface.  The first five of these are serial, while
-the last three are parallel.
-\begin{itemize}
-\item \id{fcvRoberts\_dns} is a serial chemical kinetics example (\id{BDF}/{\sunlinsoldense})
-  with rootfinding.
-\item \id{fcvRoberts\_dns\_constraints} is the same as \id{fcvRoberts\_dns} but
-  but imposes the constraint $u \geq 0.0$ for all components.
-\item \id{fcvRoberts\_dnsL} is the same as \id{fcvRoberts\_dns} but uses the Lapack
-  implementation of {\sunlinsollapdense}.
-\item \id{fcvAdvDiff\_bnd} is a serial advection-diffusion example (\id{BDF}/{\sunlinsolband}).
-\item \id{fcvDiurnal\_kry} is a serial kinetics-transport example (\id{BDF}/{\sunlinsolspgmr}).
-\item \id{fcvDiurnal\_kry\_bp} is the \id{fcvDiurnal\_kry} example with {\fcvbp}.
-\item \id{fcvDiag\_non\_p} is a nonstiff parallel diagonal ODE example
-  (\id{ADAMS}/\id{FIXEDPOINT}).
-\item \id{fcvDiag\_kry\_p} is a stiff parallel diagonal ODE example (\id{BDF}/{\sunlinsolspgmr}).
-\item \id{fcvDiag\_kry\_bbd\_p} is the same as the \id{fcvDiag\_kry\_p} example
-       but using the {\fcvbbd} module.
-\end{itemize}
+%% \vspace{0.2in}\noindent
+%% As part of the {\fcvode} module, in the directories
+%% {\em srcdir}\id{/examples/cvode/fcmix\_serial} and
+%% {\em srcdir}\id{/examples/cvode/fcmix\_parallel}, are the following examples for
+%% the {\F}-{\CC} interface.  The first five of these are serial, while
+%% the last three are parallel.
+%% \begin{itemize}
+%% \item \id{fcvRoberts\_dns} is a serial chemical kinetics example (\id{BDF}/{\sunlinsoldense})
+%%   with rootfinding.
+%% \item \id{fcvRoberts\_dns\_constraints} is the same as \id{fcvRoberts\_dns} but
+%%   but imposes the constraint $u \geq 0.0$ for all components.
+%% \item \id{fcvRoberts\_dnsL} is the same as \id{fcvRoberts\_dns} but uses the Lapack
+%%   implementation of {\sunlinsollapdense}.
+%% \item \id{fcvAdvDiff\_bnd} is a serial advection-diffusion example (\id{BDF}/{\sunlinsolband}).
+%% \item \id{fcvDiurnal\_kry} is a serial kinetics-transport example (\id{BDF}/{\sunlinsolspgmr}).
+%% \item \id{fcvDiurnal\_kry\_bp} is the \id{fcvDiurnal\_kry} example with {\fcvbp}.
+%% \item \id{fcvDiag\_non\_p} is a nonstiff parallel diagonal ODE example
+%%   (\id{ADAMS}/\id{FIXEDPOINT}).
+%% \item \id{fcvDiag\_kry\_p} is a stiff parallel diagonal ODE example (\id{BDF}/{\sunlinsolspgmr}).
+%% \item \id{fcvDiag\_kry\_bbd\_p} is the same as the \id{fcvDiag\_kry\_p} example
+%%        but using the {\fcvbbd} module.
+%% \end{itemize}
 
 \vspace{0.2in}\noindent
 In the following sections, we give detailed descriptions of some (but

diff --git a/doc/cvode/cv_examples.tex b/doc/cvode/cv_examples.tex
@@ -5,7 +5,7 @@
 \externaldocument{install}
 \externaldocument{cv_math}
 \externaldocument{cv_usage}
-\externaldocument{cv_fcmix}
+%\externaldocument{cv_fcmix}
 \externaldocument{cv_nvec}
 \externaldocument{cv_sunmat}
 \externaldocument{cv_sunlinsol}
@@ -40,7 +40,7 @@
 \include{cv_ex_parhyp}
 \include{cv_ex_cuda}
 \include{cv_ex_raja}
-\include{cv_ex_fortran}
+%\include{cv_ex_fortran}
 \include{cv_ex_tests}
 %===============================================================
 % References

diff --git a/doc/ida/Makefile b/doc/ida/Makefile
@@ -23,7 +23,9 @@ ida_ex_serial.tex   \
 ida_ex_parallel.tex \
 ida_ex_petsc.tex    \
 ida_ex_trilinos.tex    \
-ida_ex_fortran.tex  \
 ida_ex_codes.tex
 
+# Remove F77 example text
+# ida_ex_fortran.tex  \
+
 include ../Makefile.in
diff --git a/doc/ida/ida_ex_codes.tex b/doc/ida/ida_ex_codes.tex
@@ -26,12 +26,12 @@ \section{Listing of idaFoodWeb\_kry\_bbd\_p.c}\label{s:idaFoodWeb_bbd_p_c}
 
 %% Fortran examples
 
-\lstset{language=[77]Fortran}
+%% \lstset{language=[77]Fortran}
 
-\newpage
-\section{Listing of fidaRoberts\_dns.f}\label{s:fidaRoberts_f}
-\includeCode{../../examples/ida/fcmix_serial/fidaRoberts_dns.f}
+%% \newpage
+%% \section{Listing of fidaRoberts\_dns.f}\label{s:fidaRoberts_f}
+%% \includeCode{../../examples/ida/fcmix_serial/fidaRoberts_dns.f}
 
-\newpage
-\section{Listing of fidaHeat2D\_kry\_bbd\_p.f}\label{s:fidaHeat2D_bbd_p}
-\includeCode{../../examples/ida/fcmix_parallel/fidaHeat2D_kry_bbd_p.f}
+%% \newpage
+%% \section{Listing of fidaHeat2D\_kry\_bbd\_p.f}\label{s:fidaHeat2D_bbd_p}
+%% \includeCode{../../examples/ida/fcmix_parallel/fidaHeat2D_kry_bbd_p.f}
diff --git a/doc/ida/ida_ex_intro.tex b/doc/ida/ida_ex_intro.tex
@@ -7,9 +7,9 @@ \section{Introduction}\label{s:ex_intro}
 listings, on the example programs supplied with the {\ida} distribution
 package.
 
-The {\ida} distribution contains examples of four types: serial
-{\CC} examples, parallel {\CC} examples, {\F} examples,
-{\petsc} examples, and {\trilinos} examples. 
+The {\ida} distribution contains examples of the following types: serial
+{\CC} examples, parallel {\CC} examples, {\petsc} examples, and {\trilinos}
+examples.
 %%
 With the exception of ``demo''-type example files, the names of all the examples 
 distributed with {\sundials} are of the form \verb![slv][PbName]_[ls]_[prec]_[p]!, 
@@ -131,27 +131,27 @@ \section{Introduction}\label{s:ex_intro}
 
 \end{itemize}
 
-\vspace{0.2in}\noindent
-As part of the {\fida} module, in the four subdirectories \id{fcmix\_serial},
-\id{fcmix\_parallel}, \id{fcmix\_openmp}, and \id{fcmix\_pthreads},
-within the directory {\em srcdir}\id{/examples/ida},
-are the following four examples for the {\F}-{\CC} interface:
-%
-\begin{itemize}
-\item \id{fidaRoberts\_dns} is a serial chemical kinetics example ({\dense})
-       with rootfinding, equivalent to \id{idaRoberts\_dns}.
+%% As part of the {\fida} module, in the subdirectories \id{fcmix\_serial},
+%% \id{fcmix\_parallel}, \id{fcmix\_openmp}, and \id{fcmix\_pthreads},
+%% within the directory {\em srcdir}\id{/examples/ida},
+%% are the following four examples for the {\F}-{\CC} interface:
+%% %
+%% \begin{itemize}
+%% \item \id{fidaRoberts\_dns} is a serial chemical kinetics example ({\dense})
+%%        with rootfinding, equivalent to \id{idaRoberts\_dns}.
 
-\item \id{fidaHeat2D\_kry\_bbd\_p} is a parallel example ({\spgmr}/{\idabbdpre})
-       equivalent to the example \id{idaHeat2D\_kry\_bbd\_p}.
+%% \item \id{fidaHeat2D\_kry\_bbd\_p} is a parallel example ({\spgmr}/{\idabbdpre})
+%%        equivalent to the example \id{idaHeat2D\_kry\_bbd\_p}.
 
-\item \id{fidaRoberts\_dns\_openmp} is the same as \id{fidaRoberts\_dns} but
-       uses the NVECTOR module NVECTOR\_OPENMP.
+%% \item \id{fidaRoberts\_dns\_openmp} is the same as \id{fidaRoberts\_dns} but
+%%        uses the NVECTOR module NVECTOR\_OPENMP.
 
-\item \id{fidaRoberts\_dns\_pthreads} is the same as \id{fidaRoberts\_dns} but
-       uses the NVECTOR module NVECTOR\_PTHREADS.
+%% \item \id{fidaRoberts\_dns\_pthreads} is the same as \id{fidaRoberts\_dns} but
+%%        uses the NVECTOR module NVECTOR\_PTHREADS.
 
-\end{itemize}
-\
+%% \end{itemize}
+%% \
+\vspace{0.2in}\noindent
 Finally, in the subdirectory \id{petsc} of \id{examples/ida} are the
 following examples:
 \begin{itemize}

diff --git a/doc/ida/ida_examples.tex b/doc/ida/ida_examples.tex
@@ -5,7 +5,7 @@
 \externaldocument{install}
 \externaldocument{ida_math}
 \externaldocument{ida_usage}
-\externaldocument{ida_fcmix}
+%\externaldocument{ida_fcmix}
 \externaldocument{ida_nvec}
 \externaldocument{ida_sunmat}
 \externaldocument{ida_sunlinsol}
@@ -39,7 +39,7 @@
 \include{ida_ex_parallel}
 \include{ida_ex_petsc}
 \include{ida_ex_trilinos}
-\include{ida_ex_fortran}
+%\include{ida_ex_fortran}
 %===============================================================
 % References
 \bibliographystyle{plain}

diff --git a/doc/kinsol/Makefile b/doc/kinsol/Makefile
@@ -20,7 +20,9 @@ EX_FILES = \
 ${EXAMPLES}.tex \
 kin_ex_intro.tex \
 kin_ex_c.tex \
-kin_ex_cxx.tex \
-kin_ex_fortran.tex
+kin_ex_cxx.tex
+
+# Remove F77 examples
+# kin_ex_fortran.tex
 
 include ../Makefile.in
diff --git a/doc/kinsol/kin_ex_codes.tex b/doc/kinsol/kin_ex_codes.tex
@@ -16,14 +16,12 @@ \section{Listing of kinFoodWeb\_kry\_bbd\_p.c}\label{s:kinFoodWeb_kry_bbd_p_c}
 
 %% Fortran examples
 
-\lstset{language=[77]Fortran}
-
-\newpage
-\section{Listing of fkinDiagon\_kry.f}\label{s:fkinDiagon_kry_f}
-\includeCode{../../examples/kinsol/fcmix_serial/fkinDiagon_kry.f}
-
-\newpage
-\section{Listing of fkinDiagon\_kry\_p.f}\label{s:fkinDiagon_kry_p_f}
-\includeCode{../../examples/kinsol/fcmix_parallel/fkinDiagon_kry_p.f}
+%% \lstset{language=[77]Fortran}
 
+%% \newpage
+%% \section{Listing of fkinDiagon\_kry.f}\label{s:fkinDiagon_kry_f}
+%% \includeCode{../../examples/kinsol/fcmix_serial/fkinDiagon_kry.f}
 
+%% \newpage
+%% \section{Listing of fkinDiagon\_kry\_p.f}\label{s:fkinDiagon_kry_p_f}
+%% \includeCode{../../examples/kinsol/fcmix_parallel/fkinDiagon_kry_p.f}