diff --git a/dumux/decoupled/2p2c/boundaryconditions2p2c.hh b/dumux/decoupled/2p2c/boundaryconditions2p2c.hh index 34affed587933f51d2858a6196816c94215c0bb9..7dc5fcae3d6afb1ab853174bbd8097a3d146c637 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 86385e9d0e95d6dc2c6043fa8e7a5307898af310..ea2fa62b0b091b65108164012c3b0aacd3ea31b2 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 3e12b437dbc9fdf7823ab35024e877c51982a0f5..a12aef12e877bec4ac323ccca7c52e32ea7cd767 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 f469a706ab2618cae801d0f7403f2eb87d23fc77..425981318ee9b944a6635721fa14ad49bb530e0f 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 8f0da12d47f6100cf02334fb472e71b9e886c92d..accd725a830c9bce7025b1141b38e701561d20ea 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 1ddbaf26cfe4483fdc4a5754f2bae4e2406fc389..f552fb6c7d35471de886210faa72f5e11a59f863 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 15006f67a6898b48ccc2d603149aa7df9283b5a2..1d1d316ad06b4b62b6f659763dbe5ef733136ab1 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 54db9813f4123adc5e5c5cd9ecbe101b22a89459..e672a7517734cdfe8e89c4bdf95fcaf7cad96bbd 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 f9679718778420dd18875277da617f2dbb93fdc6..0ccf21c14db10239a59c59f727b00d77d4b29160 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 f0216dc07a2dafda4f1282efdf301830ef2b7aff..299915b06f33f9973930159ef2644d4ed9163b74 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 782fe03ab3c280f58f1e2de6d7fe07f20c99d924..ec777b1a8693bf01a1dd6af521686c59d51946cd 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 a2da44d4022aad3f96b6785bc43e66a084cdf692..0383a9c480fc0359ffcaede58b79ec3c062b3c5a 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 c47fc1057b262a020f4f651345c99936b5685345..e71530b4ccd4271705127d488c4380e9781c44ab 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 12af1d207488d5296982dd798fc1c0a7b0aef956..2b512b24eec45d6590049c36510b35e58bff02ee 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 e507f5878cec2a8a784bd25b9d914991665f7112..ae51fe6134fbd5c6facfe77a6cf961409e65c024 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 51ed33f4b41f85684c730f941d8e7c666edd82de..47cf9e75924b975ce3e33517b36d0c9e63ae0f03 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 2567f472f3754d5b1965e5f4843f6450acef1915..238e47250218b2a9322951ac457d80eb672eca2f 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 5e1813b4737a06ac28cfcc32e1f99322add1d191..17f1725e07640321e964f7fc0b11a18f609c16b6 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 0915f8868a81508a0e77c1e12c4ec7ad563ccd61..f4b1df40aca928fd9307d91d63f1a062131acdb9 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 0c0f12089fff1f5e2c2d8e73f33c2cfc5744e1f5..163645408483858ae06263a9604b08abd1225090 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 8fbcefaae073a5c93f3da7b48a79a643c1a92bbb..edc328ddd8ce95767f350734d67c924933758331 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 f51a3df403840751143351f2a63b481b2781c53b..9dbe9fa94c5744afa3a19a9bb584d29be2e9a491 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 e055f93fe1992314e4ee1e956119e74d74bfa8bc..f1ae6af9cff8033616fee80ea11284d5c57d3646 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 cd11c94a74f7c4cc7d26b26a12d15bdc099f6981..0424c3519bbd5e82b10b6226fd64f810807c4e36 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 77add08fe4f397e9468213f5428a2a5586117456..c40f0fefa93d0370ca1c043803f2cdadca4b99e0 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 f08bed0e564a660cee01894ff2433d413b1df373..dca0ec2492ef570a66685e3f0cd7f67d7ba80807 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 017e0bc194b63455344593db08964f79e88d45f8..ac23feb361afcb3f1b361ef82c5fa4aa6fbece4a 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 44e5950e42ac4029a8772a7870c489f8303027f7..43dacd6b598ca42cf759f0c773a2a56ab56191b6 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 74dabd4284ecf0b0e211e8f4e328f11e0b5c27ec..1e293ff3a03d85ed959fd4b09ef4e0154f796576 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 5c9649a8121ee9a6e21815e8692af751ab9ad966..98da55b5ac36c2a6ddf1dc79152ecf9b11b2fdef 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 5721435f2a0c66480f1e31e93fede740096f674d..c8df79490ed98671696693edd52d7d2c8e97cf4e 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 b62a76bfdd1150194a41f06e71e84106bc8b0399..9ed44bade1471c17dfb0c048ee8b2b20480e43bb 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