Skip to content
GitLab
Commit fc08b1ba authored by GILLES Sebastien's avatar GILLES Sebastien
Browse files

#1192 Update all header guards.

parent c285abd4
Hide whitespace changes
Inline Side-by-side
Scripts/header_guards.py
View file @ fc08b1ba
......@@ -20,7 +20,7 @@ class HeaderGuards():
def CorrectHeaderGuards(self, directory, ignore_list, header_extension_list = ("hpp", "hxx")):
"""Walk in directory and check all header guards are correct; if not propose a correction (git is there is the correction needs to be cancelled...)
\param[in] directory Source directory of the code (e.g. HappyHeart, 'M3DISIM-HappyHeart', ...).
\param[in] directory Source directory of the code (e.g. 'Morefem').
\param[in] ignore_list Paths that should be ignored while walking within directory. Path might be given absolutely or relatively to directory:
ignore_list = (os.path.join("ThirdParty", "Source"), ) // Ok
ignore_list = (os.path.join(directory, "ThirdParty", "Source"), ) // Ok
......@@ -221,10 +221,10 @@ class HeaderGuards():
if __name__ == "__main__":
directory = "${HOME}/Codes/HappyHeart/Sources"
directory = "${HOME}/Codes/Morefem/Sources"
ignore_list = (os.path.join("ThirdParty", "Source"), )
HeaderGuards("HappyHeart", directory, ignore_list)
HeaderGuards("MoReFEM", directory, ignore_list)
......
Sources/Core/Crtp/NumberingSubsetForMatrix.hpp
View file @ fc08b1ba
......@@ -9,39 +9,39 @@
/// \addtogroup CoreGroup
/// \{
#ifndef HAPPY_HEART_x_CORE_x_CRTP_x_NUMBERING_SUBSET_FOR_MATRIX_HPP_
# define HAPPY_HEART_x_CORE_x_CRTP_x_NUMBERING_SUBSET_FOR_MATRIX_HPP_
#ifndef MO_RE_F_E_M_x_CORE_x_CRTP_x_NUMBERING_SUBSET_FOR_MATRIX_HPP_
# define MO_RE_F_E_M_x_CORE_x_CRTP_x_NUMBERING_SUBSET_FOR_MATRIX_HPP_
namespace HappyHeart
{
// ============================
//! \cond IGNORE_BLOCK_IN_DOXYGEN
// Forward declarations.
// Forward declarations.
// ============================
class NumberingSubset;
// ============================
// End of forward declarations.
//! \endcond IGNORE_BLOCK_IN_DOXYGEN
// ============================
namespace Crtp
{
/// \addtogroup CoreGroup
///@{
/*!
* \brief This Crtp add two data attributes (const references to row and column numbering subsets) and accessors
* to them.
......@@ -49,59 +49,59 @@ namespace HappyHeart
template<class DerivedT>
class NumberingSubsetForMatrix
{
public:
/// \name Special members.
///@{
//! Constructor.
explicit NumberingSubsetForMatrix(const NumberingSubset& row_numbering_subset,
const NumberingSubset& col_numbering_subset);
//! Destructor.
~NumberingSubsetForMatrix() = default;
//! Copy constructor.
NumberingSubsetForMatrix(const NumberingSubsetForMatrix&);
//! Move constructor.
NumberingSubsetForMatrix(NumberingSubsetForMatrix&&) = default;
//! Copy affectation.
NumberingSubsetForMatrix& operator=(const NumberingSubsetForMatrix&) = default;
//! Move affectation.
NumberingSubsetForMatrix& operator=(NumberingSubsetForMatrix&&) = default;
///@}
//! Numbering subset used to describe rows.
const NumberingSubset& GetRowNumberingSubset() const;
//! Numbering subset used to describe columns.
const NumberingSubset& GetColNumberingSubset() const;
private:
//! Numbering subset used to describe rows.
const NumberingSubset& row_numbering_subset_;
//! Numbering subset used to describe columns.
const NumberingSubset& col_numbering_subset_;
};
///@} // \addtogroup CoreGroup
} // namespace Crtp
} // namespace HappyHeart
......@@ -111,4 +111,4 @@ namespace HappyHeart
# include "Core/Crtp/NumberingSubsetForMatrix.hxx"
#endif // HAPPY_HEART_x_CORE_x_CRTP_x_NUMBERING_SUBSET_FOR_MATRIX_HPP_
#endif // MO_RE_F_E_M_x_CORE_x_CRTP_x_NUMBERING_SUBSET_FOR_MATRIX_HPP_
Sources/Core/Crtp/NumberingSubsetForMatrix.hxx
View file @ fc08b1ba
......@@ -9,8 +9,8 @@
/// \addtogroup CoreGroup
/// \{
#ifndef HAPPY_HEART_x_CORE_x_CRTP_x_NUMBERING_SUBSET_FOR_MATRIX_HXX_
# define HAPPY_HEART_x_CORE_x_CRTP_x_NUMBERING_SUBSET_FOR_MATRIX_HXX_
#ifndef MO_RE_F_E_M_x_CORE_x_CRTP_x_NUMBERING_SUBSET_FOR_MATRIX_HXX_
# define MO_RE_F_E_M_x_CORE_x_CRTP_x_NUMBERING_SUBSET_FOR_MATRIX_HXX_
namespace HappyHeart
......@@ -19,38 +19,38 @@ namespace HappyHeart
namespace Crtp
{
template<class DerivedT>
NumberingSubsetForMatrix<DerivedT>::NumberingSubsetForMatrix(const NumberingSubset& row_numbering_subset,
const NumberingSubset& col_numbering_subset)
: row_numbering_subset_(row_numbering_subset),
col_numbering_subset_(col_numbering_subset)
{ }
template<class DerivedT>
NumberingSubsetForMatrix<DerivedT>::NumberingSubsetForMatrix(const NumberingSubsetForMatrix<DerivedT>& rhs)
: row_numbering_subset_(rhs.row_numbering_subset_),
col_numbering_subset_(rhs.col_numbering_subset_)
{ }
template<class DerivedT>
inline const NumberingSubset& NumberingSubsetForMatrix<DerivedT>::GetRowNumberingSubset() const
{
return row_numbering_subset_;
}
template<class DerivedT>
inline const NumberingSubset& NumberingSubsetForMatrix<DerivedT>::GetColNumberingSubset() const
{
return col_numbering_subset_;
}
} // namespace Crtp
......@@ -60,4 +60,4 @@ namespace HappyHeart
/// @} // addtogroup CoreGroup
#endif // HAPPY_HEART_x_CORE_x_CRTP_x_NUMBERING_SUBSET_FOR_MATRIX_HXX_
#endif // MO_RE_F_E_M_x_CORE_x_CRTP_x_NUMBERING_SUBSET_FOR_MATRIX_HXX_
Sources/Core/EnsightCaseReader/EnsightCaseReader.hpp
View file @ fc08b1ba
......@@ -6,8 +6,8 @@
// Copyright © 2016 Inria. All rights reserved.
//
#ifndef HAPPY_HEART_x_CORE_x_ENSIGHT_CASE_READER_x_ENSIGHT_CASE_READER_HPP_
# define HAPPY_HEART_x_CORE_x_ENSIGHT_CASE_READER_x_ENSIGHT_CASE_READER_HPP_
#ifndef MO_RE_F_E_M_x_CORE_x_ENSIGHT_CASE_READER_x_ENSIGHT_CASE_READER_HPP_
# define MO_RE_F_E_M_x_CORE_x_ENSIGHT_CASE_READER_x_ENSIGHT_CASE_READER_HPP_
# include <memory>
# include <vector>
......@@ -16,8 +16,8 @@
namespace HappyHeart
{
/*!
* \brief Struct to store the Ensight Geometry of a case.
*
......@@ -33,15 +33,15 @@ namespace HappyHeart
* \param[in] file Geometry file.
*/
EnsightGeometry(unsigned int time_set, const std::string& file);
//! Time set of the geometry.
unsigned int time_set_;
//! Geometry file.
std::string file_;
};
/*!
* \brief Struct to store the Ensight Time of a case.
*
......@@ -50,7 +50,7 @@ namespace HappyHeart
*/
struct EnsightTime
{
/*!
* \brief Constructor.
*
......@@ -65,19 +65,19 @@ namespace HappyHeart
unsigned int filename_start_number,
unsigned int filename_increment,
const std::vector<std::pair<double, unsigned int>>& time_values);
//! Time set of the case.
unsigned int time_set_;
//! Number of steps of the case.
unsigned int number_of_steps_;
//! Number of the first file.
unsigned int filename_start_number_;
//! Increment of the name file.
unsigned int filename_increment_;
//! Values of the times.
std::vector<std::pair<double, unsigned int>> time_values_;
};
......@@ -91,23 +91,23 @@ namespace HappyHeart
*/
class EnsightCaseReader
{
public:
//! Alias to self.
using self = EnsightCaseReader;
//! Alias to unique pointer.
using unique_ptr = std::unique_ptr<self>;
//! Alias to vector of unique pointers.
using vector_unique_ptr = std::vector<unique_ptr>;
public:
/// \name Special members.
///@{
/*!
* \brief Constructor.
*
......@@ -115,43 +115,43 @@ namespace HappyHeart
*
*/
explicit EnsightCaseReader(std::string filename);
//! Destructor.
~EnsightCaseReader() = default;
//! Copy constructor.
EnsightCaseReader(const EnsightCaseReader&) = delete;
//! Move constructor.
EnsightCaseReader(EnsightCaseReader&&) = delete;
//! Copy affectation.
EnsightCaseReader& operator=(const EnsightCaseReader&) = delete;
//! Move affectation.
EnsightCaseReader& operator=(EnsightCaseReader&&) = delete;
///@}
//! Print the info of the case.
void Print();
public:
//! Accessor to the EnsightGeometry.
const std::vector<EnsightGeometry>& GetEnsightGeometry() const noexcept;
//! Accessor to the EnsightTime.
const std::vector<EnsightTime>& GetEnsightTime() const noexcept;
private:
//! Name of the file.
std::string filename_;
//! EnsightGeometry of the case.
std::vector<EnsightGeometry> geometry_;
//! EnsightTime of the case.
std::vector<EnsightTime> time_;
......@@ -164,4 +164,4 @@ namespace HappyHeart
# include "Core/EnsightCaseReader/EnsightCaseReader.hxx"
#endif // HAPPY_HEART_x_CORE_x_ENSIGHT_CASE_READER_x_ENSIGHT_CASE_READER_HPP_
#endif // MO_RE_F_E_M_x_CORE_x_ENSIGHT_CASE_READER_x_ENSIGHT_CASE_READER_HPP_
Sources/Core/EnsightCaseReader/EnsightCaseReader.hxx
View file @ fc08b1ba
......@@ -6,8 +6,8 @@
// Copyright © 2016 Inria. All rights reserved.
//
#ifndef HAPPY_HEART_x_CORE_x_ENSIGHT_CASE_READER_x_ENSIGHT_CASE_READER_HXX_
# define HAPPY_HEART_x_CORE_x_ENSIGHT_CASE_READER_x_ENSIGHT_CASE_READER_HXX_
#ifndef MO_RE_F_E_M_x_CORE_x_ENSIGHT_CASE_READER_x_ENSIGHT_CASE_READER_HXX_
# define MO_RE_F_E_M_x_CORE_x_ENSIGHT_CASE_READER_x_ENSIGHT_CASE_READER_HXX_
namespace HappyHeart
......@@ -18,7 +18,7 @@ namespace HappyHeart
{
return geometry_;
}
inline const std::vector<EnsightTime>& EnsightCaseReader::GetEnsightTime() const noexcept
{
......@@ -29,4 +29,4 @@ namespace HappyHeart
} // namespace HappyHeart
#endif // HAPPY_HEART_x_CORE_x_ENSIGHT_CASE_READER_x_ENSIGHT_CASE_READER_HXX_
#endif // MO_RE_F_E_M_x_CORE_x_ENSIGHT_CASE_READER_x_ENSIGHT_CASE_READER_HXX_
Sources/Core/HappyHeart.hpp
View file @ fc08b1ba
......@@ -9,46 +9,46 @@
/// \addtogroup CoreGroup
/// \{
#ifndef HAPPY_HEART_x_CORE_x_HAPPY_HEART_HPP_
# define HAPPY_HEART_x_CORE_x_HAPPY_HEART_HPP_
#ifndef MO_RE_F_E_M_x_CORE_x_HAPPY_HEART_HPP_
# define MO_RE_F_E_M_x_CORE_x_HAPPY_HEART_HPP_
namespace HappyHeart
{
/// \addtogroup CoreGroup
///@{
//! Very high value to use in penalization schemes.
constexpr double penalisation_very_high_value = 1.e20;
/*!
* \brief Whether models should compute the very first processor-wise local2global array for each
* \brief Whether models should compute the very first processor-wise local2global array for each
* LocalFEltSpace/numbering subset combination found in FEltSpace.
*
] */
enum class DoConsiderProcessorWiseLocal2Global { no, yes };
/*!
* \brief If DoConsiderProcessorWiseLocal2Global is yes, each operator might decide whether it actually requires
* the processor-wise local2global array or not.
*/
enum class DoComputeProcessorWiseLocal2Global { no, yes };
//! \todo #900 Temporary trick to choose default quadrature rules.
constexpr const unsigned int DEFAULT_DEGREE_OF_EXACTNESS = 5;
///@} // \addtogroup
} // namespace HappyHeart
/// @} // addtogroup CoreGroup
#endif // HAPPY_HEART_x_CORE_x_HAPPY_HEART_HPP_
#endif // MO_RE_F_E_M_x_CORE_x_HAPPY_HEART_HPP_
Sources/Core/InitHappyHeart.hpp
View file @ fc08b1ba
......@@ -9,8 +9,8 @@
/// \addtogroup CoreGroup
/// \{
#ifndef HAPPY_HEART_x_CORE_x_INIT_HAPPY_HEART_HPP_
# define HAPPY_HEART_x_CORE_x_INIT_HAPPY_HEART_HPP_
#ifndef MO_RE_F_E_M_x_CORE_x_INIT_HAPPY_HEART_HPP_
# define MO_RE_F_E_M_x_CORE_x_INIT_HAPPY_HEART_HPP_
# include "ThirdParty/Wrappers/Mpi/Mpi.hpp"
......@@ -29,12 +29,12 @@
namespace HappyHeart
{
/// \addtogroup CoreGroup
///@{
/*!
* \brief Init HappyHeart: initialize mpi and read the input parameter file.
*
......@@ -43,7 +43,7 @@ namespace HappyHeart
* Make sure each exception is properly communicated to all ranks so that each rank can gracefully throw
* an exception and hence allow the program to stop properly.
*
* \tparam AdditionalCommandLineArgumentsT If not std::false_type, this class must include a static method with
* \tparam AdditionalCommandLineArgumentsT If not std::false_type, this class must include a static method with
* prototype
* \code
* static void AdditionalCommandLineArgumentsT::Add(TCLAP::CmdLine& command);
......@@ -59,53 +59,53 @@ namespace HappyHeart
>
class InitHappyHeart
{
public:
/// \name Special members.
///@{
//! Constructor.
explicit InitHappyHeart(int argc, char** argv);
//! Destructor.
~InitHappyHeart();
//! Copy constructor.
InitHappyHeart(const InitHappyHeart&) = delete;
//! Move constructor.
InitHappyHeart(InitHappyHeart&&) = delete;
//! Copy affectation.
InitHappyHeart& operator=(const InitHappyHeart&) = delete;
//! Move affectation.
InitHappyHeart& operator=(InitHappyHeart&&) = delete;
///@}
//! Accessor to underlying mpi object.
const Wrappers::Mpi& GetMpi() const;
//! Accessor to underlying InputParameterList object.
const InputParameterDataT& GetInputParameterList() const;
private:
//! Holds Mpi object.
Wrappers::Mpi::const_unique_ptr mpi_ = nullptr;
//! Holds RAII Petsc object, which ensures PetscFinalize() is called in due time.
Wrappers::Petsc::Petsc::const_unique_ptr petsc_ = nullptr;
//! Holds InputParameterList.
typename InputParameterDataT::const_unique_ptr input_parameter_data_ = nullptr;
};
///@} // \addtogroup
......@@ -118,4 +118,4 @@ namespace HappyHeart
# include "Core/InitHappyHeart.hxx"
#endif // HAPPY_HEART_x_CORE_x_INIT_HAPPY_HEART_HPP_
#endif // MO_RE_F_E_M_x_CORE_x_INIT_HAPPY_HEART_HPP_
Sources/Core/InitHappyHeart.hxx
View file @ fc08b1ba
......@@ -9,14 +9,14 @@
/// \addtogroup CoreGroup
/// \{
#ifndef HAPPY_HEART_x_CORE_x_INIT_HAPPY_HEART_HXX_
# define HAPPY_HEART_x_CORE_x_INIT_HAPPY_HEART_HXX_
#ifndef MO_RE_F_E_M_x_CORE_x_INIT_HAPPY_HEART_HXX_
# define MO_RE_F_E_M_x_CORE_x_INIT_HAPPY_HEART_HXX_
namespace HappyHeart
{
template
<
class InputParameterDataT,
......@@ -27,7 +27,7 @@ namespace HappyHeart
::InitHappyHeart(int argc, char** argv)
{
Wrappers::Mpi::InitEnvironment(argc, argv);
mpi_ = std::make_unique<Wrappers::Mpi>(0, Wrappers::MpiNS::Comm::World);
petsc_ = std::make_unique<Wrappers::Petsc::Petsc>(__FILE__, __LINE__);
......@@ -60,46 +60,46 @@ namespace HappyHeart
}
const auto& mpi = GetMpi();