Skip to content
GitLab
Menu
Projects
Groups
Snippets
Loading...
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
Menu
Open sidebar
MoReFEM
CoreLibrary
MoReFEM
Commits
856ff037
Commit
856ff037
authored
Nov 16, 2016
by
GILLES Sebastien
Browse files
#9
Add missing Doxygen comments.
parent
8ac12679
Changes
3
Hide whitespace changes
Inline
Side-by-side
Sources/Operators/GlobalVariationalOperator/GlobalVariationalOperator.hpp
View file @
856ff037
...
...
@@ -93,10 +93,19 @@ namespace HappyHeart
private:
/*!
* \class doxygen_hide_operator_do_allocate_gradient_felt_phi
*
* \brief Whether the gradient matrix of finite element phi will be required or not.
*
* If not allocated when it should an assert will warn you in debug mode; so you may specify no by
* default if you're not entirely sure whether it is required ot not.
*/
/*!
* \class doxygen_hide_operator_do_allocate_gradient_felt_phi_arg
*
* \param[in] do_allocate_gradient_felt_phi Whether the gradient matrix of finite element phi will be required
* \param[in] do_allocate_gradient_felt_phi Whether the gradient matrix of finite element phi will be required
* or not. If not allocated when it should an assert will warn you in debug mode; so you may specify no by
* default if you're not entirely sure whether it is required ot not.
*/
...
...
@@ -402,7 +411,7 @@ namespace HappyHeart
//! Finite element space.
const
FEltSpace
&
felt_space_
;
//! \copydoc doxygen_hide_operator_do_allocate_gradient_felt_phi
_arg
//! \copydoc doxygen_hide_operator_do_allocate_gradient_felt_phi
const
AllocateGradientFEltPhi
do_allocate_gradient_felt_phi_
;
/*!
...
...
Sources/Operators/LocalVariationalOperator/CauchyAndInvariant/InvariantComputation.hpp
View file @
856ff037
...
...
@@ -25,6 +25,8 @@ namespace HappyHeart
* \brief Returns first invariant.
*
* \copydoc doxygen_hide_cauchy_green_tensor_as_vector_arg
*
* \return Value of the first invariant.
*/
template
<
unsigned
int
DimensionT
>
double
Invariant1
(
const
LocalVector
&
cauchy_green_tensor
)
noexcept
;
...
...
@@ -33,6 +35,8 @@ namespace HappyHeart
* \brief Returns second invariant.
*
* \copydoc doxygen_hide_cauchy_green_tensor_as_vector_arg
*
* \return Value of the second invariant.
*/
template
<
unsigned
int
DimensionT
>
double
Invariant2
(
const
LocalVector
&
cauchy_green_tensor
)
noexcept
;
...
...
@@ -41,6 +45,8 @@ namespace HappyHeart
* \brief Returns third invariant.
*
* \copydoc doxygen_hide_cauchy_green_tensor_as_vector_arg
*
* \return Value of the third invariant.
*/
template
<
unsigned
int
DimensionT
>
double
Invariant3
(
const
LocalVector
&
cauchy_green_tensor
)
noexcept
;
...
...
Sources/Operators/ParameterOperator/GlobalParameterOperator/GlobalParameterOperator.hpp
View file @
856ff037
...
...
@@ -95,6 +95,7 @@ namespace HappyHeart
* LocalParameterOperator.
* \copydoc doxygen_hide_quadrature_rule_per_topology_nullptr_arg
* \copydetails doxygen_hide_do_compute_processor_wise_local_2_global_arg
* \copydoc doxygen_hide_operator_do_allocate_gradient_felt_phi_arg
*/
template
<
...
...
@@ -294,7 +295,7 @@ namespace HappyHeart
*/
const
ParameterAtQuadraturePoint
<
TypeT
,
TimeDependencyT
>&
parameter_
;
//! \copydoc doxygen_hide_operator_do_allocate_gradient_felt_phi
_arg
//! \copydoc doxygen_hide_operator_do_allocate_gradient_felt_phi
const
AllocateGradientFEltPhi
do_allocate_gradient_felt_phi_
;
};
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment