From 4f2905651c90f23667d9f82ba80eff0ede1ddaf8 Mon Sep 17 00:00:00 2001
From: Bernd Flemisch <bernd@iws.uni-stuttgart.de>
Date: Fri, 12 Nov 2010 07:13:58 +0000
Subject: [PATCH] enhanced documentation
git-svn-id: svn://svn.iws.uni-stuttgart.de/DUMUX/dumux/trunk@4678 2fb0f335-1f38-0410-981e-8018bf24f1b0
---
.../decoupled/2p2c/boundaryconditions2p2c.hh | 6 +++++-
test/boxmodels/1p/test_1p.cc | 5 +++++
test/boxmodels/1p2c/test_1p2c.cc | 5 +++++
test/boxmodels/2p/test_2p.cc | 5 +++++
test/boxmodels/2p2c/test_2p2c.cc | 5 +++++
test/boxmodels/2p2cni/test_2p2cni.cc | 5 +++++
test/boxmodels/2pni/test_2pni.cc | 5 +++++
.../richards/richardslensspatialparameters.hh | 4 +++-
test/boxmodels/richards/test_richards.cc | 5 +++++
test/common/pardiso/test_pardiso.cc | 20 +++++++++++++++++++
.../propertysystem/test_propertysystem.cc | 2 ++
test/common/spline/test_spline.cc | 2 ++
test/decoupled/1p/benchmarkresult.hh | 20 +++++++++++++++++++
test/decoupled/1p/test_1p.cc | 5 +++++
test/decoupled/1p/test_1p_problem.hh | 9 +++++++--
test/decoupled/1p/test_diffusion.cc | 5 +++++
test/decoupled/1p/test_diffusion_problem.hh | 5 +++++
.../1p/test_diffusion_spatialparams.hh | 5 +++++
test/decoupled/2p/test_impes.cc | 5 +++++
test/decoupled/2p/test_impes_problem.hh | 5 +++++
test/decoupled/2p/test_impes_spatialparams.hh | 5 +++++
test/decoupled/2p/test_transport.cc | 5 +++++
test/decoupled/2p/test_transport_problem.hh | 5 +++++
.../2p/test_transport_spatialparams.hh | 5 +++++
test/decoupled/2p2c/test_dec2p2c.cc | 5 +++++
.../2p2c/test_dec2p2c_spatialparams.hh | 5 +++++
test/decoupled/2p2c/test_dec2p2cproblem.hh | 5 +++++
test/decoupled/2p2c/test_multiphysics2p2c.cc | 5 +++++
.../2p2c/test_multiphysics2p2cproblem.hh | 5 +++++
tutorial/tutorial_decoupled.cc | 5 +++++
tutorial/tutorialproblem_decoupled.hh | 5 +++++
.../tutorialspatialparameters_decoupled.hh | 5 +++++
32 files changed, 184 insertions(+), 4 deletions(-)
diff --git a/dumux/decoupled/2p2c/boundaryconditions2p2c.hh b/dumux/decoupled/2p2c/boundaryconditions2p2c.hh
index 34affed587..7dc5fcae3d 100644
--- a/dumux/decoupled/2p2c/boundaryconditions2p2c.hh
+++ b/dumux/decoupled/2p2c/boundaryconditions2p2c.hh
@@ -13,7 +13,11 @@
* *
* This program is distributed WITHOUT ANY WARRANTY. *
*****************************************************************************/
-
+/*!
+ * \file
+ *
+ * \brief boundary condition flags for the decoupled 2p2c model
+ */
#ifndef DUMUX_BOUNDARYCONDITIONS2P2C_HH
#define DUMUX_BOUNDARYCONDITIONS2P2C_HH
diff --git a/test/boxmodels/1p/test_1p.cc b/test/boxmodels/1p/test_1p.cc
index 86385e9d0e..ea2fa62b0b 100644
--- a/test/boxmodels/1p/test_1p.cc
+++ b/test/boxmodels/1p/test_1p.cc
@@ -14,6 +14,11 @@
* *
* This program is distributed WITHOUT ANY WARRANTY. *
*****************************************************************************/
+/*!
+ * \file
+ *
+ * \brief test for the one-phase box model
+ */
#include "config.h"
#include "1ptestproblem.hh"
diff --git a/test/boxmodels/1p2c/test_1p2c.cc b/test/boxmodels/1p2c/test_1p2c.cc
index 3e12b437db..a12aef12e8 100644
--- a/test/boxmodels/1p2c/test_1p2c.cc
+++ b/test/boxmodels/1p2c/test_1p2c.cc
@@ -15,6 +15,11 @@
* *
* This program is distributed WITHOUT ANY WARRANTY. *
*****************************************************************************/
+/*!
+ * \file
+ *
+ * \brief test for the 1p2c box model
+ */
#include "config.h"
#include "tissue_tumor_problem.hh"
diff --git a/test/boxmodels/2p/test_2p.cc b/test/boxmodels/2p/test_2p.cc
index f469a706ab..425981318e 100644
--- a/test/boxmodels/2p/test_2p.cc
+++ b/test/boxmodels/2p/test_2p.cc
@@ -15,6 +15,11 @@
* *
* This program is distributed WITHOUT ANY WARRANTY. *
*****************************************************************************/
+/*!
+ * \file
+ *
+ * \brief test for the two-phase box model
+ */
#include "config.h"
#define CUBES 1
diff --git a/test/boxmodels/2p2c/test_2p2c.cc b/test/boxmodels/2p2c/test_2p2c.cc
index 8f0da12d47..accd725a83 100644
--- a/test/boxmodels/2p2c/test_2p2c.cc
+++ b/test/boxmodels/2p2c/test_2p2c.cc
@@ -13,6 +13,11 @@
* *
* This program is distributed WITHOUT ANY WARRANTY. *
*****************************************************************************/
+/*!
+ * \file
+ *
+ * \brief test for the 2p2c box model
+ */
#include "config.h"
#include "injectionproblem.hh"
#include <dumux/common/start.hh>
diff --git a/test/boxmodels/2p2cni/test_2p2cni.cc b/test/boxmodels/2p2cni/test_2p2cni.cc
index 1ddbaf26cf..f552fb6c7d 100644
--- a/test/boxmodels/2p2cni/test_2p2cni.cc
+++ b/test/boxmodels/2p2cni/test_2p2cni.cc
@@ -16,6 +16,11 @@
* *
* This program is distributed WITHOUT ANY WARRANTY. *
*****************************************************************************/
+/*!
+ * \file
+ *
+ * \brief test for the 2p2cni box model
+ */
#include "config.h"
#include "waterairproblem.hh"
#include <dumux/common/start.hh>
diff --git a/test/boxmodels/2pni/test_2pni.cc b/test/boxmodels/2pni/test_2pni.cc
index 15006f67a6..1d1d316ad0 100644
--- a/test/boxmodels/2pni/test_2pni.cc
+++ b/test/boxmodels/2pni/test_2pni.cc
@@ -15,6 +15,11 @@
* *
* This program is distributed WITHOUT ANY WARRANTY. *
*****************************************************************************/
+/*!
+ * \file
+ *
+ * \brief test for the 2pni box model
+ */
#include "config.h"
#include "injectionproblem2pni.hh"
#include <dumux/common/start.hh>
diff --git a/test/boxmodels/richards/richardslensspatialparameters.hh b/test/boxmodels/richards/richardslensspatialparameters.hh
index 54db9813f4..e672a75177 100644
--- a/test/boxmodels/richards/richardslensspatialparameters.hh
+++ b/test/boxmodels/richards/richardslensspatialparameters.hh
@@ -17,7 +17,9 @@
* This program is distributed WITHOUT ANY WARRANTY. *
*****************************************************************************/
/*!
- * \brief The spatial parameters for the RichardsLensProblem
+ * \file
+ *
+ * \brief spatial parameters for the RichardsLensProblem
*/
#ifndef DUMUX_RICHARDS_LENS_SPATIAL_PARAMETERS_HH
#define DUMUX_RICHARDS_LENS_SPATIAL_PARAMETERS_HH
diff --git a/test/boxmodels/richards/test_richards.cc b/test/boxmodels/richards/test_richards.cc
index f967971877..0ccf21c14d 100644
--- a/test/boxmodels/richards/test_richards.cc
+++ b/test/boxmodels/richards/test_richards.cc
@@ -13,6 +13,11 @@
* *
* This program is distributed WITHOUT ANY WARRANTY. *
*****************************************************************************/
+/*!
+ * \file
+ *
+ * \brief test for the Richards box model
+ */
#include "config.h"
#include "richardslensproblem.hh"
diff --git a/test/common/pardiso/test_pardiso.cc b/test/common/pardiso/test_pardiso.cc
index f0216dc07a..299915b06f 100644
--- a/test/common/pardiso/test_pardiso.cc
+++ b/test/common/pardiso/test_pardiso.cc
@@ -1,3 +1,23 @@
+// $Id$
+/*****************************************************************************
+ * Copyright (C) 2008 by Bernd Flemisch *
+ * Institute of Hydraulic Engineering *
+ * University of Stuttgart, Germany *
+ * email: andreas.lauser _at_ iws.uni-stuttgart.de *
+ * *
+ * This program is free software; you can redistribute it and/or modify *
+ * it under the terms of the GNU General Public License as published by *
+ * the Free Software Foundation; either version 2 of the License, or *
+ * (at your option) any later version, as long as this copyright notice *
+ * is included in its original form. *
+ * *
+ * This program is distributed WITHOUT ANY WARRANTY. *
+ *****************************************************************************/
+/*!
+ * \file
+ *
+ * \brief test for the Pardiso preconditioner
+ */
#include "config.h"
#include <stdio.h>
#include <stdlib.h>
diff --git a/test/common/propertysystem/test_propertysystem.cc b/test/common/propertysystem/test_propertysystem.cc
index 782fe03ab3..ec777b1a86 100644
--- a/test/common/propertysystem/test_propertysystem.cc
+++ b/test/common/propertysystem/test_propertysystem.cc
@@ -14,6 +14,8 @@
* This program is distributed WITHOUT ANY WARRANTY. *
*****************************************************************************/
/*!
+ * \file
+ *
* \brief This file tests the properties system.
*
* We define a few type tags and property tags, then we attach values
diff --git a/test/common/spline/test_spline.cc b/test/common/spline/test_spline.cc
index a2da44d402..0383a9c480 100644
--- a/test/common/spline/test_spline.cc
+++ b/test/common/spline/test_spline.cc
@@ -14,6 +14,8 @@
* This program is distributed WITHOUT ANY WARRANTY. *
*****************************************************************************/
/*!
+ * \file
+ *
* \brief This is a program to test the polynomial spline interpolation.
*
* It just prints some function to stdout. You can look at the result
diff --git a/test/decoupled/1p/benchmarkresult.hh b/test/decoupled/1p/benchmarkresult.hh
index c47fc1057b..e71530b4cc 100644
--- a/test/decoupled/1p/benchmarkresult.hh
+++ b/test/decoupled/1p/benchmarkresult.hh
@@ -1,3 +1,23 @@
+// $Id$
+/****************************************************************************
+* Copyright (C) 2007-2010 by Bernd Flemisch *
+* Institute of Hydraulic Engineering *
+* University of Stuttgart, Germany *
+* email: <givenname>.<name>@iws.uni-stuttgart.de *
+* *
+* This program is free software; you can redistribute it and/or modify *
+* it under the terms of the GNU General Public License as published by *
+* the Free Software Foundation; either version 2 of the License, or *
+* (at your option) any later version, as long as this copyright notice *
+* is included in its original form. *
+* *
+* This program is distributed WITHOUT ANY WARRANTY. *
+*****************************************************************************/
+/*!
+ * \file
+ *
+ * \brief Calculate errors for a FVCA5 benchmark problem.
+ */
#ifndef DUMUX_BENCHMARKRESULT_HH
#define DUMUX_BENCHMARKRESULT_HH
diff --git a/test/decoupled/1p/test_1p.cc b/test/decoupled/1p/test_1p.cc
index 12af1d2074..2b512b24ee 100644
--- a/test/decoupled/1p/test_1p.cc
+++ b/test/decoupled/1p/test_1p.cc
@@ -15,6 +15,11 @@
* *
* This program is distributed WITHOUT ANY WARRANTY. *
*****************************************************************************/
+/*!
+ * \file
+ *
+ * \brief test for the decoupled one-phase model.
+ */
#include "config.h"
#include <iostream>
#include <boost/format.hpp>
diff --git a/test/decoupled/1p/test_1p_problem.hh b/test/decoupled/1p/test_1p_problem.hh
index e507f5878c..ae51fe6134 100644
--- a/test/decoupled/1p/test_1p_problem.hh
+++ b/test/decoupled/1p/test_1p_problem.hh
@@ -15,8 +15,13 @@
* *
* This program is distributed WITHOUT ANY WARRANTY. *
*****************************************************************************/
-#ifndef DUMUX_TEST_2P_PROBLEM_HH
-#define DUMUX_TEST_2P_PROBLEM_HH
+/*!
+ * \file
+ *
+ * \brief test problem for the decoupled one-phase model.
+ */
+#ifndef DUMUX_TEST_1P_PROBLEM_HH
+#define DUMUX_TEST_1P_PROBLEM_HH
#if HAVE_UG
#include <dune/grid/uggrid.hh>
diff --git a/test/decoupled/1p/test_diffusion.cc b/test/decoupled/1p/test_diffusion.cc
index 51ed33f4b4..47cf9e7592 100644
--- a/test/decoupled/1p/test_diffusion.cc
+++ b/test/decoupled/1p/test_diffusion.cc
@@ -15,6 +15,11 @@
* *
* This program is distributed WITHOUT ANY WARRANTY. *
*****************************************************************************/
+/*!
+ * \file
+ *
+ * \brief test for diffusion models
+ */
#include "config.h"
#include <iostream>
#include <boost/format.hpp>
diff --git a/test/decoupled/1p/test_diffusion_problem.hh b/test/decoupled/1p/test_diffusion_problem.hh
index 2567f472f3..238e472502 100644
--- a/test/decoupled/1p/test_diffusion_problem.hh
+++ b/test/decoupled/1p/test_diffusion_problem.hh
@@ -15,6 +15,11 @@
* *
* This program is distributed WITHOUT ANY WARRANTY. *
*****************************************************************************/
+/*!
+ * \file
+ *
+ * \brief test problem for diffusion models from the FVCA5 benchmark.
+ */
#ifndef DUMUX_TEST_2P_PROBLEM_HH
#define DUMUX_TEST_2P_PROBLEM_HH
diff --git a/test/decoupled/1p/test_diffusion_spatialparams.hh b/test/decoupled/1p/test_diffusion_spatialparams.hh
index 5e1813b473..17f1725e07 100644
--- a/test/decoupled/1p/test_diffusion_spatialparams.hh
+++ b/test/decoupled/1p/test_diffusion_spatialparams.hh
@@ -13,6 +13,11 @@
* *
* This program is distributed WITHOUT ANY WARRANTY. *
*****************************************************************************/
+/*!
+ * \file
+ *
+ * \brief spatial parameters for the test problem for diffusion models.
+ */
#ifndef TEST_DIFFUSION_SPATIALPARAMETERS_HH
#define TEST_DIFFUSION_SPATIALPARAMETERS_HH
diff --git a/test/decoupled/2p/test_impes.cc b/test/decoupled/2p/test_impes.cc
index 0915f8868a..f4b1df40ac 100644
--- a/test/decoupled/2p/test_impes.cc
+++ b/test/decoupled/2p/test_impes.cc
@@ -15,6 +15,11 @@
* *
* This program is distributed WITHOUT ANY WARRANTY. *
*****************************************************************************/
+/*!
+ * \file
+ *
+ * \brief test for the sequential 2p model
+ */
#include "config.h"
#include "test_impes_problem.hh"
diff --git a/test/decoupled/2p/test_impes_problem.hh b/test/decoupled/2p/test_impes_problem.hh
index 0c0f12089f..1636454084 100644
--- a/test/decoupled/2p/test_impes_problem.hh
+++ b/test/decoupled/2p/test_impes_problem.hh
@@ -15,6 +15,11 @@
* *
* This program is distributed WITHOUT ANY WARRANTY. *
*****************************************************************************/
+/*!
+ * \file
+ *
+ * \brief test problem for the sequential 2p model
+ */
#ifndef DUMUX_TEST_IMPES_PROBLEM_HH
#define DUMUX_TEST_IMPES_PROBLEM_HH
diff --git a/test/decoupled/2p/test_impes_spatialparams.hh b/test/decoupled/2p/test_impes_spatialparams.hh
index 8fbcefaae0..edc328ddd8 100644
--- a/test/decoupled/2p/test_impes_spatialparams.hh
+++ b/test/decoupled/2p/test_impes_spatialparams.hh
@@ -13,6 +13,11 @@
* *
* This program is distributed WITHOUT ANY WARRANTY. *
*****************************************************************************/
+/*!
+ * \file
+ *
+ * \brief spatial parameters for the sequential 2p test
+ */
#ifndef TEST_IMPES_SPATIALPARAMETERS_HH
#define TEST_IMPES_SPATIALPARAMETERS_HH
diff --git a/test/decoupled/2p/test_transport.cc b/test/decoupled/2p/test_transport.cc
index f51a3df403..9dbe9fa94c 100644
--- a/test/decoupled/2p/test_transport.cc
+++ b/test/decoupled/2p/test_transport.cc
@@ -15,6 +15,11 @@
* *
* This program is distributed WITHOUT ANY WARRANTY. *
*****************************************************************************/
+/*!
+ * \file
+ *
+ * \brief test for the explicit transport model
+ */
#include "config.h"
#include "test_transport_problem.hh"
diff --git a/test/decoupled/2p/test_transport_problem.hh b/test/decoupled/2p/test_transport_problem.hh
index e055f93fe1..f1ae6af9cf 100644
--- a/test/decoupled/2p/test_transport_problem.hh
+++ b/test/decoupled/2p/test_transport_problem.hh
@@ -15,6 +15,11 @@
* *
* This program is distributed WITHOUT ANY WARRANTY. *
*****************************************************************************/
+/*!
+ * \file
+ *
+ * \brief test problem for the explicit transport model
+ */
#ifndef DUMUX_TEST_TRANSPORT_PROBLEM_HH
#define DUMUX_TEST_TRANSPORT_PROBLEM_HH
diff --git a/test/decoupled/2p/test_transport_spatialparams.hh b/test/decoupled/2p/test_transport_spatialparams.hh
index cd11c94a74..0424c3519b 100644
--- a/test/decoupled/2p/test_transport_spatialparams.hh
+++ b/test/decoupled/2p/test_transport_spatialparams.hh
@@ -13,6 +13,11 @@
* *
* This program is distributed WITHOUT ANY WARRANTY. *
*****************************************************************************/
+/*!
+ * \file
+ *
+ * \brief spatial parameters for the explicit transport test
+ */
#ifndef TEST_TRANSPORT_SPATIALPARAMETERS_HH
#define TEST_TRANSPORT_SPATIALPARAMETERS_HH
diff --git a/test/decoupled/2p2c/test_dec2p2c.cc b/test/decoupled/2p2c/test_dec2p2c.cc
index 77add08fe4..c40f0fefa9 100644
--- a/test/decoupled/2p2c/test_dec2p2c.cc
+++ b/test/decoupled/2p2c/test_dec2p2c.cc
@@ -15,6 +15,11 @@
* *
* This program is distributed WITHOUT ANY WARRANTY. *
*****************************************************************************/
+/*!
+ * \file
+ *
+ * \brief test for the sequential 2p2c model
+ */
#include "config.h"
#include "test_dec2p2cproblem.hh"
diff --git a/test/decoupled/2p2c/test_dec2p2c_spatialparams.hh b/test/decoupled/2p2c/test_dec2p2c_spatialparams.hh
index f08bed0e56..dca0ec2492 100644
--- a/test/decoupled/2p2c/test_dec2p2c_spatialparams.hh
+++ b/test/decoupled/2p2c/test_dec2p2c_spatialparams.hh
@@ -13,6 +13,11 @@
* *
* This program is distributed WITHOUT ANY WARRANTY. *
*****************************************************************************/
+/*!
+ * \file
+ *
+ * \brief spatial parameters for the sequential 2p2c test
+ */
#ifndef TEST_2P2C_SPATIALPARAMETERS_HH
#define TEST_2P2C_SPATIALPARAMETERS_HH
diff --git a/test/decoupled/2p2c/test_dec2p2cproblem.hh b/test/decoupled/2p2c/test_dec2p2cproblem.hh
index 017e0bc194..ac23feb361 100644
--- a/test/decoupled/2p2c/test_dec2p2cproblem.hh
+++ b/test/decoupled/2p2c/test_dec2p2cproblem.hh
@@ -15,6 +15,11 @@
* *
* This program is distributed WITHOUT ANY WARRANTY. *
*****************************************************************************/
+/*!
+ * \file
+ *
+ * \brief test problem for the sequential 2p2c model
+ */
#ifndef DUMUX_TEST_2P2C_PROBLEM_HH
#define DUMUX_TEST_2P2C_PROBLEM_HH
diff --git a/test/decoupled/2p2c/test_multiphysics2p2c.cc b/test/decoupled/2p2c/test_multiphysics2p2c.cc
index 44e5950e42..43dacd6b59 100644
--- a/test/decoupled/2p2c/test_multiphysics2p2c.cc
+++ b/test/decoupled/2p2c/test_multiphysics2p2c.cc
@@ -15,6 +15,11 @@
* *
* This program is distributed WITHOUT ANY WARRANTY. *
*****************************************************************************/
+/*!
+ * \file
+ *
+ * \brief test for the multiphysics 2p2c model
+ */
#include "config.h"
#include "test_multiphysics2p2cproblem.hh"
diff --git a/test/decoupled/2p2c/test_multiphysics2p2cproblem.hh b/test/decoupled/2p2c/test_multiphysics2p2cproblem.hh
index 74dabd4284..1e293ff3a0 100644
--- a/test/decoupled/2p2c/test_multiphysics2p2cproblem.hh
+++ b/test/decoupled/2p2c/test_multiphysics2p2cproblem.hh
@@ -15,6 +15,11 @@
* *
* This program is distributed WITHOUT ANY WARRANTY. *
*****************************************************************************/
+/*!
+ * \file
+ *
+ * \brief test problem for the multiphysics 2p2c model
+ */
#ifndef DUMUX_TEST_2P2C_PROBLEM_HH
#define DUMUX_TEST_2P2C_PROBLEM_HH
diff --git a/tutorial/tutorial_decoupled.cc b/tutorial/tutorial_decoupled.cc
index 5c9649a812..98da55b5ac 100644
--- a/tutorial/tutorial_decoupled.cc
+++ b/tutorial/tutorial_decoupled.cc
@@ -15,6 +15,11 @@
* *
* This program is distributed WITHOUT ANY WARRANTY. *
*****************************************************************************/
+/*!
+ * \file
+ *
+ * \brief tutorial for the sequential two-phase model
+ */
#include "config.h" /*@\label{tutorial-decoupled:include-begin}@*/
#include "tutorialproblem_decoupled.hh" /*@\label{tutorial-decoupled:include-problem-header}@*/
diff --git a/tutorial/tutorialproblem_decoupled.hh b/tutorial/tutorialproblem_decoupled.hh
index 5721435f2a..c8df79490e 100644
--- a/tutorial/tutorialproblem_decoupled.hh
+++ b/tutorial/tutorialproblem_decoupled.hh
@@ -15,6 +15,11 @@
* *
* This program is distributed WITHOUT ANY WARRANTY. *
*****************************************************************************/
+/*!
+ * \file
+ *
+ * \brief problem for the sequential tutorial
+ */
#ifndef DUMUX_TUTORIALPROBLEM_DECOUPLED_HH
#define DUMUX_TUTORIALPROBLEM_DECOUPLED_HH
diff --git a/tutorial/tutorialspatialparameters_decoupled.hh b/tutorial/tutorialspatialparameters_decoupled.hh
index b62a76bfdd..9ed44bade1 100644
--- a/tutorial/tutorialspatialparameters_decoupled.hh
+++ b/tutorial/tutorialspatialparameters_decoupled.hh
@@ -13,6 +13,11 @@
* *
* This program is distributed WITHOUT ANY WARRANTY. *
*****************************************************************************/
+/*!
+ * \file
+ *
+ * \brief spatial parameters for the sequential tutorial
+ */
#ifndef TUTORIALSPATIALPARAMETERS_DECOUPLED_HH
#define TUTORIALSPATIALPARAMETERS_DECOUPLED_HH
--
GitLab