From 43cd6fbddbefd30208e14934fec467c832a40441 Mon Sep 17 00:00:00 2001 From: Bernd Flemisch <bernd@iws.uni-stuttgart.de> Date: Fri, 12 Nov 2010 08:49:58 +0000 Subject: [PATCH] completed documentation class list git-svn-id: svn://svn.iws.uni-stuttgart.de/DUMUX/dumux/trunk@4680 2fb0f335-1f38-0410-981e-8018bf24f1b0 --- .../boxmodels/common/boxfvelementgeometry.hh | 22 +++---- dumux/boxmodels/common/pdelabboxassembler.hh | 2 +- .../common/pdelabboxistlvectorbackend.hh | 2 +- .../common/pdelabboxlocaloperator.hh | 2 - dumux/common/fixedlengthspline_.hh | 6 +- dumux/common/pdelabpreconditioner.hh | 22 ++++++- dumux/common/spline.hh | 4 +- dumux/common/splinecommon_.hh | 4 +- dumux/common/variablelengthspline_.hh | 6 +- .../2p/diffusion/fvmpfa/fvmpfaopressure2p.hh | 8 ++- .../2p/diffusion/fvmpfa/fvmpfaovelocity2p.hh | 5 +- .../2p/diffusion/mimetic/mimeticpressure2p.hh | 8 ++- dumux/io/outputToFile.hh | 2 +- dumux/material/fluidsystems/gasphase.hh | 6 +- dumux/material/fluidsystems/liquidphase.hh | 6 +- dumux/nonlinear/newtoncontroller.hh | 4 +- test/boxmodels/2p/test_2p.cc | 2 + test/decoupled/1p/benchmarkresult.hh | 64 +++++++++++++------ test/decoupled/1p/test_1p_problem.hh | 6 +- test/decoupled/1p/test_diffusion_problem.hh | 8 ++- .../1p/test_diffusion_spatialparams.hh | 5 +- test/decoupled/2p/test_impes_problem.hh | 2 + test/decoupled/2p/test_impes_spatialparams.hh | 5 +- test/decoupled/2p/test_transport_problem.hh | 2 + .../2p/test_transport_spatialparams.hh | 5 +- .../2p2c/test_dec2p2c_spatialparams.hh | 5 +- test/decoupled/2p2c/test_dec2p2cproblem.hh | 2 + 27 files changed, 142 insertions(+), 73 deletions(-) diff --git a/dumux/boxmodels/common/boxfvelementgeometry.hh b/dumux/boxmodels/common/boxfvelementgeometry.hh index b9727b1f5f..f4d39737d2 100644 --- a/dumux/boxmodels/common/boxfvelementgeometry.hh +++ b/dumux/boxmodels/common/boxfvelementgeometry.hh @@ -44,9 +44,8 @@ NEW_PROP_TAG(Scalar); // specialize member functions of template classes because of some // weird reason I didn't really get... -/*! - * \internal - */ +//!< \cond INTERNAL + template <typename BoxFVElementGeometry, int dim> class _BoxFVElemGeomHelper { @@ -57,9 +56,6 @@ public: }; }; -/*! - * \internal - */ template <typename BoxFVElementGeometry> class _BoxFVElemGeomHelper<BoxFVElementGeometry, 1> { @@ -73,9 +69,6 @@ public: } }; -/*! - * \internal - */ template <typename BoxFVElementGeometry> class _BoxFVElemGeomHelper<BoxFVElementGeometry, 2> { @@ -110,9 +103,6 @@ public: } }; -/*! - * \internal - */ template <typename BoxFVElementGeometry> class _BoxFVElemGeomHelper<BoxFVElementGeometry, 3> { @@ -286,6 +276,9 @@ public: } } }; + +//!< \endcond + // END HACK ///////////////////// @@ -567,7 +560,7 @@ public: bool inner; }; - struct SubControlVolumeFace + struct SubControlVolumeFace //! interior face of a sub control volume { int i,j; //!< scvf seperates corner i and j of elem FV ipLocal; //!< integration point in local coords @@ -577,7 +570,8 @@ public: Dune::FieldVector<Scalar, maxNC> shapeValue; //!< value of shape functions at ip }; - struct BoundaryFace { + struct BoundaryFace //! boundary face of a sub control volume + { FV ipLocal; //!< integration point in local coords FV ipGlobal; //!< integration point in global coords Scalar area; //!< area of boundary face diff --git a/dumux/boxmodels/common/pdelabboxassembler.hh b/dumux/boxmodels/common/pdelabboxassembler.hh index 443a635ba8..d3b36478f0 100644 --- a/dumux/boxmodels/common/pdelabboxassembler.hh +++ b/dumux/boxmodels/common/pdelabboxassembler.hh @@ -28,7 +28,7 @@ namespace Dumux { namespace PDELab { -/* +/*! * \brief An assembler for the Jacobian matrix based on PDELab. */ template<class TypeTag> diff --git a/dumux/boxmodels/common/pdelabboxistlvectorbackend.hh b/dumux/boxmodels/common/pdelabboxistlvectorbackend.hh index d68959beb4..ad08708ee3 100644 --- a/dumux/boxmodels/common/pdelabboxistlvectorbackend.hh +++ b/dumux/boxmodels/common/pdelabboxistlvectorbackend.hh @@ -96,7 +96,7 @@ public: } }; - // extract type of container element + //! extract type of container element template<class C> struct Value { diff --git a/dumux/boxmodels/common/pdelabboxlocaloperator.hh b/dumux/boxmodels/common/pdelabboxlocaloperator.hh index fb08945c81..3f8ad40230 100644 --- a/dumux/boxmodels/common/pdelabboxlocaloperator.hh +++ b/dumux/boxmodels/common/pdelabboxlocaloperator.hh @@ -31,8 +31,6 @@ namespace Dumux { namespace PDELab { /*! - * \file - * * \brief A local operator for PDELab which wraps the box models. */ template<class TypeTag> diff --git a/dumux/common/fixedlengthspline_.hh b/dumux/common/fixedlengthspline_.hh index fe15c7b083..7b577c3b7d 100644 --- a/dumux/common/fixedlengthspline_.hh +++ b/dumux/common/fixedlengthspline_.hh @@ -27,10 +27,8 @@ namespace Dumux { - +//! \cond INTERNAL /*! - * \internal - * * \brief The common code for all 3rd order polynomial splines with * more than two sampling points. */ @@ -150,6 +148,8 @@ protected: BlockVector m_; }; +//! \endcond + } #endif diff --git a/dumux/common/pdelabpreconditioner.hh b/dumux/common/pdelabpreconditioner.hh index 7d10a56bc6..c5e60c3110 100644 --- a/dumux/common/pdelabpreconditioner.hh +++ b/dumux/common/pdelabpreconditioner.hh @@ -44,6 +44,10 @@ NEW_PROP_TAG(ConstraintsTrafo); namespace PDELab { + +/*! + * \brief exchanges matrix entries for parallel computations + */ template<class TypeTag> class Exchanger { @@ -67,6 +71,7 @@ class Exchanger typedef typename Dune::GenericReferenceElement<CoordScalar, dim> ReferenceElement; public: + Exchanger(const Problem& problem) : gridView_(problem.gridView()), vertexMapper_(problem.vertexMapper()), borderIndices_(0) { @@ -96,6 +101,9 @@ public: } } + /*! + * \brief matrix entry for the MatEntryExchange class + */ struct MatEntry { IdType first; @@ -104,7 +112,9 @@ public: MatEntry () {} }; - // A DataHandle class to exchange matrix entries + /*! + * \brief A DataHandle class to exchange matrix entries + */ class MatEntryExchange : public Dune::CommDataHandleIF<MatEntryExchange,MatEntry> { @@ -242,7 +252,9 @@ private: std::vector<int> borderIndices_; }; -// wrapped sequential preconditioner +/*! + * \brief Wrapper for a sequential preconditioner + */ template<class CC, class GFS, class P> class NonoverlappingWrappedPreconditioner : public Dune::Preconditioner<typename P::domain_type,typename P::range_type> @@ -313,6 +325,9 @@ private: const Dune::PDELab::ParallelISTLHelper<GFS>& helper; }; +/*! + * \brief backend for an ISTL parallel ILU preconditioned BiCGSTAB solver + */ template<class TypeTag> class ISTLBackend_NoOverlap_BCGS_ILU { @@ -400,6 +415,9 @@ private: Exchanger<TypeTag> exchanger_; }; +/*! + * \brief backend for an ISTL parallel Pardiso preconditioned loop solver + */ template<class TypeTag> class ISTLBackend_NoOverlap_Loop_Pardiso { diff --git a/dumux/common/spline.hh b/dumux/common/spline.hh index fca6d3e205..d0aa63d896 100644 --- a/dumux/common/spline.hh +++ b/dumux/common/spline.hh @@ -108,7 +108,7 @@ public: { this->set(points, m0, m1); } }; -/* +/*! * \brief Specialization of a spline with the number of sampling * points only known at run time. * @@ -128,8 +128,6 @@ public: s''(x_n) & = 0 \f} */ - - template<class Scalar> class Spline<Scalar, -1> : public VariableLengthSpline_<Scalar> { diff --git a/dumux/common/splinecommon_.hh b/dumux/common/splinecommon_.hh index 0b7536babc..b8c804ebad 100644 --- a/dumux/common/splinecommon_.hh +++ b/dumux/common/splinecommon_.hh @@ -29,8 +29,8 @@ namespace Dumux { +//! \cond INTERNAL /*! - * \internal * * \brief The common code for all 3rd order polynomial splines. */ @@ -589,6 +589,8 @@ protected: { return asImp_().numSamples(); } }; +//! \endcond + } #endif diff --git a/dumux/common/variablelengthspline_.hh b/dumux/common/variablelengthspline_.hh index 1d2b7f31bc..2de1de2870 100644 --- a/dumux/common/variablelengthspline_.hh +++ b/dumux/common/variablelengthspline_.hh @@ -28,10 +28,8 @@ namespace Dumux { - +//! \cond INTERNAL /* - * \internal - * * \brief The common code for all 3rd order polynomial splines with * where the number of sampling points only known at run-time. */ @@ -209,7 +207,7 @@ protected: Vector yPos_; Vector m_; }; - +//! \endcond } #endif diff --git a/dumux/decoupled/2p/diffusion/fvmpfa/fvmpfaopressure2p.hh b/dumux/decoupled/2p/diffusion/fvmpfa/fvmpfaopressure2p.hh index 9607620c26..1ce4f8feb9 100644 --- a/dumux/decoupled/2p/diffusion/fvmpfa/fvmpfaopressure2p.hh +++ b/dumux/decoupled/2p/diffusion/fvmpfa/fvmpfaopressure2p.hh @@ -41,9 +41,11 @@ namespace Dumux { -//! \ingroup MPFA2p -//! Base class for defining an instance of a numerical diffusion model. -/*! An interface for defining a numerical diffusion model for the +/*! \ingroup MPFA2p + * + * \brief MPFA-O method for the pressure equation + * + * An interface for defining a numerical diffusion model for the * solution of equations of the form * \f$ - \text{div}\, (\lambda K \text{grad}\, p ) = 0, \f$, * \f$p = g\f$ on \f$\Gamma_1\f$, and diff --git a/dumux/decoupled/2p/diffusion/fvmpfa/fvmpfaovelocity2p.hh b/dumux/decoupled/2p/diffusion/fvmpfa/fvmpfaovelocity2p.hh index 118ff7a634..824ed06e8c 100644 --- a/dumux/decoupled/2p/diffusion/fvmpfa/fvmpfaovelocity2p.hh +++ b/dumux/decoupled/2p/diffusion/fvmpfa/fvmpfaovelocity2p.hh @@ -28,7 +28,10 @@ namespace Dumux { -//! \ingroup MPFA2p +/*! \ingroup MPFA2p + * + * \brief velocity calculation for the MPFA-O method + */ template<class TypeTag> class FVMPFAOVelocity2P: public FVMPFAOPressure2P<TypeTag> { typedef FVMPFAOVelocity2P<TypeTag> ThisType; diff --git a/dumux/decoupled/2p/diffusion/mimetic/mimeticpressure2p.hh b/dumux/decoupled/2p/diffusion/mimetic/mimeticpressure2p.hh index 6200f014ab..c14e11134c 100644 --- a/dumux/decoupled/2p/diffusion/mimetic/mimeticpressure2p.hh +++ b/dumux/decoupled/2p/diffusion/mimetic/mimeticpressure2p.hh @@ -36,9 +36,11 @@ namespace Dumux { -//! \ingroup mimetic -//! mimetic Diffusion Model -/*! Provides a mimetic implementation for the evaluation +/*! \ingroup mimetic + * + * \brief mimetic method for the pressure equation + * + * Provides a mimetic implementation for the evaluation * of equations of the form * \f[\text{div}\, \boldsymbol{v}_{total} = q.\f] * The definition of the total velocity \f$\boldsymbol{v}_total\f$ depends on the kind of pressure chosen. This could be a wetting (w) phase pressure leading to diff --git a/dumux/io/outputToFile.hh b/dumux/io/outputToFile.hh index 0432e00bda..cc230dd9c4 100644 --- a/dumux/io/outputToFile.hh +++ b/dumux/io/outputToFile.hh @@ -50,7 +50,7 @@ namespace Properties } -/* +/*! * \brief A collection of functions for output purposes. * These output files are meant for visualization with another program (matlab, gnuplot...) */ diff --git a/dumux/material/fluidsystems/gasphase.hh b/dumux/material/fluidsystems/gasphase.hh index 017dc5318d..93a9eaa27e 100644 --- a/dumux/material/fluidsystems/gasphase.hh +++ b/dumux/material/fluidsystems/gasphase.hh @@ -23,7 +23,11 @@ namespace Dumux { -template <class Scalar, class ComponentT> class GasPhase +/*! + * \brief gaseous phase consisting of a single component + */ +template <class Scalar, class ComponentT> +class GasPhase { public: typedef ComponentT Component; diff --git a/dumux/material/fluidsystems/liquidphase.hh b/dumux/material/fluidsystems/liquidphase.hh index 9039ff3677..ad523aa44e 100644 --- a/dumux/material/fluidsystems/liquidphase.hh +++ b/dumux/material/fluidsystems/liquidphase.hh @@ -23,7 +23,11 @@ namespace Dumux { -template <class Scalar, class ComponentT> class LiquidPhase +/*! + * \brief liquid phase consisting of a single component + */ +template <class Scalar, class ComponentT> +class LiquidPhase { public: typedef ComponentT Component; diff --git a/dumux/nonlinear/newtoncontroller.hh b/dumux/nonlinear/newtoncontroller.hh index dc78336cea..90056bf76c 100644 --- a/dumux/nonlinear/newtoncontroller.hh +++ b/dumux/nonlinear/newtoncontroller.hh @@ -105,8 +105,8 @@ SET_PROP_DEFAULT(NewtonUseLineSearch) }; }; +//! \cond INTERNAL /*! - * \internal * \brief Writes the intermediate solutions during * the Newton scheme */ @@ -166,7 +166,6 @@ private: }; /*! - * \internal * \brief Writes the intermediate solutions during * the Newton scheme. * @@ -201,6 +200,7 @@ struct NewtonConvergenceWriter<TypeTag, false> void endTimestep() { }; }; +//! \endcond /*! * \brief A reference implementation of a newton controller specific diff --git a/test/boxmodels/2p/test_2p.cc b/test/boxmodels/2p/test_2p.cc index 425981318e..1ee83b27cd 100644 --- a/test/boxmodels/2p/test_2p.cc +++ b/test/boxmodels/2p/test_2p.cc @@ -34,6 +34,7 @@ #include <iostream> #include <boost/format.hpp> +//! \cond INTERNAL //////////////////////// // helper class for grid instantiation //////////////////////// @@ -132,6 +133,7 @@ public: }; }; +//! \endcond //////////////////////// // the main function diff --git a/test/decoupled/1p/benchmarkresult.hh b/test/decoupled/1p/benchmarkresult.hh index e71530b4cc..6e07feb206 100644 --- a/test/decoupled/1p/benchmarkresult.hh +++ b/test/decoupled/1p/benchmarkresult.hh @@ -24,26 +24,31 @@ namespace Dumux { -template<int dim> -struct ElementLayout -{ - bool contains (Dune::GeometryType gt) - { - return gt.dim() == dim; - } -}; - -template<int dim> -struct FaceLayout -{ - bool contains (Dune::GeometryType gt) - { - return gt.dim() == dim-1; - } -}; - +/*! + * \brief calculate errors for a FVCA5 benchmark problem + */ struct BenchmarkResult { +private: + template<int dim> + struct ElementLayout + { + bool contains (Dune::GeometryType gt) + { + return gt.dim() == dim; + } + }; + + template<int dim> + struct FaceLayout + { + bool contains (Dune::GeometryType gt) + { + return gt.dim() == dim-1; + } + }; + +public: double relativeL2Error; double ergrad; double ervell2; @@ -308,8 +313,31 @@ struct BenchmarkResult } }; +/*! + * \brief calculate errors for a FVCA5 benchmark problem + */ struct ResultEvaluation { +private: + template<int dim> + struct ElementLayout + { + bool contains (Dune::GeometryType gt) + { + return gt.dim() == dim; + } + }; + + template<int dim> + struct FaceLayout + { + bool contains (Dune::GeometryType gt) + { + return gt.dim() == dim-1; + } + }; + +public: double relativeL2Error; double ergrad; double ervell2; diff --git a/test/decoupled/1p/test_1p_problem.hh b/test/decoupled/1p/test_1p_problem.hh index ae51fe6134..54e840be6a 100644 --- a/test/decoupled/1p/test_1p_problem.hh +++ b/test/decoupled/1p/test_1p_problem.hh @@ -91,8 +91,10 @@ SET_TYPE_PROP(TestProblemOneP, Problem, Dumux::TestProblemOneP<TTAG(TestProblemO } /*! -* \ingroup DecoupledProblems -*/ + * \ingroup DecoupledProblems + * + * \brief test problem for the decoupled one-phase model. + */ template<class TypeTag = TTAG(TestProblemOneP)> class TestProblemOneP: public DiffusionProblem1P<TypeTag, TestProblemOneP<TypeTag> > { diff --git a/test/decoupled/1p/test_diffusion_problem.hh b/test/decoupled/1p/test_diffusion_problem.hh index 238e472502..9e4f0b70e4 100644 --- a/test/decoupled/1p/test_diffusion_problem.hh +++ b/test/decoupled/1p/test_diffusion_problem.hh @@ -43,6 +43,7 @@ namespace Dumux { +//! \cond INTERNAL struct FileNames { enum @@ -50,6 +51,7 @@ struct FileNames TPFAName = 0, MPFAName = 1, MimeticName = 2 }; }; +//! \endcond template<class TypeTag> class TestDiffusionProblem; @@ -140,8 +142,10 @@ SET_TYPE_PROP(MimeticPressure2PTestProblem, Problem, Dumux::TestDiffusionProblem } /*! -* \ingroup DecoupledProblems -*/ + * \ingroup DecoupledProblems + * + * \brief test problem for diffusion models from the FVCA5 benchmark. + */ template<class TypeTag = TTAG(DiffusionTestProblem)> class TestDiffusionProblem: public DiffusionProblem2P<TypeTag, TestDiffusionProblem<TypeTag> > { diff --git a/test/decoupled/1p/test_diffusion_spatialparams.hh b/test/decoupled/1p/test_diffusion_spatialparams.hh index 17f1725e07..fd39217441 100644 --- a/test/decoupled/1p/test_diffusion_spatialparams.hh +++ b/test/decoupled/1p/test_diffusion_spatialparams.hh @@ -28,8 +28,9 @@ namespace Dumux { -/** \todo Please doc me! */ - +/*! + * \brief spatial parameters for the test problem for diffusion models. + */ template<class TypeTag> class TestDiffusionSpatialParams { diff --git a/test/decoupled/2p/test_impes_problem.hh b/test/decoupled/2p/test_impes_problem.hh index 1636454084..5f35b6a029 100644 --- a/test/decoupled/2p/test_impes_problem.hh +++ b/test/decoupled/2p/test_impes_problem.hh @@ -127,6 +127,8 @@ SET_SCALAR_PROP(IMPESTestProblem, CFLFactor, 0.95); /*! * \ingroup DecoupledProblems + * + * \brief test problem for the sequential 2p model */ template<class TypeTag = TTAG(IMPESTestProblem)> class TestIMPESProblem: public IMPESProblem2P<TypeTag, TestIMPESProblem<TypeTag> > diff --git a/test/decoupled/2p/test_impes_spatialparams.hh b/test/decoupled/2p/test_impes_spatialparams.hh index edc328ddd8..cab3c4125b 100644 --- a/test/decoupled/2p/test_impes_spatialparams.hh +++ b/test/decoupled/2p/test_impes_spatialparams.hh @@ -29,8 +29,9 @@ namespace Dumux { -/** \todo Please doc me! */ - +/*! + * \brief spatial parameters for the sequential 2p test + */ template<class TypeTag> class TestIMPESSpatialParams { diff --git a/test/decoupled/2p/test_transport_problem.hh b/test/decoupled/2p/test_transport_problem.hh index f1ae6af9cf..f53d758846 100644 --- a/test/decoupled/2p/test_transport_problem.hh +++ b/test/decoupled/2p/test_transport_problem.hh @@ -108,6 +108,8 @@ SET_SCALAR_PROP(TransportTestProblem, CFLFactor, 1.0); /*! * \ingroup DecoupledProblems + * + * \brief test problem for the explicit transport model */ template<class TypeTag = TTAG(TransportTestProblem)> class TestTransportProblem: public TransportProblem2P<TypeTag, TestTransportProblem<TypeTag> > diff --git a/test/decoupled/2p/test_transport_spatialparams.hh b/test/decoupled/2p/test_transport_spatialparams.hh index 0424c3519b..14e3fd6d0e 100644 --- a/test/decoupled/2p/test_transport_spatialparams.hh +++ b/test/decoupled/2p/test_transport_spatialparams.hh @@ -29,8 +29,9 @@ namespace Dumux { -/** \todo Please doc me! */ - +/*! + * \brief spatial parameters for the explicit transport test + */ template<class TypeTag> class TestTransportSpatialParams { diff --git a/test/decoupled/2p2c/test_dec2p2c_spatialparams.hh b/test/decoupled/2p2c/test_dec2p2c_spatialparams.hh index dca0ec2492..4c78fccda3 100644 --- a/test/decoupled/2p2c/test_dec2p2c_spatialparams.hh +++ b/test/decoupled/2p2c/test_dec2p2c_spatialparams.hh @@ -29,8 +29,9 @@ namespace Dumux { -/** \todo Please doc me! */ - +/*! + * \brief spatial parameters for the sequential 2p2c test + */ template<class TypeTag> class Test2P2CSpatialParams { diff --git a/test/decoupled/2p2c/test_dec2p2cproblem.hh b/test/decoupled/2p2c/test_dec2p2cproblem.hh index ac23feb361..6371eef462 100644 --- a/test/decoupled/2p2c/test_dec2p2cproblem.hh +++ b/test/decoupled/2p2c/test_dec2p2cproblem.hh @@ -119,6 +119,8 @@ SET_SCALAR_PROP(TestTwoPTwoCProblem, CFLFactor, 0.8); /*! * \ingroup DecoupledProblems + * + * \brief test problem for the sequential 2p2c model */ template<class TypeTag = TTAG(TestTwoPTwoCProblem)> class TestTwoPTwoCProblem: public IMPETProblem2P2C<TypeTag, TestTwoPTwoCProblem<TypeTag> > -- GitLab