rename propparams.ods to parameters.ods. Add html-version parameters.html and...

rename propparams.ods to parameters.ods. Add html-version parameters.html and include it in parameterlist which is read by Doxygen. Include a pointer in the handbook.

git-svn-id: svn://svn.iws.uni-stuttgart.de/DUMUX/dumux/trunk@9365 2fb0f335-1f38-0410-981e-8018bf24f1b0

doc/doxygen/Doxylocal

@@ -13,7 +13,9 @@ INPUT                 += @srcdir@/mainpage \
 						 @top_srcdir@/test \
 						 @top_srcdir@/tutorial \
 						 @srcdir@/extradoc/parameterlist
-						 
+
+EXAMPLE_PATH          += @srcdir@/extradoc
+
 IMAGE_PATH             = @srcdir@/images
 					 
 EXTRA_PACKAGES        += amsmath,amssymb

doc/doxygen/extradoc/parameterlist

@@ -4,98 +4,8 @@
 	*
 	*\brief List of currently useable run-time parameters
 	*
-	* The listed run-time parameters are in general available, but we point out that a certain model might not use 
-	* every parameter!
-	*
-	* \section listofpropparams Run-time parameters with property values as default    
-	* \subsection implicitParams [Implicit]
-	*	-# MassUpwindWeight    (double)
-	*	-# EnableHints    (bool)
-	*	-# EnableJacobianRecycling    (bool)
-	*	-# EnablePartialReassemble    (bool)
-	*	-# EnableSmoothUpwinding    (bool)
-	*	-# NumericDifferenceMethod    (int)
-	* \subsection impetParams [IMPET]
-	*	-# ErrorTermFactor    (double)
-	*	-# ErrorTermLowerBound    (double)
-	*	-# ErrorTermUpperBound    (double)
-	*	-# SwitchNormals    (bool)
-	*	-# CFLFactor    (double)
-	*	-# EnableVolumeIntegral    (bool)
-	*	-# RestrictFluxInTransport    (bool)
-	*	-# IterationFlag    (int)
-	*	-# IterationNumber    (int)
-	*	-# MaximumDefect    (double)
-	*	-# RelaxationFactor    (double)
-	* \subsection freeflowParams [Stokes]
-	*	-# StabilizationAlpha    (double)
-	*	-# StabilizationBeta    (double)
-	* \subsection timeManager [TimeManager]
-	*	-#  MaxTimeStepSize
-	* \subsection linearParams [LinearSolver]
-	*	-# PreconditionerRelaxation    (double)
-	*	-# PreconditionerIterations    (int)
-	*	-# Verbosity    (int)
-	*	-# MaxIterations    (int)
-	*	-# GMResRestart    (int)
-	*	-# ResidualReduction    (double)	
-	* \subsection nonlinearParams [Newton]
-	*	-# EnableRelativeCriterion    (bool)
-	*	-# EnableAbsoluteCriterion    (bool)
-	*	-# SatisfyAbsAndRel    (bool)
-	*	-# RelTolerance    (double)
-	*	-# AbsTolerance    (double)
-	*	-# TargetSteps    (int)
-	*	-# MaxSteps    (int)
-	*	-# WriteConvergence    (bool)
-	*	-# UseLineSearch    (bool)
-	*	-# EnableChop    (bool)
-	* \subsection adaptiveParams [GridAdapt]
-	*	-# RefineTolerance    (double)
-	*	-# CoarsenTolerance    (double)
-	*	-# MinLevel    (int)
-	*	-# MaxLevel    (int)
-	*	-# AdaptionInterval    (int)
-	*	-# EnableInitializationIndicator    (bool)	
-	* \subsection vtkParams [VTK]
-		OutputLevel    (int)
-	*	-# AddVelocity    (bool)
-	*	-# AddTemperatures    (bool)
-	*	-# AddTemperatures    (bool)
-	*	-# AddEnthalpies    (bool)
-	*	-# AddInternalEnergies    (bool)
-	*	-# AddFugacities    (bool)
-	*	-# AddPorosity    (bool)
-	*	-# AddBoundaryTypes    (bool)
-	*	-# AddSaturations    (bool)
-	*	-# AddPressures    (bool)
-	*	-# AddVelocities    (bool)
-	*	-# AddDensities    (bool)
-	*	-# AddMobilities    (bool)
-	*	-# AddAverageMolarMass    (bool)
-	*	-# AddMassFractions    (bool)
-	*	-# AddMoleFractions    (bool)
-	*	-# AddMolarities    (bool)
-	* \subsection problemParams [Problem]  
-	*	-# EnableGravity    (bool) 	     
-	*
-	* \section listofpropparamsRT Pure run-time parameters
-	* \subsection gridParamsRT [Grid]
-	*	-# UpperRightX    (double)
-	*	-# UpperRightY    (double)
-	*	-# UpperRightZ    (double)	
-	*	-# NumberOfCellsX    (int)
-	*	-# NumberOfCellsY    (int)
-	*	-# NumberOfCellsZ    (int)
-	*	-# File    (string) 	
-	* \subsection timeManagerRT [TimeManager]
-	*	-# ParameterFile    (string)
-	*	-# PrintProperties    (bool)
-	*	-# Restart    (double)
-	*	-# PrintParameters    (bool)
-	*	-# TEnd    (double)
-	*	-# DtInitial    (double) 	
-	* \subsection problemParamsRT [Problem] 
-	* \subsection spatialParamsParamsRT [SpatialParams]
-	*
+	* The listed run-time parameters are in general available, 
+        * but we point out that a certain model might not be able 
+        * to use every parameter! 
+        * \htmlinclude parameters.html
 */

doc/doxygen/modules

@@ -15,6 +15,7 @@
 	/*!
 	 * \ingroup Common
 	 * \defgroup Parameter Parameters
+         * See the file parameterlist for available parameters.
 	 */
 	/*!
 	 * \ingroup Common

doc/handbook/parameterTree.tex

 \section{Parameter Files in \Dumux}
 \label{sec:inputFiles}
-In section \ref{quick-start-guide} an application was started using an input file. 
+Parameter files can be used to set important parameters for the simulation run. 
+A list of all available parameters is provided in the Doxygen documentation 
+of the file \texttt{parameterfile}, which is accessible via \texttt{Modules -> Parameters}.
+In order to have a closer look, we return to the example from the 
+previous section \ref{quick-start-guide}. There, an application was started using an input file. 
 This file is worth taking a closer look at because using it considerably improves usability. 
 
 \begin{itemize}