From cb533f7c60f08adfb5980c78b861984a600ffa78 Mon Sep 17 00:00:00 2001 From: Timo Koch <timokoch@uio.no> Date: Wed, 28 Jun 2023 22:50:47 +0200 Subject: [PATCH] [handbook][cleanup] Remove supperfluous sections --- doc/handbook/0_dumux-handbook.tex | 6 --- doc/handbook/6_stepsofasimulation.tex | 67 --------------------------- 2 files changed, 73 deletions(-) delete mode 100644 doc/handbook/6_stepsofasimulation.tex diff --git a/doc/handbook/0_dumux-handbook.tex b/doc/handbook/0_dumux-handbook.tex index 154f27ebbe..02f5579606 100644 --- a/doc/handbook/0_dumux-handbook.tex +++ b/doc/handbook/0_dumux-handbook.tex @@ -115,11 +115,6 @@ Universit\"at Stuttgart, Paffenwaldring 61, D-70569 Stuttgart, Germany}\\ \newpage \chapter{Overview and Infrastructure} -This chapter provides an overview of the general structure in \Dumux (\ref{sc_structure}) -and gives help for basic work with \Dumux -(\ref{sc_newfoldersetup}-\ref{sc_developingdumux}). -Further, it presents useful external tools (\ref{sc_externaltools}) and basic -concepts (\ref{sc_linearsystem}). \input{5_structure} \input{5_newfoldersetup} \input{5_restartsimulations} @@ -131,7 +126,6 @@ concepts (\ref{sc_linearsystem}). This chapter contains detailed information for those who are interested in deeper modifications of underlying \Dumux models, classes, functions, etc. \input{6_temporaldiscretizations} -\input{6_stepsofasimulation} \bibliographystyle{plainnat} \bibliography{dumux-handbook} diff --git a/doc/handbook/6_stepsofasimulation.tex b/doc/handbook/6_stepsofasimulation.tex deleted file mode 100644 index 803e242289..0000000000 --- a/doc/handbook/6_stepsofasimulation.tex +++ /dev/null @@ -1,67 +0,0 @@ -% SPDX-FileCopyrightInfo: Copyright © DuMux Project contributors, see AUTHORS.md in root folder -% SPDX-License-Identifier: CC-BY-4.0 - -\section{Steps of a \Dumux Simulation} -\label{flow} - - -This chapter is supposed to give a short overview over how things are ``handed around'' in \Dumux. It -is not a comprehenisve guide through the modeling framework of \Dumux, but -hopefully it will help getting to grips with it. - -In Section \ref{content} the structure of \Dumux is shown from a \emph{content} -point of view. - -\subsection{Structure -- by Content} - -\label{content} -In Figure \ref{fig:algorithm}, the algorithmic representations of a monolithical -solution scheme is illustrated down to the element level. - -\begin{figure}[hbt] -\setcounter{thingCounter}{0} - -\scriptsize -\sffamily -\begin{center}\parbox{0cm}{ -\begin{tabbing} -\textbf{{\begin{turn}{45}\color{black}\numberThis{main}{init}\end{turn}}} \= -\textbf{{\begin{turn}{45}\color{dumuxBlue}\numberThis{time step}{prep}\end{turn}}} \= -\textbf{{\begin{turn}{45}\color{Mulberry}\numberThis{\textsc{Newton}}{elem}\end{turn}}} \= -\textbf{{\begin{turn}{45}\color{dumuxYellow}\numberThis{element}{calc}\end{turn}}} \= \\ -\\ -\color{black}initialize \\ -\color{black}\textbf{foreach} time step\\ - - \> \color{dumuxBlue}\textbf{foreach} \textsc{Newton} iteration \\ - - \> \> \color{Mulberry}\textbf{foreach} element \\ - - \> \> \> \color{dumuxYellow}- calculate element \\ - \> \> \> \color{dumuxYellow}\; residual vector and \\ - \> \> \> \color{dumuxYellow}\; Jacobian matrix\\ - \> \> \> \color{dumuxYellow}- assemble into global\\ - \> \> \> \color{dumuxYellow}\; residual vector and \\ - \> \> \> \color{dumuxYellow}\;{Jacobian} matrix \\ - - \> \> \color{Mulberry}\textbf{endfor} \\ - - \> \> \color{Mulberry}solve linear system\\ - \> \> \color{Mulberry}update solution\\ - \> \> \color{Mulberry}check for \textsc{Newton} convergence\\ - \> \color{dumuxBlue}\textbf{endfor}\\ - \> \color{dumuxBlue}- adapt time step size, \\ - \> \color{dumuxBlue}\; possibly redo with smaller step size\\ - \> \color{dumuxBlue}- write result\\ -\color{black}\textbf{endfor}\\ -\color{black}finalize -\end{tabbing}} -\end{center} -\caption{Structure of a monolithical solution scheme in \Dumux.} -\label{fig:algorithm} -\end{figure} - -\subsection{Structure -- by Implementation} -A possible starting point to understand how the above mentioned algorithm is implemented within \Dumux, -is the example main file -\url{https://git.iws.uni-stuttgart.de/dumux-repositories/dumux-course/-/blob/releases/\DumuxVersion/exercises/exercise-mainfile/exercise1pamain.cc} -- GitLab