Commit d3ac718b authored by GILLES Sebastien's avatar GILLES Sebastien
Browse files

#9 Doxygen: fix warnings for FElt library. Provide a unique documentation for all mpi arguments.

parent 044243d7
......@@ -14,9 +14,19 @@
namespace HappyHeart
{
// \todo #9 Move that in the mpi file! (do that once whole DOxygen reassembled; at the moment as I solve lib per lib
// it is more convenient to put it here.
/*!
* \class doxygen_hide_mpi_param
*
* \param[in] mpi Mpi object which knows the rank of the processor, the total number of processors, etc...
*/
constexpr double penalisation_very_high_value = 1.e10;
//! Very high value to use in penalization schemes.
constexpr double penalisation_very_high_value = 1.e20;
/*!
* \class doxygen_hide_do_consider_processor_wise_local_2_global
......@@ -41,7 +51,7 @@ namespace HappyHeart
*/
enum class DoComputeProcessorWiseLocal2Global { no, yes };
// \todo #583 Temporary tirck to choose default quadrature rules.
//! \todo #583 Temporary trick to choose default quadrature rules.
constexpr const unsigned int DEFAULT_DEGREE_OF_EXACTNESS = 5;
......
......@@ -166,13 +166,16 @@ namespace HappyHeart
* as the ordering in \a felt_list_.
*
* This array is not accessible publicly; it is used only to generate the local2global required by the
* operators (that are computed through a call to \a ComputeLocal2Global, issued in each GlobalVariationalOperator
* constructor).
* operators (that are computed through a call to \a ComputeLocal2Global, issued in each
* GlobalVariationalOperator constructor).
*
* \param[in] do_consider_processor_wise_local_2_global If yes, compute local -> global processor-wise index. This
* is not necessary for all global operators, so do not clutter space when it doesn't matter.
* \param[in] do_consider_processor_wise_local_2_global If yes, compute local -> global processor-wise index.
* This is not necessary for all global operators, so do not clutter space when it doesn't matter.
* \param[in] numbering_subset_list List of all numbering subsets for which local2global array should be
* computed.
*
* \internal <b><tt>[internal]</tt></b> Processor- and program-wise local2global arrays are actually stored in two different containers.
* \internal <b><tt>[internal]</tt></b> Processor- and program-wise local2global arrays are actually stored in
* two different containers.
*/
void InitLocal2Global(const NumberingSubset::vector_const_shared_ptr& numbering_subset_list,
DoConsiderProcessorWiseLocal2Global do_consider_processor_wise_local_2_global);
......@@ -219,11 +222,13 @@ namespace HappyHeart
*
* \warning Beware: processor-wise one must have been explicitly built with a dedicated argument in
* \a ComputeLocal2Global.
*
* \param[in] extended_unknown Couple unknown/numbering subset for which the local -> global arrray is sought.
*
* \return Local2global array related to \a unknown.
* \return Local2global array related to \a extended_unknown.
*/
template<MpiScale MpiScaleT>
const std::vector<PetscInt>& GetLocal2Global(const ExtendedUnknown& unknown) const;
const std::vector<PetscInt>& GetLocal2Global(const ExtendedUnknown& extended_unknown) const;
......
......@@ -92,7 +92,7 @@ namespace HappyHeart
*
* \internal <b><tt>[internal]</tt></b> It is private as construction should be driven by friend GodOfDofManager.
*
* \param[in] mpi Object in charge of managing Mpi-related informations.
* \copydetails doxygen_hide_mpi_param
* \param[in] mesh Mesh upon which the GodOfDof is built.
*/
explicit GodOfDof(const Wrappers::Mpi& mpi,
......
......@@ -55,6 +55,12 @@ namespace HappyHeart
* Mesh is not a typo here: there is one god of dof per mesh and so GodOfDofs are created by tracking mesh
* sections in the input parameter data.
*
* \tparam MeshSectionT Type of \a section.
*
* \param[in] section Section in the input parameter file which includes all relevant data required to build
* the mesh.
* \copydetails doxygen_hide_mpi_param
*
*/
template<class MeshSectionT>
void Create(const MeshSectionT& section,
......
......@@ -84,7 +84,7 @@ namespace HappyHeart
/*!
* \brief Constructor.
*
* \param[in] mpi Object in charge of mpi informations.
* \copydetails doxygen_hide_mpi_param
* \param[in] felt_list_per_ref_felt_space Finite element list per reference finite element space.
* It's just stored in the current class; it is actually computed elsewhere.
*/
......
......@@ -75,7 +75,7 @@ namespace HappyHeart
* \param[in] euclidian_partition Partition given by EuclidianPartition().
* \param[in] node_bearer_csr_pattern CSR pattern of the node bearers (NOT of the dofs!)
* obtained from CrudePartitioning().
* \param[in] mpi Object with Mpi informations (rank, number of processors, etc...)
* \copydetails doxygen_hide_mpi_param
* \param[in,out] node_bearer_list In input, list of all node bearers program-wise. In output, list
* of the same length with the node bearers sort differently: each one has been attributed to a
* processor and all node bearers on a same processor are grouped together.
......
......@@ -51,7 +51,7 @@ namespace HappyHeart
* and so on...
* Program-wise numbering is also applied: each of them gets as program-wise index its position in the new
* vector.
* \param[in] mpi Object including mpi informations.
* \copydetails doxygen_hide_mpi_param
* \param[in] felt_space_list List of finite element spaces in the god of dof that called present function.
*/
void PreparePartition(const Wrappers::Mpi& mpi,
......
......@@ -36,7 +36,7 @@ namespace HappyHeart
* This is this function that attributes a processor to each local_felt_space, unless it has already been
* attributed for a previous finite element space (this function is called once per finite element space).
*
* \param[in] mpi Object with Mpi informations (rank, number of processors, etc...)
* \copydetails doxygen_hide_mpi_param
* \param[in,out] felt_list_per_type The finite element list to be reduced to processor-wise values.
* \param[in,out] attribute_processor_helper Object which make the decision about the processor on which
* each geometric element should be related.
......
......@@ -66,7 +66,7 @@ namespace HappyHeart
*
* The enclosing class is there just to provide a simple object to befriend!
*
* \param[in] mpi Object with Mpi informations (rank, number of processors, etc...)
* \copydetails doxygen_hide_mpi_param
* \param[in,out] felt_space_list The list of finite elt spaces to reduce to processor-wise data.
* \param[in,out] geometric_mesh_region In input the mesh as read initially. In output, the reduced mesh
* that includes only GeometricElts on the local processor.
......
......@@ -102,7 +102,7 @@ namespace HappyHeart
* This isn't much of an issue: VariationalFormulation is expected to be build solely within base Model
* class, and this class knows this call must occur (it is already coded once and for all in its internals).
*
* \param[in] mpi Mpi object.
* \copydetails doxygen_hide_mpi_param
* \param[in] time_manager Object in charge of keeping track of the time-related informations.
* \param[in] god_of_dof God of dof into which the formulation works.
* \param[in] boundary_condition_list List of Dirichlet boundary conditions to take into account in the
......
......@@ -77,7 +77,7 @@ namespace HappyHeart
/*!
* \brief Constructor.
*
* \param[in] mpi Object that manages mpi informations.
* \copydetails doxygen_hide_mpi_param
* \param[in] time_manager Object in charge of keeping track of the time-related informations.
* \param[in] god_of_dof God of dof into which the formulation works.
* \param[in] main_felt_space Finite element space upon which the variational formulation apply.
......
......@@ -84,7 +84,7 @@ namespace HappyHeart
/*!
* \brief Constructor.
*
* \param[in] mpi Object that manages mpi informations.
* \copydetails doxygen_hide_mpi_param
* \param[in] time_manager Object in charge of keeping track of the time-related informations.
* \param[in] god_of_dof God of dof into which the formulation works.
* \param[in] main_felt_space Finite element space upon which the variational formulation apply.
......
......@@ -117,7 +117,7 @@ namespace HappyHeart
/*!
* \brief Constructor.
*
* \param[in] mpi Object that manages mpi informations.
* \copydetails doxygen_hide_mpi_param
* \param[in] time_manager Object in charge of keeping track of the time-related informations.
* \param[in] god_of_dof God of dof into which the formulation works.
* \param[in] felt_space Finite element space upon which the variational formulation apply.
......
......@@ -69,7 +69,7 @@ namespace HappyHeart
/*!
* \brief Constructor.
*
* \param[in] mpi Object that manages mpi informations.
* \copydetails doxygen_hide_mpi_param
* \param[in] input_parameter_data Object that manages data from the input parameter file.
*/
explicit HyperElasticityModel(const Wrappers::Mpi& mpi,
......
......@@ -133,7 +133,7 @@ namespace HappyHeart
/*!
* \brief Constructor.
*
* \param[in] mpi Object that manages mpi informations.
* \copydetails doxygen_hide_mpi_param
* \param[in] time_manager Object in charge of keeping track of the time-related informations.
* \param[in] god_of_dof God of dof into which the formulation works.
* \param[in] main_felt_space Finite element space upon which the variational formulation apply.
......
......@@ -77,7 +77,7 @@ namespace HappyHeart
/*!
* \brief Constructor.
*
* \param[in] mpi Object that manages mpi informations.
* \copydetails doxygen_hide_mpi_param
* \param[in] time_manager Object in charge of keeping track of the time-related informations.
* \param[in] god_of_dof God of dof into which the formulation works.
* \param[in] main_felt_space Finite element space upon which the variational formulation apply.
......
......@@ -84,7 +84,7 @@ namespace HappyHeart
/*!
* \brief Constructor.
*
* \param[in] mpi Object that manages mpi informations.
* \copydetails doxygen_hide_mpi_param
* \param[in] time_manager Object in charge of keeping track of the time-related informations.
* \param[in] god_of_dof God of dof into which the formulation works.
* \param[in] main_felt_space Finite element space upon which the variational formulation apply.
......
......@@ -111,7 +111,7 @@ namespace HappyHeart
/*!
* \brief Constructor.
*
* \param[in] mpi Object that manages mpi informations.
* \copydetails doxygen_hide_mpi_param
* \param[in] time_manager Object in charge of keeping track of the time-related informations.
* \param[in] god_of_dof God of dof into which the formulation works.
* \param[in] felt_space Finite element space upon which the variational formulation apply.
......
......@@ -84,7 +84,7 @@ namespace HappyHeart
/*!
* \brief Constructor.
*
* \param[in] mpi Object that manages mpi informations.
* \copydetails doxygen_hide_mpi_param
* \param[in] time_manager Object in charge of keeping track of the time-related informations.
* \param[in] god_of_dof God of dof into which the formulation works.
* \param[in] main_felt_space Finite element space upon which the variational formulation apply.
......
......@@ -118,7 +118,7 @@ namespace HappyHeart
/*!
* \brief Constructor.
*
* \param[in] mpi Object that manages mpi informations.
* \copydetails doxygen_hide_mpi_param
* \param[in] time_manager Object in charge of keeping track of the time-related informations.
* \param[in] god_of_dof God of dof into which the formulation works.
* \param[in] felt_space Finite element space upon which the variational formulation apply.
......
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