Commit 003bfe20 authored by GILLES Sebastien's avatar GILLES Sebastien
Browse files

#873 - #9 Doxygen comments.

parent 3af66e0b
......@@ -32,8 +32,19 @@ namespace HappyHeart
{
/*!
* \brief Helper struct to statically dispatch some operations depending on whether a time dependency
* is involved or not.
*
* I document here the generic case, but wil describe expected behaviour of the specialization
* TimeDependencyNS::None for each method.
*
* \tparam TimeDependencyT An instantiation of \a TimeDependencyNS::Base class, which handles the
* computation and the application of the time factor.
* \copydoc doxygen_hide_tparam_parameter_TypeT
*
*
*/
template
<
ParameterNS::Type TypeT,
......@@ -42,10 +53,32 @@ namespace HappyHeart
struct StaticIf
{
/*!
* \brief If TimeDependencyT == TimeDependencyNS::None, instantiate a dummy object \a time_dependency
* in Parameter class.
*
* Nothing is done if there is a time dependency (in which case user MUST explicitly call
* Parameter::SetTimeDependency()
*
* \param[out] time_dependency Reference to the namesake data attribute in Parameter class
*/
static void InitNoTimeDependencyHelper(typename TimeDependencyT<TypeT>::unique_ptr& time_dependency);
/*!
* Return type used within Parameter class.
*
* For TypeT == vector or matrix, this is actually a const ref (e.g. const LocalVector&).
*/
using return_type = typename ParameterNS::Traits<TypeT>::return_type;
/*!
* \brief Apply the time factor, and hence return the full value of the Parameter at quadrature point
* for current time step.
*
* \param[in] value_without_time_contribution Value of the spatial-only contribution.
* \param[in] time_dependency_object Object in charge of the time-only contribution.
* \return Full value of the Parameter at quadrature point for current time step.
*/
static return_type ApplyTimeFactor(return_type value_without_time_contribution,
const TimeDependencyT<TypeT>& time_dependency_object);
......@@ -54,6 +87,10 @@ namespace HappyHeart
// ============================
//! \cond IGNORE_BLOCK_IN_DOXYGEN
// ============================
template
<
ParameterNS::Type TypeT
......@@ -70,7 +107,10 @@ namespace HappyHeart
};
// ============================
//! \endcond IGNORE_BLOCK_IN_DOXYGEN
// ============================
} // namespace Private
......
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