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

#9 Doxygen: add comment for all mpi arguments.

parent e7c879ab
......@@ -28,6 +28,7 @@ namespace HappyHeart
* \brief Init the time keeper and write its logs in the output directory specified in \a input_parameter_data.
*
* This function is to be called early in your main if you want to time keep some information lines.
* \copydetails doxygen_hide_mpi_param
*/
template<class InputParameterDataT>
void InitTimeKeepLog(const Wrappers::Mpi& mpi,
......
......@@ -68,8 +68,6 @@ namespace HappyHeart
assert(iCsr.size() == static_cast<std::size_t>(Nrow + 1)
&& "This would highlight a bug within MatrixPattern class");
Utilities::PrintContainer(jCsr, std::cout, ", ", "Assert jCSR -> [");
auto current_jcsr_index = 0ul;
for (auto i = 0; i < Nrow; ++i)
......@@ -92,14 +90,11 @@ namespace HappyHeart
current_jcsr_index += Nvalue_in_pattern_row;
Utilities::PrintContainer(position_list_in_pattern, std::cout, ", ", "Pattern -> [");
Utilities::PrintContainer(position_list_in_matrix, std::cout, ", ", "Matrix -> [");
if (!std::includes(position_list_in_pattern.cbegin(),
position_list_in_pattern.cend(),
position_list_in_matrix.cbegin(),
position_list_in_matrix.cend()))
{
std::cout << "EXCEPTION!!!!" << std::endl;
throw Exception("Position in the actual matrix must match those defined in the pattern!",
invoking_file, invoking_line);
}
......
......@@ -42,6 +42,9 @@ namespace HappyHeart
/*!
* \brief Init a linear solver from what is read in the input file and the required SNES functions in case of non
* linear one.
*
* \copydetails doxygen_hide_mpi_param
*
*/
template<unsigned int SolverIndexT, class InputParameterDataT>
Wrappers::Petsc::Snes::unique_ptr InitSolver(const Wrappers::Mpi& mpi,
......
......@@ -89,7 +89,11 @@ namespace HappyHeart
/// \name Special members.
///@{
//! Constructor.
/*!
* \brief Constructor.
*
* \copydetails doxygen_hide_mpi_param
*/
explicit Storage(const Wrappers::Mpi& mpi,
LocalFEltSpacePerRefFEltSpace&& felt_list_per_type);
......
......@@ -53,7 +53,11 @@ namespace HappyHeart
/// \name Special members.
///@{
//! Constructor.
/*!
* \brief Constructor.
*
* \copydetails doxygen_hide_mpi_param
*/
Model(const Wrappers::Mpi& mpi,
const InputParameterList& input_parameter_data);
......
......@@ -68,7 +68,11 @@ namespace HappyHeart
/// \name Special members.
///@{
//! Constructor.
/*!
* \brief Constructor.
*
* \copydetails doxygen_hide_mpi_param
*/
explicit VariationalFormulation(const Wrappers::Mpi& mpi,
const NumberingSubset& numbering_subset,
const TimeManager& time_manager,
......
......@@ -59,7 +59,11 @@ namespace HappyHeart
/// \name Special members.
///@{
//! Constructor.
/*!
* \brief Constructor.
*
* \copydetails doxygen_hide_mpi_param
*/
BidomainModel(const Wrappers::Mpi& mpi,
const InputParameterList& input_parameter_data);
......
......@@ -77,7 +77,11 @@ namespace HappyHeart
/// \name Special members.
///@{
//! Constructor.
/*!
* \brief Constructor.
*
* \copydetails doxygen_hide_mpi_param
*/
explicit BidomainVariationalFormulation(const Wrappers::Mpi& mpi,
const NumberingSubset& numbering_subset_1,
const TimeManager& time_manager,
......
......@@ -59,7 +59,11 @@ namespace HappyHeart
/// \name Special members.
///@{
//! Constructor.
/*!
* \brief Constructor.
*
* \copydetails doxygen_hide_mpi_param
*/
BidomainVentriclesModel(const Wrappers::Mpi& mpi,
const InputParameterList& input_parameter_data);
......
......@@ -68,7 +68,11 @@ namespace HappyHeart
/// \name Special members.
///@{
//! Constructor.
/*!
* \brief Constructor.
*
* \copydetails doxygen_hide_mpi_param
*/
explicit BidomainVentriclesVariationalFormulation(const Wrappers::Mpi& mpi,
const NumberingSubset& numbering_subset_1,
const TimeManager& time_manager,
......
......@@ -57,7 +57,11 @@ namespace HappyHeart
/// \name Special members.
///@{
//! Constructor.
/*!
* \brief Constructor.
*
* \copydetails doxygen_hide_mpi_param
*/
Model(const Wrappers::Mpi& mpi,
const InputParameterList& input_parameter_data);
......
......@@ -106,7 +106,11 @@ namespace HappyHeart
/// \name Special members.
///@{
//! Constructor.
/*!
* \brief Constructor.
*
* \copydetails doxygen_hide_mpi_param
*/
explicit VariationalFormulation(const Wrappers::Mpi& mpi,
const NumberingSubset& displacement_numbering_subset,
const NumberingSubset& electrical_activation_numbering_subset,
......
......@@ -52,7 +52,11 @@ namespace HappyHeart
/// \name Special members.
///@{
//! Constructor.
/*!
* \brief Constructor.
*
* \copydetails doxygen_hide_mpi_param
*/
ElasticityModel(const Wrappers::Mpi& mpi,
const InputParameterList& input_parameter_data);
......
......@@ -76,7 +76,11 @@ namespace HappyHeart
/// \name Special members.
///@{
//! Constructor.
/*!
* \brief Constructor.
*
* \copydetails doxygen_hide_mpi_param
*/
explicit VariationalFormulationElasticity(const Wrappers::Mpi& mpi,
const FEltSpace& main_felt_space,
const FEltSpace& neumann_felt_space,
......
......@@ -69,7 +69,11 @@ namespace HappyHeart
/// \name Special members.
///@{
//! Constructor.
/*!
* \brief Constructor.
*
* \copydetails doxygen_hide_mpi_param
*/
explicit AleElasticVariationalFormulation(const Wrappers::Mpi& mpi,
const FEltSpace& felt_space,
const Unknown& fluid_displacement,
......
......@@ -84,6 +84,7 @@ namespace HappyHeart
* \brief Constructor.
*
* \param[in] ale_varf ALE variational formulation if ALE is activated, nullptr if not.
* \copydetails doxygen_hide_mpi_param
*/
explicit ExplicitStepVariationalFormulation(const Wrappers::Mpi& mpi,
const NumberingSubset& numbering_subset,
......
......@@ -89,8 +89,12 @@ namespace HappyHeart
/// \name Special members.
///@{
//! Constructor.
/*!
* \brief Constructor.
*
* \copydetails doxygen_hide_mpi_param
*/
explicit ImplicitStepFluidVariationalFormulation(const Wrappers::Mpi& mpi,
const NumberingSubset& numbering_subset,
const TimeManager& time_manager,
......
......@@ -77,7 +77,11 @@ namespace HappyHeart
/// \name Special members.
///@{
//! Constructor.
/*!
* \brief Constructor.
*
* \copydetails doxygen_hide_mpi_param
*/
Model(const Wrappers::Mpi& mpi,
const InputParameterList& input_parameter_data);
......
......@@ -72,7 +72,11 @@ namespace HappyHeart
/// \name Special members.
///@{
//! Constructor.
/*!
* \brief Constructor.
*
* \copydetails doxygen_hide_mpi_param
*/
explicit VariationalFormulationElasticity(const Wrappers::Mpi& mpi,
const FEltSpace& main_felt_space,
const Unknown& solid_displacement,
......
......@@ -54,7 +54,11 @@ namespace HappyHeart
/// \name Special members.
///@{
//! Constructor.
/*!
* \brief Constructor.
*
* \copydetails doxygen_hide_mpi_param
*/
explicit HeatModel(const Wrappers::Mpi& mpi,
const InputParameterList& input_parameter_data);
......
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