[Param] Source code docu.

ParameterLib/TimeDependentHeterogeneousParameter.h

@@ -13,6 +13,9 @@
 
 #include "Parameter.h"
 
+/// The TimeDependentHeterogeneousParameter class implements a parameter that
+/// varies in time and space, i.e., it is a function \f$ (t, x) \mapsto f(t, x)
+/// \in T^n \f$.
 namespace ParameterLib
 {
 class TimeDependentHeterogeneousParameter final : public Parameter<double>
@@ -25,13 +28,20 @@ public:
                                         std::vector<PairTimeParameterName>
                                             time_parameter_name_mapping);
 
+    /// @copydoc Parameter::getNumberOfComponents()
     int getNumberOfComponents() const override;
 
     bool isTimeDependent() const override;
 
+    /// @copydoc Parameter::operator()
     std::vector<double> operator()(double const t,
                                    SpatialPosition const& pos) const override;
 
+    /// The TimeDependentHeterogeneousParameter depends in each time step on a
+    /// parameter. Since, at construction time of the
+    /// TimeDependentHeterogeneousParameter other parameter needs not to be
+    /// constructed and hence can't be used to setup the object this is done
+    /// later on in the initialize method.
     void initialize(
         std::vector<std::unique_ptr<ParameterBase>> const& parameters) override;