Commit 6b248cec authored by GILLES Sebastien's avatar GILLES Sebastien
Browse files

#9 Doxygen: fix warnings from VolumicAndSurfacicSource.hpp.

parent 73f38434
......@@ -103,9 +103,11 @@ namespace HappyHeart
/*!
* \brief Whether the force operator labelled by \a ForceIndexT is activated in the current model.
* \brief Whether the force operator labelled by \a SourceTypeT is activated in the current model.
*
* This is decided within the input parameter file with parameter is_activated related to the requested force.
*
* \return True if the operator tagged by \a SourceType is considered or not in the current Model/
*/
template<SourceType SourceTypeT>
bool IsOperatorActivated() const noexcept;
......@@ -115,6 +117,8 @@ namespace HappyHeart
* \brief Get one of the force operators.
*
* It is assumed this operator is activated; this can be checked beforehand by IsOperatorActivated() method.
*
* \return The operator related to source \a SourceTypeT. This operator must be marked as activated.
*/
template<SourceType SourceTypeT>
const GlobalVariationalOperatorNS::TransientSource<TimeDependencyT>& GetForceOperator() const noexcept;
......
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