Commit b903de9a authored by GILLES Sebastien's avatar GILLES Sebastien

#1303 Complete Doxygen documentation for non linear membrane operator...

#1303 Complete Doxygen documentation for non linear membrane operator (pretension wasn't documented).
parent a2126c8a
......@@ -84,6 +84,7 @@ namespace MoReFEM
* \param[in] youngs_modulus Young's modulus of the solid.
* \param[in] poisson_ratio Poisson ratio of the solid.
* \param[in] thickness Thickness of the solid.
* \param[in] pretension Pretension (related computation are skipped if the underlying value is 0.).
*
* \internal <b><tt>[internal]</tt></b> This constructor must not be called manually: it is involved only in
* GlobalVariationalOperator<DerivedT, LocalVariationalOperatorT>::CreateLocalOperatorList() method.
......@@ -158,6 +159,8 @@ namespace MoReFEM
/*!
* \brief Compute Green-Lagrange.
*
* \param[in] pretension Value of the pretension.
*/
void ComputeGreenLagrange(const double pretension);
......@@ -201,7 +204,12 @@ namespace MoReFEM
* \return Thickness of the solid.
*/
const scalar_parameter& GetThickness() const noexcept;
/*!
* \brief Accessor to pretension parameter.
*
* \return Pretension.
*/
const scalar_parameter& GetPretension() const noexcept;
private:
......@@ -217,7 +225,8 @@ namespace MoReFEM
//! Thickness.
const scalar_parameter& thickness_;
//! Pretension.
const scalar_parameter& pretension_;
///@}
......
......@@ -91,6 +91,7 @@ namespace MoReFEM
* \param[in] youngs_modulus Young's modulus of the solid.
* \param[in] poisson_ratio Poisson ratio of the solid.
* \param[in] thickness Thickness of the solid.
* \param[in] pretension Pretension (related computation are skipped if the underlying value is 0.).
* \copydoc doxygen_hide_gvo_felt_space_arg
* \copydoc doxygen_hide_quadrature_rule_per_topology_nullptr_arg
*/
......
......@@ -128,7 +128,7 @@ namespace MoReFEM
*
* \param[in] do_assemble_into_matrix Whether we're assembling into a matrix or not.
* \param[in] do_assemble_into_vector Whether we're assembling into a vector or not.
* \param[in] pretension Whether a pretension is applied or not.
* \param[in] is_pretension Whether a pretension is applied or not.
*
* The three cases yes/yes, yes/no and no/yes are considered in the unit tests.
*/
......
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