Commit 4aff506c authored by GILLES Sebastien's avatar GILLES Sebastien
Browse files

#1050 Comments improved.

parent f3d80157
......@@ -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>
......
......@@ -14,7 +14,6 @@
namespace HappyHeart
{
template<class T>
......
......@@ -149,6 +149,7 @@ namespace HappyHeart
}
} // namespace TimeDependencyNS
......
Markdown is supported
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