From c55c6898deeffc5defaca247f5771109a4e9a8ea Mon Sep 17 00:00:00 2001
From: Thomas Fetzer <thomas.fetzer@iws.uni-stuttgart.de>
Date: Thu, 9 Jul 2015 05:06:10 +0000
Subject: [PATCH] [doxygen] fixed warnings from doxygen
[plotthermalconductivitymodel]
deprecated the old class constructor call
reviewed by nicolas
git-svn-id: svn://svn.iws.uni-stuttgart.de/DUMUX/dumux/trunk@15029 2fb0f335-1f38-0410-981e-8018bf24f1b0
---
dumux/io/gnuplotinterface.hh | 3 ++-
dumux/io/ploteffectivediffusivitymodel.hh | 3 ++-
dumux/io/plotmateriallaw.hh | 6 ++++++
dumux/io/plotthermalconductivitymodel.hh | 19 +++++++++++++++++--
.../2p/thermalconductivityjohansen.hh | 9 +++++----
.../thermalconductivitysimplefluidlumping.hh | 9 +++++----
.../2p/thermalconductivitysomerton.hh | 7 ++++---
.../2p/thermalconductivityjohansenproblem.hh | 2 +-
.../2p/thermalconductivitysomertonproblem.hh | 2 +-
.../2p/thermalconductivityspatialparams.hh | 2 +-
.../effectivediffusivityconstanttauproblem.hh | 2 +-
...ectivediffusivitymillingtonquirkproblem.hh | 2 +-
12 files changed, 46 insertions(+), 20 deletions(-)
diff --git a/dumux/io/gnuplotinterface.hh b/dumux/io/gnuplotinterface.hh
index 0dcf5a12df..0adb15dfaf 100644
--- a/dumux/io/gnuplotinterface.hh
+++ b/dumux/io/gnuplotinterface.hh
@@ -105,6 +105,7 @@ public:
*
* \param title The name of the output file
* \param plottingWindowNumber The ID of the specific plot
+ * \param interaction Specifies whether a live output via a gnuplot window is wanted
*/
void plot(const std::string &title,
const unsigned int plottingWindowNumber,
@@ -196,7 +197,7 @@ public:
/*!
* \brief Adds a file to list of plotted lines for specific window number
*
- * \param addFile Function to be plotted
+ * \param file Function to be plotted
* \param plotName The name of the data set
* \param plottingWindowNumber The ID of the specific plot
* \param plotOptions Specific gnuplot options passed to this plot
diff --git a/dumux/io/ploteffectivediffusivitymodel.hh b/dumux/io/ploteffectivediffusivitymodel.hh
index 7b9fa486a4..9afd03c17a 100644
--- a/dumux/io/ploteffectivediffusivitymodel.hh
+++ b/dumux/io/ploteffectivediffusivitymodel.hh
@@ -54,10 +54,11 @@ public:
/*!
* \brief Plot the effective diffusion factor-saturation curve
*
- * \param params The material law parameters
+ * \param porosity The porosity of the porous medium
* \param lowerSat Minimum x-value
* \param upperSat Maximum x-value
* \param plotName Name of the plotted curve
+ * \param interaction Specifies whether a live output via a gnuplot window is wanted
*/
void plotdeff(Scalar porosity,
Scalar lowerSat = 0.0,
diff --git a/dumux/io/plotmateriallaw.hh b/dumux/io/plotmateriallaw.hh
index 0a4e16090b..fba84ea636 100644
--- a/dumux/io/plotmateriallaw.hh
+++ b/dumux/io/plotmateriallaw.hh
@@ -62,6 +62,7 @@ public:
* \param lowerSat Minimum x-value
* \param upperSat Maximum x-value
* \param plotName Name of the plotted curve
+ * \param interaction Specifies whether a live output via a gnuplot window is wanted
*/
void plotpcsw(const MaterialLawParams ¶ms,
Scalar lowerSat = 0.0,
@@ -100,6 +101,7 @@ public:
* \param lowerpc Minimum x-value
* \param upperpc Maximum x-value
* \param plotName Name of the plotted curve
+ * \param interaction Specifies whether a live output via a gnuplot window is wanted
*/
void plotswpc(const MaterialLawParams ¶ms,
Scalar lowerpc = 0.0,
@@ -137,6 +139,7 @@ public:
* \param lowerSat Minimum x-value
* \param upperSat Maximum x-value
* \param plotName Name of the plotted curve
+ * \param interaction Specifies whether a live output via a gnuplot window is wanted
*/
void plotdpcdsw(const MaterialLawParams ¶ms,
Scalar lowerSat = 0.0,
@@ -175,6 +178,7 @@ public:
* \param lowerpc Minimum x-value
* \param upperpc Maximum x-value
* \param plotName Name of the plotted curve
+ * \param interaction Specifies whether a live output via a gnuplot window is wanted
*/
void plotdswdpc(const MaterialLawParams ¶ms,
Scalar lowerpc = 0.0,
@@ -212,6 +216,7 @@ public:
* \param lowerSat Minimum x-value
* \param upperSat Maximum x-value
* \param plotName Name of the plotted curve
+ * \param interaction Specifies whether a live output via a gnuplot window is wanted
*/
void plotkr(const MaterialLawParams ¶ms,
Scalar lowerSat = 0.0,
@@ -253,6 +258,7 @@ public:
* \param lowerSat Minimum x-value
* \param upperSat Maximum x-value
* \param plotName Name of the plotted curve
+ * \param interaction Specifies whether a live output via a gnuplot window is wanted
*/
void plotdkrdsw(const MaterialLawParams ¶ms,
Scalar lowerSat = 0.0,
diff --git a/dumux/io/plotthermalconductivitymodel.hh b/dumux/io/plotthermalconductivitymodel.hh
index 4ef8e58991..79ad9a9af4 100644
--- a/dumux/io/plotthermalconductivitymodel.hh
+++ b/dumux/io/plotthermalconductivitymodel.hh
@@ -24,6 +24,8 @@
#ifndef DUMUX_PLOT_THERMAL_CONDUCTIVITY_LAW_HH
#define DUMUX_PLOT_THERMAL_CONDUCTIVITY_LAW_HH
+#include <dune/common/deprecated.hh>
+
#include <dumux/common/basicproperties.hh>
#include <dumux/io/gnuplotinterface.hh>
#include <dumux/material/fluidstates/compositionalfluidstate.hh>
@@ -78,15 +80,28 @@ public:
lambdaN_ = FluidSystem::template thermalConductivity<FluidState>(fluidstate, nPhaseIdx);
}
+ //! Constructor
+ DUNE_DEPRECATED_MSG("Constructor() has changed signature")
+ PlotThermalConductivityModel()
+ : numIntervals_(1000)
+ {
+ PlotThermalConductivityModel(293.15, 1e5);
+ }
+
/*!
* \brief Plot the effective thermal conductivity-saturation curve
*
- * \param params The material law parameters
+ * \param porosity The porosity of the porous medium
+ * \param rhoSolid The density of the solid material
+ * \param lambdaSolid The thermal conductivity of the solid material
* \param lowerSat Minimum x-value
* \param upperSat Maximum x-value
* \param plotName Name of the plotted curve
+ * \param interaction Specifies whether a live output via a gnuplot window is wanted
*/
- void plotlambdaeff(Scalar porosity, Scalar rhoSolid, Scalar lambdaSolid,
+ void plotlambdaeff(Scalar porosity,
+ Scalar rhoSolid,
+ Scalar lambdaSolid,
Scalar lowerSat = 0.0,
Scalar upperSat = 1.0,
std::string plotName = "lambda_eff",
diff --git a/dumux/material/fluidmatrixinteractions/2p/thermalconductivityjohansen.hh b/dumux/material/fluidmatrixinteractions/2p/thermalconductivityjohansen.hh
index 1e79fcf522..42c56617dc 100644
--- a/dumux/material/fluidmatrixinteractions/2p/thermalconductivityjohansen.hh
+++ b/dumux/material/fluidmatrixinteractions/2p/thermalconductivityjohansen.hh
@@ -108,11 +108,12 @@ public:
/*!
* \brief Returns the effective thermal conductivity \f$[W/(m K)]\f$ after Johansen (1975).
*
- * \param sw The saturation of the wetting phase
- * \param lambdaW the thermal conductivity of the wetting phase
- * \param lambdaN the thermal conductivity of the non-wetting phase
- * \param lambdaSolid the thermal conductivity of the solid phase
+ * \param Sw The saturation of the wetting phase
+ * \param lambdaW The thermal conductivity of the wetting phase
+ * \param lambdaN The thermal conductivity of the non-wetting phase
+ * \param lambdaSolid The thermal conductivity of the solid phase
* \param porosity The porosity
+ * \param rhoSolid The density of solid phase
*
* \return Effective thermal conductivity \f$[W/(m K)]\f$ after Johansen (1975)
*/
diff --git a/dumux/material/fluidmatrixinteractions/2p/thermalconductivitysimplefluidlumping.hh b/dumux/material/fluidmatrixinteractions/2p/thermalconductivitysimplefluidlumping.hh
index 9165e1eec2..5128e984d4 100644
--- a/dumux/material/fluidmatrixinteractions/2p/thermalconductivitysimplefluidlumping.hh
+++ b/dumux/material/fluidmatrixinteractions/2p/thermalconductivitysimplefluidlumping.hh
@@ -74,11 +74,12 @@ public:
* \brief Returns the effective thermal conductivity \f$[W/(m K)]\f$.
*
* \param sw The saturation of the wetting phase
- * \param lambdaW the thermal conductivity of the wetting phase
- * \param lambdaN the thermal conductivity of the non-wetting phase
- * \param lambdaSolid the thermal conductivity of the solid phase
+ * \param lambdaW The thermal conductivity of the wetting phase
+ * \param lambdaN The thermal conductivity of the non-wetting phase
+ * \param lambdaSolid The thermal conductivity of the solid phase
* \param porosity The porosity
- *
+ * \param rhoSolid The density of the solid phase
+ *
* \return Effective thermal conductivity of the fluid phases
*/
static Scalar effectiveThermalConductivity(const Scalar sw,
diff --git a/dumux/material/fluidmatrixinteractions/2p/thermalconductivitysomerton.hh b/dumux/material/fluidmatrixinteractions/2p/thermalconductivitysomerton.hh
index e5227b44b8..f81607dcb5 100644
--- a/dumux/material/fluidmatrixinteractions/2p/thermalconductivitysomerton.hh
+++ b/dumux/material/fluidmatrixinteractions/2p/thermalconductivitysomerton.hh
@@ -103,10 +103,11 @@ public:
* \brief effective thermal conductivity \f$[W/(m K)]\f$ after Somerton (1974)
*
* \param sw The saturation of the wetting phase
- * \param lambdaW the thermal conductivity of the wetting phase
- * \param lambdaN the thermal conductivity of the non-wetting phase
- * \param lambdaSolid the thermal conductivity of the solid phase
+ * \param lambdaW The thermal conductivity of the wetting phase
+ * \param lambdaN The thermal conductivity of the non-wetting phase
+ * \param lambdaSolid The thermal conductivity of the solid phase
* \param porosity The porosity
+ * \param rhoSolid The density of solid phase
*
* \return effective thermal conductivity \f$[W/(m K)]\f$ after Somerton (1974)
*/
diff --git a/test/material/fluidmatrixinteractions/2p/thermalconductivityjohansenproblem.hh b/test/material/fluidmatrixinteractions/2p/thermalconductivityjohansenproblem.hh
index f73d1fd11a..0ca88a4e31 100644
--- a/test/material/fluidmatrixinteractions/2p/thermalconductivityjohansenproblem.hh
+++ b/test/material/fluidmatrixinteractions/2p/thermalconductivityjohansenproblem.hh
@@ -193,7 +193,7 @@ public:
}
- //! \copydoc Dumux::ImplicitProblem::initialPhasePresence()
+ //! \copydoc Dumux::InjectionProblem::initialPhasePresence()
int initialPhasePresence(const Vertex &vertex,
int &vIdxGlobal,
const GlobalPosition &globalPos) const
diff --git a/test/material/fluidmatrixinteractions/2p/thermalconductivitysomertonproblem.hh b/test/material/fluidmatrixinteractions/2p/thermalconductivitysomertonproblem.hh
index 115c20ed84..8b0de7a6de 100644
--- a/test/material/fluidmatrixinteractions/2p/thermalconductivitysomertonproblem.hh
+++ b/test/material/fluidmatrixinteractions/2p/thermalconductivitysomertonproblem.hh
@@ -193,7 +193,7 @@ public:
}
- //! \copydoc Dumux::ImplicitProblem::initialPhasePresence()
+ //! \copydoc Dumux::InjectionProblem::initialPhasePresence()
int initialPhasePresence(const Vertex &vertex,
int &vIdxGlobal,
const GlobalPosition &globalPos) const
diff --git a/test/material/fluidmatrixinteractions/2p/thermalconductivityspatialparams.hh b/test/material/fluidmatrixinteractions/2p/thermalconductivityspatialparams.hh
index 5f8bbbdebf..da6a5bf19e 100644
--- a/test/material/fluidmatrixinteractions/2p/thermalconductivityspatialparams.hh
+++ b/test/material/fluidmatrixinteractions/2p/thermalconductivityspatialparams.hh
@@ -106,7 +106,7 @@ public:
*/
void plotMaterialLaw()
{
- PlotThermalConductivityModel<TypeTag> plotThermalConductivityModel_;
+ PlotThermalConductivityModel<TypeTag> plotThermalConductivityModel_(293.15, 1e5);
std::string fileName = GET_RUNTIME_PARAM_FROM_GROUP(TypeTag, std::string, Conductivity, File);
plotThermalConductivityModel_.plotlambdaeff(porosity_, rhoSolid_, lambdaSolid_,
0.0, 1.0, fileName, false);
diff --git a/test/material/fluidmatrixinteractions/effectivediffusivityconstanttauproblem.hh b/test/material/fluidmatrixinteractions/effectivediffusivityconstanttauproblem.hh
index ac5a0717fe..365cdd7e3a 100644
--- a/test/material/fluidmatrixinteractions/effectivediffusivityconstanttauproblem.hh
+++ b/test/material/fluidmatrixinteractions/effectivediffusivityconstanttauproblem.hh
@@ -193,7 +193,7 @@ public:
}
- //! \copydoc Dumux::ImplicitProblem::initialPhasePresence()
+ //! \copydoc Dumux::InjectionProblem::initialPhasePresence()
int initialPhasePresence(const Vertex &vertex,
int &vIdxGlobal,
const GlobalPosition &globalPos) const
diff --git a/test/material/fluidmatrixinteractions/effectivediffusivitymillingtonquirkproblem.hh b/test/material/fluidmatrixinteractions/effectivediffusivitymillingtonquirkproblem.hh
index ace1313140..ae1ddf3168 100644
--- a/test/material/fluidmatrixinteractions/effectivediffusivitymillingtonquirkproblem.hh
+++ b/test/material/fluidmatrixinteractions/effectivediffusivitymillingtonquirkproblem.hh
@@ -193,7 +193,7 @@ public:
}
- //! \copydoc Dumux::ImplicitProblem::initialPhasePresence()
+ //! \copydoc Dumux::InjectionProblem::initialPhasePresence()
int initialPhasePresence(const Vertex &vertex,
int &vIdxGlobal,
const GlobalPosition &globalPos) const
--
GitLab