From a97fb6db5af3703b256dc5625831bb8a390e602a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Dennis=20Gl=C3=A4ser?= <dennis.glaeser@iws.uni-stuttgart.de> Date: Tue, 8 May 2018 20:33:19 +0200 Subject: [PATCH] [inertsolidstate] cleanup --- dumux/material/solidstates/inertsolidstate.hh | 37 +++++++++---------- 1 file changed, 18 insertions(+), 19 deletions(-) diff --git a/dumux/material/solidstates/inertsolidstate.hh b/dumux/material/solidstates/inertsolidstate.hh index fb86c49c7c..17c45028f3 100644 --- a/dumux/material/solidstates/inertsolidstate.hh +++ b/dumux/material/solidstates/inertsolidstate.hh @@ -45,6 +45,10 @@ public: numInertComponents = SolidSystem::numInertComponents, }; + /*! + * \brief Allows compile-time evaluation of if the solid system + * is inert or takes part in any kind of reactions. + */ static constexpr bool isInert() { static_assert(SolidSystem::isInert(), "Only inert solid systems are allowed with the InertSolidState"); @@ -72,19 +76,20 @@ public: return porosity; } - /*! - * \brief The mass density \f$\rho_\alpha\f$ of the fluid phase - * \f$\alpha\f$ in \f$\mathrm{[kg/m^3]}\f$ - */ - Scalar density() const - { return density_; } + //! The mass density of the solid phase in \f$\mathrm{[kg/m^3]}\f$ + Scalar density() const { return density_; } + + //! The heat capacity of the solid phase in \f$\mathrm{[J/(kg*K)}\f$ + Scalar heatCapacity() const { return heatCapacity_; } - Scalar heatCapacity() const - { return heatCapacity_; } + //! The thermal conductivity of the solid phase in \f$\mathrm{[[W/(m*K)]}\f$ + Scalar thermalConductivity() const { return thermalConducivity_; } - Scalar thermalConductivity() const - { return thermalConducivity_; } + //! The temperature of the solid phase in \f$\mathrm{[K]}\f$ + Scalar temperature() const { return temperature_; } + //! The volume fraction of a solid component within the solid phase + Scalar volumeFraction(const int compIdx) const { return volumeFraction_[compIdx]; } /*! * \brief The molar density \f$\rho_{mol,\alpha}\f$ @@ -97,15 +102,6 @@ public: Scalar molarDensity() const { return density_/averageMolarMass(); } - /*! - * \brief The temperature within the domain \f$\mathrm{[K]}\f$ - */ - Scalar temperature() const - { return temperature_; } - - Scalar volumeFraction(const int compIdx) const - { return volumeFraction_[compIdx]; } - /***************************************************** * Setter methods. Note that these are not part of the * generic InertSolidState interface but specific for each @@ -156,6 +152,9 @@ public: void setHeatCapacity(Scalar value) { heatCapacity_ = value; } + /*! + * \brief Set the volume fraction of a solid component + */ void setVolumeFraction(const int compIdx, Scalar value) { volumeFraction_[compIdx] = value; } -- GitLab