Commit 4f290565 authored by Bernd Flemisch's avatar Bernd Flemisch
Browse files

enhanced documentation

git-svn-id: svn://svn.iws.uni-stuttgart.de/DUMUX/dumux/trunk@4678 2fb0f335-1f38-0410-981e-8018bf24f1b0
parent 06195531
......@@ -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
......
......@@ -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"
......
......@@ -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"
......
......@@ -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
......
......@@ -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>
......
......@@ -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>
......
......@@ -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>
......
......@@ -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
......
......@@ -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"
......
// $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>
......
......@@ -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
......
......@@ -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
......
// $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
......
......@@ -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>
......
......@@ -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>
......
......@@ -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>
......
......@@ -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
......
......@@ -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
......
......@@ -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"
......
......@@ -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
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment