From 4aff506c22e94f951cd70721cde0c94f1c31a3aa Mon Sep 17 00:00:00 2001
From: Sebastien Gilles <sebastien.gilles@inria.fr>
Date: Thu, 10 Nov 2016 18:21:35 +0100
Subject: [PATCH] #1050 Comments improved.
---
Sources/Parameters/ScalarParameterFromFile.hpp | 8 +++++++-
Sources/Parameters/ScalarParameterFromFile.hxx | 1 -
Sources/Parameters/TimeDependency/TimeDependency.hxx | 1 +
3 files changed, 8 insertions(+), 2 deletions(-)
diff --git a/Sources/Parameters/ScalarParameterFromFile.hpp b/Sources/Parameters/ScalarParameterFromFile.hpp
index 2598fb3474..74d1ad3fda 100644
--- a/Sources/Parameters/ScalarParameterFromFile.hpp
+++ b/Sources/Parameters/ScalarParameterFromFile.hpp
@@ -52,12 +52,18 @@ namespace HappyHeart
/*!
- * \brief Abstract class used to define a ParameterFromFile.
+ * \brief Define a spatially constant \a Parameter that varies with a time dependency given from a file.
*
*
* A ParameterFromFile is first and foremost a time-dependant data: its main purpose is to describe the value
* of a physical parameter over time. It is assumed that is is constant over space.
*
+ * \internal By adding few template parameters and substituting functions such as InitScalarParameterFromInputData,
+ * it would be easy to extend present class to encompass much more cases. It is not yet done as the need has not
+ * yet arisen. Anyway, current class is purely cosmetic: one can always create its own Parameter with time dependency
+ * type properly given and then use afterwards call SetTimeDependency(); present class is just there to provide
+ * a slicker interface to a very specific case.
+ *
*/
class ScalarParameterFromFile final
: public Parameter<ParameterNS::Type::scalar, ParameterNS::TimeDependencyFromFile>
diff --git a/Sources/Parameters/ScalarParameterFromFile.hxx b/Sources/Parameters/ScalarParameterFromFile.hxx
index c4b646278f..0c27dac65e 100644
--- a/Sources/Parameters/ScalarParameterFromFile.hxx
+++ b/Sources/Parameters/ScalarParameterFromFile.hxx
@@ -14,7 +14,6 @@
namespace HappyHeart
{
-
template<class T>
diff --git a/Sources/Parameters/TimeDependency/TimeDependency.hxx b/Sources/Parameters/TimeDependency/TimeDependency.hxx
index 8554f7f702..4d113683cf 100644
--- a/Sources/Parameters/TimeDependency/TimeDependency.hxx
+++ b/Sources/Parameters/TimeDependency/TimeDependency.hxx
@@ -149,6 +149,7 @@ namespace HappyHeart
}
+
} // namespace TimeDependencyNS
--
GitLab