OilfieldToolsNet/opm-simulators
4
0
Fork 0
mirror of https://github.com/OPM/opm-simulators.git synced 2025-02-25 18:55:30 -06:00
Code Issues Packages Projects Releases Wiki Activity

Fix a few doxygen issues with the tutorials

Browse Source
This commit is contained in:
Andreas Lauser 2013-04-15 17:49:41 +02:00
parent 31e7eba497
commit 616a92cf80
4 changed files with 11 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
tutorials/tutorial1.cpp
View File

@ -1,5 +1,5 @@
/// \cond SKIP
/*! /*!
\cond SKIP
Copyright 2012 SINTEF ICT, Applied Mathematics. Copyright 2012 SINTEF ICT, Applied Mathematics.
This file is part of the Open Porous Media project (OPM). This file is part of the Open Porous Media project (OPM).
@ -16,11 +16,8 @@
You should have received a copy of the GNU General Public License You should have received a copy of the GNU General Public License
along with OPM. If not, see <http://www.gnu.org/licenses/>. along with OPM. If not, see <http://www.gnu.org/licenses/>.
\endcond
*/ */
#if HAVE_CONFIG_H ///\endcond
#include "config.h"
#endif // HAVE_CONFIG_H
/// \page tutorial1 A simple cartesian grid /// \page tutorial1 A simple cartesian grid
/// This tutorial explains how to construct a simple Cartesian grid, /// This tutorial explains how to construct a simple Cartesian grid,
@ -34,6 +31,8 @@
/// \snippet tutorial1.cpp including headers /// \snippet tutorial1.cpp including headers
/// \internal [including headers] /// \internal [including headers]
#include "config.h"
#include <opm/core/grid.h> #include <opm/core/grid.h>
#include <opm/core/grid/GridManager.hpp> #include <opm/core/grid/GridManager.hpp>
#include <opm/core/io/vtk/writeVtkData.hpp> #include <opm/core/io/vtk/writeVtkData.hpp>

7
tutorials/tutorial2.cpp
View File

@ -1,5 +1,5 @@
/// \cond SKIP
/*! /*!
\cond SKIP
Copyright 2012 SINTEF ICT, Applied Mathematics. Copyright 2012 SINTEF ICT, Applied Mathematics.
This file is part of the Open Porous Media project (OPM). This file is part of the Open Porous Media project (OPM).
@ -16,8 +16,9 @@
You should have received a copy of the GNU General Public License You should have received a copy of the GNU General Public License
along with OPM. If not, see <http://www.gnu.org/licenses/>. along with OPM. If not, see <http://www.gnu.org/licenses/>.
\endcond
*/ */
/// \endcond
/// \page tutorial2 Flow Solver for a single phase /// \page tutorial2 Flow Solver for a single phase
/// \details The flow equations consist of the mass conservation equation /// \details The flow equations consist of the mass conservation equation
/// \f[\nabla\cdot {\bf u}=q\f] and the Darcy law \f[{\bf u} =- \frac{1}{\mu}K\nabla p.\f] Here, /// \f[\nabla\cdot {\bf u}=q\f] and the Darcy law \f[{\bf u} =- \frac{1}{\mu}K\nabla p.\f] Here,
@ -27,9 +28,7 @@
/// We solve the flow equations for a Cartesian grid and we set the source term /// We solve the flow equations for a Cartesian grid and we set the source term
/// \f$q\f$ be zero except at the left-lower and right-upper corner, where it is equal /// \f$q\f$ be zero except at the left-lower and right-upper corner, where it is equal
/// with opposite sign (inflow equal to outflow). /// with opposite sign (inflow equal to outflow).
#if HAVE_CONFIG_H
#include "config.h" #include "config.h"
#endif // HAVE_CONFIG_H
#include <opm/core/grid.h> #include <opm/core/grid.h>
#include <opm/core/grid/GridManager.hpp> #include <opm/core/grid/GridManager.hpp>

6
tutorials/tutorial3.cpp
View File

@ -1,5 +1,5 @@
/// \cond SKIP
/*! /*!
\cond SKIP
Copyright 2012 SINTEF ICT, Applied Mathematics. Copyright 2012 SINTEF ICT, Applied Mathematics.
This file is part of the Open Porous Media project (OPM). This file is part of the Open Porous Media project (OPM).
@ -16,11 +16,9 @@
You should have received a copy of the GNU General Public License You should have received a copy of the GNU General Public License
along with OPM. If not, see <http://www.gnu.org/licenses/>. along with OPM. If not, see <http://www.gnu.org/licenses/>.
\endcond
*/ */
#if HAVE_CONFIG_H /// \endcond
#include "config.h" #include "config.h"
#endif // HAVE_CONFIG_H
#include <iostream> #include <iostream>
#include <iomanip> #include <iomanip>

6
tutorials/tutorial4.cpp
View File

@ -1,5 +1,5 @@
/// \cond SKIP
/*! /*!
\cond SKIP
Copyright 2012 SINTEF ICT, Applied Mathematics. Copyright 2012 SINTEF ICT, Applied Mathematics.
This file is part of the Open Porous Media project (OPM). This file is part of the Open Porous Media project (OPM).
@ -16,11 +16,9 @@
You should have received a copy of the GNU General Public License You should have received a copy of the GNU General Public License
along with OPM. If not, see <http://www.gnu.org/licenses/>. along with OPM. If not, see <http://www.gnu.org/licenses/>.
\endcond
*/ */
#if HAVE_CONFIG_H /// \endcond
#include "config.h" #include "config.h"
#endif // HAVE_CONFIG_H
#include <iostream> #include <iostream>
#include <iomanip> #include <iomanip>