From 74dd119cf66e036b0b728200aca19d7d7b948562 Mon Sep 17 00:00:00 2001
From: Timo Koch <timokoch@uio.no>
Date: Wed, 28 Jun 2023 22:56:16 +0200
Subject: [PATCH] [doxygen] Move restart section to doxygen
---
doc/doxygen/pages/input-output.md | 22 +++++++++++++++++++++-
doc/handbook/0_dumux-handbook.tex | 1 -
doc/handbook/5_restartsimulations.tex | 20 --------------------
3 files changed, 21 insertions(+), 22 deletions(-)
delete mode 100644 doc/handbook/5_restartsimulations.tex
diff --git a/doc/doxygen/pages/input-output.md b/doc/doxygen/pages/input-output.md
index 8e1a206dd8..639679b156 100644
--- a/doc/doxygen/pages/input-output.md
+++ b/doc/doxygen/pages/input-output.md
@@ -159,7 +159,7 @@ and Dumux::GridManager<Dune::YaspGrid<dim,Dune::TensorProductCoordinates<ctype,d
## Other input and output formats
-The following formats are supported for checkpointing, visualization, and general
+The following formats are supported for visualization, and general
data input and output.
### VTK file format (output)
@@ -248,3 +248,23 @@ If you want to read and write simple vectors, have a look at the header `dumux/i
`dune-istl` (the Dune Iterative Solver Template Library) supports writing and reading vectors
and matrices to/from different format. For example you can write a matrix in a sparse matrix format that
can be read by Matlab (see the header `dune/istl/io.hh`).
+
+## Restarting simulations (check-pointing)
+
+DuMux has some experimental support for check-pointing (restarting paused/stopped/crashed simulations).
+You can restart a DuMux simulation from any time point where a VTK file was written out.
+This is currently only supported for sequential, non-adaptive simulations. For adaptive simulation
+the full hierarchical grid has to be stored. This is usually done with the grid's `Dune::BackupRestoreFacility`.
+There is currently no special support by DuMux for that, but it is possible to implement
+a restart using `Dune::BackupRestoreFacility` with plain Dune.
+
+For VTK files the output can be read with the free function `Dumux::loadSolution`. Grids can be read with
+the `Dumux::VTKReader` or you can simply recreate the grid as you did in the first simulation run.
+
+Writing double-precision floating point numbers to VTK files is available since Dune release 2.7.
+If you are using that version, it is now possible to specify output precision in the input file using
+`Dumux::Vtk::Precision` followed by either `Float32`, `Float64`, `UInt32`, `UInt8` or `Int32`
+`Float32` is set as the default. We especially advice the use of `Float64` when working with restart files.
+
+The restart capabilities will hopefully be improved in future versions of DuMux $3$.
+We are looking forward to any contributions (especially HDF5 / XDMF support, improvement of VTK support).
diff --git a/doc/handbook/0_dumux-handbook.tex b/doc/handbook/0_dumux-handbook.tex
index 02f5579606..1f1068a22d 100644
--- a/doc/handbook/0_dumux-handbook.tex
+++ b/doc/handbook/0_dumux-handbook.tex
@@ -117,7 +117,6 @@ Universit\"at Stuttgart, Paffenwaldring 61, D-70569 Stuttgart, Germany}\\
\chapter{Overview and Infrastructure}
\input{5_structure}
\input{5_newfoldersetup}
-\input{5_restartsimulations}
\input{5_developingdumux}
\input{5_scripts}
\input{5_assemblinglinearsystem}
diff --git a/doc/handbook/5_restartsimulations.tex b/doc/handbook/5_restartsimulations.tex
deleted file mode 100644
index a0bc5c96b8..0000000000
--- a/doc/handbook/5_restartsimulations.tex
+++ /dev/null
@@ -1,20 +0,0 @@
-% SPDX-FileCopyrightInfo: Copyright © DuMux Project contributors, see AUTHORS.md in root folder
-% SPDX-License-Identifier: CC-BY-4.0
-
-\section{Restart \Dumux Simulations}
-\label{sc_restartsimulations}
-
-\Dumux has some experimental support for check-pointing (restarting paused/stopped/crashed simulations).
-You can restart a \Dumux simulation from any time point where a VTK file was written out.
-This is currently only supported for sequential, non-adaptive simulations. For adaptive simulation
-the full hierarchical grid has to be stored. This is usually done with the grid's \texttt{BackupRestoreFacility}.
-There is currently no special support by \Dumux for that, but it is possible to implement
-a restart using \texttt{BackupRestoreFacility} with plain Dune.
-
-For VTK files the output can be read with the free function \texttt{loadSolution}. Grids can be read with
-the \texttt{Dumux::VTKReader} or you can simply recreate the grid as you did in the first simulation run.
-
-Writing double-precision floating point numbers to VTK files is available since \Dune release 2.7. If you are using that version, it is now possible to specify output precision in the input file using \texttt{Vtk.Precision} followed by either \texttt{Float32}, \texttt{Float64}, \texttt{UInt32}, \texttt{UInt8} or \texttt{Int32}. \texttt{Float32} is set as the default. We especially advice the use of \texttt{Float64} when working with restart files.
-
-The restart capabilities will hopefully be improved in future versions of \Dumux-3.
-We are looking forward to any contributions (especially HDF5 / XDMF support, improvement of VTK support).
--
GitLab