Commit c55c6898 authored by Thomas Fetzer's avatar Thomas Fetzer
Browse files

[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
parent d66265bd
......@@ -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
......
......@@ -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,
......
......@@ -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 &params,
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 &params,
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 &params,
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 &params,
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 &params,
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 &params,
Scalar lowerSat = 0.0,
......
......@@ -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",
......
......@@ -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)
*/
......
......@@ -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,
......
......@@ -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)
*/
......
......@@ -193,7 +193,7 @@ public:
}
//! \copydoc Dumux::ImplicitProblem::initialPhasePresence()
//! \copydoc Dumux::InjectionProblem::initialPhasePresence()
int initialPhasePresence(const Vertex &vertex,
int &vIdxGlobal,
const GlobalPosition &globalPos) const
......
......@@ -193,7 +193,7 @@ public:
}
//! \copydoc Dumux::ImplicitProblem::initialPhasePresence()
//! \copydoc Dumux::InjectionProblem::initialPhasePresence()
int initialPhasePresence(const Vertex &vertex,
int &vIdxGlobal,
const GlobalPosition &globalPos) const
......
......@@ -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);
......
......@@ -193,7 +193,7 @@ public:
}
//! \copydoc Dumux::ImplicitProblem::initialPhasePresence()
//! \copydoc Dumux::InjectionProblem::initialPhasePresence()
int initialPhasePresence(const Vertex &vertex,
int &vIdxGlobal,
const GlobalPosition &globalPos) const
......
......@@ -193,7 +193,7 @@ public:
}
//! \copydoc Dumux::ImplicitProblem::initialPhasePresence()
//! \copydoc Dumux::InjectionProblem::initialPhasePresence()
int initialPhasePresence(const Vertex &vertex,
int &vIdxGlobal,
const GlobalPosition &globalPos) const
......
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