Skip to content

Commit 880d094

Browse files
authored
Add doxygen biref to ale.h (chaos-polymtl#1017)
Description of the problem Doxygen missing in ale.h Description of the solution Add the required description. How Has This Been Tested? compile and inspect the doxygen output. Future changes parameters.h is next. Comments Since it is in the parameters namespace, the same description will be use in the parameters.h for declare and parse. I wanted to avoid the repetition of the description for declare and parse, but sometimes they differ a little bit, so I guess we should add the description everywher. Former-commit-id: 23dbe56
1 parent ae1f0c3 commit 880d094

File tree

1 file changed

+34
-6
lines changed

1 file changed

+34
-6
lines changed

include/core/ale.h

Lines changed: 34 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -23,39 +23,67 @@
2323
#include <deal.II/lac/vector.h>
2424

2525
using namespace dealii;
26-
/**
27-
* The ALE class provides an interface for all common
28-
* element required for the introduction of the required terms for a moving
29-
*referential in the governing equations.
30-
**/
3126

3227
namespace Parameters
3328
{
29+
/**
30+
* @brief An interface for all the common parameters required to consider
31+
* a moving frame of reference in a simplified Arbitrary Lagrangian Eulerian
32+
* (ALE) module.
33+
*
34+
* @tparam dim An integer that denotes the dimension of the space in which
35+
* the problem is solved.
36+
*/
3437
template <int dim>
3538
class ALE
3639
{
3740
public:
41+
/**
42+
* @brief Construct a new ALE object.
43+
*/
3844
ALE()
3945
{
4046
velocity = std::make_shared<Functions::ParsedFunction<dim>>(dim);
4147
}
4248

49+
50+
/**
51+
* @brief Declare the parameters.
52+
*
53+
* @param[in,out] prm The ParameterHandler.
54+
*/
4355
virtual void
4456
declare_parameters(ParameterHandler &prm);
57+
58+
/**
59+
* @brief Parse the parameters.
60+
*
61+
* @param[in,out] prm The ParameterHandler.
62+
*/
4563
virtual void
4664
parse_parameters(ParameterHandler &prm);
4765

4866

49-
// ALE-Velocity function
67+
/**
68+
* @brief ALE velocity function
69+
*/
5070
std::shared_ptr<Functions::ParsedFunction<dim>> velocity;
5171

72+
/**
73+
* @brief Return if the ALE module is enabled.
74+
*
75+
* @return enable A boolean that indicates if the ALE module is enabled.
76+
*/
5277
bool
5378
enabled() const
5479
{
5580
return enable;
5681
}
5782

5883
private:
84+
/**
85+
* @brief Boolean indicating if the ALE module is enabled.
86+
*/
5987
bool enable;
6088
};
6189

0 commit comments

Comments
 (0)