Commit 5c8778f7 authored by Christoph Grueninger's avatar Christoph Grueninger
Browse files

Fix broken doxygen, mainly due to addition of non-equlibrium model.


git-svn-id: svn://svn.iws.uni-stuttgart.de/DUMUX/dumux/trunk@11095 2fb0f335-1f38-0410-981e-8018bf24f1b0
parent 7ebd90b2
......@@ -59,8 +59,6 @@ public:
/*! \brief Initializes the pressure model
*
* \copydetails ParentType::initialize()
*
* \param solveTwice indicates if more than one iteration is allowed to get an initial pressure solution
*/
void initialize()
{
......
......@@ -48,8 +48,6 @@ public:
/*! \brief Initializes the pressure model
*
* \copydetails ParentType::initialize()
*
* \param solveTwice indicates if more than one iteration is allowed to get an initial pressure solution
*/
void initialize()
{
......
......@@ -410,7 +410,7 @@ public:
* \param fluidState Container for all the secondary variables concerning the fluids
* \param globalPos The position at which the check is conducted
*/
bool physicalness(const FluidState & fs,
bool physicalness(const FluidState & fluidState,
const GlobalPosition & globalPos)
{
const Scalar eps = 1e-6 ;
......@@ -428,7 +428,7 @@ public:
* \param fluidState Container for all the secondary variables concerning the fluids
* \param message A string returning the error message for this module
*/
const void physicalnessError(const FluidState & fs,
const void physicalnessError(const FluidState & fluidState,
std::stringstream & message)
{
message <<"IA: \n";
......
......@@ -102,7 +102,7 @@ public:
* \param paramCache A container for iterative calculation of fluid composition
* \param refPhaseIdx The index of the phase whose's composition is known.
* \param setViscosity Should the viscosity be set in the fluidstate?
* \param setViscosity Should the enthalpy be set in the fluidstate?
* \param setEnthalpy Should the enthalpy be set in the fluidstate?
*/
template <class FluidState, class ParameterCache>
static void solve(FluidState & fluidState,
......
......@@ -120,7 +120,7 @@ public:
* \param fluidState A container with the current (physical) state of the fluid
* \param paramCache A container for iterative calculation of fluid composition
* \param setViscosity Should the viscosity be set in the fluidstate?
* \param setViscosity Should the enthalpy be set in the fluidstate?
* \param setInternalEnergy Should the enthalpy be set in the fluidstate?
*/
template <class FluidState, class ParameterCache>
static void solve(FluidState & fluidState,
......
/*****************************************************************************
* Copyright (C) 2008 by Philipp Nuske *
* Institute for Modelling Hydraulic and Environmental Systems *
* University of Stuttgart, Germany *
* email: <givenname>.<name>@iws.uni-stuttgart.de *
* See the file COPYING for full copying permissions. *
* *
* 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 *
......@@ -11,19 +8,18 @@
* *
* This program is distributed in the hope that it will be useful, *
* but WITHOUT ANY WARRANTY; without even the implied warranty of *
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
* GNU General Public License for more details. *
* *
* You should have received a copy of the GNU General Public License *
* along with this program. If not, see <http://www.gnu.org/licenses/>. *
* along with this program. If not, see <http://www.gnu.org/licenses/>. *
*****************************************************************************/
/*!
* \file awnSurfaceExpFct.hh Specification of the material params
* specific interfacial area surface as a function of wetting phase Saturation
* and capillary pressure.
* \file
* Specification of the material params specific interfacial area surface
* as a function of wetting phase Saturation and capillary pressure.
*/
#ifndef AWN_SURFACE_EXP_FCT_HH
#define AWN_SURFACE_EXP_FCT_HH
......
/*****************************************************************************
* Copyright (C) 2010 by Philipp Nuske *
* Institute for Modelling Hydraulic and Environmental Systems *
* University of Stuttgart, Germany *
* email: <givenname>.<name>@iws.uni-stuttgart.de *
* See the file COPYING for full copying permissions. *
* *
* 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 *
......@@ -11,15 +8,16 @@
* *
* This program is distributed in the hope that it will be useful, *
* but WITHOUT ANY WARRANTY; without even the implied warranty of *
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
* GNU General Public License for more details. *
* *
* You should have received a copy of the GNU General Public License *
* along with this program. If not, see <http://www.gnu.org/licenses/>. *
* along with this program. If not, see <http://www.gnu.org/licenses/>. *
*****************************************************************************/
/*!
* \file awnSurfaceExpFctParams.hh Specification of the material params
* for the interfacial area surface parameters
* \file
* Specification of the material params for the interfacial area surface
* parameters
*/
#ifndef AWN_SURFACE_EXP_FCT_PARAMS_HH
#define AWN_SURFACE_EXP_FCT_PARAMS_HH
......
/*****************************************************************************
* Copyright (C) 2008 by Philipp Nuske *
* Institute for Modelling Hydraulic and Environmental Systems *
* University of Stuttgart, Germany *
* email: <givenname>.<name>@iws.uni-stuttgart.de *
* See the file COPYING for full copying permissions. *
* *
* 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 *
......@@ -11,16 +8,16 @@
* *
* This program is distributed in the hope that it will be useful, *
* but WITHOUT ANY WARRANTY; without even the implied warranty of *
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
* GNU General Public License for more details. *
* *
* You should have received a copy of the GNU General Public License *
* along with this program. If not, see <http://www.gnu.org/licenses/>. *
* along with this program. If not, see <http://www.gnu.org/licenses/>. *
*****************************************************************************/
/*!
* \file awnSurfaceExpFct.hh Specification of the material params
* specific interfacial area surface as a function of wetting phase Saturation
* and capillary pressure.
* \file
* Specification of the material params specific interfacial area surface as
* a function of wetting phase Saturation and capillary pressure.
*/
......
/*****************************************************************************
* Copyright (C) 2010 by Philipp Nuske *
* Institute for Modelling Hydraulic and Environmental Systems *
* University of Stuttgart, Germany *
* email: <givenname>.<name>@iws.uni-stuttgart.de *
* See the file COPYING for full copying permissions. *
* *
* 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 *
......@@ -11,15 +8,16 @@
* *
* This program is distributed in the hope that it will be useful, *
* but WITHOUT ANY WARRANTY; without even the implied warranty of *
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
* GNU General Public License for more details. *
* *
* You should have received a copy of the GNU General Public License *
* along with this program. If not, see <http://www.gnu.org/licenses/>. *
* along with this program. If not, see <http://www.gnu.org/licenses/>. *
*****************************************************************************/
/*!
* \file awnSurfacePolynomialEdgeZero2ndOrderParams.hh Specification of the material params
* for the interfacial area surface parameters
* \file
* Specification of the material params for the interfacial area surfaces
* parameters
*/
#ifndef AWN_SURFACE_EXP_SW_PC_TO_3_PARAMS
#define AWN_SURFACE_EXP_SW_PC_TO_3_PARAMS
......
/*****************************************************************************
* Copyright (C) 2012 by Philipp Nuske *
* Institute for Modelling Hydraulic and Environmental Systems *
* University of Stuttgart, Germany *
* email: <givenname>.<name>@iws.uni-stuttgart.de *
* See the file COPYING for full copying permissions. *
* *
* 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 *
......@@ -11,15 +8,12 @@
* *
* This program is distributed in the hope that it will be useful, *
* but WITHOUT ANY WARRANTY; without even the implied warranty of *
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
* GNU General Public License for more details. *
* *
* You should have received a copy of the GNU General Public License *
* along with this program. If not, see <http://www.gnu.org/licenses/>. *
* along with this program. If not, see <http://www.gnu.org/licenses/>. *
*****************************************************************************/
#ifndef AWN_SURFACE_PCMAX_FCT_HH
#define AWN_SURFACE_PCMAX_FCT_HH
......
/*****************************************************************************
* Copyright (C) 2012 by Philipp Nuske *
* Institute for Modelling Hydraulic and Environmental Systems *
* University of Stuttgart, Germany *
* email: <givenname>.<name>@iws.uni-stuttgart.de *
* See the file COPYING for full copying permissions. *
* *
* 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 *
......@@ -11,13 +8,12 @@
* *
* This program is distributed in the hope that it will be useful, *
* but WITHOUT ANY WARRANTY; without even the implied warranty of *
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
* GNU General Public License for more details. *
* *
* You should have received a copy of the GNU General Public License *
* along with this program. If not, see <http://www.gnu.org/licenses/>. *
* along with this program. If not, see <http://www.gnu.org/licenses/>. *
*****************************************************************************/
#ifndef AWN_SURFACE_PCMAX_FCT_PARAMS_HH
#define AWN_SURFACE_PCMAX_FCT_PARAMS_HH
......
/*****************************************************************************
* Copyright (C) 2008 by Philipp Nuske *
* Institute for Modelling Hydraulic and Environmental Systems *
* University of Stuttgart, Germany *
* email: <givenname>.<name>@iws.uni-stuttgart.de *
* See the file COPYING for full copying permissions. *
* *
* 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 *
......@@ -11,19 +8,18 @@
* *
* This program is distributed in the hope that it will be useful, *
* but WITHOUT ANY WARRANTY; without even the implied warranty of *
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
* GNU General Public License for more details. *
* *
* You should have received a copy of the GNU General Public License *
* along with this program. If not, see <http://www.gnu.org/licenses/>. *
* along with this program. If not, see <http://www.gnu.org/licenses/>. *
*****************************************************************************/
/*!
* \file awnSurfacePylynomial2ndOrder.hh Specification of the material params
* specific interfacial area surface as a function of wetting phase Saturation
* and capillara pressure.
* \file
* Specification of the material params specific interfacial area surface
* as a function of wetting phase Saturation and capillara pressure.
*/
#ifndef AWN_SURFACE_POLYNOMIAL_2ND_ORDER_HH
#define AWN_SURFACE_POLYNOMIAL_2ND_ORDER_HH
......
/*****************************************************************************
* Copyright (C) 2010 by Philipp Nuske *
* Institute for Modelling Hydraulic and Environmental Systems *
* University of Stuttgart, Germany *
* email: <givenname>.<name>@iws.uni-stuttgart.de *
* See the file COPYING for full copying permissions. *
* *
* 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 *
......@@ -11,11 +8,11 @@
* *
* This program is distributed in the hope that it will be useful, *
* but WITHOUT ANY WARRANTY; without even the implied warranty of *
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
* GNU General Public License for more details. *
* *
* You should have received a copy of the GNU General Public License *
* along with this program. If not, see <http://www.gnu.org/licenses/>. *
* along with this program. If not, see <http://www.gnu.org/licenses/>. *
*****************************************************************************/
#ifndef AWN_SURFACE_POLYNOMIAL_2ND_ORDER_PARAMS_HH
#define AWN_SURFACE_POLYNOMIAL_2ND_ORDER_PARAMS_HH
......
/*****************************************************************************
* Copyright (C) 2008 by Philipp Nuske *
* Institute for Modelling Hydraulic and Environmental Systems *
* University of Stuttgart, Germany *
* email: <givenname>.<name>@iws.uni-stuttgart.de *
* See the file COPYING for full copying permissions. *
* *
* 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 *
......@@ -11,13 +8,12 @@
* *
* This program is distributed in the hope that it will be useful, *
* but WITHOUT ANY WARRANTY; without even the implied warranty of *
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
* GNU General Public License for more details. *
* *
* You should have received a copy of the GNU General Public License *
* along with this program. If not, see <http://www.gnu.org/licenses/>. *
* along with this program. If not, see <http://www.gnu.org/licenses/>. *
*****************************************************************************/
#ifndef AWN_SURFACE_POLYNOMIAL_EDGE_ZERO_2ND_ORDER_HH
#define AWN_SURFACE_POLYNOMIAL_EDGE_ZERO_2ND_ORDER_HH
......
/*****************************************************************************
* Copyright (C) 2010 by Philipp Nuske *
* Institute for Modelling Hydraulic and Environmental Systems *
* University of Stuttgart, Germany *
* email: <givenname>.<name>@iws.uni-stuttgart.de *
* See the file COPYING for full copying permissions. *
* *
* 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 *
......@@ -11,19 +8,21 @@
* *
* This program is distributed in the hope that it will be useful, *
* but WITHOUT ANY WARRANTY; without even the implied warranty of *
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
* GNU General Public License for more details. *
* *
* You should have received a copy of the GNU General Public License *
* along with this program. If not, see <http://www.gnu.org/licenses/>. *
* along with this program. If not, see <http://www.gnu.org/licenses/>. *
*****************************************************************************/
/*!
* \file awnSurfacePolynomialEdgeZero2ndOrderParams.hh Specification of the material params
* for the interfacial area surface parameters
*/
#ifndef AWN_SURFACE_POLYNOMIAL_EDGE_ZERO_2ND_ORDER_PARAMS_HH
#define AWN_SURFACE_POLYNOMIAL_EDGE_ZERO_2ND_ORDER_PARAMS_HH
/*!
* \file
* Specification of the material params for the interfacial area surface
* parameters
*/
namespace Dumux
{
/*!
......@@ -48,34 +47,34 @@ public:
}
/*!
* \brief Return the \f$a_{1}\f$ shape parameter of awn surface.
*/
const Scalar a1() const
{ return a1_; }
* \brief Return the \f$a_{1}\f$ shape parameter of awn surface.
*/
const Scalar a1() const
{ return a1_; }
/*!
* \brief Return the \f$a_{2}\f$ shape parameter of awn surface.
*/
const Scalar a2() const
{ return a2_; }
/*!
* \brief Return the \f$a_{2}\f$ shape parameter of awn surface.
*/
const Scalar a2() const
{ return a2_; }
/*!
* \brief Return the \f$a_{3}\f$ shape parameter of awn surface.
*/
const Scalar a3() const
{ return a3_; }
/*!
* \brief Return the \f$a_{3}\f$ shape parameter of awn surface.
*/
const Scalar a3() const
{ return a3_; }
/*!
* \brief Return the \f$a_{3}\f$ shape parameter of awn surface.
*/
const Scalar Swr() const
{ return Swr_; }
/*!
* \brief Return the \f$a_{3}\f$ shape parameter of awn surface.
*/
const Scalar Swr() const
{ return Swr_; }
/*!
* \brief Set the residual water saturation
*/
void setSwr(const Scalar v)
{ Swr_ = v; }
/*!
* \brief Set the residual water saturation
*/
void setSwr(const Scalar v)
{ Swr_ = v; }
/*!
* \brief Set the \f$a_{1}\f$ shape parameter.
......
......@@ -137,8 +137,8 @@ public:
*
* \param fluidState A container with the current (physical) state of the fluid
* \param paramCache A container for iterative calculation of fluid composition
* \param referencePhaseIdx The index of the phase who's composition is known.
* \parma calcCompIdx The component who's composition in the other phase is to be
* \param referencePhaseIdx The index of the phase for which composition is known.
* \param calcCompIdx The component for which the composition in the other phase is to be
* calculated.
*/
template <class FluidState>
......
......@@ -456,7 +456,7 @@ public:
* \brief Specifies which kind of boundary condition should be
* used for which equation on a given boundary segment.
*
* \param values The bounentraldary types for the conservation equations
* \param bTypes The bounentraldary types for the conservation equations
* \param vertex The vertex for which the boundary type is set
*/
void boundaryTypes(BoundaryTypes & bTypes,
......@@ -497,7 +497,7 @@ public:
* \brief Evaluate the boundary conditions for a dirichlet
* boundary segment.
*
* \param values The dirichlet values for the primary variables
* \param priVars The dirichlet values for the primary variables
* \param vertex The vertex for which the boundary type is set
*
* For this method, the \a values parameter stores primary variables.
......
......@@ -29,7 +29,7 @@
/*!
* \brief Print a usage string for simulations.
*
* \param progname The name of the executable
* \param progName The name of the executable
*/
void printUsage(const char *progName)
{
......@@ -317,11 +317,9 @@ int start_(int argc,
*
* \param argc The number of command line arguments of the program
* \param argv The contents of the command line arguments of the program
* \param usage Callback function for printing the usage message
*/
template <class TypeTag>
int start(int argc,
char **argv)
int start(int argc, char **argv)
{
try {
return start_<TypeTag>(argc, argv);
......
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