diff --git a/configure.ac b/configure.ac index 55700aa1d47e215e396cdf129141db465a19073b..1699216f8b6369d8579a41482471d08406782a0e 100644 --- a/configure.ac +++ b/configure.ac @@ -86,6 +86,7 @@ AC_CONFIG_FILES([dumux.pc Makefile doc/Makefile doc/doxygen/Makefile + doc/doxygen/Doxyfile doc/handbook/Makefile dumux/Makefile dumux/boxmodels/Makefile diff --git a/doc/Makefile.am b/doc/Makefile.am index 1d247672f6cd58c60d22fb1809ff1c32a411a8b6..961a1b1788a247ac92b5f10dfc976839ecafe2f9 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -1,12 +1,10 @@ - SUBDIRS = doxygen handbook -CURDIR = doc -BASEDIR = .. - -# add list of html files to generate from wml -PAGES= -docdir=$(datadir)/doc/dumux +# setting like in dune-web +CURDIR=doc +# position of the web base directory, +# relative to $(CURDIR) +BASEDIR=.. include $(top_srcdir)/am/webstuff include $(top_srcdir)/am/global-rules diff --git a/doc/doxygen/Doxylocal b/doc/doxygen/Doxylocal index 6b9a5f6e8682e30cfac1643397d28e6c031ecdae..879c09f96db18c46a82502d5939dd952eeeab874 100644 --- a/doc/doxygen/Doxylocal +++ b/doc/doxygen/Doxylocal @@ -1,30 +1,5 @@ # This file contains local changes to the doxygen configuration # please us '+=' to add file/directories to the lists -# The INPUT tag can be used to specify the files and/or directories that contain -# documented source files. You may enter file names like "myfile.cpp" or -# directories like "/usr/src/myproject". Separate the files or directories -# with spaces. - -INPUT += @top_srcdir@/dune/ -# see e.g. dune-grid for the examples of mainpage and modules -# INPUT += @srcdir@/mainpage # @srcdir@/modules - -# The EXCLUDE tag can be used to specify files and/or directories that should -# excluded from the INPUT source files. This way you can easily exclude a -# subdirectory from a directory tree whose root is specified with the INPUT tag. - -# EXCLUDE += @top_srcdir@/dune/dumux/test - -# The EXAMPLE_PATH tag can be used to specify one or more files or -# directories that contain example code fragments that are included (see -# the \include command). - -# EXAMPLE_PATH += @top_srcdir@/src - -# The IMAGE_PATH tag can be used to specify one or more files or -# directories that contain image that are included in the documentation (see -# the \image command). - -# IMAGE_PATH += @top_srcdir@/dune/dumux/pics - +INPUT += @top_srcdir@/dune/dumux +EXTRA_PACKAGES += amsmath,amssymb diff --git a/doc/doxygen/Makefile.am b/doc/doxygen/Makefile.am index d94c751b4a1ba391b553822f67bcb7ea32621f90..a9792f86f9a38a47d97f6149edb66dbc6e889284 100644 --- a/doc/doxygen/Makefile.am +++ b/doc/doxygen/Makefile.am @@ -1,7 +1,11 @@ - +# setting like in dune-web BASEDIR=../.. CURDIR=doc/doxygen +# add some more stuff to install and tarball +DOCFILES = $(PAGES) +EXTRA_DIST = $(PAGES) + include $(top_srcdir)/am/doxygen include $(top_srcdir)/am/global-rules diff --git a/dumux/boxmodels/common/boxmodel.hh b/dumux/boxmodels/common/boxmodel.hh index 7c7ef3e87cf0e9d0243064ad864e433e02e63ee1..a20dfe12293dc66aebbb137b597951e2fc933222 100644 --- a/dumux/boxmodels/common/boxmodel.hh +++ b/dumux/boxmodels/common/boxmodel.hh @@ -561,6 +561,11 @@ public: writer.addVertexData(x[i], (boost::format("primaryVar%i")%i).str().c_str()); } + /*! + * \brief Reference to the grid view of the spatial domain. + */ + const GridView &gridView() const + { return problem_().gridView(); } protected: /*! diff --git a/dumux/material/fluidmatrixinteractions/2p/brookscorey.hh b/dumux/material/fluidmatrixinteractions/2p/brookscorey.hh index 7b6eb70abed48a53f038af1e37a6d263cb38ee2e..d6ba01d22db736302ed5434c9d3fc8e1908dd648 100644 --- a/dumux/material/fluidmatrixinteractions/2p/brookscorey.hh +++ b/dumux/material/fluidmatrixinteractions/2p/brookscorey.hh @@ -71,7 +71,7 @@ public: \overline{S}_w = (\frac{p_C}{p_e})^{-\alpha} \f] * - * \param pC Capillary pressure \f$\p_C\f$ + * \param pC Capillary pressure \f$p_C\f$ * \return The effective saturaion of the wetting phase \f$\overline{S}_w\f$ */ static Scalar Sw(const Params ¶ms, Scalar pC) diff --git a/dumux/material/fluidmatrixinteractions/2p/efftoabslaw.hh b/dumux/material/fluidmatrixinteractions/2p/efftoabslaw.hh index c8369dbed60321c6a1610c9b2d7bb9970b8dbd29..20b43f3ef350e3a304a9c3534bbb581eec618b23 100644 --- a/dumux/material/fluidmatrixinteractions/2p/efftoabslaw.hh +++ b/dumux/material/fluidmatrixinteractions/2p/efftoabslaw.hh @@ -55,7 +55,7 @@ public: /*! * \brief The saturation-capillary pressure curve. * - * \param pC Capillary pressure \f$\p_C\f$ + * \param pC Capillary pressure \f$p_C\f$ * \return The absolute saturation of the wetting phase \f$S_w\f$ */ static Scalar Sw(const Params ¶ms, Scalar pC) diff --git a/dumux/material/fluidmatrixinteractions/2p/linearmaterial.hh b/dumux/material/fluidmatrixinteractions/2p/linearmaterial.hh index 6a8bf280ebdb231e375fc3af13bca704e07922d0..60cb6b47d5ade9492c7802496585098b8f70d021 100644 --- a/dumux/material/fluidmatrixinteractions/2p/linearmaterial.hh +++ b/dumux/material/fluidmatrixinteractions/2p/linearmaterial.hh @@ -67,7 +67,7 @@ public: S_w = 1 - \frac{p_C - p_{C,entry}}{p_{C,max} - p_{C,entry}} \f] * - * \param pC Capillary pressure \f$\p_C\f$ + * \param pC Capillary pressure \f$p_C\f$ * \return The effective saturaion of the wetting phase \f$\overline{S}_w\f$ */ static Scalar Sw(const Params ¶ms, Scalar pC) diff --git a/dumux/material/fluidmatrixinteractions/2p/regularizedlinearmaterial.hh b/dumux/material/fluidmatrixinteractions/2p/regularizedlinearmaterial.hh index 926579900f556bd2af101e3f3708519f8a33bc05..2f18cc9d4937f3cd8aa11224c1131a4357302a95 100644 --- a/dumux/material/fluidmatrixinteractions/2p/regularizedlinearmaterial.hh +++ b/dumux/material/fluidmatrixinteractions/2p/regularizedlinearmaterial.hh @@ -70,7 +70,7 @@ public: S_w = 1 - \frac{p_C - p_{C,entry}}{p_{C,max} - p_{C,entry}} \f] * - * \param pC Capillary pressure \f$\p_C\f$ + * \param pC Capillary pressure \f$p_C\f$ * \return The effective saturaion of the wetting phase \f$\overline{S}_w\f$ */ static Scalar Sw(const Params ¶ms, Scalar pC) diff --git a/dumux/material/fluidmatrixinteractions/2p/regularizedvangenuchten.hh b/dumux/material/fluidmatrixinteractions/2p/regularizedvangenuchten.hh index 91eccad9aeeb60c8182de4cfa7c8915830d421f1..b63f48ecb03eb535d74ff084d1f9e9628d25fb22 100644 --- a/dumux/material/fluidmatrixinteractions/2p/regularizedvangenuchten.hh +++ b/dumux/material/fluidmatrixinteractions/2p/regularizedvangenuchten.hh @@ -92,7 +92,7 @@ public: \overline{S}_w = {p_C}^{-1} = ((\alpha p_C)^n + 1)^{-m} \f] * - * \param pC Capillary pressure \f$\p_C\f$ + * \param pC Capillary pressure \f$p_C\f$ * \return The effective saturaion of the wetting phase \f$\overline{S}_w\f$ */ static Scalar Sw(const Params ¶ms, Scalar pC) diff --git a/dumux/material/fluidmatrixinteractions/2p/vangenuchten.hh b/dumux/material/fluidmatrixinteractions/2p/vangenuchten.hh index d44fb9350f6282cfa921639bb3b8c8f686d214f5..2c4fe3e1f918f072e53db01bf72e6ed832cc299a 100644 --- a/dumux/material/fluidmatrixinteractions/2p/vangenuchten.hh +++ b/dumux/material/fluidmatrixinteractions/2p/vangenuchten.hh @@ -68,7 +68,7 @@ public: \overline{S}_w = {p_C}^{-1} = ((\alpha p_C)^n + 1)^{-m} \f] * - * \param pC Capillary pressure \f$\p_C\f$ + * \param pC Capillary pressure \f$p_C\f$ * \return The effective saturaion of the wetting phase \f$\overline{S}_w\f$ */ static Scalar Sw(const Params ¶ms, Scalar pC)