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

#1385 Complete Doxygen documentation so that latest versions of Doxygen may be...

#1385 Complete Doxygen documentation so that latest versions of Doxygen may be used without letting warnings.
parent 2451488a
......@@ -56,6 +56,8 @@ namespace MoReFEM
///@{
//! Constructor.
//! \param[in] row_numbering_subset \a NumberingSubset to use to define the numbering of rows.
//! \param[in] col_numbering_subset \a NumberingSubset to use to define the numbering of columns.
explicit NumberingSubsetForMatrix(const NumberingSubset& row_numbering_subset,
const NumberingSubset& col_numbering_subset);
......@@ -68,10 +70,10 @@ namespace MoReFEM
//! Move constructor.
NumberingSubsetForMatrix(NumberingSubsetForMatrix&&) = default;
//! Copy affectation.
//! \copydoc doxygen_hide_copy_affectation
NumberingSubsetForMatrix& operator=(const NumberingSubsetForMatrix&) = default;
//! Move affectation.
//! \copydoc doxygen_hide_move_affectation
NumberingSubsetForMatrix& operator=(NumberingSubsetForMatrix&&) = default;
///@}
......
......@@ -128,10 +128,10 @@ namespace MoReFEM
//! Move constructor.
EnsightCaseReader(EnsightCaseReader&&) = delete;
//! Copy affectation.
//! \copydoc doxygen_hide_copy_affectation
EnsightCaseReader& operator=(const EnsightCaseReader&) = delete;
//! Move affectation.
//! \copydoc doxygen_hide_move_affectation
EnsightCaseReader& operator=(EnsightCaseReader&&) = delete;
///@}
......
......@@ -78,10 +78,10 @@ namespace MoReFEM
//! Move constructor.
InputData(InputData&&) = delete;
//! Copy affectation.
//! \copydoc doxygen_hide_copy_affectation
InputData& operator=(const InputData&) = delete;
//! Move affectation.
//! \copydoc doxygen_hide_move_affectation
InputData& operator=(InputData&&) = delete;
......
......@@ -50,6 +50,8 @@ namespace MoReFEM
///@{
//! Constructor.
//! \param[in] numbering_subset \a NumberingSubset to use to define the numbering of rows and columns of the
//! diagonal matrix.
explicit GlobalDiagonalMatrix(const NumberingSubset& numbering_subset);
//! Destructor.
......@@ -61,10 +63,10 @@ namespace MoReFEM
//! Move constructor.
GlobalDiagonalMatrix(GlobalDiagonalMatrix&&) = delete;
//! Copy affectation.
//! \copydoc doxygen_hide_copy_affectation
GlobalDiagonalMatrix& operator=(const GlobalDiagonalMatrix&) = delete;
//! Move affectation.
//! \copydoc doxygen_hide_move_affectation
GlobalDiagonalMatrix& operator=(GlobalDiagonalMatrix&&) = delete;
///@}
......
......@@ -76,6 +76,8 @@ namespace MoReFEM
///@{
//! Constructor.
//! \param[in] row_numbering_subset \a NumberingSubset to use to define the numbering of rows.
//! \param[in] col_numbering_subset \a NumberingSubset to use to define the numbering of columns.
explicit GlobalMatrix(const NumberingSubset& row_numbering_subset,
const NumberingSubset& col_numbering_subset);
......@@ -88,10 +90,10 @@ namespace MoReFEM
//! Move constructor.
GlobalMatrix(GlobalMatrix&&) = delete;
//! Copy affectation.
//! \copydoc doxygen_hide_copy_affectation
GlobalMatrix& operator=(const GlobalMatrix&) = delete;
//! Move affectation.
//! \copydoc doxygen_hide_move_affectation
GlobalMatrix& operator=(GlobalMatrix&&) = delete;
///@}
......
......@@ -70,6 +70,7 @@ namespace MoReFEM
///@{
//! Constructor.
//! \param[in] numbering_subset \a NumberingSubset to use to define the numbering of the vector.
explicit GlobalVector(const NumberingSubset& numbering_subset);
//! Destructor.
......@@ -81,10 +82,10 @@ namespace MoReFEM
//! Move constructor.
GlobalVector(GlobalVector&&) = delete;
//! Copy affectation.
//! \copydoc doxygen_hide_copy_affectation
GlobalVector& operator=(const GlobalVector&) = delete;
//! Move affectation.
//! \copydoc doxygen_hide_move_affectation
GlobalVector& operator=(GlobalVector&&) = delete;
///@}
......
......@@ -99,10 +99,10 @@ namespace MoReFEM
//! Move constructor.
MoReFEMData(MoReFEMData&&) = delete;
//! Copy affectation.
//! \copydoc doxygen_hide_copy_affectation
MoReFEMData& operator=(const MoReFEMData&) = delete;
//! Move affectation.
//! \copydoc doxygen_hide_move_affectation
MoReFEMData& operator=(MoReFEMData&&) = delete;
///@}
......
......@@ -52,6 +52,8 @@ namespace MoReFEM
public:
//! Constructor.
//! \param[in] numbering_subset The \a NumberingSubset that will be used as equality criteria
//! in std::find_if algorithm.
explicit FindIfCondition(const NumberingSubset& numbering_subset);
//! Destructor.
......@@ -63,14 +65,15 @@ namespace MoReFEM
//! Move constructor.
FindIfCondition(FindIfCondition&&) = default;
//! Copy affectation.
//! \copydoc doxygen_hide_copy_affectation
FindIfCondition& operator=(const FindIfCondition&) = delete;
//! Move affectation.
//! \copydoc doxygen_hide_move_affectation
FindIfCondition& operator=(FindIfCondition&&) = delete;
//! Prototype to compare objects shielded by unique_ptr.
bool operator()(const T& rhs) const noexcept;
//! \param[in] item The (unary) element which will be compared to the stored \a numbering_subset_.
bool operator()(const T& item) const noexcept;
private:
......@@ -105,6 +108,10 @@ namespace MoReFEM
public:
//! Constructor.
//! \param[in] row_numbering_subset The \a NumberingSubset that will be used as equality criteria
//! for the rows in std::find_if algorithm.
//! \param[in] col_numbering_subset The \a NumberingSubset that will be used as equality criteria
//! for the columns in std::find_if algorithm.
FindIfConditionForPair(const NumberingSubset& row_numbering_subset,
const NumberingSubset& col_numbering_subset);
......@@ -117,14 +124,15 @@ namespace MoReFEM
//! Move constructor.
FindIfConditionForPair(FindIfConditionForPair&&) = default;
//! Copy affectation.
//! \copydoc doxygen_hide_copy_affectation
FindIfConditionForPair& operator=(const FindIfConditionForPair&) = delete;
//! Move affectation.
//! \copydoc doxygen_hide_move_affectation
FindIfConditionForPair& operator=(FindIfConditionForPair&&) = delete;
//! Prototype to compare objects shielded by unique_ptr.
bool operator()(const T& rhs) const noexcept;
//! \param[in] item The (unary) element which will be compared to the stored numbering_subsets.
bool operator()(const T& item) const noexcept;
private:
......
......@@ -42,7 +42,11 @@ namespace MoReFEM
public:
//! Name of the class (required for some Singleton-related errors).
/*!
* \brief Returns the name of the class (required for some Singleton-related errors).
*
* \return Name of the class.
*/
static const std::string& ClassName();
/*!
......@@ -116,6 +120,7 @@ namespace MoReFEM
//! \name Singleton requirements.
///@{
//! Constructor.
NumberingSubsetManager() = default;
......@@ -144,6 +149,7 @@ namespace MoReFEM
NumberingSubset::vector_const_shared_ptr& GetNonCstList();
//! Get the iterator to the element matching \a unique_id.
//! \param[in] unique_id The unique identifier which iterator is sought.
NumberingSubset::vector_const_shared_ptr::const_iterator GetIterator(unsigned int unique_id) const;
......
......@@ -117,10 +117,10 @@ namespace MoReFEM
//! Move constructor.
NumberingSubset(NumberingSubset&&) = delete;
//! Copy affectation.
//! \copydoc doxygen_hide_copy_affectation
NumberingSubset& operator=(const NumberingSubset&) = delete;
//! Move affectation.
//! \copydoc doxygen_hide_move_affectation
NumberingSubset& operator=(NumberingSubset&&) = delete;
///@}
......@@ -143,10 +143,18 @@ namespace MoReFEM
};
//! Comparison use the underlying id.
/*!
* \copydoc doxygen_hide_operator_equal
*
* Criterion chosen is the unique identifier of the à NumberingSubset.
*/
bool operator==(const NumberingSubset& lhs, const NumberingSubset& rhs);
//! Comparison use the underlying id.
/*!
* \copydoc doxygen_hide_operator_less
*
* Criterion chosen is the unique identifier of the à NumberingSubset.
*/
bool operator<(const NumberingSubset& lhs, const NumberingSubset& rhs);
......
......@@ -35,19 +35,7 @@ namespace MoReFEM
*
* \copydetails doxygen_hide_mpi_param
* \copydoc doxygen_hide_input_data_arg
* \param[in] snes_function If linear solve, just give nullptr. If non linear solve, give here the function
* evaluation routine. See Petsc documentation
* http://www.mcs.anl.gov/petsc/petsc-current/docs/manualpages/SNES/SNESSetFunction.html for more details.
* \param[in] snes_jacobian If non linear solve, give here the function that computes the jacobian. See Petsc
* documentation
* http://www.mcs.anl.gov/petsc/petsc-current/docs/manualpages/SNES/SNESSetJacobian.html for more details.
* \param[in] snes_viewer If non linear solve, give here the function that may print some informations at each
* iteration step. See Petsc documentation
* http://www.mcs.anl.gov/petsc/petsc-current/docs/manualpages/SNES/SNESMonitorSet.html for more details.
* \param[in] snes_convergence_test_function If non linear solve, give here the functional form used for testing of
* convergence of nonlinear solver. See Petsc documentation
* http://www.mcs.anl.gov/petsc/petsc-current/docs/manualpages/SNES/SNESConvergenceTestFunction.html for more
* details.
* \copydoc doxygen_hide_snes_functions_args
*
* \return \a Wrappers::Petsc::Snes correctly initialized.
*/
......
......@@ -65,10 +65,10 @@ namespace MoReFEM
//! Move constructor.
ConstantTimeStep(ConstantTimeStep&&) = delete;
//! Copy affectation.
//! \copydoc doxygen_hide_copy_affectation
ConstantTimeStep& operator=(const ConstantTimeStep&) = delete;
//! Move affectation.
//! \copydoc doxygen_hide_move_affectation
ConstantTimeStep& operator=(ConstantTimeStep&&) = delete;
///@}
......@@ -98,6 +98,7 @@ namespace MoReFEM
double& GetNonCstTimeStep();
//! Returns true if current time is equal or beyond maximum time.
//! \param[in] time Current time.
bool HasFinished(double time) const;
//! Returns whether the time step is constant (obviously true for this class!).
......@@ -115,6 +116,7 @@ namespace MoReFEM
const double time);
//! Set a new time step.
//! \param[in] time_step New value for time step.
void SetTimeStep(double time_step);
/*!
......
......@@ -64,10 +64,10 @@ namespace MoReFEM
//! Move constructor.
VariableTimeStep(VariableTimeStep&&) = delete;
//! Copy affectation.
//! \copydoc doxygen_hide_copy_affectation
VariableTimeStep& operator=(const VariableTimeStep&) = delete;
//! Move affectation.
//! \copydoc doxygen_hide_move_affectation
VariableTimeStep& operator=(VariableTimeStep&&) = delete;
///@}
......@@ -97,6 +97,7 @@ namespace MoReFEM
double& GetNonCstTimeStep() noexcept;
//! Returns true if current time is equal or beyond maximum time.
//! \param[in] time Current time.
bool HasFinished(double time) const;
//! Returns whether the time step is constant (obviously false for this class!).
......@@ -120,6 +121,7 @@ namespace MoReFEM
double GetMinimumTimeStep() const noexcept;
//! Set a new time step.
//! \param[in] time_step New value for time step.
void SetTimeStep(double time_step);
/*!
......
......@@ -82,10 +82,10 @@ namespace MoReFEM
//! Move constructor.
TimeManager(self&&) = delete;
//! Copy affectation.
//! \copydoc doxygen_hide_copy_affectation
self& operator=(const self&) = delete;
//! Move affectation.
//! \copydoc doxygen_hide_move_affectation
self& operator=(self&&) = delete;
///@}
......@@ -100,6 +100,7 @@ namespace MoReFEM
double GetTime() const;
//! Set the current time to a new value.
//! \param[in] time New time.
void SetTime(double time);
/*!
......@@ -155,6 +156,7 @@ namespace MoReFEM
virtual double GetMaximumTime() const = 0;
//! Set a new time step.
//! \param[in] time_step New value of time step.
virtual void SetTimeStep(double time_step) = 0;
/*!
......
......@@ -63,10 +63,10 @@ namespace MoReFEM
//! Move constructor.
TimeManagerInstance(self&&) = delete;
//! Copy affectation.
//! \copydoc doxygen_hide_copy_affectation
self& operator=(const self&) = delete;
//! Move affectation.
//! \copydoc doxygen_hide_move_affectation
self& operator=(self&&) = delete;
///@}
......@@ -93,6 +93,7 @@ namespace MoReFEM
virtual double GetMaximumTime() const override;
//! Set a new time step.
//! \param[in] time_step New value of time step.
virtual void SetTimeStep(double time_step) override;
//! \copydoc doxygen_hide_time_manager_adapt_time_step
......
......@@ -136,10 +136,10 @@ namespace MoReFEM
//! Move constructor.
DirichletBoundaryCondition(DirichletBoundaryCondition&&) = delete;
//! Copy affectation.
//! \copydoc doxygen_hide_copy_affectation
DirichletBoundaryCondition& operator=(const DirichletBoundaryCondition&) = delete;
//! Move affectation.
//! \copydoc doxygen_hide_move_affectation
DirichletBoundaryCondition& operator=(DirichletBoundaryCondition&&) = delete;
///@}
......
......@@ -58,7 +58,11 @@ namespace MoReFEM
*/
using CallBack = std::map<std::string, FunctionPrototype>;
//! Name of the class (required for some Singleton-related errors).
/*!
* \brief Returns the name of the class (required for some Singleton-related errors).
*
* \return Name of the class.
*/
static const std::string& ClassName();
......
......@@ -61,10 +61,10 @@ namespace MoReFEM
//! Move constructor.
ComponentManager(ComponentManager&&) = delete;
//! Copy affectation.
//! \copydoc doxygen_hide_copy_affectation
ComponentManager& operator=(const ComponentManager&) = delete;
//! Move affectation.
//! \copydoc doxygen_hide_move_affectation
ComponentManager& operator=(ComponentManager&&) = delete;
......
......@@ -54,10 +54,10 @@ namespace MoReFEM
//! Move constructor.
TComponentManager(TComponentManager&&) = delete;
//! Copy affectation.
//! \copydoc doxygen_hide_copy_affectation
TComponentManager& operator=(const TComponentManager&) = delete;
//! Move affectation.
//! \copydoc doxygen_hide_move_affectation
TComponentManager& operator=(TComponentManager&&) = delete;
};
......
......@@ -101,10 +101,10 @@ namespace MoReFEM
//! Move constructor.
DofStorage(DofStorage&&) = default;
//! Copy affectation.
//! \copydoc doxygen_hide_copy_affectation
DofStorage& operator=(const DofStorage&) = delete;
//! Move affectation.
//! \copydoc doxygen_hide_move_affectation
DofStorage& operator=(DofStorage&&) = delete;
///@}
......
......@@ -115,10 +115,10 @@ namespace MoReFEM
//! Move constructor.
FElt(FElt&&) = delete;
//! Copy affectation.
//! \copydoc doxygen_hide_copy_affectation
FElt& operator=(const FElt&) = delete;
//! Move affectation.
//! \copydoc doxygen_hide_move_affectation
FElt& operator=(FElt&&) = delete;
......
......@@ -108,10 +108,10 @@ namespace MoReFEM
//! Move constructor.
Local2GlobalStorage(Local2GlobalStorage&&) = delete;
//! Copy affectation.
//! \copydoc doxygen_hide_copy_affectation
Local2GlobalStorage& operator=(const Local2GlobalStorage&) = delete;
//! Move affectation.
//! \copydoc doxygen_hide_move_affectation
Local2GlobalStorage& operator=(Local2GlobalStorage&&) = delete;
///@}
......
......@@ -124,10 +124,10 @@ namespace MoReFEM
//! Move constructor.
GodOfDof(GodOfDof&&) = default;
//! Copy affectation.
//! \copydoc doxygen_hide_copy_affectation
GodOfDof& operator=(const GodOfDof&) = delete;
//! Move affectation.
//! \copydoc doxygen_hide_move_affectation
GodOfDof& operator=(GodOfDof&&) = delete;
......
......@@ -40,7 +40,11 @@ namespace MoReFEM
public:
//! Name of the class (required for some Singleton-related errors).
/*!
* \brief Returns the name of the class (required for some Singleton-related errors).
*
* \return Name of the class.
*/
static const std::string& ClassName();
......
......@@ -148,10 +148,10 @@ namespace MoReFEM
//! Move constructor.
DofProgramWiseIndexListPerVertexCoordIndexList(DofProgramWiseIndexListPerVertexCoordIndexList&&) = delete;
//! Copy affectation.
//! \copydoc doxygen_hide_copy_affectation
DofProgramWiseIndexListPerVertexCoordIndexList& operator=(const DofProgramWiseIndexListPerVertexCoordIndexList&) = delete;
//! Move affectation.
//! \copydoc doxygen_hide_move_affectation
DofProgramWiseIndexListPerVertexCoordIndexList& operator=(DofProgramWiseIndexListPerVertexCoordIndexList&&) = delete;
///@}
......
......@@ -61,7 +61,11 @@ namespace MoReFEM
public:
//! Name of the class (required for some Singleton-related errors).
/*!
* \brief Returns the name of the class (required for some Singleton-related errors).
*
* \return Name of the class.
*/
static const std::string& ClassName();
......
......@@ -110,10 +110,10 @@ namespace MoReFEM
//! Move constructor.
Storage(Storage&&) = delete;
//! Copy affectation.
//! \copydoc doxygen_hide_copy_affectation
Storage& operator=(const Storage&) = delete;
//! Move affectation.
//! \copydoc doxygen_hide_move_affectation
Storage& operator=(Storage&&) = delete;
......
......@@ -74,10 +74,10 @@ namespace MoReFEM
//! Move constructor.
AttributeProcessorHelper(AttributeProcessorHelper&&) = delete;
//! Copy affectation.
//! \copydoc doxygen_hide_copy_affectation
AttributeProcessorHelper& operator=(const AttributeProcessorHelper&) = delete;
//! Move affectation.
//! \copydoc doxygen_hide_move_affectation
AttributeProcessorHelper& operator=(AttributeProcessorHelper&&) = delete;
......
......@@ -120,10 +120,10 @@ namespace MoReFEM
//! Move constructor.
InternalStorage(InternalStorage&&) = default;
//! Copy affectation.
//! \copy