mirror of
https://github.com/OPM/opm-simulators.git
synced 2025-02-25 18:55:30 -06:00
chapter structure of handbook filled a bit
This commit is contained in:
committed by
Andreas Lauser
parent
72c6a73ad1
commit
2a1452fed2
@@ -129,6 +129,23 @@
|
||||
|
||||
}
|
||||
|
||||
@article{Pardiso,
|
||||
title = {Solving unsymmetric sparse systems of linear equations with {PARDISO}},
|
||||
journal = {Future Generation Computer Systems},
|
||||
volume = {20},
|
||||
number = {3},
|
||||
pages = {475 - 487},
|
||||
year = {2004},
|
||||
issn = {0167-739X},
|
||||
doi = {DOI: 10.1016/j.future.2003.07.011},
|
||||
url = {http://www.sciencedirect.com/science/article/B6V06-49NXY7J-F/2/e8260e5d8f19639019cddea4776c024c},
|
||||
author = {Olaf Schenk and Klaus G\"artner},
|
||||
keywords = {Computational sciences},
|
||||
keywords = {Numerical linear algebra},
|
||||
keywords = {Direct solver},
|
||||
keywords = {Unsymmetric linear systems}
|
||||
}
|
||||
|
||||
@article{WHITAKER1985,
|
||||
author = {S. Whitaker},
|
||||
title = {Flow in porous media I: A theoretical derivation of Darcy's law},
|
||||
|
||||
@@ -1,2 +1,103 @@
|
||||
\chapter{Structure}
|
||||
|
||||
We briefly describe the structure of \Dumux in terms
|
||||
of subdirectories, source files, and tests. For more details,
|
||||
the Doxygen documentation should be considered.
|
||||
\Dumux comes in form of a DUNE module \texttt{dune-mux}.
|
||||
It has a similar structure as other DUNE modules like \texttt{dune-grid}.
|
||||
The following subdirectories are within the module's root directory,
|
||||
from now on assumed to be \texttt{dune-mux}:
|
||||
\begin{itemize}
|
||||
\item \texttt{CMake}: the configuration options
|
||||
for building \Dumux using CMake. See the file \texttt{INSTALL.cmake} in
|
||||
the root directory \texttt{dune-mux} for details. Of course,
|
||||
it is also possible to use the DUNE buildsystem just like for the other
|
||||
DUNE modules.
|
||||
\item \texttt{doc}: contains the Doxygen documentation in \texttt{doxygen},
|
||||
this handbook in \texttt{handbook}, and the \Dumux logo in various formats in
|
||||
\texttt{logo}. The html documentation produced by Doxygen can be accessed as usual,
|
||||
namely, by opening \texttt{doc/doxygen/html/index.html} with a web browser.
|
||||
\item \texttt{dumux}: the \Dumux source files. See Section \ref{sec:dumux} for details.
|
||||
\item \texttt{test}: tests for each numerical model and the property system.
|
||||
See Section \ref{sec:test} for details.
|
||||
\item \texttt{tutorial}: contains the tutorials described in Chapter \ref{chp:tutorial}.
|
||||
\item \texttt{util}: contains various auxiliary programs which are not
|
||||
directly related to the core \Dumux libraries like programs to generate
|
||||
tables for material laws, to fix the indentation of the source code,
|
||||
etc.
|
||||
\end{itemize}
|
||||
|
||||
|
||||
|
||||
\section{The directory \texttt{dumux}}\label{sec:dumux}
|
||||
|
||||
The directory \texttt{dumux} contains the \Dumux source files. It consists
|
||||
of the following subdirectories:
|
||||
\begin{itemize}
|
||||
\item \texttt{auxiliary}:
|
||||
general stuff like the property system and the time management for the
|
||||
fully coupled models.
|
||||
|
||||
\item \texttt{boxmodels}:
|
||||
the general fully implicit box method is contained in the subdirectory
|
||||
\texttt{boxscheme}, while each of the other subdirectories contains
|
||||
a derived specific numerical model.
|
||||
|
||||
\item \texttt{diffusion}: numerical models to solve the pressure equation
|
||||
as part of the fractional flow formulation. The particular models are contained
|
||||
in corresponding subdirectories, which are distinguished by the respectively employed
|
||||
discretization scheme.
|
||||
|
||||
\item \texttt{fractionalflow}:
|
||||
the (non-compositional) fractional flow model, which utilizes the IMPES method
|
||||
contained in the subdirectory \texttt{impes}.
|
||||
|
||||
\item \texttt{functions}:
|
||||
the Crouzeix--Raviart function implemented in the style of \texttt{dune-disc}'s P1 function.
|
||||
|
||||
\item \texttt{fvgeometry}:
|
||||
employed by the box method to extract the dual mesh geometry information out of the
|
||||
primal one.
|
||||
|
||||
\item \texttt{io}: Additional in-/output possibilities like restart files
|
||||
and a VTKWriter extension.
|
||||
|
||||
\item \texttt{material}: everything related to material parameters and
|
||||
constitutive equations. The base classes for matrix and fluid properties
|
||||
can be found in \texttt{property\_baseclasses.hh}, while the base classes
|
||||
for constitutive relations are in \texttt{twophaserelations.hh} and \texttt{multicomponentrelations.hh}.
|
||||
Derived particular properties and relations are contained in
|
||||
\texttt{matrixproperties.hh} and in the subdirectories
|
||||
\texttt{fluids} and \texttt{constrel}.
|
||||
|
||||
|
||||
\item \texttt{nonlinear}: Newton's method.
|
||||
|
||||
|
||||
\item \texttt{operators}: based on \texttt{dune-disc}, assembly operators for Crouzeix--Raviart
|
||||
elements and mimetic finite differences.
|
||||
|
||||
|
||||
\item \texttt{pardiso}: interface to the Pardiso direct solver library, \cite{Pardiso}.
|
||||
|
||||
|
||||
\item \texttt{shapefunctions}: Crouzeix--Raviart element shape functions.
|
||||
|
||||
|
||||
\item \texttt{timedisc}: time discretization for the decoupled models.
|
||||
|
||||
|
||||
\item \texttt{transport}: numerical models to solve the pressure equation
|
||||
as part of the fractional flow formulation analogous to the \texttt{diffusion}
|
||||
directory. Moreover, the compositional decoupled models are included here.
|
||||
|
||||
|
||||
\end{itemize}
|
||||
|
||||
|
||||
|
||||
\section{The directory \texttt{test}}\label{sec:test}
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
\chapter[Tutorial]{Tutorial}
|
||||
\chapter[Tutorial]{Tutorial}\label{chp:tutorial}
|
||||
|
||||
In \Dumux two sorts of models are implemented: Fully coupled models, and decoupled models. In the fully coupled models a flow system is described by a system of strongly coupled equations which can be mass balance equations, balance equations of components, energy balance equations, etc. In contrast a decoupled model consists of a pressure equation which is decoupled or only weakly coupled to a saturation equation, concentration equations, energy balance equations, etc.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user