From ba89f6a1b7b44b859ecdb0842c4fdc57335b3cfc Mon Sep 17 00:00:00 2001 From: Sebastien Gilles Date: Wed, 27 Dec 2017 16:38:30 +0100 Subject: [PATCH 01/11] #859 Add include. --- Sources/Utilities/Singleton/Singleton.hpp | 1 + 1 file changed, 1 insertion(+) diff --git a/Sources/Utilities/Singleton/Singleton.hpp b/Sources/Utilities/Singleton/Singleton.hpp index f083cac5e8..a366003279 100644 --- a/Sources/Utilities/Singleton/Singleton.hpp +++ b/Sources/Utilities/Singleton/Singleton.hpp @@ -15,6 +15,7 @@ # include # include # include +# include # include "Utilities/Singleton/Exceptions/Singleton.hpp" -- GitLab From ad674c4ec22f52092f814daaa40a69e5d36b67ba Mon Sep 17 00:00:00 2001 From: Sebastien Gilles Date: Mon, 1 Jan 2018 21:35:06 +0100 Subject: [PATCH 02/11] #1211 Test ParameterAtDof: also check the vectorial fiber manager. --- Sources/Test/Parameter/AtDof/Model.cpp | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/Sources/Test/Parameter/AtDof/Model.cpp b/Sources/Test/Parameter/AtDof/Model.cpp index 1448b9a1f3..8c4af2f26b 100644 --- a/Sources/Test/Parameter/AtDof/Model.cpp +++ b/Sources/Test/Parameter/AtDof/Model.cpp @@ -37,11 +37,13 @@ namespace MoReFEM { static_cast(morefem_data); - Internal::FiberNS::FiberListManager::GetInstance().GetNonCstFiberList(2).Initialize(); + decltype(auto) scalar_fiber_manager = + Internal::FiberNS::FiberListManager::GetInstance(); + scalar_fiber_manager.GetNonCstFiberList(EnumUnderlyingType(FiberIndex::distance)).Initialize(); - // decltype(auto) fiber_list = - //Internal::FiberNS::FiberListManager::GetInstance().GetNonCstFiberList(2).Initialize(); - + decltype(auto) vectorial_fiber_manager = + Internal::FiberNS::FiberListManager::GetInstance(); + vectorial_fiber_manager.GetNonCstFiberList(EnumUnderlyingType(FiberIndex::fiber)).Initialize(); } -- GitLab From 7ed49666b23bc7161fe1dda3b3f78edc26c8efd3 Mon Sep 17 00:00:00 2001 From: Sebastien Gilles Date: Mon, 1 Jan 2018 21:36:17 +0100 Subject: [PATCH 03/11] #1211 Test ConformProjector: correct the commented code (that will have to be reactivated somehow before putting it in continuous integration). --- Sources/Test/Operators/ConformProjector/Model.cpp | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/Sources/Test/Operators/ConformProjector/Model.cpp b/Sources/Test/Operators/ConformProjector/Model.cpp index 4b18e237da..bd6d8e4d60 100644 --- a/Sources/Test/Operators/ConformProjector/Model.cpp +++ b/Sources/Test/Operators/ConformProjector/Model.cpp @@ -215,13 +215,13 @@ namespace MoReFEM // felt_space3, // output_directory, // mpi); - - +// +// // interpolator_2_3_ = std::make_unique(felt_space2, -// felt_space3, // numbering_subset2, +// felt_space3, // numbering_subset3); -// +// // interpolator_2_3_->Init(); -- GitLab From 4f682b97ac033691a46a916c676069cdb83cce29 Mon Sep 17 00:00:00 2001 From: Sebastien Gilles Date: Sat, 30 Dec 2017 15:59:15 +0100 Subject: [PATCH 04/11] #1211 Add tests folder to Doxygen scope and fix warnings. ModelInstances not yet added but some of the warnings have nonetheless been fixed in the same time as their test counterpart (for instance NumberingSubsetIndex legend has been added for both tests and ModelInstances folder). --- Documentation/Doxygen/morefem.dox | 8 +- MoReFEM.xcodeproj/project.pbxproj | 2 + Sources/Core/Core.doxygen | 116 ++++++++++++++++++ .../InputParameterData/InputParameterList.hpp | 11 -- Sources/Core/TimeManager/TimeManager.doxygen | 4 +- .../VariationalFormulation.doxygen | 22 ++++ Sources/Model/Model.doxygen | 22 ++++ .../Elasticity/ElasticityModel.hpp | 10 +- .../Elasticity/InputParameterList.hpp | 11 ++ .../VariationalFormulationElasticity.hpp | 6 +- Sources/ModelInstances/Elasticity/main.cpp | 3 +- .../Elasticity/main_ensight_output.cpp | 1 + Sources/ModelInstances/Heat/HeatModel.hpp | 10 +- .../Heat/HeatVariationalFormulation.hpp | 12 +- .../Heat/InputParameterList.hpp | 26 +++- Sources/ModelInstances/Heat/main.cpp | 3 +- .../Heat/main_ensight_output.cpp | 1 + .../Hyperelasticity/InputParameterList.hpp | 24 +++- .../ModelInstances/Hyperelasticity/Model.hpp | 10 +- .../VariationalFormulation.hpp | 12 +- .../ModelInstances/Hyperelasticity/main.cpp | 3 +- .../Hyperelasticity/main_ensight_output.cpp | 1 + .../Laplacian/InputParameterList.hpp | 26 +++- Sources/ModelInstances/Laplacian/Model.hpp | 10 +- .../Laplacian/VariationalFormulation.hpp | 12 +- Sources/ModelInstances/Laplacian/main.cpp | 3 +- .../Laplacian/main_ensight_output.cpp | 1 + .../RivlinCube/InputParameterList.hpp | 26 +++- Sources/ModelInstances/RivlinCube/Model.hpp | 10 +- .../RivlinCube/VariationalFormulation.hpp | 11 +- Sources/ModelInstances/RivlinCube/main.cpp | 3 +- .../RivlinCube/main_ensight_output.cpp | 1 + .../Stokes/InputParameterList.hpp | 26 +++- Sources/ModelInstances/Stokes/Model.hpp | 10 +- .../Stokes/VariationalFormulation.hpp | 14 +-- Sources/ModelInstances/Stokes/main.cpp | 3 +- .../Stokes/main_ensight_output_monolithic.cpp | 1 + .../BilinearForm/Local/ScalarDivVectorial.hpp | 1 + .../BilinearForm/Local/Stokes.hpp | 1 + .../RefineMeshQuadranglesSpectral/Model.hpp | 8 +- .../main_convert_matrix_to_freefem.cpp | 2 + .../main_refined_mesh_output.cpp | 2 + .../VariableTimeStep/InputParameterList.hpp | 22 +++- Sources/Test/Core/VariableTimeStep/Model.hpp | 13 +- Sources/Test/Core/VariableTimeStep/main.cpp | 3 +- .../Geometry/Coloring/InputParameterList.hpp | 64 +++++----- Sources/Test/Geometry/Coloring/Model.hpp | 11 +- .../Geometry/Coloring/main_test_coloring.cpp | 3 +- .../CoordsInParallel/InputParameterList.hpp | 14 ++- .../Test/Geometry/CoordsInParallel/Model.hpp | 13 +- .../Test/Geometry/CoordsInParallel/main.cpp | 3 +- .../DomainListInCoords/InputParameterList.hpp | 8 +- .../Geometry/DomainListInCoords/Model.hpp | 13 +- .../Test/Geometry/DomainListInCoords/main.cpp | 3 +- .../InputParameterList.hpp | 22 ++-- .../Geometry/LightweightDomainList/Model.hpp | 13 +- .../main_test_lightweight_domain_list.cpp | 3 +- .../Geometry/Movemesh/InputParameterList.hpp | 22 +++- Sources/Test/Geometry/Movemesh/Model.hpp | 11 +- Sources/Test/Geometry/Movemesh/main.cpp | 3 +- .../NcoordInDomain/InputParameterList.hpp | 23 +++- .../Test/Geometry/NcoordInDomain/Model.hpp | 11 +- Sources/Test/Geometry/NcoordInDomain/main.cpp | 3 +- Sources/Test/Ondomatic/InputParameterList.hpp | 86 +++++++------ Sources/Test/Ondomatic/Model.hpp | 11 +- .../Test/Ondomatic/VariationalFormulation.hpp | 20 ++- Sources/Test/Ondomatic/main.cpp | 3 +- .../OndomaticNumbering/InputParameterList.hpp | 3 + .../main_test_ondomatic_numbering.cpp | 3 +- .../ConformProjector/InputParameterList.hpp | 23 ++-- .../Test/Operators/ConformProjector/Model.hpp | 16 +-- .../Test/Operators/ConformProjector/main.cpp | 3 +- .../FromVertexMatching/InputParameterList.hpp | 24 ++-- .../FromVertexMatching/Model.hpp | 11 +- .../FromVertexMatching/main.cpp | 3 +- .../P1_to_HigherOrder/InputParameterList.hpp | 14 ++- .../Operators/P1_to_HigherOrder/Model.hpp | 13 +- .../main_interpolator_P1_P1b.cpp | 3 +- .../main_interpolator_P1_P2.cpp | 3 +- .../TestFunctions/ExpectedResults.hpp | 111 ++++++++++++++++- .../TestFunctions/InputParameterList.hpp | 26 +++- .../Test/Operators/TestFunctions/Model.hpp | 11 +- .../TestFunctions/VariationalFormulation.hpp | 14 +-- Sources/Test/Operators/TestFunctions/main.cpp | 3 +- .../Parameter/AtDof/InputParameterList.hpp | 11 ++ Sources/Test/Parameter/AtDof/Model.cpp | 5 +- Sources/Test/Parameter/AtDof/Model.hpp | 16 +-- Sources/Test/Parameter/AtDof/main.cpp | 1 + .../TimeDependency/InputParameterList.hpp | 25 +++- .../Test/Parameter/TimeDependency/Model.hpp | 15 ++- .../Test/Parameter/TimeDependency/main.cpp | 3 +- Sources/Test/Test.doxygen | 18 +++ .../Mpi/ErrorHandling/InputParameterList.hpp | 7 +- .../ThirdParty/Mpi/ErrorHandling/main.cpp | 3 +- .../Mpi/Functions/InputParameterList.hpp | 7 +- .../Test/ThirdParty/Mpi/Functions/main.cpp | 3 +- .../Mpi/SendReceive/InputParameterList.hpp | 7 +- .../ThirdParty/Mpi/SendReceive/main_array.cpp | 3 +- .../Mpi/SendReceive/main_single_value.cpp | 3 +- .../InputParameterList/InputParameterList.hpp | 25 ++-- .../Utilities/InputParameterList/main.cpp | 3 +- .../___FILEBASENAME___.hpp | 23 +++- .../Main.xctemplate/___FILEBASENAME___.cpp | 3 +- .../___FILEBASENAME___.cpp | 1 + .../Model.xctemplate/___FILEBASENAME___.hpp | 12 +- .../___FILEBASENAME___.hpp | 16 +-- 106 files changed, 896 insertions(+), 488 deletions(-) create mode 100644 Sources/Test/Test.doxygen diff --git a/Documentation/Doxygen/morefem.dox b/Documentation/Doxygen/morefem.dox index 35cdb6a250..3154c76605 100644 --- a/Documentation/Doxygen/morefem.dox +++ b/Documentation/Doxygen/morefem.dox @@ -32,7 +32,7 @@ DOXYFILE_ENCODING = UTF-8 # title of most generated pages and in a few other places. # The default value is: My Project. -PROJECT_NAME = "MoReFEM +PROJECT_NAME = "MoReFEM" # The PROJECT_NUMBER tag can be used to enter a project or revision number. This # could be handy for archiving the generated documentation or if some version @@ -777,7 +777,8 @@ INPUT = ../../Sources/Utilities \ ../../Sources/OperatorInstances \ ../../Sources/FormulationSolver \ ../../Sources/Model \ - ../../Sources/PostProcessing + ../../Sources/PostProcessing \ + ../../Sources/Test # This tag can be used to specify the character encoding of the source files # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses @@ -834,8 +835,7 @@ EXCLUDE_SYMLINKS = NO # Note that the wildcards are matched against the file with absolute path, so to # exclude all test directories for example use the pattern */test/* -EXCLUDE_PATTERNS = *ThirdParty/Source* \ - *ModelInstances* +EXCLUDE_PATTERNS = *ThirdParty/Source* # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names # (namespaces, classes, functions, etc.) that should be excluded from the diff --git a/MoReFEM.xcodeproj/project.pbxproj b/MoReFEM.xcodeproj/project.pbxproj index dfc9e3ded5..27fd4a8b3d 100644 --- a/MoReFEM.xcodeproj/project.pbxproj +++ b/MoReFEM.xcodeproj/project.pbxproj @@ -5163,6 +5163,7 @@ BE7DE82A19CC541D00D24C7D /* Comm.cpp */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.cpp; path = Comm.cpp; sourceTree = ""; }; BE7DE82B19CC541D00D24C7D /* Comm.hpp */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.h; path = Comm.hpp; sourceTree = ""; }; BE80308718E43CAE00B4CA03 /* Interface.hxx */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.cpp.h; path = Interface.hxx; sourceTree = ""; }; + BE8058C91FF7DA5C008E97D2 /* Test.doxygen */ = {isa = PBXFileReference; lastKnownFileType = text; path = Test.doxygen; sourceTree = ""; }; BE80EE571DE72A88005502B4 /* ScalarTransientSource.hpp */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.h; name = ScalarTransientSource.hpp; path = Parameter/Source/ScalarTransientSource.hpp; sourceTree = ""; }; BE80EE581DE72A88005502B4 /* ScalarTransientSource.hxx */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.h; name = ScalarTransientSource.hxx; path = Parameter/Source/ScalarTransientSource.hxx; sourceTree = ""; }; BE8553A31BBD77BF00DB109E /* DofSource.cpp */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.cpp; path = DofSource.cpp; sourceTree = ""; }; @@ -8428,6 +8429,7 @@ BE372DCD18C47F0500127212 /* Test */ = { isa = PBXGroup; children = ( + BE8058C91FF7DA5C008E97D2 /* Test.doxygen */, BE6C215D19AF26AE00CC674B /* SConscript */, BE372DDB18C4802900127212 /* main_test.cpp */, BE436A151F694FBE003CE8E3 /* Tools */, diff --git a/Sources/Core/Core.doxygen b/Sources/Core/Core.doxygen index 1367e27bf6..3e3e03bcbe 100644 --- a/Sources/Core/Core.doxygen +++ b/Sources/Core/Core.doxygen @@ -26,3 +26,119 @@ /// \namespace MoReFEM::TimeManagerNS::Policy /// \brief Namespace that enclose time step policies related to TimeManager. + + + +/*! + * + * \class doxygen_hide_input_parameter_data_arg + * + * \param[in] input_parameter_data Object which hold the values of all the parameters defined in + * the input file. + */ + + +/*! + * + * \class doxygen_hide_morefem_data_param + * + * \param[in] morefem_data Object which hold few objects (mpi, input parameter file, Petsc helper and directory into + * which results are stored) that are almost global variables. + */ + + +/*! + * \class doxygen_hide_mesh_enum + * + * \brief Enum used to index the available meshes. + */ + + +/*! + * \class doxygen_hide_domain_enum + * + * \brief Enum used to index the available domains. + */ + + +/*! + * \class doxygen_hide_felt_space_enum + * + * \brief Enum used to index the available finite element spaces. + */ + + +/*! + * \class doxygen_hide_unknown_enum + * + * \brief Enum used to index the available unknowns. + */ + + +/*! + * \class doxygen_hide_solver_enum + * + * \brief Enum used to index the available solvers. + */ + + +/*! + * \class doxygen_hide_numbering_subset_enum + * + * \brief Enum used to index the available numbering subsets. + */ + +/*! + * \class doxygen_hide_source_enum + * + * \brief Enum used to index the available sources. + */ + +/*! + * \class doxygen_hide_boundary_condition_enum + * + * \brief Enum used to index the available boundary conditions. + */ + + +/*! + * \class doxygen_hide_input_parameter_tuple + * + * \brief Tuple which enumerates all the quantities that are addressed in the input file. + * + */ + + +/*! + * \class doxygen_hide_initial_condition_enum + * + * \brief Enum used to index the available initial conditions. + * + */ + + +/*! + * \class doxygen_hide_model_specific_input_parameter_list + * + * \brief The input parameter list object required for the current test or model. + * + */ + + + +/*! + * \class doxygen_hide_fiber_enum + * + * \brief Enum used to index the available fibers. + * + */ + +/*! + * \class doxygen_hide_morefem_data_type + * + * \brief The MoReFEMDataType object required for the current test or model. + * + */ + + + diff --git a/Sources/Core/InputParameterData/InputParameterList.hpp b/Sources/Core/InputParameterData/InputParameterList.hpp index c482f01307..978377da2a 100644 --- a/Sources/Core/InputParameterData/InputParameterList.hpp +++ b/Sources/Core/InputParameterData/InputParameterList.hpp @@ -33,17 +33,6 @@ namespace MoReFEM /// \addtogroup CoreGroup ///@{ - - /*! - * - * \class doxygen_hide_input_parameter_data_arg - * - * \param[in] input_parameter_data Object which hold the values of all the parameters defined in - * the input file. - */ - - - /*! * \brief This class read the input parameters and then is in charge of holding the values read. * diff --git a/Sources/Core/TimeManager/TimeManager.doxygen b/Sources/Core/TimeManager/TimeManager.doxygen index d4d752debf..e7235140db 100644 --- a/Sources/Core/TimeManager/TimeManager.doxygen +++ b/Sources/Core/TimeManager/TimeManager.doxygen @@ -1,7 +1,7 @@ /*! * \class doxygen_hide_time_manager_arg * - * \param[in] time_manager Object in charge of keeping track of the time-related informations. + * \param[in,out] time_manager Object in charge of keeping track of the time-related informations. */ @@ -11,4 +11,4 @@ * \brief Object in charge of keeping track of the time-related informations. * * \return Reference to the \a TimeManager. - */ \ No newline at end of file + */ diff --git a/Sources/FormulationSolver/VariationalFormulation.doxygen b/Sources/FormulationSolver/VariationalFormulation.doxygen index 4c009fb756..861af49bce 100644 --- a/Sources/FormulationSolver/VariationalFormulation.doxygen +++ b/Sources/FormulationSolver/VariationalFormulation.doxygen @@ -21,4 +21,26 @@ ///@} +/*! + * \class doxygen_hide_varf_constructor + * + * \copydoc doxygen_hide_morefem_data_param + * \copydoc doxygen_hide_time_manager_arg + * \param[in] god_of_dof \a GodOfDof upon which the variational formulation is defined. + * \param[in] boundary_condition_list List of Dirichlet boundary conditions to consider (please notice it is also + * possible to handle them directly; it is for conveniency it might be given here). + */ + + +/*! + * \class doxygen_hide_varf_suppl_init + * + * \brief Specific initialisation for derived class attributes. + * + * \internal [internal] This method is called by base class method VariationalFormulation::Init(). + * + * \copydoc doxygen_hide_input_parameter_data_arg + */ + + diff --git a/Sources/Model/Model.doxygen b/Sources/Model/Model.doxygen index 0aa071301e..6efff33ab0 100644 --- a/Sources/Model/Model.doxygen +++ b/Sources/Model/Model.doxygen @@ -18,5 +18,27 @@ ///@} +/*! + * \class doxygen_hide_model_SupplHasFinishedConditions_common + * + * \brief Whether the model wants to add additional cases in which the Model stops (besides the reach of + * maximum time). + * + */ + +/*! +* \class doxygen_hide_model_SupplHasFinishedConditions +* +* \copydoc doxygen_hide_model_SupplHasFinishedConditions_common +* +* \return True if one of the additional finish condition defined specifically in current \a Model is reached. +*/ +/*! + * \class doxygen_hide_model_SupplHasFinishedConditions_always_true + * + * \copydoc doxygen_hide_model_SupplHasFinishedConditions_common + * + * \return Always true (no such additional condition in this Model). + */ diff --git a/Sources/ModelInstances/Elasticity/ElasticityModel.hpp b/Sources/ModelInstances/Elasticity/ElasticityModel.hpp index 16e3898072..58a8d719c7 100644 --- a/Sources/ModelInstances/Elasticity/ElasticityModel.hpp +++ b/Sources/ModelInstances/Elasticity/ElasticityModel.hpp @@ -52,7 +52,7 @@ namespace MoReFEM /*! * \brief Constructor. * - * \copydetails doxygen_hide_mpi_param + * \copydoc doxygen_hide_morefem_data_param */ ElasticityModel(const morefem_data_type& morefem_data); @@ -82,6 +82,7 @@ namespace MoReFEM * \brief Initialise the problem. * * This initialisation includes the resolution of the static problem. + * \copydoc doxygen_hide_morefem_data_param */ void SupplInitialize(const morefem_data_type& morefem_data); @@ -113,12 +114,7 @@ namespace MoReFEM - /*! - * \brief Whether the model wants to add additional cases in which the Model stops (besides the reach of - * maximum time). - * - * Returns always true (no such additional condition in this Model). - */ + //! \copydoc doxygen_hide_model_SupplHasFinishedConditions_always_true bool SupplHasFinishedConditions() const; diff --git a/Sources/ModelInstances/Elasticity/InputParameterList.hpp b/Sources/ModelInstances/Elasticity/InputParameterList.hpp index 8bf51e1b65..f48aedcf20 100644 --- a/Sources/ModelInstances/Elasticity/InputParameterList.hpp +++ b/Sources/ModelInstances/Elasticity/InputParameterList.hpp @@ -32,12 +32,14 @@ namespace MoReFEM { + //! \copydoc doxygen_hide_mesh_enum enum class MeshIndex { mesh = 1 // only one mesh considered in current model! }; + //! \copydoc doxygen_hide_domain_enum enum class DomainIndex { highest_dimension = 1, @@ -47,6 +49,7 @@ namespace MoReFEM }; + //! \copydoc doxygen_hide_felt_space_enum enum class FEltSpaceIndex { highest_dimension = 1, @@ -54,24 +57,28 @@ namespace MoReFEM }; + //! \copydoc doxygen_hide_unknown_enum enum class UnknownIndex { solid_displacement = 1 }; + //! \copydoc doxygen_hide_solver_enum enum class SolverIndex { solver = 1 }; + //! \copydoc doxygen_hide_numbering_subset_enum enum class NumberingSubsetIndex { monolithic = 1 }; + //! \copydoc doxygen_hide_source_enum enum class SourceIndex { volumic = 1, @@ -79,12 +86,14 @@ namespace MoReFEM }; + //! \copydoc doxygen_hide_boundary_condition_enum enum class BoundaryConditionIndex { sole = 1 }; + //! \copydoc doxygen_hide_input_parameter_tuple using InputParameterTuple = std::tuple < InputParameter::TimeManager, @@ -119,8 +128,10 @@ namespace MoReFEM >; + //! \copydoc doxygen_hide_model_specific_input_parameter_list using InputParameterList = InputParameterList; + //! \copydoc doxygen_hide_morefem_data_type using morefem_data_type = MoReFEMData; diff --git a/Sources/ModelInstances/Elasticity/VariationalFormulationElasticity.hpp b/Sources/ModelInstances/Elasticity/VariationalFormulationElasticity.hpp index 56d1a3ba6d..11410a51e6 100644 --- a/Sources/ModelInstances/Elasticity/VariationalFormulationElasticity.hpp +++ b/Sources/ModelInstances/Elasticity/VariationalFormulationElasticity.hpp @@ -76,11 +76,7 @@ namespace MoReFEM /// \name Special members. ///@{ - /*! - * \brief Constructor. - * - * \copydetails doxygen_hide_mpi_param - */ + //! copydoc doxygen_hide_varf_constructor explicit VariationalFormulationElasticity(const morefem_data_type& morefem_data, const FEltSpace& main_felt_space, const FEltSpace& neumann_felt_space, diff --git a/Sources/ModelInstances/Elasticity/main.cpp b/Sources/ModelInstances/Elasticity/main.cpp index 42a07da358..f469eb72f1 100644 --- a/Sources/ModelInstances/Elasticity/main.cpp +++ b/Sources/ModelInstances/Elasticity/main.cpp @@ -21,7 +21,8 @@ using namespace MoReFEM; int main(int argc, char** argv) { - using InputParameterList = ElasticityNS::InputParameterList; + //! \copydoc doxygen_hide_model_specific_input_parameter_list + using InputParameterList = ElasticityNS::InputParameterList; try { diff --git a/Sources/ModelInstances/Elasticity/main_ensight_output.cpp b/Sources/ModelInstances/Elasticity/main_ensight_output.cpp index 9cfd815b39..117c060d65 100644 --- a/Sources/ModelInstances/Elasticity/main_ensight_output.cpp +++ b/Sources/ModelInstances/Elasticity/main_ensight_output.cpp @@ -29,6 +29,7 @@ int main(int argc, char** argv) try { + //! \copydoc doxygen_hide_model_specific_input_parameter_list using InputParameterList = ElasticityNS::InputParameterList; MoReFEMData morefem_data(argc, argv); diff --git a/Sources/ModelInstances/Heat/HeatModel.hpp b/Sources/ModelInstances/Heat/HeatModel.hpp index 6bcedfbbc7..cbd285de4e 100644 --- a/Sources/ModelInstances/Heat/HeatModel.hpp +++ b/Sources/ModelInstances/Heat/HeatModel.hpp @@ -54,7 +54,7 @@ namespace MoReFEM /*! * \brief Constructor. * - * \copydetails doxygen_hide_mpi_param + * \copydoc doxygen_hide_morefem_data_param */ explicit HeatModel(const morefem_data_type& morefem_data); @@ -84,6 +84,7 @@ namespace MoReFEM * \brief Initialise the problem. * * This initialisation includes the resolution of the static problem. + * \copydoc doxygen_hide_morefem_data_param */ void SupplInitialize(const morefem_data_type& morefem_data); @@ -119,12 +120,7 @@ namespace MoReFEM private: - /*! - * \brief Whether the model wants to add additional cases in which the Model stops (besides the reach of - * maximum time). - * - * Returns always true (no such additional condition in this Model). - */ + //! \copydoc doxygen_hide_model_SupplHasFinishedConditions_always_true bool SupplHasFinishedConditions() const; diff --git a/Sources/ModelInstances/Heat/HeatVariationalFormulation.hpp b/Sources/ModelInstances/Heat/HeatVariationalFormulation.hpp index a8689b1328..bf1e4465fc 100644 --- a/Sources/ModelInstances/Heat/HeatVariationalFormulation.hpp +++ b/Sources/ModelInstances/Heat/HeatVariationalFormulation.hpp @@ -73,11 +73,7 @@ namespace MoReFEM /// \name Special members. ///@{ - /*! - * \brief Constructor. - * - * \copydetails doxygen_hide_mpi_param - */ + //! copydoc doxygen_hide_varf_constructor explicit HeatVariationalFormulation(const morefem_data_type& morefem_data, const NumberingSubset& numbering_subset, TimeManager& time_manager, @@ -175,11 +171,7 @@ namespace MoReFEM /// \name CRTP-required methods. ///@{ - /*! - * \brief Specific initialisation for derived class attributes. - * - * \internal [internal] This method is called by base class method VariationalFormulation::Init(). - */ + //! \copydoc doxygen_hide_varf_suppl_init void SupplInit(const InputParameterList& input_parameter_data); /*! diff --git a/Sources/ModelInstances/Heat/InputParameterList.hpp b/Sources/ModelInstances/Heat/InputParameterList.hpp index 9af0a45041..88eb9faf84 100644 --- a/Sources/ModelInstances/Heat/InputParameterList.hpp +++ b/Sources/ModelInstances/Heat/InputParameterList.hpp @@ -29,6 +29,7 @@ namespace MoReFEM { + //! \copydoc doxygen_hide_source_enum enum class ForceIndexList : unsigned int { volumic_source = 1, @@ -37,13 +38,15 @@ namespace MoReFEM }; - enum class MeshIndex + //! \copydoc doxygen_hide_mesh_enum + enum class MeshIndex { mesh = 1 // only one mesh considered in current model! }; - enum class DomainIndex + //! \copydoc doxygen_hide_domain_enum + enum class DomainIndex { highest_dimension = 1, neumann = 2, @@ -54,6 +57,7 @@ namespace MoReFEM }; + //! \copydoc doxygen_hide_boundary_condition_enum enum class BoundaryConditionIndex { first = 1, @@ -61,7 +65,8 @@ namespace MoReFEM }; - enum class FEltSpaceIndex + //! \copydoc doxygen_hide_felt_space_enum + enum class FEltSpaceIndex { highest_dimension = 1, neumann = 2, @@ -69,19 +74,23 @@ namespace MoReFEM }; - enum class UnknownIndex + //! \copydoc doxygen_hide_unknown_enum + enum class UnknownIndex { temperature = 1 }; - enum class SolverIndex + //! \copydoc doxygen_hide_solver_enum + enum class SolverIndex + { solver = 1 }; - enum class NumberingSubsetIndex + //! \copydoc doxygen_hide_numbering_subset_enum + enum class NumberingSubsetIndex { monolithic = 1 }; @@ -92,11 +101,14 @@ namespace MoReFEM }; + //! \copydoc doxygen_hide_initial_condition_enum enum class InitialConditionIndex { temperature_initial_condition = 1 }; + + //! \copydoc doxygen_hide_input_parameter_tuple using InputParameterTuple = std::tuple < InputParameter::TimeManager, @@ -138,8 +150,10 @@ namespace MoReFEM >; + //! \copydoc doxygen_hide_model_specific_input_parameter_list using InputParameterList = InputParameterList; + //! \copydoc doxygen_hide_morefem_data_type using morefem_data_type = MoReFEMData; diff --git a/Sources/ModelInstances/Heat/main.cpp b/Sources/ModelInstances/Heat/main.cpp index 6536151dd3..fdc2e9f057 100644 --- a/Sources/ModelInstances/Heat/main.cpp +++ b/Sources/ModelInstances/Heat/main.cpp @@ -21,7 +21,8 @@ using namespace MoReFEM; int main(int argc, char** argv) { - using InputParameterList = HeatNS::InputParameterList; + //! \copydoc doxygen_hide_model_specific_input_parameter_list + using InputParameterList = HeatNS::InputParameterList; try { diff --git a/Sources/ModelInstances/Heat/main_ensight_output.cpp b/Sources/ModelInstances/Heat/main_ensight_output.cpp index 8b13a152f5..1e572402f6 100644 --- a/Sources/ModelInstances/Heat/main_ensight_output.cpp +++ b/Sources/ModelInstances/Heat/main_ensight_output.cpp @@ -29,6 +29,7 @@ int main(int argc, char** argv) try { + //! \copydoc doxygen_hide_model_specific_input_parameter_list using InputParameterList = HeatNS::InputParameterList; MoReFEMData morefem_data(argc, argv); diff --git a/Sources/ModelInstances/Hyperelasticity/InputParameterList.hpp b/Sources/ModelInstances/Hyperelasticity/InputParameterList.hpp index df3a2107e7..3e038e648f 100644 --- a/Sources/ModelInstances/Hyperelasticity/InputParameterList.hpp +++ b/Sources/ModelInstances/Hyperelasticity/InputParameterList.hpp @@ -31,22 +31,26 @@ namespace MoReFEM { - enum class NumberingSubsetIndex + //! \copydoc doxygen_hide_numbering_subset_enum + enum class NumberingSubsetIndex { displacement = 1 }; - enum class UnknownIndex + //! \copydoc doxygen_hide_unknown_enum + enum class UnknownIndex { displacement = 1 }; - enum class MeshIndex + //! \copydoc doxygen_hide_mesh_enum + enum class MeshIndex { mesh = 1 }; - enum class DomainIndex + //! \copydoc doxygen_hide_domain_enum + enum class DomainIndex { full_mesh = 1, volume = 2, @@ -54,28 +58,34 @@ namespace MoReFEM dirichlet = 4, }; + //! \copydoc doxygen_hide_boundary_condition_enum enum class BoundaryConditionIndex { clamped = 1 }; - enum class FEltSpaceIndex + //! \copydoc doxygen_hide_felt_space_enum + enum class FEltSpaceIndex { volume = 1, force = 2 }; - enum class SolverIndex + //! \copydoc doxygen_hide_solver_enum + enum class SolverIndex + { solver = 1 }; + //! \copydoc doxygen_hide_source_enum enum class ForceIndexList { surfacic = 1 }; + //! \copydoc doxygen_hide_input_parameter_tuple using InputParameterTuple = std::tuple < InputParameter::TimeManager, @@ -109,8 +119,10 @@ namespace MoReFEM >; + //! \copydoc doxygen_hide_model_specific_input_parameter_list using InputParameterList = InputParameterList; + //! \copydoc doxygen_hide_morefem_data_type using morefem_data_type = MoReFEMData; diff --git a/Sources/ModelInstances/Hyperelasticity/Model.hpp b/Sources/ModelInstances/Hyperelasticity/Model.hpp index d76a9a0af9..711d19bc19 100644 --- a/Sources/ModelInstances/Hyperelasticity/Model.hpp +++ b/Sources/ModelInstances/Hyperelasticity/Model.hpp @@ -57,7 +57,7 @@ namespace MoReFEM /*! * \brief Constructor. * - * \copydetails doxygen_hide_mpi_param + * \copydoc doxygen_hide_morefem_data_param */ Model(const morefem_data_type& morefem_data); @@ -87,6 +87,7 @@ namespace MoReFEM * \brief Initialise the problem. * * This initialisation includes the resolution of the static problem. + * \copydoc doxygen_hide_morefem_data_param */ void SupplInitialize(const morefem_data_type& morefem_data); @@ -112,12 +113,7 @@ namespace MoReFEM private: - /*! - * \brief Whether the model wants to add additional cases in which the Model stops (besides the reach of - * maximum time). - * - * Returns always true (no such additional condition in this Model). - */ + //! \copydoc doxygen_hide_model_SupplHasFinishedConditions_always_true bool SupplHasFinishedConditions() const; diff --git a/Sources/ModelInstances/Hyperelasticity/VariationalFormulation.hpp b/Sources/ModelInstances/Hyperelasticity/VariationalFormulation.hpp index 553cc0a2b1..da0a08319a 100644 --- a/Sources/ModelInstances/Hyperelasticity/VariationalFormulation.hpp +++ b/Sources/ModelInstances/Hyperelasticity/VariationalFormulation.hpp @@ -117,11 +117,7 @@ namespace MoReFEM /// \name Special members. ///@{ - /*! - * \brief Constructor. - * - * \copydetails doxygen_hide_mpi_param - */ + //! copydoc doxygen_hide_varf_constructor explicit VariationalFormulation(const morefem_data_type& morefem_data, const NumberingSubset& displacement_numbering_subset, TimeManager& time_manager, @@ -163,11 +159,7 @@ namespace MoReFEM /// \name CRTP-required methods. ///@{ - /*! - * \brief Specific initialisation for derived class attributes. - * - * \internal [internal] This method is called by base class method VariationalFormulation::Init(). - */ + //! \copydoc doxygen_hide_varf_suppl_init void SupplInit(const InputParameterList& input_parameter_data); /*! diff --git a/Sources/ModelInstances/Hyperelasticity/main.cpp b/Sources/ModelInstances/Hyperelasticity/main.cpp index b9241e8e2a..a171e0765c 100644 --- a/Sources/ModelInstances/Hyperelasticity/main.cpp +++ b/Sources/ModelInstances/Hyperelasticity/main.cpp @@ -19,7 +19,8 @@ using namespace MoReFEM; int main(int argc, char** argv) { - using InputParameterList = MidpointHyperelasticityNS::InputParameterList; + //! \copydoc doxygen_hide_model_specific_input_parameter_list + using InputParameterList = MidpointHyperelasticityNS::InputParameterList; try { diff --git a/Sources/ModelInstances/Hyperelasticity/main_ensight_output.cpp b/Sources/ModelInstances/Hyperelasticity/main_ensight_output.cpp index d6b3b8a0b6..03a64d74b1 100644 --- a/Sources/ModelInstances/Hyperelasticity/main_ensight_output.cpp +++ b/Sources/ModelInstances/Hyperelasticity/main_ensight_output.cpp @@ -29,6 +29,7 @@ int main(int argc, char** argv) try { + //! \copydoc doxygen_hide_model_specific_input_parameter_list using InputParameterList = MidpointHyperelasticityNS::InputParameterList; MoReFEMData morefem_data(argc, argv); diff --git a/Sources/ModelInstances/Laplacian/InputParameterList.hpp b/Sources/ModelInstances/Laplacian/InputParameterList.hpp index daa26c9e6f..9996b4302a 100644 --- a/Sources/ModelInstances/Laplacian/InputParameterList.hpp +++ b/Sources/ModelInstances/Laplacian/InputParameterList.hpp @@ -28,23 +28,27 @@ namespace MoReFEM { - enum class MeshIndex + //! \copydoc doxygen_hide_mesh_enum + enum class MeshIndex { mesh = 1 // only one mesh considered in current model! }; - enum class NumberingSubsetIndex + //! \copydoc doxygen_hide_numbering_subset_enum + enum class NumberingSubsetIndex { monolithic = 1 }; - enum class UnknownIndex + //! \copydoc doxygen_hide_unknown_enum + enum class UnknownIndex { pressure = 1 }; - enum class DomainIndex + //! \copydoc doxygen_hide_domain_enum + enum class DomainIndex { full_mesh = 1, volume = 2, @@ -52,32 +56,40 @@ namespace MoReFEM }; + //! \copydoc doxygen_hide_boundary_condition_enum enum class BoundaryConditionIndex { first = 1 }; - enum class FEltSpaceIndex + //! \copydoc doxygen_hide_felt_space_enum + enum class FEltSpaceIndex { volume = 1 }; - enum class SolverIndex + //! \copydoc doxygen_hide_solver_enum + enum class SolverIndex + { solver = 1 }; + //! \copydoc doxygen_hide_source_enum enum class SourceIndexList : unsigned int { volumic_source = 1 }; + + //! \copydoc doxygen_hide_initial_condition_enum enum class InitialConditionIndex { initial_condition = 1 }; + //! \copydoc doxygen_hide_input_parameter_tuple using InputParameterTuple = std::tuple < InputParameter::TimeManager, @@ -107,8 +119,10 @@ namespace MoReFEM >; + //! \copydoc doxygen_hide_model_specific_input_parameter_list using InputParameterList = InputParameterList; + //! \copydoc doxygen_hide_morefem_data_type using morefem_data_type = MoReFEMData; diff --git a/Sources/ModelInstances/Laplacian/Model.hpp b/Sources/ModelInstances/Laplacian/Model.hpp index 8afcc6c5e7..22d16580e7 100644 --- a/Sources/ModelInstances/Laplacian/Model.hpp +++ b/Sources/ModelInstances/Laplacian/Model.hpp @@ -54,7 +54,7 @@ namespace MoReFEM /*! * \brief Constructor. * - * \copydetails doxygen_hide_mpi_param + * \copydoc doxygen_hide_morefem_data_param */ explicit Model(const morefem_data_type& morefem_data); @@ -84,6 +84,7 @@ namespace MoReFEM * \brief Initialise the problem. * * This initialisation includes the resolution of the static problem. + * \copydoc doxygen_hide_morefem_data_param */ void SupplInitialize(const morefem_data_type& morefem_data); @@ -118,12 +119,7 @@ namespace MoReFEM private: - /*! - * \brief Whether the model wants to add additional cases in which the Model stops (besides the reach of - * maximum time). - * - * Returns always true (no such additional condition in this Model). - */ + //! \copydoc doxygen_hide_model_SupplHasFinishedConditions_always_true bool SupplHasFinishedConditions() const; diff --git a/Sources/ModelInstances/Laplacian/VariationalFormulation.hpp b/Sources/ModelInstances/Laplacian/VariationalFormulation.hpp index 993826f28e..925bd95aea 100644 --- a/Sources/ModelInstances/Laplacian/VariationalFormulation.hpp +++ b/Sources/ModelInstances/Laplacian/VariationalFormulation.hpp @@ -69,10 +69,7 @@ namespace MoReFEM /// \name Special members. ///@{ - /*! - * \brief Constructor. - * - */ + //! copydoc doxygen_hide_varf_constructor explicit VariationalFormulation(const morefem_data_type& morefem_data, TimeManager& time_manager, const GodOfDof& god_of_dof, @@ -107,17 +104,12 @@ namespace MoReFEM /// \name CRTP-required methods. ///@{ - /*! - * \brief Specific initialisation for derived class attributes. - * - * \internal [internal] This method is called by base class method VariationalFormulation::Init(). - */ + //! \copydoc doxygen_hide_varf_suppl_init void SupplInit(const InputParameterList& input_parameter_data); /*! * \brief Allocate the global matrices and vectors. */ - void AllocateMatricesAndVectors(); diff --git a/Sources/ModelInstances/Laplacian/main.cpp b/Sources/ModelInstances/Laplacian/main.cpp index dc24da50ac..4a33c06876 100644 --- a/Sources/ModelInstances/Laplacian/main.cpp +++ b/Sources/ModelInstances/Laplacian/main.cpp @@ -21,7 +21,8 @@ using namespace MoReFEM; int main(int argc, char** argv) { - using InputParameterList = LaplacianNS::InputParameterList; + //! \copydoc doxygen_hide_model_specific_input_parameter_list + using InputParameterList = LaplacianNS::InputParameterList; try { diff --git a/Sources/ModelInstances/Laplacian/main_ensight_output.cpp b/Sources/ModelInstances/Laplacian/main_ensight_output.cpp index b01b2cb525..57c0b4f65f 100644 --- a/Sources/ModelInstances/Laplacian/main_ensight_output.cpp +++ b/Sources/ModelInstances/Laplacian/main_ensight_output.cpp @@ -29,6 +29,7 @@ int main(int argc, char** argv) try { + //! \copydoc doxygen_hide_model_specific_input_parameter_list using InputParameterList = LaplacianNS::InputParameterList; MoReFEMData morefem_data(argc, argv); diff --git a/Sources/ModelInstances/RivlinCube/InputParameterList.hpp b/Sources/ModelInstances/RivlinCube/InputParameterList.hpp index 396a559480..5495d2dd21 100644 --- a/Sources/ModelInstances/RivlinCube/InputParameterList.hpp +++ b/Sources/ModelInstances/RivlinCube/InputParameterList.hpp @@ -30,13 +30,15 @@ namespace MoReFEM { - enum class MeshIndex + //! \copydoc doxygen_hide_mesh_enum + enum class MeshIndex { mesh = 1 }; - enum class DomainIndex + //! \copydoc doxygen_hide_domain_enum + enum class DomainIndex { highest_dimension = 1, face1 = 2, @@ -50,6 +52,7 @@ namespace MoReFEM }; + //! \copydoc doxygen_hide_boundary_condition_enum enum class BoundaryConditionIndex { face1 = 1, @@ -58,36 +61,44 @@ namespace MoReFEM }; - enum class FEltSpaceIndex + //! \copydoc doxygen_hide_felt_space_enum + enum class FEltSpaceIndex { highest_dimension = 1, surface_pressure = 2 }; - enum class UnknownIndex + //! \copydoc doxygen_hide_unknown_enum + enum class UnknownIndex { displacement = 1 }; - enum class NumberingSubsetIndex + //! \copydoc doxygen_hide_numbering_subset_enum + enum class NumberingSubsetIndex { monolithic = 1 }; - enum class SolverIndex + //! \copydoc doxygen_hide_solver_enum + enum class SolverIndex + { solver = 1 }; + + //! \copydoc doxygen_hide_initial_condition_enum enum class InitialConditionIndex { displacement_initial_condition = 1 }; + //! \copydoc doxygen_hide_input_parameter_tuple using InputParameterTuple = std::tuple < InputParameter::TimeManager, @@ -129,10 +140,13 @@ namespace MoReFEM >; + //! \copydoc doxygen_hide_model_specific_input_parameter_list using InputParameterList = InputParameterList; + //! \copydoc doxygen_hide_morefem_data_type using morefem_data_type = MoReFEMData; + //! \copydoc doxygen_hide_morefem_data_type using morefem_data_type = MoReFEMData; diff --git a/Sources/ModelInstances/RivlinCube/Model.hpp b/Sources/ModelInstances/RivlinCube/Model.hpp index 85a7d45cbd..d3b64fbe5c 100644 --- a/Sources/ModelInstances/RivlinCube/Model.hpp +++ b/Sources/ModelInstances/RivlinCube/Model.hpp @@ -38,7 +38,7 @@ namespace MoReFEM //! Convenient alias. using parent = MoReFEM::Model; - //! Convenient alias. + //! \copydoc doxygen_hide_morefem_data_type using morefem_data_type = MoReFEMData; public: @@ -87,6 +87,7 @@ namespace MoReFEM * \brief Initialise the problem. * * This initialisation includes the resolution of the static problem. + * \copydoc doxygen_hide_morefem_data_param */ void SupplInitialize(const morefem_data_type& morefem_data); @@ -121,12 +122,7 @@ namespace MoReFEM private: - /*! - * \brief Whether the model wants to add additional cases in which the Model stops (besides the reach of - * maximum time). - * - * Returns always true (no such additional condition in this Model). - */ + //! \copydoc doxygen_hide_model_SupplHasFinishedConditions_always_true bool SupplHasFinishedConditions() const; diff --git a/Sources/ModelInstances/RivlinCube/VariationalFormulation.hpp b/Sources/ModelInstances/RivlinCube/VariationalFormulation.hpp index 3d679ba43a..7ee7b8e5b9 100644 --- a/Sources/ModelInstances/RivlinCube/VariationalFormulation.hpp +++ b/Sources/ModelInstances/RivlinCube/VariationalFormulation.hpp @@ -130,10 +130,7 @@ namespace MoReFEM /// \name Special members. ///@{ - /*! - * \brief Constructor. - * - */ + //! copydoc doxygen_hide_varf_constructor explicit VariationalFormulation(const morefem_data_type& morefem_data, const NumberingSubset& numbering_subset, TimeManager& time_manager, @@ -172,11 +169,7 @@ namespace MoReFEM /// \name CRTP-required methods. ///@{ - /*! - * \brief Specific initialisation for derived class attributes. - * - * \internal [internal] This method is called by base class method VariationalFormulation::Init(). - */ + //! \copydoc doxygen_hide_varf_suppl_init void SupplInit(const InputParameterList& input_parameter_data); /*! diff --git a/Sources/ModelInstances/RivlinCube/main.cpp b/Sources/ModelInstances/RivlinCube/main.cpp index dad39d5e21..af2cc7db85 100644 --- a/Sources/ModelInstances/RivlinCube/main.cpp +++ b/Sources/ModelInstances/RivlinCube/main.cpp @@ -21,7 +21,8 @@ using namespace MoReFEM; int main(int argc, char** argv) { - using InputParameterList = RivlinCubeNS::InputParameterList; + //! \copydoc doxygen_hide_model_specific_input_parameter_list + using InputParameterList = RivlinCubeNS::InputParameterList; try { diff --git a/Sources/ModelInstances/RivlinCube/main_ensight_output.cpp b/Sources/ModelInstances/RivlinCube/main_ensight_output.cpp index fa15b8d70c..4558d1ec99 100644 --- a/Sources/ModelInstances/RivlinCube/main_ensight_output.cpp +++ b/Sources/ModelInstances/RivlinCube/main_ensight_output.cpp @@ -29,6 +29,7 @@ int main(int argc, char** argv) try { + //! \copydoc doxygen_hide_model_specific_input_parameter_list using InputParameterList = RivlinCubeNS::InputParameterList; MoReFEMData morefem_data(argc, argv); diff --git a/Sources/ModelInstances/Stokes/InputParameterList.hpp b/Sources/ModelInstances/Stokes/InputParameterList.hpp index fb2f320e7a..e0c21e90f3 100644 --- a/Sources/ModelInstances/Stokes/InputParameterList.hpp +++ b/Sources/ModelInstances/Stokes/InputParameterList.hpp @@ -29,13 +29,15 @@ namespace MoReFEM { - enum class MeshIndex + //! \copydoc doxygen_hide_mesh_enum + enum class MeshIndex { mesh = 1 // only one mesh considered in current model! }; - enum class DomainIndex + //! \copydoc doxygen_hide_domain_enum + enum class DomainIndex { highest_dimension = 1, neumann = 2, @@ -44,33 +46,39 @@ namespace MoReFEM }; - enum class FEltSpaceIndex + //! \copydoc doxygen_hide_felt_space_enum + enum class FEltSpaceIndex { highest_dimension = 1, neumann = 2 }; - enum class UnknownIndex + //! \copydoc doxygen_hide_unknown_enum + enum class UnknownIndex { velocity = 1, pressure = 2 }; - enum class SolverIndex + //! \copydoc doxygen_hide_solver_enum + enum class SolverIndex + { solver = 1 }; - enum class NumberingSubsetIndex + //! \copydoc doxygen_hide_numbering_subset_enum + enum class NumberingSubsetIndex { velocity_or_monolithic = 1, pressure_or_irrelevant = 2 }; + //! \copydoc doxygen_hide_source_enum enum class SourceIndex { volumic = 1, @@ -78,6 +86,7 @@ namespace MoReFEM }; + //! \copydoc doxygen_hide_boundary_condition_enum enum class BoundaryConditionIndex { sole = 1 @@ -85,6 +94,7 @@ namespace MoReFEM + //! \copydoc doxygen_hide_input_parameter_tuple using InputParameterTuple = std::tuple < InputParameter::TimeManager, @@ -118,8 +128,12 @@ namespace MoReFEM >; + //! \copydoc doxygen_hide_morefem_data_type + //! \copydoc doxygen_hide_model_specific_input_parameter_list using InputParameterList = InputParameterList; + //! \copydoc doxygen_hide_morefem_data_type + //! \copydoc doxygen_hide_morefem_data_type using morefem_data_type = MoReFEMData; diff --git a/Sources/ModelInstances/Stokes/Model.hpp b/Sources/ModelInstances/Stokes/Model.hpp index d18c256b0c..3cff47c249 100644 --- a/Sources/ModelInstances/Stokes/Model.hpp +++ b/Sources/ModelInstances/Stokes/Model.hpp @@ -49,7 +49,7 @@ namespace MoReFEM /*! * \brief Constructor. * - * \copydetails doxygen_hide_mpi_param + * \copydoc doxygen_hide_morefem_data_param */ Model(const morefem_data_type& morefem_data); @@ -79,6 +79,7 @@ namespace MoReFEM * \brief Initialise the problem. * * This initialisation includes the resolution of the static problem. + * \copydoc doxygen_hide_morefem_data_param */ void SupplInitialize(const morefem_data_type& morefem_data); @@ -111,12 +112,7 @@ namespace MoReFEM - /*! - * \brief Whether the model wants to add additional cases in which the Model stops (besides the reach of - * maximum time). - * - * Returns always true (no such additional condition in this Model). - */ + //! \copydoc doxygen_hide_model_SupplHasFinishedConditions_always_true bool SupplHasFinishedConditions() const; diff --git a/Sources/ModelInstances/Stokes/VariationalFormulation.hpp b/Sources/ModelInstances/Stokes/VariationalFormulation.hpp index cea00b6176..6549f58695 100644 --- a/Sources/ModelInstances/Stokes/VariationalFormulation.hpp +++ b/Sources/ModelInstances/Stokes/VariationalFormulation.hpp @@ -79,11 +79,7 @@ namespace MoReFEM /// \name Special members. ///@{ - /*! - * \brief Constructor. - * - * \copydetails doxygen_hide_mpi_param - */ + //! copydoc doxygen_hide_varf_constructor explicit VariationalFormulation(const morefem_data_type& morefem_data, const NumberingSubset& velocity_numbering_subset, const NumberingSubset& pressure_numbering_subset, @@ -139,13 +135,7 @@ namespace MoReFEM /// \name CRTP-required methods. ///@{ - - - /*! - * \brief Specific initialisation for derived class attributes. - * - * \internal [internal] This method is called by base class method VariationalFormulation::Init(). - */ + //! \copydoc doxygen_hide_varf_suppl_init void SupplInit(const InputParameterList& input_parameter_data); /*! diff --git a/Sources/ModelInstances/Stokes/main.cpp b/Sources/ModelInstances/Stokes/main.cpp index c9e55d77c4..2ce0e7a7a2 100644 --- a/Sources/ModelInstances/Stokes/main.cpp +++ b/Sources/ModelInstances/Stokes/main.cpp @@ -21,7 +21,8 @@ using namespace MoReFEM; int main(int argc, char** argv) { - using InputParameterList = StokesNS::InputParameterList; + //! \copydoc doxygen_hide_model_specific_input_parameter_list + using InputParameterList = StokesNS::InputParameterList; try { diff --git a/Sources/ModelInstances/Stokes/main_ensight_output_monolithic.cpp b/Sources/ModelInstances/Stokes/main_ensight_output_monolithic.cpp index 9b440710f1..0890fbfd1f 100644 --- a/Sources/ModelInstances/Stokes/main_ensight_output_monolithic.cpp +++ b/Sources/ModelInstances/Stokes/main_ensight_output_monolithic.cpp @@ -29,6 +29,7 @@ int main(int argc, char** argv) try { + //! \copydoc doxygen_hide_model_specific_input_parameter_list using InputParameterList = StokesNS::InputParameterList; MoReFEMData morefem_data(argc, argv); diff --git a/Sources/OperatorInstances/VariationalOperator/BilinearForm/Local/ScalarDivVectorial.hpp b/Sources/OperatorInstances/VariationalOperator/BilinearForm/Local/ScalarDivVectorial.hpp index c72a8c3d69..7704be4677 100644 --- a/Sources/OperatorInstances/VariationalOperator/BilinearForm/Local/ScalarDivVectorial.hpp +++ b/Sources/OperatorInstances/VariationalOperator/BilinearForm/Local/ScalarDivVectorial.hpp @@ -159,6 +159,7 @@ namespace MoReFEM private: //! Convenient enum to tag each of the two \a Unknowns considered. + //! \copydoc doxygen_hide_unknown_enum enum class UnknownIndex { vectorial = 0, diff --git a/Sources/OperatorInstances/VariationalOperator/BilinearForm/Local/Stokes.hpp b/Sources/OperatorInstances/VariationalOperator/BilinearForm/Local/Stokes.hpp index 6353d2172e..959f85ceaf 100644 --- a/Sources/OperatorInstances/VariationalOperator/BilinearForm/Local/Stokes.hpp +++ b/Sources/OperatorInstances/VariationalOperator/BilinearForm/Local/Stokes.hpp @@ -164,6 +164,7 @@ namespace MoReFEM private: //! Convenient enum to tag each of the two \a Unknowns considered. + //! \copydoc doxygen_hide_unknown_enum enum class UnknownIndex { vectorial = 0, diff --git a/Sources/PostProcessing/RefineMeshQuadranglesSpectral/Model.hpp b/Sources/PostProcessing/RefineMeshQuadranglesSpectral/Model.hpp index 8ac520818e..58019da987 100644 --- a/Sources/PostProcessing/RefineMeshQuadranglesSpectral/Model.hpp +++ b/Sources/PostProcessing/RefineMeshQuadranglesSpectral/Model.hpp @@ -117,13 +117,7 @@ namespace MoReFEM private: - /*! - * \brief Whether the model wants to add additional cases in which the Model stops (besides the reach of - * maximum time). - * - * - * \return Always true (no such additional condition in this Model). - */ + //! \copydoc doxygen_hide_model_SupplHasFinishedConditions_always_true bool SupplHasFinishedConditions() const; diff --git a/Sources/PostProcessing/main_convert_matrix_to_freefem.cpp b/Sources/PostProcessing/main_convert_matrix_to_freefem.cpp index 5658b62bd5..678e928745 100644 --- a/Sources/PostProcessing/main_convert_matrix_to_freefem.cpp +++ b/Sources/PostProcessing/main_convert_matrix_to_freefem.cpp @@ -37,6 +37,7 @@ int main(int argc, char** argv) { using Mesh = InputParameter::Mesh<1>; + //! \copydoc doxygen_hide_input_parameter_tuple using InputParameterTuple = std::tuple < InputParameter::Mesh, @@ -46,6 +47,7 @@ int main(int argc, char** argv) InputParameter::Result::OutputDirectory >; + //! \copydoc doxygen_hide_model_specific_input_parameter_list using InputParameterList = InputParameterList; MoReFEMData morefem_data(argc, argv); diff --git a/Sources/PostProcessing/main_refined_mesh_output.cpp b/Sources/PostProcessing/main_refined_mesh_output.cpp index 699aa969b1..5e62f58290 100644 --- a/Sources/PostProcessing/main_refined_mesh_output.cpp +++ b/Sources/PostProcessing/main_refined_mesh_output.cpp @@ -43,6 +43,7 @@ int main(int argc, char** argv) { + //! \copydoc doxygen_hide_input_parameter_tuple using InputParameterTuple = std::tuple < InputParameter::TimeManager, @@ -60,6 +61,7 @@ int main(int argc, char** argv) InputParameter::Result >; + //! \copydoc doxygen_hide_model_specific_input_parameter_list using InputParameterList = InputParameterList; MoReFEMData morefem_data(argc, argv); diff --git a/Sources/Test/Core/VariableTimeStep/InputParameterList.hpp b/Sources/Test/Core/VariableTimeStep/InputParameterList.hpp index 4b135c2e90..b2f27624a3 100644 --- a/Sources/Test/Core/VariableTimeStep/InputParameterList.hpp +++ b/Sources/Test/Core/VariableTimeStep/InputParameterList.hpp @@ -25,42 +25,50 @@ namespace MoReFEM { - enum class MeshIndex + //! \copydoc doxygen_hide_mesh_enum + enum class MeshIndex { mesh = 1 }; - enum class DomainIndex + //! \copydoc doxygen_hide_domain_enum + enum class DomainIndex { full_mesh = 1 }; - enum class FEltSpaceIndex + //! \copydoc doxygen_hide_felt_space_enum + enum class FEltSpaceIndex { index = 1 }; - enum class UnknownIndex + //! \copydoc doxygen_hide_unknown_enum + enum class UnknownIndex { scalar = 1 }; - enum class SolverIndex + //! \copydoc doxygen_hide_solver_enum + enum class SolverIndex + { solver = 1 }; - enum class NumberingSubsetIndex + //! \copydoc doxygen_hide_numbering_subset_enum + enum class NumberingSubsetIndex { scalar = 1 }; + //! \copydoc doxygen_hide_input_parameter_tuple using InputParameterTuple = std::tuple < InputParameter::TimeManager, @@ -81,8 +89,10 @@ namespace MoReFEM >; + //! \copydoc doxygen_hide_model_specific_input_parameter_list using InputParameterList = InputParameterList; + //! \copydoc doxygen_hide_morefem_data_type using morefem_data_type = MoReFEMData; diff --git a/Sources/Test/Core/VariableTimeStep/Model.hpp b/Sources/Test/Core/VariableTimeStep/Model.hpp index 36cd950f97..3ef5d02d2d 100644 --- a/Sources/Test/Core/VariableTimeStep/Model.hpp +++ b/Sources/Test/Core/VariableTimeStep/Model.hpp @@ -23,6 +23,7 @@ namespace MoReFEM { + //! \copydoc doxygen_hide_model_4_test class Model : public MoReFEM::Model { @@ -50,8 +51,7 @@ namespace MoReFEM /*! * \brief Constructor. * - * \copydetails doxygen_hide_mpi_param - * \copydoc doxygen_hide_input_parameter_data_arg + * \copydoc doxygen_hide_morefem_data_param */ Model(const morefem_data_type& morefem_data); @@ -81,7 +81,7 @@ namespace MoReFEM * \brief Initialise the problem. * * This initialisation includes the resolution of the static problem. - * \copydoc doxygen_hide_input_parameter_data_arg + * \copydoc doxygen_hide_morefem_data_param */ void SupplInitialize(const morefem_data_type& morefem_data); @@ -108,12 +108,7 @@ namespace MoReFEM private: - /*! - * \brief Whether the model wants to add additional cases in which the Model stops (besides the reach of - * maximum time). - * - * Returns always true (no such additional condition in this Model). - */ + //! \copydoc doxygen_hide_model_SupplHasFinishedConditions_always_true bool SupplHasFinishedConditions() const; diff --git a/Sources/Test/Core/VariableTimeStep/main.cpp b/Sources/Test/Core/VariableTimeStep/main.cpp index bd9e6245f1..62502784e9 100644 --- a/Sources/Test/Core/VariableTimeStep/main.cpp +++ b/Sources/Test/Core/VariableTimeStep/main.cpp @@ -21,7 +21,8 @@ using namespace MoReFEM; int main(int argc, char** argv) { - using InputParameterList = TestVariableTimeStepNS::InputParameterList; + //! \copydoc doxygen_hide_model_specific_input_parameter_list + using InputParameterList = TestVariableTimeStepNS::InputParameterList; try { diff --git a/Sources/Test/Geometry/Coloring/InputParameterList.hpp b/Sources/Test/Geometry/Coloring/InputParameterList.hpp index 466ddea672..c174c3fb29 100644 --- a/Sources/Test/Geometry/Coloring/InputParameterList.hpp +++ b/Sources/Test/Geometry/Coloring/InputParameterList.hpp @@ -22,71 +22,75 @@ namespace MoReFEM { - - + + namespace TestNS { - - + + namespace ColoringNS { - - + + + //! Default value for some input parameter that are required by a MoReFEM model but are actually unused for current test. enum class Unused { value = 1 }; - - + + + //! \copydoc doxygen_hide_mesh_enum enum class MeshIndex { mesh = 1 }; - - + + + //! Enum used to index numbering subsets, domains and finite element spaces. enum class DimensionIndex { Dim1 = 1, Dim2 = 2 }; + - - - + //! \copydoc doxygen_hide_input_parameter_tuple using InputParameterTuple = std::tuple < InputParameter::TimeManager, - + InputParameter::NumberingSubset, InputParameter::NumberingSubset, - + InputParameter::Unknown, - + InputParameter::Domain, InputParameter::Domain, - + InputParameter::FEltSpace, InputParameter::FEltSpace, - + InputParameter::Petsc, - + InputParameter::Mesh, - + InputParameter::Result >; - - + + + //! \copydoc doxygen_hide_model_specific_input_parameter_list using InputParameterList = InputParameterList; - - using morefem_data_type = MoReFEMData; - - + + //! \copydoc doxygen_hide_morefem_data_type + using morefem_data_type = MoReFEMData; + + } // namespace P1_to_P_HigherOrder_NS - - + + } // namespace TestNS - - + + } // namespace MoReFEM diff --git a/Sources/Test/Geometry/Coloring/Model.hpp b/Sources/Test/Geometry/Coloring/Model.hpp index 196ce60ff7..85b63990de 100644 --- a/Sources/Test/Geometry/Coloring/Model.hpp +++ b/Sources/Test/Geometry/Coloring/Model.hpp @@ -28,6 +28,7 @@ namespace MoReFEM { + //! \copydoc doxygen_hide_model_4_test class Model : public MoReFEM::Model { @@ -55,7 +56,7 @@ namespace MoReFEM /*! * \brief Constructor. * - * \copydetails doxygen_hide_mpi_param + * \copydoc doxygen_hide_morefem_data_param */ Model(const morefem_data_type& morefem_data); @@ -85,6 +86,7 @@ namespace MoReFEM * \brief Initialise the problem. * * This initialisation includes the resolution of the static problem. + * \copydoc doxygen_hide_morefem_data_param */ void SupplInitialize(const morefem_data_type& morefem_data); @@ -110,12 +112,7 @@ namespace MoReFEM private: - /*! - * \brief Whether the model wants to add additional cases in which the Model stops (besides the reach of - * maximum time). - * - * Returns always true (no such additional condition in this Model). - */ + //! \copydoc doxygen_hide_model_SupplHasFinishedConditions_always_true bool SupplHasFinishedConditions() const; diff --git a/Sources/Test/Geometry/Coloring/main_test_coloring.cpp b/Sources/Test/Geometry/Coloring/main_test_coloring.cpp index ce1c94c5c6..c0094332a4 100644 --- a/Sources/Test/Geometry/Coloring/main_test_coloring.cpp +++ b/Sources/Test/Geometry/Coloring/main_test_coloring.cpp @@ -26,7 +26,8 @@ int main(int argc, char** argv) using namespace MoReFEM; - using InputParameterList = TestNS::ColoringNS::InputParameterList; + //! \copydoc doxygen_hide_model_specific_input_parameter_list + using InputParameterList = TestNS::ColoringNS::InputParameterList; try { diff --git a/Sources/Test/Geometry/CoordsInParallel/InputParameterList.hpp b/Sources/Test/Geometry/CoordsInParallel/InputParameterList.hpp index a52ab0c4bf..dc0cf22f64 100644 --- a/Sources/Test/Geometry/CoordsInParallel/InputParameterList.hpp +++ b/Sources/Test/Geometry/CoordsInParallel/InputParameterList.hpp @@ -29,6 +29,7 @@ namespace MoReFEM { + //! \copydoc doxygen_hide_mesh_enum enum class MeshIndex { mesh1 = 1, @@ -36,6 +37,7 @@ namespace MoReFEM }; + //! \copydoc doxygen_hide_domain_enum enum class DomainIndex { mesh1 = 1, @@ -43,6 +45,7 @@ namespace MoReFEM }; + //! \copydoc doxygen_hide_felt_space_enum enum class FEltSpaceIndex { mesh1 = 1, @@ -50,18 +53,22 @@ namespace MoReFEM }; + //! \copydoc doxygen_hide_unknown_enum enum class UnknownIndex { unknown = 1 }; + //! \copydoc doxygen_hide_solver_enum enum class SolverIndex + { solver = 1 }; + //! \copydoc doxygen_hide_numbering_subset_enum enum class NumberingSubsetIndex { mesh1 = 1, @@ -70,7 +77,8 @@ namespace MoReFEM - using InputParameterTuple = std::tuple + //! \copydoc doxygen_hide_input_parameter_tuple + using InputParameterTuple = std::tuple < InputParameter::TimeManager, @@ -95,8 +103,10 @@ namespace MoReFEM >; - using InputParameterList = InputParameterList; + //! \copydoc doxygen_hide_model_specific_input_parameter_list + using InputParameterList = InputParameterList; + //! \copydoc doxygen_hide_morefem_data_type using morefem_data_type = MoReFEMData; diff --git a/Sources/Test/Geometry/CoordsInParallel/Model.hpp b/Sources/Test/Geometry/CoordsInParallel/Model.hpp index 5a67e42691..5c0a094d9f 100644 --- a/Sources/Test/Geometry/CoordsInParallel/Model.hpp +++ b/Sources/Test/Geometry/CoordsInParallel/Model.hpp @@ -29,7 +29,8 @@ namespace MoReFEM //! Model for the test of the behaviour of \a Coords after parallel reduction. - class Model final : public MoReFEM::Model + //! \copydoc doxygen_hide_model_4_test + class Model final : public MoReFEM::Model { @@ -57,7 +58,7 @@ namespace MoReFEM /*! * \brief Constructor. * - * \copydetails doxygen_hide_mpi_param + * \copydoc doxygen_hide_morefem_data_param */ explicit Model(const morefem_data_type& morefem_data); @@ -87,6 +88,7 @@ namespace MoReFEM * \brief Initialise the problem. * * This initialisation includes the resolution of the static problem. + * \copydoc doxygen_hide_morefem_data_param */ void SupplInitialize(const morefem_data_type& morefem_data); @@ -112,12 +114,7 @@ namespace MoReFEM private: - /*! - * \brief Whether the model wants to add additional cases in which the Model stops (besides the reach of - * maximum time). - * - * Returns always true (no such additional condition in this Model). - */ + //! \copydoc doxygen_hide_model_SupplHasFinishedConditions_always_true bool SupplHasFinishedConditions() const; diff --git a/Sources/Test/Geometry/CoordsInParallel/main.cpp b/Sources/Test/Geometry/CoordsInParallel/main.cpp index d02f90ab06..bf86df241d 100644 --- a/Sources/Test/Geometry/CoordsInParallel/main.cpp +++ b/Sources/Test/Geometry/CoordsInParallel/main.cpp @@ -20,7 +20,8 @@ using namespace MoReFEM; int main(int argc, char** argv) { - using InputParameterList = TestNS::CoordsInParallelNS::InputParameterList; + //! \copydoc doxygen_hide_model_specific_input_parameter_list + using InputParameterList = TestNS::CoordsInParallelNS::InputParameterList; try { diff --git a/Sources/Test/Geometry/DomainListInCoords/InputParameterList.hpp b/Sources/Test/Geometry/DomainListInCoords/InputParameterList.hpp index 2e40dd04c2..37b1062217 100644 --- a/Sources/Test/Geometry/DomainListInCoords/InputParameterList.hpp +++ b/Sources/Test/Geometry/DomainListInCoords/InputParameterList.hpp @@ -33,12 +33,14 @@ namespace MoReFEM { + //! \copydoc doxygen_hide_mesh_enum enum class MeshIndex { mesh = 1 }; + //! \copydoc doxygen_hide_domain_enum enum class DomainIndex { volume = 1, @@ -48,9 +50,11 @@ namespace MoReFEM }; + //! Default value for some input parameter that are required by a MoReFEM model but are actually unused for current test. constexpr auto whatever = 0; + //! \copydoc doxygen_hide_input_parameter_tuple using InputParameterTuple = std::tuple < InputParameter::TimeManager, @@ -73,9 +77,11 @@ namespace MoReFEM >; + //! \copydoc doxygen_hide_model_specific_input_parameter_list using InputParameterList = InputParameterList; - using morefem_data_type = MoReFEMData; + //! \copydoc doxygen_hide_morefem_data_type + using morefem_data_type = MoReFEMData; } // namespace DomainListInCoordsNS diff --git a/Sources/Test/Geometry/DomainListInCoords/Model.hpp b/Sources/Test/Geometry/DomainListInCoords/Model.hpp index eb5e189758..d6055c9625 100644 --- a/Sources/Test/Geometry/DomainListInCoords/Model.hpp +++ b/Sources/Test/Geometry/DomainListInCoords/Model.hpp @@ -35,7 +35,8 @@ namespace MoReFEM * \brief Toy model used to perform tests about variable domain. * */ - class Model : public MoReFEM::Model + //! \copydoc doxygen_hide_model_4_test + class Model : public MoReFEM::Model { private: @@ -63,7 +64,7 @@ namespace MoReFEM /*! * \brief Constructor. * - * \copydetails doxygen_hide_mpi_param + * \copydoc doxygen_hide_morefem_data_param */ Model(const morefem_data_type& morefem_data); @@ -93,6 +94,7 @@ namespace MoReFEM * \brief Initialise the problem. * * This initialisation includes the resolution of the static problem. + * \copydoc doxygen_hide_morefem_data_param */ void SupplInitialize(const morefem_data_type& morefem_data); @@ -122,12 +124,7 @@ namespace MoReFEM private: - /*! - * \brief Whether the model wants to add additional cases in which the Model stops (besides the reach of - * maximum time). - * - * Returns always true (no such additional condition in this Model). - */ + //! \copydoc doxygen_hide_model_SupplHasFinishedConditions_always_true bool SupplHasFinishedConditions() const; diff --git a/Sources/Test/Geometry/DomainListInCoords/main.cpp b/Sources/Test/Geometry/DomainListInCoords/main.cpp index fd251665f4..ecad0178d0 100644 --- a/Sources/Test/Geometry/DomainListInCoords/main.cpp +++ b/Sources/Test/Geometry/DomainListInCoords/main.cpp @@ -22,7 +22,8 @@ using namespace MoReFEM::TestNS; int main(int argc, char** argv) { - using InputParameterList = DomainListInCoordsNS::InputParameterList; + //! \copydoc doxygen_hide_model_specific_input_parameter_list + using InputParameterList = DomainListInCoordsNS::InputParameterList; try diff --git a/Sources/Test/Geometry/LightweightDomainList/InputParameterList.hpp b/Sources/Test/Geometry/LightweightDomainList/InputParameterList.hpp index 21470d99bf..a9842c9a70 100644 --- a/Sources/Test/Geometry/LightweightDomainList/InputParameterList.hpp +++ b/Sources/Test/Geometry/LightweightDomainList/InputParameterList.hpp @@ -33,42 +33,48 @@ namespace MoReFEM { + //! \copydoc doxygen_hide_mesh_enum enum class MeshIndex { mesh = 1 }; + //! \copydoc doxygen_hide_domain_enum enum class DomainIndex { domain = 1, }; + //! Default value for some input parameter that are required by a MoReFEM model but are actually unused for current test. constexpr auto whatever = 0; + //! \copydoc doxygen_hide_input_parameter_tuple using InputParameterTuple = std::tuple < InputParameter::TimeManager, - + InputParameter::Mesh, - + InputParameter::Domain, InputParameter::LightweightDomainList<1>, - + InputParameter::Unknown, InputParameter::NumberingSubset, InputParameter::FEltSpace, InputParameter::Petsc, - + InputParameter::Result >; - - + + + //! \copydoc doxygen_hide_model_specific_input_parameter_list using InputParameterList = InputParameterList; - - using morefem_data_type = MoReFEMData; + + //! \copydoc doxygen_hide_morefem_data_type + using morefem_data_type = MoReFEMData; } // namespace P1_to_P_HigherOrder_NS diff --git a/Sources/Test/Geometry/LightweightDomainList/Model.hpp b/Sources/Test/Geometry/LightweightDomainList/Model.hpp index 94076b9a63..464eaff19f 100644 --- a/Sources/Test/Geometry/LightweightDomainList/Model.hpp +++ b/Sources/Test/Geometry/LightweightDomainList/Model.hpp @@ -35,7 +35,8 @@ namespace MoReFEM * \brief Toy model used to perform tests about variable domain. * */ - class Model : public MoReFEM::Model + //! \copydoc doxygen_hide_model_4_test + class Model : public MoReFEM::Model { private: @@ -63,7 +64,7 @@ namespace MoReFEM /*! * \brief Constructor. * - * \copydetails doxygen_hide_mpi_param + * \copydoc doxygen_hide_morefem_data_param */ Model(const morefem_data_type& morefem_data); @@ -93,6 +94,7 @@ namespace MoReFEM * \brief Initialise the problem. * * This initialisation includes the resolution of the static problem. + * \copydoc doxygen_hide_morefem_data_param */ void SupplInitialize(const morefem_data_type& morefem_data); @@ -122,12 +124,7 @@ namespace MoReFEM private: - /*! - * \brief Whether the model wants to add additional cases in which the Model stops (besides the reach of - * maximum time). - * - * Returns always true (no such additional condition in this Model). - */ + //! \copydoc doxygen_hide_model_SupplHasFinishedConditions_always_true bool SupplHasFinishedConditions() const; diff --git a/Sources/Test/Geometry/LightweightDomainList/main_test_lightweight_domain_list.cpp b/Sources/Test/Geometry/LightweightDomainList/main_test_lightweight_domain_list.cpp index 5523868674..02f60d082b 100644 --- a/Sources/Test/Geometry/LightweightDomainList/main_test_lightweight_domain_list.cpp +++ b/Sources/Test/Geometry/LightweightDomainList/main_test_lightweight_domain_list.cpp @@ -22,7 +22,8 @@ using namespace MoReFEM::TestNS; int main(int argc, char** argv) { - using InputParameterList = LightweightDomainListNS::InputParameterList; + //! \copydoc doxygen_hide_model_specific_input_parameter_list + using InputParameterList = LightweightDomainListNS::InputParameterList; try diff --git a/Sources/Test/Geometry/Movemesh/InputParameterList.hpp b/Sources/Test/Geometry/Movemesh/InputParameterList.hpp index 759fcacc83..e93cd76c6c 100644 --- a/Sources/Test/Geometry/Movemesh/InputParameterList.hpp +++ b/Sources/Test/Geometry/Movemesh/InputParameterList.hpp @@ -26,43 +26,51 @@ namespace MoReFEM { - enum class MeshIndex + //! \copydoc doxygen_hide_mesh_enum + enum class MeshIndex { mesh = 1 }; - enum class DomainIndex + //! \copydoc doxygen_hide_domain_enum + enum class DomainIndex { domain = 1 }; - enum class FEltSpaceIndex + //! \copydoc doxygen_hide_felt_space_enum + enum class FEltSpaceIndex { felt_space = 1 }; - enum class UnknownIndex + //! \copydoc doxygen_hide_unknown_enum + enum class UnknownIndex { displacement = 1 }; - enum class SolverIndex + //! \copydoc doxygen_hide_solver_enum + enum class SolverIndex + { solver = 1 }; - enum class NumberingSubsetIndex + //! \copydoc doxygen_hide_numbering_subset_enum + enum class NumberingSubsetIndex { subset = 1 }; + //! \copydoc doxygen_hide_input_parameter_tuple using InputParameterTuple = std::tuple < InputParameter::TimeManager, @@ -83,8 +91,10 @@ namespace MoReFEM >; + //! \copydoc doxygen_hide_model_specific_input_parameter_list using InputParameterList = InputParameterList; + //! \copydoc doxygen_hide_morefem_data_type using morefem_data_type = MoReFEMData; diff --git a/Sources/Test/Geometry/Movemesh/Model.hpp b/Sources/Test/Geometry/Movemesh/Model.hpp index bff6d939fc..a0bf237b69 100644 --- a/Sources/Test/Geometry/Movemesh/Model.hpp +++ b/Sources/Test/Geometry/Movemesh/Model.hpp @@ -24,6 +24,7 @@ namespace MoReFEM { + //! \copydoc doxygen_hide_model_4_test class Model : public MoReFEM::Model { @@ -51,7 +52,7 @@ namespace MoReFEM /*! * \brief Constructor. * - * \copydetails doxygen_hide_mpi_param + * \copydoc doxygen_hide_morefem_data_param */ Model(const morefem_data_type& morefem_data); @@ -81,6 +82,7 @@ namespace MoReFEM * \brief Initialise the problem. * * This initialisation includes the resolution of the static problem. + * \copydoc doxygen_hide_morefem_data_param */ void SupplInitialize(const morefem_data_type& morefem_data); @@ -106,12 +108,7 @@ namespace MoReFEM private: - /*! - * \brief Whether the model wants to add additional cases in which the Model stops (besides the reach of - * maximum time). - * - * Returns always true (no such additional condition in this Model). - */ + //! \copydoc doxygen_hide_model_SupplHasFinishedConditions_always_true bool SupplHasFinishedConditions() const; diff --git a/Sources/Test/Geometry/Movemesh/main.cpp b/Sources/Test/Geometry/Movemesh/main.cpp index 01d62bbfed..f04df64cc8 100644 --- a/Sources/Test/Geometry/Movemesh/main.cpp +++ b/Sources/Test/Geometry/Movemesh/main.cpp @@ -19,7 +19,8 @@ using namespace MoReFEM; int main(int argc, char** argv) { - using InputParameterList = TestNS::MovemeshNS::InputParameterList; + //! \copydoc doxygen_hide_model_specific_input_parameter_list + using InputParameterList = TestNS::MovemeshNS::InputParameterList; try { diff --git a/Sources/Test/Geometry/NcoordInDomain/InputParameterList.hpp b/Sources/Test/Geometry/NcoordInDomain/InputParameterList.hpp index 0b57964ab3..2b2b72e6ea 100644 --- a/Sources/Test/Geometry/NcoordInDomain/InputParameterList.hpp +++ b/Sources/Test/Geometry/NcoordInDomain/InputParameterList.hpp @@ -25,51 +25,60 @@ namespace MoReFEM { - enum class MeshIndex + //! \copydoc doxygen_hide_mesh_enum + enum class MeshIndex { mesh = 1 }; - enum class DomainIndex + //! \copydoc doxygen_hide_domain_enum + enum class DomainIndex { full_mesh = 1 }; - enum class FEltSpaceIndex + //! \copydoc doxygen_hide_felt_space_enum + enum class FEltSpaceIndex { volume_potential_1_potential_2 = 1, volume_displacement_potential_1 = 5, }; - enum class UnknownIndex + //! \copydoc doxygen_hide_unknown_enum + enum class UnknownIndex { potential_1 = 1, displacement = 5 }; - enum class NumberingSubsetIndex + //! \copydoc doxygen_hide_numbering_subset_enum + enum class NumberingSubsetIndex { potential_1 = 1, displacement_potential_1 = 5, }; - enum class SolverIndex + //! \copydoc doxygen_hide_solver_enum + enum class SolverIndex + { solver = 1 }; + //! \copydoc doxygen_hide_source_enum enum class ForceIndexList : unsigned int { source = 1 }; + //! \copydoc doxygen_hide_input_parameter_tuple using InputParameterTuple = std::tuple < InputParameter::TimeManager, @@ -93,8 +102,10 @@ namespace MoReFEM >; + //! \copydoc doxygen_hide_model_specific_input_parameter_list using InputParameterList = InputParameterList; + //! \copydoc doxygen_hide_morefem_data_type using morefem_data_type = MoReFEMData; diff --git a/Sources/Test/Geometry/NcoordInDomain/Model.hpp b/Sources/Test/Geometry/NcoordInDomain/Model.hpp index a4a35cd822..379b7becd2 100644 --- a/Sources/Test/Geometry/NcoordInDomain/Model.hpp +++ b/Sources/Test/Geometry/NcoordInDomain/Model.hpp @@ -26,6 +26,7 @@ namespace MoReFEM { + //! \copydoc doxygen_hide_model_4_test class Model : public MoReFEM::Model { @@ -53,7 +54,7 @@ namespace MoReFEM /*! * \brief Constructor. * - * \copydetails doxygen_hide_mpi_param + * \copydoc doxygen_hide_morefem_data_param */ Model(const morefem_data_type& morefem_data); @@ -83,6 +84,7 @@ namespace MoReFEM * \brief Initialise the problem. * * This initialisation includes the resolution of the static problem. + * \copydoc doxygen_hide_morefem_data_param */ void SupplInitialize(const morefem_data_type& morefem_data); @@ -108,12 +110,7 @@ namespace MoReFEM private: - /*! - * \brief Whether the model wants to add additional cases in which the Model stops (besides the reach of - * maximum time). - * - * Returns always true (no such additional condition in this Model). - */ + //! \copydoc doxygen_hide_model_SupplHasFinishedConditions_always_true bool SupplHasFinishedConditions() const; diff --git a/Sources/Test/Geometry/NcoordInDomain/main.cpp b/Sources/Test/Geometry/NcoordInDomain/main.cpp index fb7d68d9a6..168df22b55 100644 --- a/Sources/Test/Geometry/NcoordInDomain/main.cpp +++ b/Sources/Test/Geometry/NcoordInDomain/main.cpp @@ -21,7 +21,8 @@ using namespace MoReFEM; int main(int argc, char** argv) { - using InputParameterList = TestNcoordInDomainNS::InputParameterList; + //! \copydoc doxygen_hide_model_specific_input_parameter_list + using InputParameterList = TestNcoordInDomainNS::InputParameterList; try { diff --git a/Sources/Test/Ondomatic/InputParameterList.hpp b/Sources/Test/Ondomatic/InputParameterList.hpp index 2a3efec162..d68712ca7f 100644 --- a/Sources/Test/Ondomatic/InputParameterList.hpp +++ b/Sources/Test/Ondomatic/InputParameterList.hpp @@ -27,13 +27,15 @@ namespace MoReFEM namespace OndomaticNS { - + + //! \copydoc doxygen_hide_mesh_enum enum class MeshIndex { mesh = 1 }; - - + + + //! \copydoc doxygen_hide_domain_enum enum class DomainIndex { highest_dimension = 1, @@ -46,14 +48,16 @@ namespace MoReFEM face123 = 8, full_mesh = 9 }; - - + + + //! \copydoc doxygen_hide_boundary_condition_enum enum class BoundaryConditionIndex { face123 = 1 }; - - + + + //! \copydoc doxygen_hide_felt_space_enum enum class FEltSpaceIndex { highest_dimension = 1, @@ -61,48 +65,56 @@ namespace MoReFEM surface_pressure_5 = 3, surface_pressure_6 = 4 }; - - + + + //! \copydoc doxygen_hide_unknown_enum enum class UnknownIndex { pressure = 1 }; - - + + + //! \copydoc doxygen_hide_numbering_subset_enum enum class NumberingSubsetIndex { monolithic = 1 }; - - + + + //! \copydoc doxygen_hide_solver_enum enum class SolverIndex + { solver = 1 }; - + + + //! \copydoc doxygen_hide_initial_condition_enum enum class InitialConditionIndex { pressure_initial_condition = 1 }; - + + //! \copydoc doxygen_hide_source_enum enum class ForceIndexList : unsigned int { surface_pressure_4 = 1, surface_pressure_5 = 2, surface_pressure_6 = 3 }; - - + + + //! \copydoc doxygen_hide_input_parameter_tuple using InputParameterTuple = std::tuple < InputParameter::TimeManager, - + InputParameter::NumberingSubset, - + InputParameter::Unknown, - + InputParameter::Mesh, - + InputParameter::Domain, InputParameter::Domain, InputParameter::Domain, @@ -112,35 +124,37 @@ namespace MoReFEM InputParameter::Domain, InputParameter::Domain, InputParameter::Domain, - + InputParameter::DirichletBoundaryCondition, - + InputParameter::FEltSpace, InputParameter::FEltSpace, InputParameter::FEltSpace, InputParameter::FEltSpace, - + InputParameter::Petsc, - + InputParameter::InitialCondition, - + InputParameter::ScalarTransientSource, InputParameter::ScalarTransientSource, InputParameter::ScalarTransientSource, - + InputParameter::Result >; - - + + + //! \copydoc doxygen_hide_model_specific_input_parameter_list using InputParameterList = InputParameterList; - + + //! \copydoc doxygen_hide_morefem_data_type using morefem_data_type = MoReFEMData; - - + + } // namespace OndomaticNS - - + + } // namespace MoReFEM - - + + #endif // MOREFEM_x_TEST_x_ONDOMATIC_x_INPUT_PARAMETER_LIST_HPP_ diff --git a/Sources/Test/Ondomatic/Model.hpp b/Sources/Test/Ondomatic/Model.hpp index 005073732f..5e4dd774e5 100644 --- a/Sources/Test/Ondomatic/Model.hpp +++ b/Sources/Test/Ondomatic/Model.hpp @@ -27,6 +27,7 @@ namespace MoReFEM { + //! \copydoc doxygen_hide_model_4_test class Model : public MoReFEM::Model { @@ -54,7 +55,7 @@ namespace MoReFEM /*! * \brief Constructor. * - * \copydetails doxygen_hide_mpi_param + * \copydoc doxygen_hide_morefem_data_param */ Model(const morefem_data_type& morefem_data); @@ -84,6 +85,7 @@ namespace MoReFEM * \brief Initialise the problem. * * This initialisation includes the resolution of the static problem. + * \copydoc doxygen_hide_morefem_data_param */ void SupplInitialize(const morefem_data_type& morefem_data); @@ -118,12 +120,7 @@ namespace MoReFEM private: - /*! - * \brief Whether the model wants to add additional cases in which the Model stops (besides the reach of - * maximum time). - * - * Returns always true (no such additional condition in this Model). - */ + //! \copydoc doxygen_hide_model_SupplHasFinishedConditions_always_true bool SupplHasFinishedConditions() const; diff --git a/Sources/Test/Ondomatic/VariationalFormulation.hpp b/Sources/Test/Ondomatic/VariationalFormulation.hpp index ca76e03102..2a9235b9de 100644 --- a/Sources/Test/Ondomatic/VariationalFormulation.hpp +++ b/Sources/Test/Ondomatic/VariationalFormulation.hpp @@ -31,6 +31,7 @@ namespace MoReFEM { + //! \copydoc doxygen_hide_varf_4_test class VariationalFormulation : public MoReFEM::VariationalFormulation < @@ -70,9 +71,10 @@ namespace MoReFEM ///@{ /*! - * \brief Constructor. - * - * \copydetails doxygen_hide_mpi_param + * \copydoc doxygen_hide_varf_constructor + * \param[in] numbering_subset Only \a NumberingSubset relevant for this formulation. It is a remnant of + * a former interface of \a MoReFEM::VariationalFormulation; now in most cases (but obviously not in + * test...) \a NumberingSubset is reached through the \a GodOfDof dedicated method. */ explicit VariationalFormulation(const morefem_data_type& morefem_data, const NumberingSubset& numbering_subset, @@ -97,11 +99,7 @@ namespace MoReFEM ///@} - /*! - * \brief Get the only numbering subset relevant for this VariationalFormulation. - * - * There is a more generic accessor in the base class but is use is more unwieldy. - */ + //! Get the only numbering subset relevant for this VariationalFormulation. const NumberingSubset& GetNumberingSubset() const; private: @@ -109,11 +107,7 @@ namespace MoReFEM /// \name CRTP-required methods. ///@{ - /*! - * \brief Specific initialisation for derived class attributes. - * - * \internal [internal] This method is called by base class method VariationalFormulation::Init(). - */ + //! \copydoc doxygen_hide_varf_suppl_init void SupplInit(const InputParameterList& input_parameter_data); /*! diff --git a/Sources/Test/Ondomatic/main.cpp b/Sources/Test/Ondomatic/main.cpp index 0f4f5007e9..4f002fbc48 100644 --- a/Sources/Test/Ondomatic/main.cpp +++ b/Sources/Test/Ondomatic/main.cpp @@ -21,7 +21,8 @@ using namespace MoReFEM; int main(int argc, char** argv) { - using InputParameterList = OndomaticNS::InputParameterList; + //! \copydoc doxygen_hide_model_specific_input_parameter_list + using InputParameterList = OndomaticNS::InputParameterList; try { diff --git a/Sources/Test/OndomaticNumbering/InputParameterList.hpp b/Sources/Test/OndomaticNumbering/InputParameterList.hpp index e58d8201fb..6abfa27135 100644 --- a/Sources/Test/OndomaticNumbering/InputParameterList.hpp +++ b/Sources/Test/OndomaticNumbering/InputParameterList.hpp @@ -22,6 +22,7 @@ namespace MoReFEM { + //! \copydoc doxygen_hide_input_parameter_tuple using InputParameterTuple = std::tuple < InputParameter::Unknown::Name<1>, @@ -48,8 +49,10 @@ namespace MoReFEM >; + //! \copydoc doxygen_hide_model_specific_input_parameter_list using InputParameterList = InputParameterList; + //! \copydoc doxygen_hide_morefem_data_type using morefem_data_type = MoReFEMData; diff --git a/Sources/Test/OndomaticNumbering/main_test_ondomatic_numbering.cpp b/Sources/Test/OndomaticNumbering/main_test_ondomatic_numbering.cpp index 6570f5f54a..405862b545 100644 --- a/Sources/Test/OndomaticNumbering/main_test_ondomatic_numbering.cpp +++ b/Sources/Test/OndomaticNumbering/main_test_ondomatic_numbering.cpp @@ -24,7 +24,8 @@ using namespace MoReFEM; int main(int argc, char * argv[]) { - using InputParameterList = OndomaticNumberingNS::InputParameterList ; + //! \copydoc doxygen_hide_model_specific_input_parameter_list + using InputParameterList = OndomaticNumberingNS::InputParameterList ; std::cerr << "#523 This program needs a complete overhaul!" << std::endl; diff --git a/Sources/Test/Operators/ConformProjector/InputParameterList.hpp b/Sources/Test/Operators/ConformProjector/InputParameterList.hpp index 9be705a0cc..91699eda49 100644 --- a/Sources/Test/Operators/ConformProjector/InputParameterList.hpp +++ b/Sources/Test/Operators/ConformProjector/InputParameterList.hpp @@ -26,19 +26,22 @@ namespace MoReFEM { - enum class MeshIndex + //! \copydoc doxygen_hide_mesh_enum + enum class MeshIndex { mesh = 1 }; - enum class DomainIndex + //! \copydoc doxygen_hide_domain_enum + enum class DomainIndex { domain = 1 }; - enum class FEltSpaceIndex + //! \copydoc doxygen_hide_felt_space_enum + enum class FEltSpaceIndex { velocity_pressure = 1, velocity = 2, @@ -46,20 +49,24 @@ namespace MoReFEM }; - enum class UnknownIndex + //! \copydoc doxygen_hide_unknown_enum + enum class UnknownIndex { velocity = 1, pressure = 2 }; - enum class SolverIndex + //! \copydoc doxygen_hide_solver_enum + enum class SolverIndex + { solver = 1 }; - enum class NumberingSubsetIndex + //! \copydoc doxygen_hide_numbering_subset_enum + enum class NumberingSubsetIndex { velocity_pressure = 1, velocity = 2, @@ -67,7 +74,7 @@ namespace MoReFEM }; - + //! \copydoc doxygen_hide_input_parameter_tuple using InputParameterTuple = std::tuple < InputParameter::TimeManager, @@ -93,8 +100,10 @@ namespace MoReFEM >; + //! \copydoc doxygen_hide_model_specific_input_parameter_list using InputParameterList = InputParameterList; + //! \copydoc doxygen_hide_morefem_data_type using morefem_data_type = MoReFEMData; diff --git a/Sources/Test/Operators/ConformProjector/Model.hpp b/Sources/Test/Operators/ConformProjector/Model.hpp index 7f6bbbf5cb..123dcb717b 100644 --- a/Sources/Test/Operators/ConformProjector/Model.hpp +++ b/Sources/Test/Operators/ConformProjector/Model.hpp @@ -28,6 +28,7 @@ namespace MoReFEM { + //! \copydoc doxygen_hide_model_4_test class Model : public MoReFEM::Model { @@ -55,7 +56,7 @@ namespace MoReFEM /*! * \brief Constructor. * - * \copydetails doxygen_hide_mpi_param + * \copydoc doxygen_hide_morefem_data_param */ Model(const morefem_data_type& morefem_data); @@ -85,6 +86,7 @@ namespace MoReFEM * \brief Initialise the problem. * * This initialisation includes the resolution of the static problem. + * \copydoc doxygen_hide_morefem_data_param */ void SupplInitialize(const morefem_data_type& morefem_data); @@ -114,12 +116,7 @@ namespace MoReFEM private: - /*! - * \brief Whether the model wants to add additional cases in which the Model stops (besides the reach of - * maximum time). - * - * Returns always true (no such additional condition in this Model). - */ + //! \copydoc doxygen_hide_model_SupplHasFinishedConditions_always_true bool SupplHasFinishedConditions() const; @@ -138,14 +135,19 @@ namespace MoReFEM //! Output directory. const std::string output_directory_; + //! Interpolator from \a FEltSpace 1 to \a FEltSpace 2. ConformInterpolatorNS::SubsetOrSuperset::unique_ptr interpolator_1_2_ = nullptr; + //! Interpolator from \a FEltSpace 1 to \a FEltSpace 3. ConformInterpolatorNS::SubsetOrSuperset::unique_ptr interpolator_1_3_ = nullptr; + //! Interpolator from \a FEltSpace 2 to \a FEltSpace 1. ConformInterpolatorNS::SubsetOrSuperset::unique_ptr interpolator_2_1_ = nullptr; + //! Interpolator from \a FEltSpace 3 to \a FEltSpace 1. ConformInterpolatorNS::SubsetOrSuperset::unique_ptr interpolator_3_1_ = nullptr; + //! Interpolator from \a FEltSpace 2 to \a FEltSpace 3. ConformInterpolatorNS::SubsetOrSuperset::unique_ptr interpolator_2_3_ = nullptr; }; diff --git a/Sources/Test/Operators/ConformProjector/main.cpp b/Sources/Test/Operators/ConformProjector/main.cpp index 5e1328b690..9407e6379e 100644 --- a/Sources/Test/Operators/ConformProjector/main.cpp +++ b/Sources/Test/Operators/ConformProjector/main.cpp @@ -21,7 +21,8 @@ using namespace MoReFEM; int main(int argc, char** argv) { - using InputParameterList = ConformProjectorNS::InputParameterList; + //! \copydoc doxygen_hide_model_specific_input_parameter_list + using InputParameterList = ConformProjectorNS::InputParameterList; try { diff --git a/Sources/Test/Operators/NonConformInterpolator/FromVertexMatching/InputParameterList.hpp b/Sources/Test/Operators/NonConformInterpolator/FromVertexMatching/InputParameterList.hpp index 004dcbe4f9..bc42dee86f 100644 --- a/Sources/Test/Operators/NonConformInterpolator/FromVertexMatching/InputParameterList.hpp +++ b/Sources/Test/Operators/NonConformInterpolator/FromVertexMatching/InputParameterList.hpp @@ -26,21 +26,24 @@ namespace MoReFEM { - enum class MeshIndex + //! \copydoc doxygen_hide_mesh_enum + enum class MeshIndex { fluid = 1, solid = 2 }; - enum class DomainIndex + //! \copydoc doxygen_hide_domain_enum + enum class DomainIndex { fluid = 10, solid = 20 }; - enum class FEltSpaceIndex + //! \copydoc doxygen_hide_felt_space_enum + enum class FEltSpaceIndex { fluid = 10, @@ -48,7 +51,8 @@ namespace MoReFEM }; - enum class UnknownIndex + //! \copydoc doxygen_hide_unknown_enum + enum class UnknownIndex { unknown = 1, @@ -56,13 +60,16 @@ namespace MoReFEM }; - enum class SolverIndex + //! \copydoc doxygen_hide_solver_enum + enum class SolverIndex + { solver = 1 }; - enum class NumberingSubsetIndex : unsigned int + //! \copydoc doxygen_hide_numbering_subset_enum + enum class NumberingSubsetIndex : unsigned int { unknown_on_fluid = 10, @@ -71,7 +78,7 @@ namespace MoReFEM }; - + //! Indexes for the vertex matching interpolator. enum class InitVertexMatchingInterpolator { unknown_on_fluid = 10, @@ -81,6 +88,7 @@ namespace MoReFEM + //! \copydoc doxygen_hide_input_parameter_tuple using InputParameterTuple = std::tuple < InputParameter::TimeManager, @@ -112,8 +120,10 @@ namespace MoReFEM >; + //! \copydoc doxygen_hide_model_specific_input_parameter_list using InputParameterList = InputParameterList; + //! \copydoc doxygen_hide_morefem_data_type using morefem_data_type = MoReFEMData; diff --git a/Sources/Test/Operators/NonConformInterpolator/FromVertexMatching/Model.hpp b/Sources/Test/Operators/NonConformInterpolator/FromVertexMatching/Model.hpp index 12ecfc0691..a24365b7fc 100644 --- a/Sources/Test/Operators/NonConformInterpolator/FromVertexMatching/Model.hpp +++ b/Sources/Test/Operators/NonConformInterpolator/FromVertexMatching/Model.hpp @@ -28,6 +28,7 @@ namespace MoReFEM { + //! \copydoc doxygen_hide_model_4_test class Model : public MoReFEM::Model { @@ -55,7 +56,7 @@ namespace MoReFEM /*! * \brief Constructor. * - * \copydetails doxygen_hide_mpi_param + * \copydoc doxygen_hide_morefem_data_param */ Model(const morefem_data_type& morefem_data); @@ -85,6 +86,7 @@ namespace MoReFEM * \brief Initialise the problem. * * This initialisation includes the resolution of the static problem. + * \copydoc doxygen_hide_morefem_data_param */ void SupplInitialize(const morefem_data_type& morefem_data); @@ -117,12 +119,7 @@ namespace MoReFEM private: - /*! - * \brief Whether the model wants to add additional cases in which the Model stops (besides the reach of - * maximum time). - * - * Returns always true (no such additional condition in this Model). - */ + //! \copydoc doxygen_hide_model_SupplHasFinishedConditions_always_true bool SupplHasFinishedConditions() const; diff --git a/Sources/Test/Operators/NonConformInterpolator/FromVertexMatching/main.cpp b/Sources/Test/Operators/NonConformInterpolator/FromVertexMatching/main.cpp index df41bf3fd9..5320f24572 100644 --- a/Sources/Test/Operators/NonConformInterpolator/FromVertexMatching/main.cpp +++ b/Sources/Test/Operators/NonConformInterpolator/FromVertexMatching/main.cpp @@ -22,7 +22,8 @@ using namespace MoReFEM; int main(int argc, char** argv) { - using InputParameterList = TestVertexMatchingNS::InputParameterList; + //! \copydoc doxygen_hide_model_specific_input_parameter_list + using InputParameterList = TestVertexMatchingNS::InputParameterList; try { diff --git a/Sources/Test/Operators/P1_to_HigherOrder/InputParameterList.hpp b/Sources/Test/Operators/P1_to_HigherOrder/InputParameterList.hpp index 1bf9910c34..cb7bc2831a 100644 --- a/Sources/Test/Operators/P1_to_HigherOrder/InputParameterList.hpp +++ b/Sources/Test/Operators/P1_to_HigherOrder/InputParameterList.hpp @@ -30,18 +30,21 @@ namespace MoReFEM { + //! \copydoc doxygen_hide_mesh_enum enum class MeshIndex { mesh = 1 }; + //! \copydoc doxygen_hide_domain_enum enum class DomainIndex { domain = 1 }; + //! \copydoc doxygen_hide_felt_space_enum enum class FEltSpaceIndex { fluid_velocity = 1, @@ -49,6 +52,7 @@ namespace MoReFEM }; + //! \copydoc doxygen_hide_unknown_enum enum class UnknownIndex { velocity = 1, @@ -57,12 +61,15 @@ namespace MoReFEM }; + //! \copydoc doxygen_hide_solver_enum enum class SolverIndex + { solver = 1 }; + //! \copydoc doxygen_hide_numbering_subset_enum enum class NumberingSubsetIndex { fluid_velocity = 1, @@ -71,7 +78,8 @@ namespace MoReFEM - using InputParameterTuple = std::tuple + //! \copydoc doxygen_hide_input_parameter_tuple + using InputParameterTuple = std::tuple < InputParameter::TimeManager, @@ -95,8 +103,10 @@ namespace MoReFEM >; - using InputParameterList = InputParameterList; + //! \copydoc doxygen_hide_model_specific_input_parameter_list + using InputParameterList = InputParameterList; + //! \copydoc doxygen_hide_morefem_data_type using morefem_data_type = MoReFEMData; diff --git a/Sources/Test/Operators/P1_to_HigherOrder/Model.hpp b/Sources/Test/Operators/P1_to_HigherOrder/Model.hpp index d9e9ec4bd7..e86ba8c649 100644 --- a/Sources/Test/Operators/P1_to_HigherOrder/Model.hpp +++ b/Sources/Test/Operators/P1_to_HigherOrder/Model.hpp @@ -75,7 +75,8 @@ namespace MoReFEM * \tparam HigherOrderT Which is the target order of the interpolation. For instance, P2 to consider P1 -> P2. */ template - class Model : public MoReFEM::Model, DoConsiderProcessorWiseLocal2Global::yes> + //! \copydoc doxygen_hide_model_4_test + class Model : public MoReFEM::Model, DoConsiderProcessorWiseLocal2Global::yes> { private: @@ -106,7 +107,7 @@ namespace MoReFEM /*! * \brief Constructor. * - * \copydetails doxygen_hide_mpi_param + * \copydoc doxygen_hide_morefem_data_param */ Model(const morefem_data_type& morefem_data); @@ -136,6 +137,7 @@ namespace MoReFEM * \brief Initialise the problem. * * This initialisation includes the resolution of the static problem. + * \copydoc doxygen_hide_morefem_data_param */ void SupplInitialize(const morefem_data_type& morefem_data); @@ -165,12 +167,7 @@ namespace MoReFEM private: - /*! - * \brief Whether the model wants to add additional cases in which the Model stops (besides the reach of - * maximum time). - * - * Returns always true (no such additional condition in this Model). - */ + //! \copydoc doxygen_hide_model_SupplHasFinishedConditions_always_true bool SupplHasFinishedConditions() const; diff --git a/Sources/Test/Operators/P1_to_HigherOrder/main_interpolator_P1_P1b.cpp b/Sources/Test/Operators/P1_to_HigherOrder/main_interpolator_P1_P1b.cpp index 65836fcb31..97fd6d9793 100644 --- a/Sources/Test/Operators/P1_to_HigherOrder/main_interpolator_P1_P1b.cpp +++ b/Sources/Test/Operators/P1_to_HigherOrder/main_interpolator_P1_P1b.cpp @@ -22,7 +22,8 @@ using namespace MoReFEM::TestNS; int main(int argc, char** argv) { - using InputParameterList = P1_to_P_HigherOrder_NS::InputParameterList; + //! \copydoc doxygen_hide_model_specific_input_parameter_list + using InputParameterList = P1_to_P_HigherOrder_NS::InputParameterList; try diff --git a/Sources/Test/Operators/P1_to_HigherOrder/main_interpolator_P1_P2.cpp b/Sources/Test/Operators/P1_to_HigherOrder/main_interpolator_P1_P2.cpp index 90e644787e..ec4f9bda76 100644 --- a/Sources/Test/Operators/P1_to_HigherOrder/main_interpolator_P1_P2.cpp +++ b/Sources/Test/Operators/P1_to_HigherOrder/main_interpolator_P1_P2.cpp @@ -22,7 +22,8 @@ using namespace MoReFEM::TestNS; int main(int argc, char** argv) { - using InputParameterList = P1_to_P_HigherOrder_NS::InputParameterList; + //! \copydoc doxygen_hide_model_specific_input_parameter_list + using InputParameterList = P1_to_P_HigherOrder_NS::InputParameterList; try { diff --git a/Sources/Test/Operators/TestFunctions/ExpectedResults.hpp b/Sources/Test/Operators/TestFunctions/ExpectedResults.hpp index 731101d963..e3eb131e7d 100644 --- a/Sources/Test/Operators/TestFunctions/ExpectedResults.hpp +++ b/Sources/Test/Operators/TestFunctions/ExpectedResults.hpp @@ -41,6 +41,12 @@ namespace MoReFEM { + /*! + * \brief Convenient alias to choose the underlying storage for the expected result, depending on the + * \a IsMatrixOrVectorT template parameter. + * + * \tparam IsMatrixOrVectorT Whether matrix or vector is considered. + */ template using content_type = std::conditional_t < @@ -50,6 +56,12 @@ namespace MoReFEM >; + /*! + * \brief Convenient alias to define the associative container which stores all expected results (key is a + * unique keyword to identify which is which). + * + * \tparam LinAlgT Whether matrix or vector is considered. + */ template using expected_results_type = std::unordered_map < @@ -57,27 +69,100 @@ namespace MoReFEM content_type >; - + /*! + * \class doxygen_hide_GetExpectedVectorialResults_common + * + * \param[in] is_parallel Whether the vectorial expected results were obtained in sequential or in + * parallel. Due to parallel renumbering, positioning of values might not be the same. + * + * \return The expected results for all vectorial quantities to check (key is a unique string identifier, + * value the expected result stored in a std::vector). + */ + + + /*! + * \class doxygen_hide_GetExpectedMatricialResults_common + * + * \param[in] is_parallel Whether the matricial expected results were obtained in sequential or in + * parallel. Due to parallel renumbering, positioning of values might not be the same. + * + * \return The expected results for all matricial quantities to check (key is a unique string identifier, + * value the expected result stored in a std::vector of std::vector: first for indexing the row, and inner + * one to store the actual values to check). + */ + + /*! + * \brief Get the expected results for the vectorial quantities to check. + * + * \param[in] dimension Whether we're considering dimension 1, 2 or 3. + * \copydoc doxygen_hide_GetExpectedVectorialResults_common + */ expected_results_type GetExpectedVectorialResults(unsigned int dimension, bool is_parallel); - + /*! + * \brief Get the expected results for the matricial quantities to check. + * + * \param[in] dimension Whether we're considering dimension 1, 2 or 3. + * \copydoc doxygen_hide_GetExpectedMatricialResults_common + */ expected_results_type GetExpectedMatricialResults(unsigned int dimension, bool is_parallel); + /*! + * \brief The underlying function called by \a GetExpectedVectorialResults() for 1D case. + * + * \copydoc doxygen_hide_GetExpectedVectorialResults_common + */ expected_results_type GetExpectedVectorialResults1D(bool is_parallel); + /*! + * \brief The underlying function called by \a GetExpectedMatricialResults() for 1D case. + * + * \copydoc doxygen_hide_GetExpectedMatricialResults_common + */ expected_results_type GetExpectedMatricialResults1D(bool is_parallel); + /*! + * \brief The underlying function called by \a GetExpectedVectorialResults() for 2D case. + * + * \copydoc doxygen_hide_GetExpectedVectorialResults_common + */ expected_results_type GetExpectedVectorialResults2D(bool is_parallel); + /*! + * \brief The underlying function called by \a GetExpectedMatricialResults() for 2D case. + * + * \copydoc doxygen_hide_GetExpectedMatricialResults_common + */ expected_results_type GetExpectedMatricialResults2D(bool is_parallel); + /*! + * \brief The underlying function called by \a GetExpectedVectorialResults() for 3D case. + * + * \copydoc doxygen_hide_GetExpectedVectorialResults_common + */ expected_results_type GetExpectedVectorialResults3D(bool is_parallel); + /*! + * \brief The underlying function called by \a GetExpectedMatricialResults() for 3D case. + * + * \copydoc doxygen_hide_GetExpectedMatricialResults_common + */ expected_results_type GetExpectedMatricialResults3D(bool is_parallel); + /*! + * \brief Insert a new entry in the expected results storage. + * + * \tparam IsMatrixOrVectorT Whether the new entry is matricial or vectorial. + * + * \param[in] name Identifier of the new entry; must be unique in the storage. + * \param[in] content The associated numerical values of the new entry. + * \param[in,out] expected_results The storage in which all entries are stored. New one is added in output + * of this function. + * \copydoc doxygen_hide_invoking_file_and_line + */ template void InsertNewEntry(const std::string& name, content_type&& content, @@ -85,6 +170,17 @@ namespace MoReFEM const char* invoking_file, int invoking_line); + /*! + * \brief Check whether the matrix obtained is the same as the one stored in expected result storage. + * + * \param[in] god_of_dof \a GodOfDof upon which the matrix is defined. It is requested to retrieve + * informations related to numbering. + * \param[in] name Identifier of the entry to check. + * \param[in] obtained Value obtained by the computation; the content must match the expected one. + * \param[in] expected_results The storage in which all matricial entries are stored. + * \copydoc doxygen_hide_invoking_file_and_line + * \param[in] epsilon Value under which two floating point quantities are consider equal. + */ void CheckMatrix(const GodOfDof& god_of_dof, const GlobalMatrix& obtained, const expected_results_type& expected_results, @@ -93,6 +189,17 @@ namespace MoReFEM const double epsilon = 1.e-12); + /*! + * \brief Check whether the vector obtained is the same as the one stored in expected result storage. + * + * \param[in] god_of_dof \a GodOfDof upon which the vector is defined. It is requested to retrieve + * informations related to numbering. + * \param[in] name Identifier of the entry to check. + * \param[in] obtained Value obtained by the computation; the content must match the expected one. + * \param[in] expected_results The storage in which all vectorial entries are stored. + * \copydoc doxygen_hide_invoking_file_and_line + * \param[in] epsilon Value under which two floating point quantities are consider equal. + */ void CheckVector(const GodOfDof& god_of_dof, const GlobalVector& obtained, const expected_results_type& expected_results, diff --git a/Sources/Test/Operators/TestFunctions/InputParameterList.hpp b/Sources/Test/Operators/TestFunctions/InputParameterList.hpp index 6fa1fb305b..27a58061ca 100644 --- a/Sources/Test/Operators/TestFunctions/InputParameterList.hpp +++ b/Sources/Test/Operators/TestFunctions/InputParameterList.hpp @@ -30,13 +30,15 @@ namespace MoReFEM { - enum class MeshIndex + //! \copydoc doxygen_hide_mesh_enum + enum class MeshIndex { mesh = 1 }; - enum class DomainIndex + //! \copydoc doxygen_hide_domain_enum + enum class DomainIndex { volume = 1, surface = 2, @@ -44,7 +46,8 @@ namespace MoReFEM }; - enum class FEltSpaceIndex + //! \copydoc doxygen_hide_felt_space_enum + enum class FEltSpaceIndex { volume_potential_1_potential_2 = 1, volume_potential_1 = 2, @@ -59,7 +62,8 @@ namespace MoReFEM }; - enum class UnknownIndex + //! \copydoc doxygen_hide_unknown_enum + enum class UnknownIndex { potential_1 = 1, potential_2 = 2, @@ -69,7 +73,8 @@ namespace MoReFEM }; - enum class NumberingSubsetIndex + //! \copydoc doxygen_hide_numbering_subset_enum + enum class NumberingSubsetIndex { potential_1_potential_2 = 1, potential_1 = 2, @@ -82,12 +87,15 @@ namespace MoReFEM }; - enum class SolverIndex + //! \copydoc doxygen_hide_solver_enum + enum class SolverIndex + { solver = 1 }; + //! \copydoc doxygen_hide_fiber_enum enum class FiberIndex { fibers_in_volume = 1, @@ -95,11 +103,15 @@ namespace MoReFEM angles = 3 }; + + //! \copydoc doxygen_hide_source_enum enum class ForceIndexList : unsigned int { source = 1 }; + + //! \copydoc doxygen_hide_input_parameter_tuple using InputParameterTuple = std::tuple < InputParameter::TimeManager, @@ -164,8 +176,10 @@ namespace MoReFEM >; + //! \copydoc doxygen_hide_model_specific_input_parameter_list using InputParameterList = InputParameterList; + //! \copydoc doxygen_hide_morefem_data_type using morefem_data_type = MoReFEMData; diff --git a/Sources/Test/Operators/TestFunctions/Model.hpp b/Sources/Test/Operators/TestFunctions/Model.hpp index ee7dacad16..e29381df96 100644 --- a/Sources/Test/Operators/TestFunctions/Model.hpp +++ b/Sources/Test/Operators/TestFunctions/Model.hpp @@ -27,6 +27,7 @@ namespace MoReFEM { + //! \copydoc doxygen_hide_model_4_test class Model : public MoReFEM::Model { @@ -54,7 +55,7 @@ namespace MoReFEM /*! * \brief Constructor. * - * \copydetails doxygen_hide_mpi_param + * \copydoc doxygen_hide_morefem_data_param */ Model(const morefem_data_type& morefem_data); @@ -84,6 +85,7 @@ namespace MoReFEM * \brief Initialise the problem. * * This initialisation includes the resolution of the static problem. + * \copydoc doxygen_hide_morefem_data_param */ void SupplInitialize(const morefem_data_type& morefem_data); @@ -118,12 +120,7 @@ namespace MoReFEM private: - /*! - * \brief Whether the model wants to add additional cases in which the Model stops (besides the reach of - * maximum time). - * - * Returns always true (no such additional condition in this Model). - */ + //! \copydoc doxygen_hide_model_SupplHasFinishedConditions_always_true bool SupplHasFinishedConditions() const; diff --git a/Sources/Test/Operators/TestFunctions/VariationalFormulation.hpp b/Sources/Test/Operators/TestFunctions/VariationalFormulation.hpp index a76ddeb4a7..33233338ab 100644 --- a/Sources/Test/Operators/TestFunctions/VariationalFormulation.hpp +++ b/Sources/Test/Operators/TestFunctions/VariationalFormulation.hpp @@ -52,6 +52,7 @@ namespace MoReFEM { + //! \copydoc doxygen_hide_varf_4_test class VariationalFormulation : public MoReFEM::VariationalFormulation < @@ -100,6 +101,7 @@ namespace MoReFEM using ActiveStressPolicy = GlobalVariationalOperatorNS::SecondPiolaKirchhoffStressTensorNS::ActiveStressPolicyNS::None; + //! Alias to the hyperelasticity policy used. using hyperelasticity_policy = GlobalVariationalOperatorNS::SecondPiolaKirchhoffStressTensorNS::HyperelasticityPolicyNS ::Hyperelasticity; @@ -136,11 +138,7 @@ namespace MoReFEM /// \name Special members. ///@{ - /*! - * \brief Constructor. - * - * \copydetails doxygen_hide_mpi_param - */ + //! copydoc doxygen_hide_varf_constructor explicit VariationalFormulation(const morefem_data_type& morefem_data, TimeManager& time_manager, const GodOfDof& god_of_dof, @@ -168,11 +166,7 @@ namespace MoReFEM /// \name CRTP-required methods. ///@{ - /*! - * \brief Specific initialisation for derived class attributes. - * - * \internal [internal] This method is called by base class method VariationalFormulation::Init(). - */ + //! \copydoc doxygen_hide_varf_suppl_init void SupplInit(const InputParameterList& input_parameter_data); /*! diff --git a/Sources/Test/Operators/TestFunctions/main.cpp b/Sources/Test/Operators/TestFunctions/main.cpp index 78197ce735..6b9e7e630c 100644 --- a/Sources/Test/Operators/TestFunctions/main.cpp +++ b/Sources/Test/Operators/TestFunctions/main.cpp @@ -21,7 +21,8 @@ using namespace MoReFEM; int main(int argc, char** argv) { - using InputParameterList = TestFunctionsNS::InputParameterList; + //! \copydoc doxygen_hide_model_specific_input_parameter_list + using InputParameterList = TestFunctionsNS::InputParameterList; try { diff --git a/Sources/Test/Parameter/AtDof/InputParameterList.hpp b/Sources/Test/Parameter/AtDof/InputParameterList.hpp index afeaaed72a..810213d675 100644 --- a/Sources/Test/Parameter/AtDof/InputParameterList.hpp +++ b/Sources/Test/Parameter/AtDof/InputParameterList.hpp @@ -26,12 +26,14 @@ namespace MoReFEM { + //! \copydoc doxygen_hide_mesh_enum enum class MeshIndex { mesh = 1 }; + //! \copydoc doxygen_hide_domain_enum enum class DomainIndex { domain = 1, @@ -39,12 +41,14 @@ namespace MoReFEM }; + //! \copydoc doxygen_hide_felt_space_enum enum class FEltSpaceIndex { index = 1 }; + //! \copydoc doxygen_hide_unknown_enum enum class UnknownIndex { scalar = 1, @@ -52,12 +56,15 @@ namespace MoReFEM }; + //! \copydoc doxygen_hide_solver_enum enum class SolverIndex + { solver = 1 }; + //! \copydoc doxygen_hide_numbering_subset_enum enum class NumberingSubsetIndex { scalar = 1, @@ -65,6 +72,7 @@ namespace MoReFEM }; + //! \copydoc doxygen_hide_fiber_enum enum class FiberIndex { fiber = 1, @@ -73,6 +81,7 @@ namespace MoReFEM + //! \copydoc doxygen_hide_input_parameter_tuple using InputParameterTuple = std::tuple < InputParameter::TimeManager, @@ -99,8 +108,10 @@ namespace MoReFEM >; + //! \copydoc doxygen_hide_model_specific_input_parameter_list using InputParameterList = InputParameterList; + //! \copydoc doxygen_hide_morefem_data_type using morefem_data_type = MoReFEMData; diff --git a/Sources/Test/Parameter/AtDof/Model.cpp b/Sources/Test/Parameter/AtDof/Model.cpp index 8c4af2f26b..76dcfe88af 100644 --- a/Sources/Test/Parameter/AtDof/Model.cpp +++ b/Sources/Test/Parameter/AtDof/Model.cpp @@ -56,10 +56,7 @@ namespace MoReFEM void Model::SupplFinalize() - { -// Internal::FiberNS::FiberListManager::Destroy(); -// Internal::FiberNS::FiberListManager::Destroy(); - } + { } } // namespace TestAtDofNS diff --git a/Sources/Test/Parameter/AtDof/Model.hpp b/Sources/Test/Parameter/AtDof/Model.hpp index 00cd15b59e..7847fe3b72 100644 --- a/Sources/Test/Parameter/AtDof/Model.hpp +++ b/Sources/Test/Parameter/AtDof/Model.hpp @@ -28,6 +28,7 @@ namespace MoReFEM { + //! \copydoc doxygen_hide_model_4_test class Model : public MoReFEM::Model { @@ -55,9 +56,8 @@ namespace MoReFEM /*! * \brief Constructor. * - * \copydetails doxygen_hide_mpi_param + * \copydoc doxygen_hide_morefem_data_param */ - Model(const morefem_data_type& morefem_data); //! Destructor. @@ -86,6 +86,7 @@ namespace MoReFEM * \brief Initialise the problem. * * This initialisation includes the resolution of the static problem. + * \copydoc doxygen_hide_morefem_data_param */ void SupplInitialize(const morefem_data_type& morefem_data); @@ -115,12 +116,7 @@ namespace MoReFEM private: - /*! - * \brief Whether the model wants to add additional cases in which the Model stops (besides the reach of - * maximum time). - * - * Returns always true (no such additional condition in this Model). - */ + //! \copydoc doxygen_hide_model_SupplHasFinishedConditions_always_true bool SupplHasFinishedConditions() const; @@ -139,10 +135,6 @@ namespace MoReFEM //! Output directory. const std::string output_directory_; - GlobalVector::unique_ptr scalar_parameter_vector_ = nullptr; - - GlobalVector::unique_ptr vectorial_parameter_vector_ = nullptr; - }; diff --git a/Sources/Test/Parameter/AtDof/main.cpp b/Sources/Test/Parameter/AtDof/main.cpp index e0144d4da3..94a5c3a1ef 100644 --- a/Sources/Test/Parameter/AtDof/main.cpp +++ b/Sources/Test/Parameter/AtDof/main.cpp @@ -21,6 +21,7 @@ using namespace MoReFEM; int main(int argc, char** argv) { + //! \copydoc doxygen_hide_model_specific_input_parameter_list using InputParameterList = TestAtDofNS::InputParameterList; try diff --git a/Sources/Test/Parameter/TimeDependency/InputParameterList.hpp b/Sources/Test/Parameter/TimeDependency/InputParameterList.hpp index 439a9285c1..2c6a3d9ebe 100644 --- a/Sources/Test/Parameter/TimeDependency/InputParameterList.hpp +++ b/Sources/Test/Parameter/TimeDependency/InputParameterList.hpp @@ -28,50 +28,60 @@ namespace MoReFEM { - enum class MeshIndex + //! \copydoc doxygen_hide_mesh_enum + enum class MeshIndex { mesh = 1 }; - enum class DomainIndex + //! \copydoc doxygen_hide_domain_enum + enum class DomainIndex { domain = 1, full_mesh = 2 }; - enum class FEltSpaceIndex + //! \copydoc doxygen_hide_felt_space_enum + enum class FEltSpaceIndex { index = 1 }; - enum class UnknownIndex + //! \copydoc doxygen_hide_unknown_enum + enum class UnknownIndex { scalar = 1, vectorial = 2 }; - enum class SolverIndex + //! \copydoc doxygen_hide_solver_enum + enum class SolverIndex + { solver = 1 }; - enum class NumberingSubsetIndex + //! \copydoc doxygen_hide_numbering_subset_enum + enum class NumberingSubsetIndex { scalar = 1, vectorial = 2 }; + //! \copydoc doxygen_hide_source_enum enum class SourceIndex { source = 1, }; + + //! Index for the rpessure read from a file. enum class PressureIndex { pressure = 1 @@ -79,6 +89,7 @@ namespace MoReFEM + //! \copydoc doxygen_hide_input_parameter_tuple using InputParameterTuple = std::tuple < InputParameter::TimeManager, @@ -109,8 +120,10 @@ namespace MoReFEM >; + //! \copydoc doxygen_hide_model_specific_input_parameter_list using InputParameterList = InputParameterList; + //! \copydoc doxygen_hide_morefem_data_type using morefem_data_type = MoReFEMData; diff --git a/Sources/Test/Parameter/TimeDependency/Model.hpp b/Sources/Test/Parameter/TimeDependency/Model.hpp index 93129f6534..08e4002dcd 100644 --- a/Sources/Test/Parameter/TimeDependency/Model.hpp +++ b/Sources/Test/Parameter/TimeDependency/Model.hpp @@ -30,6 +30,7 @@ namespace MoReFEM { + //! \copydoc doxygen_hide_model_4_test class Model : public MoReFEM::Model { @@ -49,6 +50,7 @@ namespace MoReFEM //! Friendship granted to the base class so this one can manipulates private methods. friend parent; + //! Convenient alias. using scalar_varying_type_functor = Parameter < ParameterNS::Type::scalar, @@ -56,6 +58,7 @@ namespace MoReFEM ParameterNS::TimeDependencyFunctor >; + //! Convenient alias. using scalar_varying_type_from_file = Parameter < ParameterNS::Type::scalar, @@ -63,7 +66,7 @@ namespace MoReFEM ParameterNS::TimeDependencyFromFile >; - + //! Convenient alias. using scalar_immutable_type = Parameter < ParameterNS::Type::scalar, @@ -79,7 +82,7 @@ namespace MoReFEM /*! * \brief Constructor. * - * \copydetails doxygen_hide_mpi_param + * \copydoc doxygen_hide_morefem_data_param */ Model(const morefem_data_type& morefem_data); @@ -109,6 +112,7 @@ namespace MoReFEM * \brief Initialise the problem. * * This initialisation includes the resolution of the static problem. + * \copydoc doxygen_hide_morefem_data_param */ void SupplInitialize(const morefem_data_type& morefem_data); @@ -135,12 +139,7 @@ namespace MoReFEM private: - /*! - * \brief Whether the model wants to add additional cases in which the Model stops (besides the reach of - * maximum time). - * - * Returns always true (no such additional condition in this Model). - */ + //! \copydoc doxygen_hide_model_SupplHasFinishedConditions_always_true bool SupplHasFinishedConditions() const; diff --git a/Sources/Test/Parameter/TimeDependency/main.cpp b/Sources/Test/Parameter/TimeDependency/main.cpp index 79dbc4881a..23865d3e35 100644 --- a/Sources/Test/Parameter/TimeDependency/main.cpp +++ b/Sources/Test/Parameter/TimeDependency/main.cpp @@ -21,7 +21,8 @@ using namespace MoReFEM; int main(int argc, char** argv) { - using InputParameterList = TestParameterTimeDependencyNS::InputParameterList; + //! \copydoc doxygen_hide_model_specific_input_parameter_list + using InputParameterList = TestParameterTimeDependencyNS::InputParameterList; try { diff --git a/Sources/Test/Test.doxygen b/Sources/Test/Test.doxygen new file mode 100644 index 0000000000..e687bcfc4c --- /dev/null +++ b/Sources/Test/Test.doxygen @@ -0,0 +1,18 @@ +/*! + * \class doxygen_hide_model_4_test + * + * \brief Model tailored for the test usage. + */ + + +/*! + * \class doxygen_hide_varf_4_test + * + * \brief Variational formulation tailored for the test usage. + */ + + + + + + diff --git a/Sources/Test/ThirdParty/Mpi/ErrorHandling/InputParameterList.hpp b/Sources/Test/ThirdParty/Mpi/ErrorHandling/InputParameterList.hpp index 250e440d4a..369cbd85ed 100644 --- a/Sources/Test/ThirdParty/Mpi/ErrorHandling/InputParameterList.hpp +++ b/Sources/Test/ThirdParty/Mpi/ErrorHandling/InputParameterList.hpp @@ -28,15 +28,18 @@ namespace MoReFEM - using InputParameterTuple = std::tuple + //! \copydoc doxygen_hide_input_parameter_tuple + using InputParameterTuple = std::tuple < InputParameter::TimeManager, InputParameter::Result >; - using InputParameterList = InputParameterList; + //! \copydoc doxygen_hide_model_specific_input_parameter_list + using InputParameterList = InputParameterList; + //! \copydoc doxygen_hide_morefem_data_type using morefem_data_type = MoReFEMData; diff --git a/Sources/Test/ThirdParty/Mpi/ErrorHandling/main.cpp b/Sources/Test/ThirdParty/Mpi/ErrorHandling/main.cpp index f3c23fbb2f..7b7674b5d0 100644 --- a/Sources/Test/ThirdParty/Mpi/ErrorHandling/main.cpp +++ b/Sources/Test/ThirdParty/Mpi/ErrorHandling/main.cpp @@ -21,7 +21,8 @@ using namespace MoReFEM; int main(int argc, char** argv) { - using InputParameterList = TestNS::InputParameterListNS::InputParameterList; + //! \copydoc doxygen_hide_model_specific_input_parameter_list + using InputParameterList = TestNS::InputParameterListNS::InputParameterList; try { diff --git a/Sources/Test/ThirdParty/Mpi/Functions/InputParameterList.hpp b/Sources/Test/ThirdParty/Mpi/Functions/InputParameterList.hpp index 96e40f7dd1..739ff55559 100644 --- a/Sources/Test/ThirdParty/Mpi/Functions/InputParameterList.hpp +++ b/Sources/Test/ThirdParty/Mpi/Functions/InputParameterList.hpp @@ -26,15 +26,18 @@ namespace MoReFEM { - using InputParameterTuple = std::tuple + //! \copydoc doxygen_hide_input_parameter_tuple + using InputParameterTuple = std::tuple < InputParameter::TimeManager, InputParameter::Result >; - using InputParameterList = InputParameterList; + //! \copydoc doxygen_hide_model_specific_input_parameter_list + using InputParameterList = InputParameterList; + //! \copydoc doxygen_hide_morefem_data_type using morefem_data_type = MoReFEMData; diff --git a/Sources/Test/ThirdParty/Mpi/Functions/main.cpp b/Sources/Test/ThirdParty/Mpi/Functions/main.cpp index 4576a5ad90..1e8d58b0c4 100644 --- a/Sources/Test/ThirdParty/Mpi/Functions/main.cpp +++ b/Sources/Test/ThirdParty/Mpi/Functions/main.cpp @@ -38,7 +38,8 @@ namespace // anonymous int main(int argc, char** argv) { - using InputParameterList = TestNS::InputParameterListNS::InputParameterList; + //! \copydoc doxygen_hide_model_specific_input_parameter_list + using InputParameterList = TestNS::InputParameterListNS::InputParameterList; try { diff --git a/Sources/Test/ThirdParty/Mpi/SendReceive/InputParameterList.hpp b/Sources/Test/ThirdParty/Mpi/SendReceive/InputParameterList.hpp index d64db4248d..82213a7117 100644 --- a/Sources/Test/ThirdParty/Mpi/SendReceive/InputParameterList.hpp +++ b/Sources/Test/ThirdParty/Mpi/SendReceive/InputParameterList.hpp @@ -28,15 +28,18 @@ namespace MoReFEM - using InputParameterTuple = std::tuple + //! \copydoc doxygen_hide_input_parameter_tuple + using InputParameterTuple = std::tuple < InputParameter::TimeManager, InputParameter::Result >; - using InputParameterList = InputParameterList; + //! \copydoc doxygen_hide_model_specific_input_parameter_list + using InputParameterList = InputParameterList; + //! \copydoc doxygen_hide_morefem_data_type using morefem_data_type = MoReFEMData; diff --git a/Sources/Test/ThirdParty/Mpi/SendReceive/main_array.cpp b/Sources/Test/ThirdParty/Mpi/SendReceive/main_array.cpp index 524d3675af..9c7c8ba131 100644 --- a/Sources/Test/ThirdParty/Mpi/SendReceive/main_array.cpp +++ b/Sources/Test/ThirdParty/Mpi/SendReceive/main_array.cpp @@ -23,7 +23,8 @@ using namespace MoReFEM; int main(int argc, char** argv) { - using InputParameterList = TestNS::MpiSendReceiveNS::InputParameterList; + //! \copydoc doxygen_hide_model_specific_input_parameter_list + using InputParameterList = TestNS::MpiSendReceiveNS::InputParameterList; try { diff --git a/Sources/Test/ThirdParty/Mpi/SendReceive/main_single_value.cpp b/Sources/Test/ThirdParty/Mpi/SendReceive/main_single_value.cpp index eacd0c2d15..96baa8dbdf 100644 --- a/Sources/Test/ThirdParty/Mpi/SendReceive/main_single_value.cpp +++ b/Sources/Test/ThirdParty/Mpi/SendReceive/main_single_value.cpp @@ -23,7 +23,8 @@ using namespace MoReFEM; int main(int argc, char** argv) { - using InputParameterList = TestNS::MpiSendReceiveNS::InputParameterList; + //! \copydoc doxygen_hide_model_specific_input_parameter_list + using InputParameterList = TestNS::MpiSendReceiveNS::InputParameterList; try { diff --git a/Sources/Test/Utilities/InputParameterList/InputParameterList.hpp b/Sources/Test/Utilities/InputParameterList/InputParameterList.hpp index f237aeb3df..1fd780f528 100644 --- a/Sources/Test/Utilities/InputParameterList/InputParameterList.hpp +++ b/Sources/Test/Utilities/InputParameterList/InputParameterList.hpp @@ -20,6 +20,7 @@ # include "Core/InputParameter/Solver/Petsc.hpp" # include "Core/InputParameter/Geometry/InterpolationFile.hpp" + namespace MoReFEM { @@ -32,55 +33,51 @@ namespace MoReFEM { + //! \copydoc doxygen_hide_mesh_enum enum class MeshIndex { mesh = 1 }; + //! \copydoc doxygen_hide_domain_enum enum class DomainIndex { domain = 1 }; + //! \copydoc doxygen_hide_felt_space_enum enum class FEltSpaceIndex { felt_space = 1 }; + //! \copydoc doxygen_hide_unknown_enum enum class UnknownIndex { unknown = 1 }; + //! \copydoc doxygen_hide_solver_enum enum class SolverIndex + { solver = 1 }; + //! \copydoc doxygen_hide_numbering_subset_enum enum class NumberingSubsetIndex : unsigned int { numbering_subset = 1 }; - struct HardcodedNumberingSubset - { - - static const std::string& Value() - { - static const std::string ret("Hardcoded numbering subset"); - return ret; - } - - - }; - + //! \copydoc doxygen_hide_input_parameter_tuple using InputParameterTuple = std::tuple < InputParameter::TimeManager, @@ -104,9 +101,11 @@ namespace MoReFEM >; + //! \copydoc doxygen_hide_model_specific_input_parameter_list using InputParameterList = InputParameterList; - using morefem_data_type = MoReFEMData; + //! \copydoc doxygen_hide_morefem_data_type + using morefem_data_type = MoReFEMData; } // namespace TestNS diff --git a/Sources/Test/Utilities/InputParameterList/main.cpp b/Sources/Test/Utilities/InputParameterList/main.cpp index 9531004dba..fd3474450b 100644 --- a/Sources/Test/Utilities/InputParameterList/main.cpp +++ b/Sources/Test/Utilities/InputParameterList/main.cpp @@ -23,7 +23,8 @@ using namespace MoReFEM; int main(int argc, char** argv) { - using InputParameterList = TestNS::InputParameterListNS::InputParameterList; + //! \copydoc doxygen_hide_model_specific_input_parameter_list + using InputParameterList = TestNS::InputParameterListNS::InputParameterList; try { diff --git a/XCodeTemplates/InputParameterList.xctemplate/___FILEBASENAME___.hpp b/XCodeTemplates/InputParameterList.xctemplate/___FILEBASENAME___.hpp index 1037a9840a..c6391a27ce 100644 --- a/XCodeTemplates/InputParameterList.xctemplate/___FILEBASENAME___.hpp +++ b/XCodeTemplates/InputParameterList.xctemplate/___FILEBASENAME___.hpp @@ -31,13 +31,15 @@ namespace MoReFEM { - enum class MeshIndex + //! \copydoc doxygen_hide_mesh_enum + enum class MeshIndex { mesh = 1 }; - enum class DomainIndex + //! \copydoc doxygen_hide_domain_enum + enum class DomainIndex { /* TODO Complete with something like: highest_dimension = 1, @@ -46,7 +48,8 @@ namespace MoReFEM }; - enum class FEltSpaceIndex + //! \copydoc doxygen_hide_felt_space_enum + enum class FEltSpaceIndex { /* TODO Complete with something like: highest_dimension = 1, @@ -56,7 +59,8 @@ namespace MoReFEM }; - enum class UnknownIndex + //! \copydoc doxygen_hide_unknown_enum + enum class UnknownIndex { /* TODO Complete with something like: velocity = 1, @@ -65,6 +69,7 @@ namespace MoReFEM }; + //! \copydoc doxygen_hide_boundary_condition_enum enum class BoundaryConditionIndex { /* TODO Complete with something like: @@ -75,13 +80,16 @@ namespace MoReFEM - enum class SolverIndex + //! \copydoc doxygen_hide_solver_enum + enum class SolverIndex + { solver = 1 }; - enum class NumberingSubsetIndex + //! \copydoc doxygen_hide_numbering_subset_enum + enum class NumberingSubsetIndex { /* TODO Complete with something like: monolithic = @@ -90,6 +98,7 @@ namespace MoReFEM + //! \copydoc doxygen_hide_input_parameter_tuple using InputParameterTuple = std::tuple < InputParameter::TimeManager, @@ -114,8 +123,10 @@ namespace MoReFEM >; + //! \copydoc doxygen_hide_model_specific_input_parameter_list using InputParameterList = InputParameterList; + //! \copydoc doxygen_hide_morefem_data_type using morefem_data_type = MoReFEMData; diff --git a/XCodeTemplates/Main.xctemplate/___FILEBASENAME___.cpp b/XCodeTemplates/Main.xctemplate/___FILEBASENAME___.cpp index 1b372b87cd..2a5e77d34f 100644 --- a/XCodeTemplates/Main.xctemplate/___FILEBASENAME___.cpp +++ b/XCodeTemplates/Main.xctemplate/___FILEBASENAME___.cpp @@ -22,7 +22,8 @@ using namespace MoReFEM; int main(int argc, char** argv) { - using InputParameterList = ___VARIABLE_problemName:identifier___NS::InputParameterList; + //! \copydoc doxygen_hide_model_specific_input_parameter_list + using InputParameterList = ___VARIABLE_problemName:identifier___NS::InputParameterList; try { diff --git a/XCodeTemplates/MainEnsightOutput.xctemplate/___FILEBASENAME___.cpp b/XCodeTemplates/MainEnsightOutput.xctemplate/___FILEBASENAME___.cpp index 873aa3c745..3ce336ed65 100644 --- a/XCodeTemplates/MainEnsightOutput.xctemplate/___FILEBASENAME___.cpp +++ b/XCodeTemplates/MainEnsightOutput.xctemplate/___FILEBASENAME___.cpp @@ -32,6 +32,7 @@ int main(int argc, char** argv) try { + //! \copydoc doxygen_hide_model_specific_input_parameter_list using InputParameterList = ___VARIABLE_problemName:identifier___NS::InputParameterList; MoReFEMData morefem_data(argc, argv); diff --git a/XCodeTemplates/Model.xctemplate/___FILEBASENAME___.hpp b/XCodeTemplates/Model.xctemplate/___FILEBASENAME___.hpp index c75ec6579b..f0e5f5ea2e 100644 --- a/XCodeTemplates/Model.xctemplate/___FILEBASENAME___.hpp +++ b/XCodeTemplates/Model.xctemplate/___FILEBASENAME___.hpp @@ -55,7 +55,7 @@ namespace MoReFEM /*! * \brief Constructor. * - * \copydetails doxygen_hide_mpi_param + * \copydoc doxygen_hide_morefem_data_param */ Model(const morefem_data_type& morefem_data); @@ -84,7 +84,7 @@ namespace MoReFEM /*! * \brief Initialise the problem. * - * This initialisation includes the resolution of the static problem. + * \copydoc doxygen_hide_morefem_data_param */ void SupplInitialize(const morefem_data_type& morefem_data); @@ -109,13 +109,7 @@ namespace MoReFEM private: - - /*! - * \brief Whether the model wants to add additional cases in which the Model stops (besides the reach of - * maximum time). - * - * Returns always true (no such additional condition in this Model). - */ + //! \copydoc doxygen_hide_model_SupplHasFinishedConditions_always_true bool SupplHasFinishedConditions() const; diff --git a/XCodeTemplates/VariationalFormulation.xctemplate/___FILEBASENAME___.hpp b/XCodeTemplates/VariationalFormulation.xctemplate/___FILEBASENAME___.hpp index 20a9832ba2..ab0afb1458 100644 --- a/XCodeTemplates/VariationalFormulation.xctemplate/___FILEBASENAME___.hpp +++ b/XCodeTemplates/VariationalFormulation.xctemplate/___FILEBASENAME___.hpp @@ -67,15 +67,11 @@ namespace MoReFEM /// \name Special members. ///@{ - /*! - * \brief Constructor. - * - * \copydetails doxygen_hide_mpi_param - */ + //! copydoc doxygen_hide_varf_constructor explicit VariationalFormulation(const morefem_data_type& morefem_data, const NumberingSubset& numbering_subset1, const NumberingSubset& numbering_subset2, // TODO and more if needed... - const TimeManager& time_manager, + TimeManager& time_manager, const GodOfDof& god_of_dof, DirichletBoundaryCondition::vector_shared_ptr&& boundary_condition_list); @@ -102,13 +98,7 @@ namespace MoReFEM /// \name CRTP-required methods. ///@{ - /*! - * \brief Specific initialisation for derived class attributes. - * - * \internal [internal] This method is called by base class method VariationalFormulation::Init(). - * - * \copydoc doxygen_hide_input_parameter_data_arg - */ + //! \copydoc doxygen_hide_varf_suppl_init // TODO: InputParameterDataT might probably be replaced by the actual InputParameterList used in the Model. template void SupplInit(const InputParameterDataT& input_parameter_data); -- GitLab From 29d7c35924d67c673419733710b65267374619ac Mon Sep 17 00:00:00 2001 From: Sebastien Gilles Date: Mon, 1 Jan 2018 22:09:34 +0100 Subject: [PATCH 05/11] #1211 Add a perfunctory README.md at the root of the project, and make Doxygen use it for its main page. --- Documentation/Doxygen/morefem.dox | 8 +++++--- README.md | 1 + 2 files changed, 6 insertions(+), 3 deletions(-) create mode 100644 README.md diff --git a/Documentation/Doxygen/morefem.dox b/Documentation/Doxygen/morefem.dox index 3154c76605..af314baeec 100644 --- a/Documentation/Doxygen/morefem.dox +++ b/Documentation/Doxygen/morefem.dox @@ -778,7 +778,9 @@ INPUT = ../../Sources/Utilities \ ../../Sources/FormulationSolver \ ../../Sources/Model \ ../../Sources/PostProcessing \ - ../../Sources/Test + ../../Sources/Test \ + ../../Sources/ModelInstances \ + ../../README.md # This tag can be used to specify the character encoding of the source files # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses @@ -926,9 +928,9 @@ FILTER_SOURCE_PATTERNS = # If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that # is part of the input, its contents will be placed on the main page # (index.html). This can be useful if you have a project on for instance GitHub -# and want to reuse the introduction page also for the doxygen output. +# and want to reuse the introduction page also for the Doxygen output. -USE_MDFILE_AS_MAINPAGE = +USE_MDFILE_AS_MAINPAGE = ../../README.md #--------------------------------------------------------------------------- # Configuration options related to source browsing diff --git a/README.md b/README.md new file mode 100644 index 0000000000..102f9085fb --- /dev/null +++ b/README.md @@ -0,0 +1 @@ +A HPC finite element library developed for the implementation of the models of M3DISIM Inria team. -- GitLab From 8b659849207fb2afb7091b1218036e3ea5158a73 Mon Sep 17 00:00:00 2001 From: Sebastien Gilles Date: Wed, 3 Jan 2018 22:18:50 +0100 Subject: [PATCH 06/11] #1211 - #859 Break Utilities::Sort into several files (previously Internal was not separated and everything was in hpp, including template definition). --- MoReFEM.xcodeproj/project.pbxproj | 8 ++ .../Utilities/Containers/Internal/Sort.hpp | 133 ++++++++++++++++++ .../Utilities/Containers/Internal/Sort.hxx | 87 ++++++++++++ Sources/Utilities/Containers/Sort.hpp | 126 +---------------- 4 files changed, 231 insertions(+), 123 deletions(-) create mode 100644 Sources/Utilities/Containers/Internal/Sort.hpp create mode 100644 Sources/Utilities/Containers/Internal/Sort.hxx diff --git a/MoReFEM.xcodeproj/project.pbxproj b/MoReFEM.xcodeproj/project.pbxproj index 27fd4a8b3d..8636288940 100644 --- a/MoReFEM.xcodeproj/project.pbxproj +++ b/MoReFEM.xcodeproj/project.pbxproj @@ -1115,6 +1115,8 @@ BE7C949C1F605266003D2C52 /* GradPhiTauTauGradPhi.hxx in Headers */ = {isa = PBXBuildFile; fileRef = BE7C94961F605266003D2C52 /* GradPhiTauTauGradPhi.hxx */; }; BE80EE591DE72A88005502B4 /* ScalarTransientSource.hpp in Headers */ = {isa = PBXBuildFile; fileRef = BE80EE571DE72A88005502B4 /* ScalarTransientSource.hpp */; }; BE80EE5A1DE72A88005502B4 /* ScalarTransientSource.hxx in Headers */ = {isa = PBXBuildFile; fileRef = BE80EE581DE72A88005502B4 /* ScalarTransientSource.hxx */; }; + BE83582B1FFD779E0009956E /* Sort.hpp in Headers */ = {isa = PBXBuildFile; fileRef = BE83582A1FFD779E0009956E /* Sort.hpp */; }; + BE83582D1FFD78DE0009956E /* Sort.hxx in Headers */ = {isa = PBXBuildFile; fileRef = BE83582C1FFD78DD0009956E /* Sort.hxx */; }; BE8553A91BBD77BF00DB109E /* DofSource.cpp in Sources */ = {isa = PBXBuildFile; fileRef = BE8553A31BBD77BF00DB109E /* DofSource.cpp */; }; BE8553AA1BBD77BF00DB109E /* DofSource.hpp in Headers */ = {isa = PBXBuildFile; fileRef = BE8553A41BBD77BF00DB109E /* DofSource.hpp */; }; BE8553AB1BBD77BF00DB109E /* DofSource.hxx in Headers */ = {isa = PBXBuildFile; fileRef = BE8553A51BBD77BF00DB109E /* DofSource.hxx */; }; @@ -5166,6 +5168,8 @@ BE8058C91FF7DA5C008E97D2 /* Test.doxygen */ = {isa = PBXFileReference; lastKnownFileType = text; path = Test.doxygen; sourceTree = ""; }; BE80EE571DE72A88005502B4 /* ScalarTransientSource.hpp */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.h; name = ScalarTransientSource.hpp; path = Parameter/Source/ScalarTransientSource.hpp; sourceTree = ""; }; BE80EE581DE72A88005502B4 /* ScalarTransientSource.hxx */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.h; name = ScalarTransientSource.hxx; path = Parameter/Source/ScalarTransientSource.hxx; sourceTree = ""; }; + BE83582A1FFD779E0009956E /* Sort.hpp */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.h; path = Sort.hpp; sourceTree = ""; }; + BE83582C1FFD78DD0009956E /* Sort.hxx */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.h; path = Sort.hxx; sourceTree = ""; }; BE8553A31BBD77BF00DB109E /* DofSource.cpp */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.cpp; path = DofSource.cpp; sourceTree = ""; }; BE8553A41BBD77BF00DB109E /* DofSource.hpp */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.h; path = DofSource.hpp; sourceTree = ""; }; BE8553A51BBD77BF00DB109E /* DofSource.hxx */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.h; path = DofSource.hxx; sourceTree = ""; }; @@ -7400,6 +7404,8 @@ BE110E8B1E114F1400D2D2C8 /* Internal */ = { isa = PBXGroup; children = ( + BE83582A1FFD779E0009956E /* Sort.hpp */, + BE83582C1FFD78DD0009956E /* Sort.hxx */, BE110E8C1E114F1400D2D2C8 /* TupleHelper.hpp */, ); path = Internal; @@ -12432,6 +12438,7 @@ BE90E1CF1A2492AA00CCAFDE /* PetscSys.hpp in Headers */, BE53FC1F1E0D7F0500C5D6F5 /* PrepareDefaultEntry.hpp in Headers */, BE90E1AD1A24929A00CCAFDE /* MatrixPattern.hpp in Headers */, + BE83582B1FFD779E0009956E /* Sort.hpp in Headers */, BE145A041E54BC49000A2BF5 /* HelpVisitor.h in Headers */, BE5B6F911C3C16E9004A0284 /* ShellMatrix.hpp in Headers */, BE53FC161E0D7C6800C5D6F5 /* TupleIteration.hxx in Headers */, @@ -12476,6 +12483,7 @@ BE6E4EE21B2ABE8B0049BB2D /* AccessGhostContent.hpp in Headers */, BE76F24F1D7D5D900061B50E /* LocalMatrixStorage.hxx in Headers */, BE90E1621A24926E00CCAFDE /* Exception.hpp in Headers */, + BE83582D1FFD78DE0009956E /* Sort.hxx in Headers */, BEDEB92A1C3C073100B1C71B /* Umfpack.hxx in Headers */, BE90E16A1A24926E00CCAFDE /* Sort.hpp in Headers */, 135F21441E7ADB2A00B9E633 /* Viscoelasticity.hpp in Headers */, diff --git a/Sources/Utilities/Containers/Internal/Sort.hpp b/Sources/Utilities/Containers/Internal/Sort.hpp new file mode 100644 index 0000000000..451c6f9e78 --- /dev/null +++ b/Sources/Utilities/Containers/Internal/Sort.hpp @@ -0,0 +1,133 @@ +/// +////// \file +/// +/// +/// Created by Sebastien Gilles on the Thu, 17 Jan 2013 10:43:51 +0100 +/// Copyright (c) Inria. All rights reserved. +/// +/// \ingroup UtilitiesGroup +/// \addtogroup UtilitiesGroup +/// \{ + +#ifndef MOREFEM_x_UTILITIES_x_CONTAINERS_x_INTERNAL_x_SORT_HPP_ +# define MOREFEM_x_UTILITIES_x_CONTAINERS_x_INTERNAL_x_SORT_HPP_ + + +# include +# include + + +namespace MoReFEM +{ + + + namespace Internal + { + + + namespace SortNS + { + +// * static int Value(const T& element) +// * { +// * return T.GetDimension(); +// * } + + /*! + * \brief Compare whether two objects of same type are equal regarding one unary function. + * + * \tparam T Type of the objects involved. + * \tparam UnaryT Structure which is expected to define a static unary function named + * Value which sole parameter is a \a T object. + * Typically UnaryT will be a trick to get the results of a method of T object. + * + * For instance: + * \code{.cpp} + struct Dimension + { + static int Value(const T& element) + { + return T.GetDimension(); + } + }; + + T foo, bar; + + bool are_equal = IsEqual(foo, bar); + //< actually performs foo.GetDimension() == bar.GetDimension(); + \endcode + * + * In the above example it may seem pointlessly complicated, but the highlight + * is that it can be used in metaprogramming context (see for instance Sort + * implementation). + * + * + * \copydoc doxygen_hide_lhs_rhs_arg + * \return True of both lhs and rhs are equal considering \a UnaryT function. + */ + template + bool IsEqual(const T& lhs, const T& rhs); + + + + /*! + * \brief Helper function for SortingCriterion. + * + * See SortingCriterion documentation to understand what is the goal. + * + * \tparam T Type of the objects to sort. Operators < and == must be defined for this type. + * \tparam IndexT This index is going downward from the size of the tuple minus 1 to 0 (reason + * for this awful trick is that to end the recursion I can use 0 but not std::tuple_size::value). + * So SortHelper is first called with IndexT = Size - 1, which means in fact very first element + * of the tuple. Then with Size - 2, which means second element of tuple... and so forth! + */ + template + struct SortHelper + { + + //! Actual function (wrapped into a class for template specialization). + static bool Compare(const T& lhs, const T& rhs); + + + }; + + + // ============================ + //! \cond IGNORE_BLOCK_IN_DOXYGEN + // ============================ + + + //! Same as above, used to end the recursion. + template + struct SortHelper + { + + //! Actual function (wrapped into a class for template specialization). + static bool Compare(const T& lhs, const T& rhs); + + + }; + + + // ============================ + //! \endcond IGNORE_BLOCK_IN_DOXYGEN + // ============================ + + + + } // namespace SortNS + + + } // namespace Internal + + +} // namespace MoReFEM + + +/// @} // addtogroup UtilitiesGroup + + +# include "Utilities/Containers/Internal/Sort.hxx" + + +#endif // MOREFEM_x_UTILITIES_x_CONTAINERS_x_INTERNAL_x_SORT_HPP_ diff --git a/Sources/Utilities/Containers/Internal/Sort.hxx b/Sources/Utilities/Containers/Internal/Sort.hxx new file mode 100644 index 0000000000..b49300bd97 --- /dev/null +++ b/Sources/Utilities/Containers/Internal/Sort.hxx @@ -0,0 +1,87 @@ +/// +////// \file +/// +/// +/// Created by Sebastien Gilles on the Thu, 17 Jan 2013 10:43:51 +0100 +/// Copyright (c) Inria. All rights reserved. +/// +/// \ingroup UtilitiesGroup +/// \addtogroup UtilitiesGroup +/// \{ + +#ifndef MOREFEM_x_UTILITIES_x_CONTAINERS_x_INTERNAL_x_SORT_HXX_ +# define MOREFEM_x_UTILITIES_x_CONTAINERS_x_INTERNAL_x_SORT_HXX_ + + +# include +# include + + +namespace MoReFEM +{ + + + namespace Internal + { + + + namespace SortNS + { + + + template + bool IsEqual(const T& lhs, const T& rhs) + { + return UnaryT::Value(lhs) == UnaryT::Value(rhs); + } + + + template + bool SortHelper::Compare(const T& lhs, const T& rhs) + { + enum { size = std::tuple_size::value } ; + + using Criterion = typename std::tuple_element::type; + + if (!IsEqual(lhs, rhs)) + { + return typename Criterion::StrictOrderingOperator()(Criterion::Value(lhs), Criterion::Value(rhs)); + } + + return SortHelper::Compare(lhs, rhs); + } + + + template + bool SortHelper::Compare(const T& lhs, const T& rhs) + { + enum { size = std::tuple_size::value } ; + + using Criterion = typename std::tuple_element::type; + + if (!IsEqual(lhs, rhs)) + return typename Criterion::StrictOrderingOperator()(Criterion::Value(lhs), Criterion::Value(rhs)); + + // False is returned here as we consider the sorting criterion + // expects a strict ordering criterion: typically STL functions + // expect < and not <=. + // So when \a lhs and \a rhs are completely equal for all criteria, + // we do not want to return true (which would mean there is + // actually a difference in one of the sorting criterion). + return false; + } + + + } // namespace SortNS + + + } // namespace Internal + + +} // namespace MoReFEM + + +/// @} // addtogroup UtilitiesGroup + + +#endif // MOREFEM_x_UTILITIES_x_CONTAINERS_x_INTERNAL_x_SORT_HXX_ diff --git a/Sources/Utilities/Containers/Sort.hpp b/Sources/Utilities/Containers/Sort.hpp index 6e2ba799ed..d9149ed424 100644 --- a/Sources/Utilities/Containers/Sort.hpp +++ b/Sources/Utilities/Containers/Sort.hpp @@ -12,10 +12,11 @@ #ifndef MOREFEM_x_UTILITIES_x_CONTAINERS_x_SORT_HPP_ # define MOREFEM_x_UTILITIES_x_CONTAINERS_x_SORT_HPP_ - # include # include +# include "Utilities/Containers/Internal/Sort.hpp" + namespace MoReFEM { @@ -25,126 +26,6 @@ namespace MoReFEM { - namespace SortNS - { - - - namespace Impl - { - - - /*! - * \brief Compare whether two objects of same type are equal regarding one unary function. - * - * \tparam T Type of the objects involved. - * \tparam UnaryT Structure which is expected to define a static unary function named - * Value which sole parameter is a \a T object. - * Typically UnaryT will be a trick to get the results of a method of T object. - * For instance: - * \code - * struct Dimension - * { - * - * static int Value(const T& element) - * { - * return T.GetDimension(); - * } - * - * }; - * - * T foo, bar; - * - * bool are_equal = IsEqual(foo, bar); - * //< actually performs foo.GetDimension() == bar.GetDimension(); - * - * \endcode - * - * In the above example it may seem pointlessly complicated, but the highlight - * is that it can be used in metaprogramming context (see for instance Sort - * implementation). - * - * - * \copydoc doxygen_hide_lhs_rhs_arg - * \return True of both lhs and rhs are equal considering \a UnaryT function. - */ - template - bool IsEqual(const T& lhs, const T& rhs) - { - return UnaryT::Value(lhs) == UnaryT::Value(rhs); - } - - - - /*! - * \brief Helper function for SortingCriterion. - * - * See SortingCriterion documentation to understand what is the goal. - * - * \tparam T Type of the objects to sort. Operators < and == must be defined for this type. - * \tparam IndexT This index is going downward from the size of the tuple minus 1 to 0 (reason - * for this awful trick is that to end the recursion I can use 0 but not std::tuple_size::value). - * So SortHelper is first called with IndexT = Size - 1, which means in fact very first element - * of the tuple. Then with Size - 2, which means second element of tuple... and so forth! - - */ - template - struct SortHelper - { - - //! Actual function (wrapped into a class for template specialization). - static bool Compare(const T& lhs, const T& rhs) - { - enum { size = std::tuple_size::value } ; - - using Criterion = typename std::tuple_element::type; - - if (!IsEqual(lhs, rhs)) - { - return typename Criterion::StrictOrderingOperator()(Criterion::Value(lhs), Criterion::Value(rhs)); - } - - return SortHelper::Compare(lhs, rhs); - } - - - }; - - - //! Same as above, used to end the recursion. - template - struct SortHelper - { - - //! Actual function (wrapped into a class for template specialization). - static bool Compare(const T& lhs, const T& rhs) - { - enum { size = std::tuple_size::value } ; - - using Criterion = typename std::tuple_element::type; - - if (!IsEqual(lhs, rhs)) - return typename Criterion::StrictOrderingOperator()(Criterion::Value(lhs), Criterion::Value(rhs)); - - // False is returned here as we consider the sorting criterion - // expects a strict ordering criterion: typically STL functions - // expect < and not <=. - // So when \a lhs and \a rhs are completely equal for all criteria, - // we do not want to return true (which would mean there is - // actually a difference in one of the sorting criterion). - return false; - } - - - }; - - - } // namespace Impl - - - } // namespace SortNS - - - /*! * \brief Defines the ordering of two differents objects. * @@ -225,7 +106,7 @@ namespace MoReFEM enum { size = std::tuple_size::value } ; - return SortNS::Impl::SortHelper::Compare(lhs, rhs); + return ::MoReFEM::Internal::SortNS::SortHelper::Compare(lhs, rhs); } @@ -238,5 +119,4 @@ namespace MoReFEM /// @} // addtogroup UtilitiesGroup - #endif // MOREFEM_x_UTILITIES_x_CONTAINERS_x_SORT_HPP_ -- GitLab From fc6ba7fe78ccea99007f0d48a3bf87b3864ca50a Mon Sep 17 00:00:00 2001 From: Sebastien Gilles Date: Wed, 3 Jan 2018 22:20:14 +0100 Subject: [PATCH 07/11] #1211 Run FileHeader.py script. --- Sources/Core/InitTimeKeepLog.cpp | 7 ++++++- Sources/Parameters/Policy/AtDof/AtDof.hxx | 1 - .../RefineMeshQuadranglesSpectral/RefineMesh.cpp | 1 - Sources/ThirdParty/Wrappers/Petsc/Solver/Snes.cpp | 1 - 4 files changed, 6 insertions(+), 4 deletions(-) diff --git a/Sources/Core/InitTimeKeepLog.cpp b/Sources/Core/InitTimeKeepLog.cpp index b8d809cdbd..fef2eb134c 100644 --- a/Sources/Core/InitTimeKeepLog.cpp +++ b/Sources/Core/InitTimeKeepLog.cpp @@ -5,7 +5,9 @@ /// Created by Sebastien Gilles on the Wed, 7 Jan 2015 14:19:22 +0100 /// Copyright (c) Inria. All rights reserved. /// - +/// \ingroup CoreGroup +/// \addtogroup CoreGroup +/// \{ #include "InitTimeKeepLog.hpp" @@ -34,3 +36,6 @@ namespace MoReFEM } // namespace MoReFEM + + +/// @} // addtogroup CoreGroup diff --git a/Sources/Parameters/Policy/AtDof/AtDof.hxx b/Sources/Parameters/Policy/AtDof/AtDof.hxx index 72846af269..96ae8f02ca 100644 --- a/Sources/Parameters/Policy/AtDof/AtDof.hxx +++ b/Sources/Parameters/Policy/AtDof/AtDof.hxx @@ -9,7 +9,6 @@ /// \addtogroup ParametersGroup /// \{ - #ifndef MOREFEM_x_PARAMETERS_x_POLICY_x_AT_DOF_x_AT_DOF_HXX_ # define MOREFEM_x_PARAMETERS_x_POLICY_x_AT_DOF_x_AT_DOF_HXX_ diff --git a/Sources/PostProcessing/RefineMeshQuadranglesSpectral/RefineMesh.cpp b/Sources/PostProcessing/RefineMeshQuadranglesSpectral/RefineMesh.cpp index 246091f7aa..8f1d6fa31b 100644 --- a/Sources/PostProcessing/RefineMeshQuadranglesSpectral/RefineMesh.cpp +++ b/Sources/PostProcessing/RefineMeshQuadranglesSpectral/RefineMesh.cpp @@ -9,7 +9,6 @@ /// \addtogroup PostProcessingGroup /// \{ - #include #include diff --git a/Sources/ThirdParty/Wrappers/Petsc/Solver/Snes.cpp b/Sources/ThirdParty/Wrappers/Petsc/Solver/Snes.cpp index cc840704c0..516edadf1a 100644 --- a/Sources/ThirdParty/Wrappers/Petsc/Solver/Snes.cpp +++ b/Sources/ThirdParty/Wrappers/Petsc/Solver/Snes.cpp @@ -9,7 +9,6 @@ /// \addtogroup ThirdPartyGroup /// \{ - #include #include "ThirdParty/Wrappers/Petsc/Solver/Snes.hpp" -- GitLab From 4360a39364be77bcdb05d5fe0404d66df97a24ba Mon Sep 17 00:00:00 2001 From: Sebastien Gilles Date: Thu, 4 Jan 2018 20:53:33 +0100 Subject: [PATCH 08/11] #1211 Doxygen for Unknown: remove duplicate addtogroup that prevent smooth latex compilation (said compilation doesn't fully work yet). --- Sources/FiniteElement/Unknown/EnumUnknown.hpp | 11 ++--------- Sources/FiniteElement/Unknown/ExtendedUnknown.hpp | 11 +---------- Sources/FiniteElement/Unknown/Unknown.hpp | 9 +-------- Sources/FiniteElement/Unknown/UnknownManager.hpp | 7 ------- 4 files changed, 4 insertions(+), 34 deletions(-) diff --git a/Sources/FiniteElement/Unknown/EnumUnknown.hpp b/Sources/FiniteElement/Unknown/EnumUnknown.hpp index 129a9012a5..e2e33ab39b 100644 --- a/Sources/FiniteElement/Unknown/EnumUnknown.hpp +++ b/Sources/FiniteElement/Unknown/EnumUnknown.hpp @@ -20,11 +20,7 @@ namespace MoReFEM namespace UnknownNS { - - /// \addtogroup FiniteElementGroup - ///@{ - - + /*! * \brief Possible values for the nature of a given Unknown. */ @@ -34,10 +30,7 @@ namespace MoReFEM vectorial = 1 }; - - ///@} // \addtogroup - - + } // namespace UnknownNS diff --git a/Sources/FiniteElement/Unknown/ExtendedUnknown.hpp b/Sources/FiniteElement/Unknown/ExtendedUnknown.hpp index a5ec74999f..aa8e2ae346 100644 --- a/Sources/FiniteElement/Unknown/ExtendedUnknown.hpp +++ b/Sources/FiniteElement/Unknown/ExtendedUnknown.hpp @@ -19,12 +19,7 @@ namespace MoReFEM { - - /// \addtogroup FiniteElementGroup - ///@{ - - - + /*! * \brief This class encapsulates an unknown in a given finite element space. * @@ -108,10 +103,6 @@ namespace MoReFEM bool operator<(const ExtendedUnknown& lhs, const ExtendedUnknown& rhs); - - ///@} // \addtogroup - - } // namespace MoReFEM diff --git a/Sources/FiniteElement/Unknown/Unknown.hpp b/Sources/FiniteElement/Unknown/Unknown.hpp index e3fe604531..ec42738d0e 100644 --- a/Sources/FiniteElement/Unknown/Unknown.hpp +++ b/Sources/FiniteElement/Unknown/Unknown.hpp @@ -43,11 +43,7 @@ namespace MoReFEM //! \endcond IGNORE_BLOCK_IN_DOXYGEN // ============================ - - /// \addtogroup FiniteElementGroup - ///@{ - - + /*! * \brief Very generic informations about a given unknown. * @@ -143,9 +139,6 @@ namespace MoReFEM const unsigned int mesh_dimension); - ///@} // \addtogroup - - } // namespace MoReFEM diff --git a/Sources/FiniteElement/Unknown/UnknownManager.hpp b/Sources/FiniteElement/Unknown/UnknownManager.hpp index 887f894ab3..a29e1a35d7 100644 --- a/Sources/FiniteElement/Unknown/UnknownManager.hpp +++ b/Sources/FiniteElement/Unknown/UnknownManager.hpp @@ -30,10 +30,6 @@ namespace MoReFEM { - /// \addtogroup FiniteElementGroup - ///@{ - - /*! * \brief Singleton that is aware of all considered unknown, regardless of GodOfDof. * @@ -152,9 +148,6 @@ namespace MoReFEM void WriteUnknownList(const std::string& output_directory); - ///@} // \addtogroup - - } // namespace MoReFEM -- GitLab From 497e621fdbafa6ab9ea4df68ed58fdd3fa363483 Mon Sep 17 00:00:00 2001 From: Sebastien Gilles Date: Thu, 4 Jan 2018 21:02:06 +0100 Subject: [PATCH 09/11] #1211 Fix Doxygen documentation so that latex compilation works fine. The purpose is not to provide the LaTeX documentation per se: with the dot graphs the document is unwieldy and huge (almost 5000 pages at the time of this writing...) but to fix possible issues than were left unseen in the html documentation (for instance putting \code blocks in a param description is a bad idea that create a compilation issue with LaTeX). --- Documentation/Doxygen/morefem.dox | 23 ++++--------------- Sources/Core/MoReFEMData/MoReFEMData.hpp | 3 ++- .../Internal/FetchFunction.hpp | 8 +++++-- .../Internal/BasicRefFElt.hpp | 19 ++++++++------- .../Domain/Advanced/LightweightDomainList.hpp | 14 +++++------ .../GeometricElt/Advanced/ComputeJacobian.hpp | 4 ++-- .../Instances/Hexahedron/Hexahedron20.hpp | 2 +- .../Instances/Hexahedron/Hexahedron27.hpp | 2 +- .../Instances/Hexahedron/Hexahedron8.hpp | 2 +- .../Instances/Point/Point1.hpp | 2 +- .../Instances/Quadrangle/Quadrangle4.hpp | 2 +- .../Instances/Quadrangle/Quadrangle8.hpp | 2 +- .../Instances/Quadrangle/Quadrangle9.hpp | 2 +- .../Instances/Segment/Segment2.hpp | 2 +- .../Instances/Segment/Segment3.hpp | 2 +- .../Instances/Tetrahedron/Tetrahedron10.hpp | 2 +- .../Instances/Tetrahedron/Tetrahedron4.hpp | 2 +- .../Instances/Triangle/Triangle3.hpp | 2 +- .../Instances/Triangle/Triangle6.hpp | 2 +- .../CourtemancheRamirezNattel.hpp | 4 ++-- .../Internal/GlobalVariationalOperator.hpp | 4 +++- .../AtQuadraturePoint/AtQuadraturePoint.hpp | 1 + .../TimeDependency/TimeDependency.hpp | 2 +- .../Freefem/MatrixConversion.hpp | 9 ++++---- .../Petsc/Matrix/MatrixOperations.hpp | 8 +++---- .../Wrappers/Petsc/Vector/Vector.hpp | 8 +++---- Sources/ThirdParty/Wrappers/Petsc/Viewer.hpp | 19 +++++++++++---- 27 files changed, 80 insertions(+), 72 deletions(-) diff --git a/Documentation/Doxygen/morefem.dox b/Documentation/Doxygen/morefem.dox index af314baeec..412c03313a 100644 --- a/Documentation/Doxygen/morefem.dox +++ b/Documentation/Doxygen/morefem.dox @@ -766,20 +766,7 @@ WARN_LOGFILE = "warnings.txt" # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING # Note: If this tag is empty the current directory is searched. -INPUT = ../../Sources/Utilities \ - ../../Sources/ThirdParty \ - ../../Sources/Core \ - ../../Sources/Geometry \ - ../../Sources/FiniteElement \ - ../../Sources/Parameters \ - ../../Sources/Operators \ - ../../Sources/ParameterInstances \ - ../../Sources/OperatorInstances \ - ../../Sources/FormulationSolver \ - ../../Sources/Model \ - ../../Sources/PostProcessing \ - ../../Sources/Test \ - ../../Sources/ModelInstances \ +INPUT = ../../Sources \ ../../README.md # This tag can be used to specify the character encoding of the source files @@ -1533,7 +1520,7 @@ SEARCHENGINE = YES # The default value is: NO. # This tag requires that the tag SEARCHENGINE is set to YES. -SERVER_BASED_SEARCH = NO +SERVER_BASED_SEARCH = YES # When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP # script for searching. Instead the search results are written to an XML file @@ -1560,7 +1547,7 @@ EXTERNAL_SEARCH = NO # Searching" for details. # This tag requires that the tag SEARCHENGINE is set to YES. -SEARCHENGINE_URL = +SEARCHENGINE_URL = doxysearch # When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed # search data is written to a file for indexing by an external tool. With the @@ -1576,7 +1563,7 @@ SEARCHDATA_FILE = searchdata.xml # projects and redirect the results back to the right project. # This tag requires that the tag SEARCHENGINE is set to YES. -EXTERNAL_SEARCH_ID = +EXTERNAL_SEARCH_ID = MoReFEM # The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen # projects other than the one defined by this configuration file, but that are @@ -1595,7 +1582,7 @@ EXTRA_SEARCH_MAPPINGS = # If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output. # The default value is: YES. -GENERATE_LATEX = NO +GENERATE_LATEX = YES # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of diff --git a/Sources/Core/MoReFEMData/MoReFEMData.hpp b/Sources/Core/MoReFEMData/MoReFEMData.hpp index e3301f2d8b..180d36dd27 100644 --- a/Sources/Core/MoReFEMData/MoReFEMData.hpp +++ b/Sources/Core/MoReFEMData/MoReFEMData.hpp @@ -44,7 +44,8 @@ namespace MoReFEM * 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 - * prototype + * prototype: + * * \code * static void AdditionalCommandLineArgumentsT::Add(TCLAP::CmdLine& command); * \endcode diff --git a/Sources/Core/NumberingSubset/Internal/FetchFunction.hpp b/Sources/Core/NumberingSubset/Internal/FetchFunction.hpp index 2b397d1d1b..03b95abe5a 100644 --- a/Sources/Core/NumberingSubset/Internal/FetchFunction.hpp +++ b/Sources/Core/NumberingSubset/Internal/FetchFunction.hpp @@ -49,7 +49,8 @@ namespace MoReFEM /*! * \brief Returns the requested numbering subset from \a object when T is a pointer or smart pointer. * - * \param[in] pointer Pointer or pointer-like to an object that must define a method with prototype + * \param[in] pointer Pointer or pointer-like to an object that must define a method with prototype: + * * \code * const NumberingSubset& GetNumberingSubset() const; * \endcode @@ -70,7 +71,8 @@ namespace MoReFEM * \brief Returns the requested numbering subset from \a object when T is not a pointer or smart * pointer. * - * \param[in] object Object that must define a method with prototype + * \param[in] object Object that must define a method with prototype: + * * \code * const NumberingSubset& GetNumberingSubset() const; * \endcode @@ -92,6 +94,7 @@ namespace MoReFEM * * \param[in] pointer Pointer or pointer-like to an object that must define methods with following * prototypes: + * * \code * const NumberingSubset& GetRowNumberingSubset() const; * const NumberingSubset& GetColNumberingSubset() const; @@ -114,6 +117,7 @@ namespace MoReFEM * pointer. * * \param[in] object Object that must define methods with following prototypes: + * * \code * const NumberingSubset& GetRowNumberingSubset() const; * const NumberingSubset& GetColNumberingSubset() const; diff --git a/Sources/FiniteElement/RefFiniteElement/Internal/BasicRefFElt.hpp b/Sources/FiniteElement/RefFiniteElement/Internal/BasicRefFElt.hpp index 63b56f2d55..39973373af 100644 --- a/Sources/FiniteElement/RefFiniteElement/Internal/BasicRefFElt.hpp +++ b/Sources/FiniteElement/RefFiniteElement/Internal/BasicRefFElt.hpp @@ -195,14 +195,17 @@ namespace MoReFEM * finite element associated to a quadrangle: * \param[in] orientation Index which gives away the orientation chosen. See \a OrientedEdge for more * details. - * - * 3-----------2 - * | | - * | | Edges: { { 0, 1 } }, - * | | { { 1, 2 } }, - * | | { { 3, 2 } }, - * | | { { 0, 3 } } - * 0-----------1 + + \verbatim + + 3-----------2 + | | + | | Edges: { { 0, 1 } }, + | | { { 1, 2 } }, + | | { { 3, 2 } }, + | | { { 0, 3 } } + 0-----------1 + \endverbatim * * \return The LocalNode objects associated to this edge (its internal index is the one computed * within current class). diff --git a/Sources/Geometry/Domain/Advanced/LightweightDomainList.hpp b/Sources/Geometry/Domain/Advanced/LightweightDomainList.hpp index b2338434e5..fca723e9ce 100644 --- a/Sources/Geometry/Domain/Advanced/LightweightDomainList.hpp +++ b/Sources/Geometry/Domain/Advanced/LightweightDomainList.hpp @@ -116,13 +116,13 @@ namespace MoReFEM * Let's illustrate this by an example: * * \verbatim - * LightweightDomainList1 = { - * - * mesh_label_list = { 0, 1, 1, 2, 3, 2, 3 }, - * domain_index_list = { 3, 4, 5, 6 }, - * number_in_domain_list = { 2, 3, 1, 1 } - * } -- LightweightDomainList1 - * \endverbatim + LightweightDomainList1 = { + + mesh_label_list = { 0, 1, 1, 2, 3, 2, 3 }, + domain_index_list = { 3, 4, 5, 6 }, + number_in_domain_list = { 2, 3, 1, 1 } + } -- LightweightDomainList1 + \endverbatim * * Means that: * - Domain 3 is composed of \a MeshLabel 0 and 1. diff --git a/Sources/Geometry/GeometricElt/Advanced/ComputeJacobian.hpp b/Sources/Geometry/GeometricElt/Advanced/ComputeJacobian.hpp index ee86835482..12a087bf3a 100644 --- a/Sources/Geometry/GeometricElt/Advanced/ComputeJacobian.hpp +++ b/Sources/Geometry/GeometricElt/Advanced/ComputeJacobian.hpp @@ -121,8 +121,8 @@ namespace MoReFEM LocalMatrix& GetNonCstJacobian() noexcept; /*! - * \brief Non constant accessor to the values of the first derivates of the shape function, updated - * along  jacobian_. + * \brief Non constant accessor to the values of the first derivates of the shape function, + * updated along \a jacobian_. * * Likewise, it should not be accessed publicly. * diff --git a/Sources/Geometry/RefGeometricElt/Instances/Hexahedron/Hexahedron20.hpp b/Sources/Geometry/RefGeometricElt/Instances/Hexahedron/Hexahedron20.hpp index c4ddc5608a..e404fa6634 100644 --- a/Sources/Geometry/RefGeometricElt/Instances/Hexahedron/Hexahedron20.hpp +++ b/Sources/Geometry/RefGeometricElt/Instances/Hexahedron/Hexahedron20.hpp @@ -44,7 +44,7 @@ namespace MoReFEM * \endcode * * or to be a template parameter to MoReFEM::RefGeomEltNS::Hexahedron20 class (current class is in an - * additional layer of namespace: + * additional layer of namespace): * * \code * MoReFEM::RefGeomEltNS::Traits::Hexahedron20 diff --git a/Sources/Geometry/RefGeometricElt/Instances/Hexahedron/Hexahedron27.hpp b/Sources/Geometry/RefGeometricElt/Instances/Hexahedron/Hexahedron27.hpp index fac851951e..4962dc6428 100644 --- a/Sources/Geometry/RefGeometricElt/Instances/Hexahedron/Hexahedron27.hpp +++ b/Sources/Geometry/RefGeometricElt/Instances/Hexahedron/Hexahedron27.hpp @@ -48,7 +48,7 @@ namespace MoReFEM * \endcode * * or to be a template parameter to MoReFEM::RefGeomEltNS::Hexahedron27 class (current class is in an - * additional layer of namespace: + * additional layer of namespace): * * \code * MoReFEM::RefGeomEltNS::Traits::Hexahedron27 diff --git a/Sources/Geometry/RefGeometricElt/Instances/Hexahedron/Hexahedron8.hpp b/Sources/Geometry/RefGeometricElt/Instances/Hexahedron/Hexahedron8.hpp index 52b812f59e..c7ba6583ee 100644 --- a/Sources/Geometry/RefGeometricElt/Instances/Hexahedron/Hexahedron8.hpp +++ b/Sources/Geometry/RefGeometricElt/Instances/Hexahedron/Hexahedron8.hpp @@ -44,7 +44,7 @@ namespace MoReFEM * \endcode * * or to be a template parameter to MoReFEM::RefGeomEltNS::Hexahedron8 class (current class is in an - * additional layer of namespace: + * additional layer of namespace): * * \code * MoReFEM::RefGeomEltNS::Traits::Hexahedron8 diff --git a/Sources/Geometry/RefGeometricElt/Instances/Point/Point1.hpp b/Sources/Geometry/RefGeometricElt/Instances/Point/Point1.hpp index 378d082832..b4f7ebec98 100644 --- a/Sources/Geometry/RefGeometricElt/Instances/Point/Point1.hpp +++ b/Sources/Geometry/RefGeometricElt/Instances/Point/Point1.hpp @@ -45,7 +45,7 @@ namespace MoReFEM * \endcode * * or to be a template parameter to MoReFEM::RefGeomEltNS::Point1 class (current class is in an - * additional layer of namespace: + * additional layer of namespace): * * \code * MoReFEM::RefGeomEltNS::Traits::Point1 diff --git a/Sources/Geometry/RefGeometricElt/Instances/Quadrangle/Quadrangle4.hpp b/Sources/Geometry/RefGeometricElt/Instances/Quadrangle/Quadrangle4.hpp index b03d808435..a02926f964 100644 --- a/Sources/Geometry/RefGeometricElt/Instances/Quadrangle/Quadrangle4.hpp +++ b/Sources/Geometry/RefGeometricElt/Instances/Quadrangle/Quadrangle4.hpp @@ -45,7 +45,7 @@ namespace MoReFEM * \endcode * * or to be a template parameter to MoReFEM::RefGeomEltNS::Quadrangle4 class (current class is in an - * additional layer of namespace: + * additional layer of namespace): * * \code * MoReFEM::RefGeomEltNS::Traits::Quadrangle4 diff --git a/Sources/Geometry/RefGeometricElt/Instances/Quadrangle/Quadrangle8.hpp b/Sources/Geometry/RefGeometricElt/Instances/Quadrangle/Quadrangle8.hpp index dac9242a40..333712a7c5 100644 --- a/Sources/Geometry/RefGeometricElt/Instances/Quadrangle/Quadrangle8.hpp +++ b/Sources/Geometry/RefGeometricElt/Instances/Quadrangle/Quadrangle8.hpp @@ -45,7 +45,7 @@ namespace MoReFEM * \endcode * * or to be a template parameter to MoReFEM::RefGeomEltNS::Quadrangle8 class (current class is in an - * additional layer of namespace: + * additional layer of namespace): * * \code * MoReFEM::RefGeomEltNS::Traits::Quadrangle8 diff --git a/Sources/Geometry/RefGeometricElt/Instances/Quadrangle/Quadrangle9.hpp b/Sources/Geometry/RefGeometricElt/Instances/Quadrangle/Quadrangle9.hpp index 1fb580ce77..0fcf7e8956 100644 --- a/Sources/Geometry/RefGeometricElt/Instances/Quadrangle/Quadrangle9.hpp +++ b/Sources/Geometry/RefGeometricElt/Instances/Quadrangle/Quadrangle9.hpp @@ -44,7 +44,7 @@ namespace MoReFEM * \endcode * * or to be a template parameter to MoReFEM::RefGeomEltNS::Quadrangle9 class (current class is in an - * additional layer of namespace: + * additional layer of namespace): * * \code * MoReFEM::RefGeomEltNS::Traits::Quadrangle9 diff --git a/Sources/Geometry/RefGeometricElt/Instances/Segment/Segment2.hpp b/Sources/Geometry/RefGeometricElt/Instances/Segment/Segment2.hpp index b729fba5a3..ddb81b0118 100644 --- a/Sources/Geometry/RefGeometricElt/Instances/Segment/Segment2.hpp +++ b/Sources/Geometry/RefGeometricElt/Instances/Segment/Segment2.hpp @@ -47,7 +47,7 @@ namespace MoReFEM * \endcode * * or to be a template parameter to MoReFEM::RefGeomEltNS::Segment2 class (current class is in an - * additional layer of namespace: + * additional layer of namespace): * * \code * MoReFEM::RefGeomEltNS::Traits::Segment2 diff --git a/Sources/Geometry/RefGeometricElt/Instances/Segment/Segment3.hpp b/Sources/Geometry/RefGeometricElt/Instances/Segment/Segment3.hpp index 7130c7f93c..2e1d637e2d 100644 --- a/Sources/Geometry/RefGeometricElt/Instances/Segment/Segment3.hpp +++ b/Sources/Geometry/RefGeometricElt/Instances/Segment/Segment3.hpp @@ -45,7 +45,7 @@ namespace MoReFEM * \endcode * * or to be a template parameter to MoReFEM::RefGeomEltNS::Segment3 class (current class is in an - * additional layer of namespace: + * additional layer of namespace): * * \code * MoReFEM::RefGeomEltNS::Traits::Segment3 diff --git a/Sources/Geometry/RefGeometricElt/Instances/Tetrahedron/Tetrahedron10.hpp b/Sources/Geometry/RefGeometricElt/Instances/Tetrahedron/Tetrahedron10.hpp index d2a9456f9a..e941514dcf 100644 --- a/Sources/Geometry/RefGeometricElt/Instances/Tetrahedron/Tetrahedron10.hpp +++ b/Sources/Geometry/RefGeometricElt/Instances/Tetrahedron/Tetrahedron10.hpp @@ -47,7 +47,7 @@ namespace MoReFEM * \endcode * * or to be a template parameter to MoReFEM::RefGeomEltNS::Tetrahedron10 class (current class is in an - * additional layer of namespace: + * additional layer of namespace): * * \code * MoReFEM::RefGeomEltNS::Traits::Tetrahedron10 diff --git a/Sources/Geometry/RefGeometricElt/Instances/Tetrahedron/Tetrahedron4.hpp b/Sources/Geometry/RefGeometricElt/Instances/Tetrahedron/Tetrahedron4.hpp index 3b8764a2c6..9d166ec080 100644 --- a/Sources/Geometry/RefGeometricElt/Instances/Tetrahedron/Tetrahedron4.hpp +++ b/Sources/Geometry/RefGeometricElt/Instances/Tetrahedron/Tetrahedron4.hpp @@ -44,7 +44,7 @@ namespace MoReFEM * \endcode * * or to be a template parameter to MoReFEM::RefGeomEltNS::Tetrahedron4 class (current class is in an - * additional layer of namespace: + * additional layer of namespace): * * \code * MoReFEM::RefGeomEltNS::Traits::Tetrahedron4 diff --git a/Sources/Geometry/RefGeometricElt/Instances/Triangle/Triangle3.hpp b/Sources/Geometry/RefGeometricElt/Instances/Triangle/Triangle3.hpp index b416806a1a..13212a530e 100644 --- a/Sources/Geometry/RefGeometricElt/Instances/Triangle/Triangle3.hpp +++ b/Sources/Geometry/RefGeometricElt/Instances/Triangle/Triangle3.hpp @@ -46,7 +46,7 @@ namespace MoReFEM * \endcode * * or to be a template parameter to MoReFEM::RefGeomEltNS::Triangle3 class (current class is in an - * additional layer of namespace: + * additional layer of namespace): * * \code * MoReFEM::RefGeomEltNS::Traits::Triangle3 diff --git a/Sources/Geometry/RefGeometricElt/Instances/Triangle/Triangle6.hpp b/Sources/Geometry/RefGeometricElt/Instances/Triangle/Triangle6.hpp index 11513bdb39..fee28e9c94 100644 --- a/Sources/Geometry/RefGeometricElt/Instances/Triangle/Triangle6.hpp +++ b/Sources/Geometry/RefGeometricElt/Instances/Triangle/Triangle6.hpp @@ -44,7 +44,7 @@ namespace MoReFEM * \endcode * * or to be a template parameter to MoReFEM::RefGeomEltNS::Triangle6 class (current class is in an - * additional layer of namespace: + * additional layer of namespace): * * \code * MoReFEM::RefGeomEltNS::Traits::Triangle6 diff --git a/Sources/OperatorInstances/VariationalOperator/LinearForm/Local/NonLinearSource/ReactionLaw/Instantiations/CourtemancheRamirezNattel.hpp b/Sources/OperatorInstances/VariationalOperator/LinearForm/Local/NonLinearSource/ReactionLaw/Instantiations/CourtemancheRamirezNattel.hpp index 5dc223ce32..47557603ee 100644 --- a/Sources/OperatorInstances/VariationalOperator/LinearForm/Local/NonLinearSource/ReactionLaw/Instantiations/CourtemancheRamirezNattel.hpp +++ b/Sources/OperatorInstances/VariationalOperator/LinearForm/Local/NonLinearSource/ReactionLaw/Instantiations/CourtemancheRamirezNattel.hpp @@ -204,7 +204,7 @@ namespace MoReFEM * \param[in] index Index of the sought \a Parameter. To make the code more readable, use the enum class: * \code * decltype(auto) nsr_param = GetNonCstParameter(EnumUnderlyingType(parameter_index::nsr)); - * \endcode + \endcode * * \return Reference to the required \a Parameter. */ @@ -217,7 +217,7 @@ namespace MoReFEM * \param[in] index Index of the sought \a Parameter. To make the code more readable, use the enum class: * \code * decltype(auto) nsr_param = GetParameter(EnumUnderlyingType(parameter_index::nsr)); - * \endcode + \endcode * * \return Constant reference to the required \a Parameter. */ diff --git a/Sources/Operators/GlobalVariationalOperator/Internal/GlobalVariationalOperator.hpp b/Sources/Operators/GlobalVariationalOperator/Internal/GlobalVariationalOperator.hpp index 01d53eab13..145af118bf 100644 --- a/Sources/Operators/GlobalVariationalOperator/Internal/GlobalVariationalOperator.hpp +++ b/Sources/Operators/GlobalVariationalOperator/Internal/GlobalVariationalOperator.hpp @@ -212,7 +212,9 @@ namespace MoReFEM * * \copydoc doxygen_hide_operator_do_allocate_gradient_felt_phi_arg * \param[in] args Variadic arguments that will be perfect-forwarded to the constructor of each - * LocalVariationalOperator. For instance Force needs the definition of the force applied, so its prototype will be: + * LocalVariationalOperator. For instance Force needs the definition of the force applied, so its + * prototype will be: + * * \code * Force(const InputParameterDataT& input_parameter_data, * const FEltSpace& felt_space, diff --git a/Sources/Parameters/Policy/AtQuadraturePoint/AtQuadraturePoint.hpp b/Sources/Parameters/Policy/AtQuadraturePoint/AtQuadraturePoint.hpp index 73f93f90c3..018ffe8eba 100644 --- a/Sources/Parameters/Policy/AtQuadraturePoint/AtQuadraturePoint.hpp +++ b/Sources/Parameters/Policy/AtQuadraturePoint/AtQuadraturePoint.hpp @@ -170,6 +170,7 @@ namespace MoReFEM * * * \tparam UpdateFunctorT The expected prototype of the update_functor functor is: + * * \code * [](storage_value_type& value_to_modify) -> void * \endcode diff --git a/Sources/Parameters/TimeDependency/TimeDependency.hpp b/Sources/Parameters/TimeDependency/TimeDependency.hpp index e5770458e8..fc4682eb14 100644 --- a/Sources/Parameters/TimeDependency/TimeDependency.hpp +++ b/Sources/Parameters/TimeDependency/TimeDependency.hpp @@ -180,7 +180,7 @@ namespace MoReFEM /// \name Accessors ///@{ - //! Constant accessor to the value of TimeManager::NtimesModified() at the last Update() call. + //! Constant accessor to the value of \a TimeManager::NtimesModified() at the last \a Update() call. unsigned int GetNtimesModifiedAtLastUpdate() const noexcept; ///@} diff --git a/Sources/PostProcessing/ConvertLinearAlgebra/Freefem/MatrixConversion.hpp b/Sources/PostProcessing/ConvertLinearAlgebra/Freefem/MatrixConversion.hpp index 820cd48d44..9c204f2d12 100644 --- a/Sources/PostProcessing/ConvertLinearAlgebra/Freefem/MatrixConversion.hpp +++ b/Sources/PostProcessing/ConvertLinearAlgebra/Freefem/MatrixConversion.hpp @@ -97,12 +97,13 @@ namespace MoReFEM * through Matrix::ViewBinary() method. * \param[in] freefem_numbering_informations_file Freefem proceeds to an ad hoc renumbering * for shape functions other than P1; we need this information to map MoReFEM dofs to Freefem's. + * * So we just need a file which gives the following information: * \verbatim - * 10 14 9 12 - * 10 9 6 5 - * ... - * \endverbatim + 10 14 9 12 + 10 9 6 5 + ... + \endverbatim * where each line provide the list of dofs for the geometric element that share the line number * Dofs on vertex come first, then on edges, then on faces. * See #936 discussion for more details (and for the informations from Freefem's author). diff --git a/Sources/ThirdParty/Wrappers/Petsc/Matrix/MatrixOperations.hpp b/Sources/ThirdParty/Wrappers/Petsc/Matrix/MatrixOperations.hpp index a4f9c4ffe0..3419ada434 100644 --- a/Sources/ThirdParty/Wrappers/Petsc/Matrix/MatrixOperations.hpp +++ b/Sources/ThirdParty/Wrappers/Petsc/Matrix/MatrixOperations.hpp @@ -345,7 +345,7 @@ namespace MoReFEM * * Formula is: * \verbatim - * m3 = m1^T * m2. + m3 = m1^T * m2. * \endverbatim * * \copydetails doxygen_hide_matmatmult_warning @@ -421,9 +421,9 @@ namespace MoReFEM * * \warning Unfortunately a simple test with P = I leads to error * \verbatim - * [0]PETSC ERROR: Nonconforming object sizes - * [0]PETSC ERROR: Expected fill=-2 must be >= 1.0 - * \endverbatim + [0;39m[0;49m[0]PETSC ERROR: Nonconforming object sizes + [0]PETSC ERROR: Expected fill=-2 must be >= 1.0 + \endverbatim * The reason is that PETSC_DEFAULT may not be supported (I've asked Petsc developers); but even with * hand-tailored fill it doesn't seem to work... * So unfortunately I have to advise instead MatMatMult followed by MatTransposeMatMult instead... diff --git a/Sources/ThirdParty/Wrappers/Petsc/Vector/Vector.hpp b/Sources/ThirdParty/Wrappers/Petsc/Vector/Vector.hpp index b46d003e57..0ffad3dbb1 100644 --- a/Sources/ThirdParty/Wrappers/Petsc/Vector/Vector.hpp +++ b/Sources/ThirdParty/Wrappers/Petsc/Vector/Vector.hpp @@ -745,10 +745,10 @@ namespace MoReFEM * * \attention Petsc man page mentions performance issues with this one. * \verbatim - * per-processor memory bandwidth - * interprocessor latency - * work load inbalance that causes certain processes to arrive much earlier than others - * \endverbatim + per-processor memory bandwidth + interprocessor latency + work load inbalance that causes certain processes to arrive much earlier than others + \endverbatim * * \note This function may work for parallel vectors; no need to reduce the result obtained on each process * (on the contrary you would compute number of proc * dot_product...). diff --git a/Sources/ThirdParty/Wrappers/Petsc/Viewer.hpp b/Sources/ThirdParty/Wrappers/Petsc/Viewer.hpp index e10a52a981..30e74c6215 100644 --- a/Sources/ThirdParty/Wrappers/Petsc/Viewer.hpp +++ b/Sources/ThirdParty/Wrappers/Petsc/Viewer.hpp @@ -25,8 +25,20 @@ namespace MoReFEM namespace Wrappers { - // Forward declaration. + + // ============================ + //! \cond IGNORE_BLOCK_IN_DOXYGEN + // Forward declarations. + // ============================ + + class Mpi; + + + // ============================ + // End of forward declarations. + //! \endcond IGNORE_BLOCK_IN_DOXYGEN + // ============================ namespace Petsc @@ -61,7 +73,7 @@ namespace MoReFEM /*! * \class doxygen_hide_petsc_file_mode * - * \param[in] file_mode From http://www.mcs.anl.gov/petsc/petsc-current/docs/manualpages/Viewer/PetscViewerBinaryOpen.html#PetscViewerBinaryOpen : + * \param[in] file_mode Same modes as in Petsc documentation, i.e.: * - FILE_MODE_WRITE - create new file for binary output. * - FILE_MODE_READ - open existing file for binary input. * - FILE_MODE_APPEND - open existing file for binary output. @@ -112,8 +124,6 @@ namespace MoReFEM }; - - } // namespace Petsc @@ -126,5 +136,4 @@ namespace MoReFEM /// @} // addtogroup ThirdPartyGroup - #endif // MOREFEM_x_THIRD_PARTY_x_WRAPPERS_x_PETSC_x_VIEWER_HPP_ -- GitLab From f5138f1a261857e25604a62c5a60680f0ea58442 Mon Sep 17 00:00:00 2001 From: Sebastien Gilles Date: Wed, 10 Jan 2018 17:56:15 +0100 Subject: [PATCH 10/11] #1211 Fix Doxygen warnings in ModelInstances. --- MoReFEM.xcodeproj/project.pbxproj | 2 ++ .../Internal/FetchFunction.hpp | 4 +-- .../VariationalFormulation.doxygen | 1 + .../Mesh/Internal/Format/Format.doxygen | 4 +-- .../Elasticity/ElasticityModel.hpp | 1 + .../VariationalFormulationElasticity.hpp | 23 +++++++++++-- .../Heat/HeatVariationalFormulation.hpp | 5 ++- .../Heat/InputParameterList.hpp | 2 ++ .../ModelInstances/Hyperelasticity/Model.hpp | 4 +-- .../VariationalFormulation.hpp | 30 +++++++++++++---- Sources/ModelInstances/Laplacian/Model.hpp | 2 +- .../Laplacian/VariationalFormulation.hpp | 33 ------------------- Sources/ModelInstances/ModelInstances.doxygen | 14 ++++++++ Sources/ModelInstances/RivlinCube/Model.hpp | 3 +- .../RivlinCube/VariationalFormulation.hpp | 26 ++++++++++++--- Sources/ModelInstances/Stokes/Model.hpp | 1 + .../Stokes/VariationalFormulation.hpp | 7 ++++ .../Advanced/SourceOrTargetData.hpp | 2 +- .../Test/Ondomatic/VariationalFormulation.hpp | 4 +-- Sources/Utilities/Containers/BoolArray.hpp | 2 +- .../Storage/Local/LocalVectorStorage.hpp | 2 +- .../___FILEBASENAME___.hpp | 1 + 22 files changed, 113 insertions(+), 60 deletions(-) create mode 100644 Sources/ModelInstances/ModelInstances.doxygen diff --git a/MoReFEM.xcodeproj/project.pbxproj b/MoReFEM.xcodeproj/project.pbxproj index 8636288940..ef2a24d2de 100644 --- a/MoReFEM.xcodeproj/project.pbxproj +++ b/MoReFEM.xcodeproj/project.pbxproj @@ -4536,6 +4536,7 @@ BE168F071CC97F120090AC88 /* Triangle6.cpp */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.cpp; lineEnding = 0; path = Triangle6.cpp; sourceTree = ""; xcLanguageSpecificationIdentifier = xcode.lang.cpp; }; BE168F081CC97F120090AC88 /* Triangle6.hpp */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.h; path = Triangle6.hpp; sourceTree = ""; }; BE1798131E316640004326D2 /* Traits.hpp */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.h; path = Traits.hpp; sourceTree = ""; }; + BE18EB0C2003A21E002FEC2C /* ModelInstances.doxygen */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text; path = ModelInstances.doxygen; sourceTree = ""; }; BE19AB511A37354100EAF725 /* SegmentP1.cpp */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.cpp; path = SegmentP1.cpp; sourceTree = ""; }; BE19AB521A37354100EAF725 /* SegmentP1.hpp */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.h; path = SegmentP1.hpp; sourceTree = ""; }; BE1ABAB71B9DC6FC00A7DBD8 /* TestInterpolatorP1_to_P2 */ = {isa = PBXFileReference; explicitFileType = "compiled.mach-o.executable"; includeInIndex = 0; path = TestInterpolatorP1_to_P2; sourceTree = BUILT_PRODUCTS_DIR; }; @@ -10521,6 +10522,7 @@ BEA0753A186052FB00E83E71 /* ModelInstances */ = { isa = PBXGroup; children = ( + BE18EB0C2003A21E002FEC2C /* ModelInstances.doxygen */, BE5BE50A19336DF6006BE2BF /* SConscript */, BE5ECE1219AC852E00C636A7 /* Stokes */, BE63B4911A31C20E003A6523 /* Elasticity */, diff --git a/Sources/Core/NumberingSubset/Internal/FetchFunction.hpp b/Sources/Core/NumberingSubset/Internal/FetchFunction.hpp index 03b95abe5a..4ecece1be1 100644 --- a/Sources/Core/NumberingSubset/Internal/FetchFunction.hpp +++ b/Sources/Core/NumberingSubset/Internal/FetchFunction.hpp @@ -55,7 +55,7 @@ namespace MoReFEM * const NumberingSubset& GetNumberingSubset() const; * \endcode * - * \return Reference returned by pointer->GetNUmberingSubset(). + * \return Reference returned by pointer->GetNumberingSubset(). */ template std::enable_if_t @@ -77,7 +77,7 @@ namespace MoReFEM * const NumberingSubset& GetNumberingSubset() const; * \endcode * - * \return Object returned by object.GetNUmberingSubset(). + * \return Object returned by object.GetNumberingSubset(). */ template std::enable_if_t diff --git a/Sources/FormulationSolver/VariationalFormulation.doxygen b/Sources/FormulationSolver/VariationalFormulation.doxygen index 861af49bce..473ae32e8c 100644 --- a/Sources/FormulationSolver/VariationalFormulation.doxygen +++ b/Sources/FormulationSolver/VariationalFormulation.doxygen @@ -44,3 +44,4 @@ + diff --git a/Sources/Geometry/Mesh/Internal/Format/Format.doxygen b/Sources/Geometry/Mesh/Internal/Format/Format.doxygen index da3c78935a..548041a50b 100644 --- a/Sources/Geometry/Mesh/Internal/Format/Format.doxygen +++ b/Sources/Geometry/Mesh/Internal/Format/Format.doxygen @@ -7,7 +7,7 @@ * there only because a reference to the mnesh is required to build a \a MeshLabel. * \param[in] file Path to the file being read. * \copydoc doxygen_hide_space_unit_arg - * \param[out] dimension NUmber of components considered in the Coords objects. It is format_dependant: Ensight + * \param[out] dimension Number of components considered in the Coords objects. It is format_dependant: Ensight * always returns 3 regarless of rthe mesh considered whereas Medit may return 2 or 3. * \param[out] unsort_element_list List of geometric elements read in the file. No specific order is expected here; * \a GeometricMeshRegion will anyway reorder them for its own needs. @@ -44,4 +44,4 @@ * \internal [internal] The parent true_type is extremely important: the operator bool() * it defines is used within TGeometricElt to check whether the GeometricElt can be manipulated by * Medit or not. - */ \ No newline at end of file + */ diff --git a/Sources/ModelInstances/Elasticity/ElasticityModel.hpp b/Sources/ModelInstances/Elasticity/ElasticityModel.hpp index 58a8d719c7..46accf6070 100644 --- a/Sources/ModelInstances/Elasticity/ElasticityModel.hpp +++ b/Sources/ModelInstances/Elasticity/ElasticityModel.hpp @@ -25,6 +25,7 @@ namespace MoReFEM { + //! \copydoc doxygen_hide_simple_model class ElasticityModel final : public Model { diff --git a/Sources/ModelInstances/Elasticity/VariationalFormulationElasticity.hpp b/Sources/ModelInstances/Elasticity/VariationalFormulationElasticity.hpp index 11410a51e6..bdf053e209 100644 --- a/Sources/ModelInstances/Elasticity/VariationalFormulationElasticity.hpp +++ b/Sources/ModelInstances/Elasticity/VariationalFormulationElasticity.hpp @@ -35,6 +35,7 @@ namespace MoReFEM { + //! \copydoc doxygen_hide_simple_varf class VariationalFormulationElasticity final : public VariationalFormulation < @@ -53,8 +54,10 @@ namespace MoReFEM private: + //! Alias to self. using self = VariationalFormulationElasticity; + //! Alias to parent class. using parent = VariationalFormulation; //! Friendship to parent class, so this one can access private methods defined below through CRTP. @@ -65,7 +68,7 @@ namespace MoReFEM //! Alias to unique pointer. using unique_ptr = std::unique_ptr; - + //! Alias to the appropriate \a ScalarParameter used to describe the solid. using solid_scalar_parameter = ScalarParameter; //! Alias on a pair of Unknown. @@ -125,9 +128,11 @@ namespace MoReFEM void UpdateDisplacementAndVelocity(); /*! - * \brief Get the only numbering subset relevant for this VariationalFormulation + * \brief Get the only numbering subset relevant for this VariationalFormulation. * * There is a more generic accessor in the base class but is use is more unwieldy. + * + * \return The only \a NumberingSubset present in this \a VariationalFormulation. */ const NumberingSubset& GetNumberingSubset() const noexcept; @@ -173,6 +178,8 @@ namespace MoReFEM * \brief Specific initialisation for derived class attributes. * * \internal [internal] This method is called by base class method VariationalFormulation::Init(). + * + * \copydoc doxygen_hide_input_parameter_data_arg */ void SupplInit(const InputParameterList& input_parameter_data); @@ -206,30 +213,42 @@ namespace MoReFEM /// \name Accessors to vectors and matrices specific to the elastic problem. ///@{ + //! Accessor to the \a GlobalVector which contains current displacement. const GlobalVector& GetVectorCurrentDisplacement() const noexcept; + //! Non constant accessor to the \a GlobalVector which contains current displacement. GlobalVector& GetNonCstVectorCurrentDisplacement() noexcept; + //! Accessor to the \a GlobalVector which contains current velocity. const GlobalVector& GetVectorCurrentVelocity() const noexcept; + //! Non constant accessor to the \a GlobalVector which contains current velocity. GlobalVector& GetNonCstVectorCurrentVelocity() noexcept; + //! Accessor to the \a GlobalMatrix used along displacement in the model. const GlobalMatrix& GetMatrixCurrentDisplacement() const noexcept; public: //todo #691 + //! Non constant accessor to the \a GlobalMatrix used along displacement in the model. GlobalMatrix& GetNonCstMatrixCurrentDisplacement() noexcept; + //! Accessor to the \a GlobalMatrix used along velocity in the model. const GlobalMatrix& GetMatrixCurrentVelocity() const noexcept; + //! Non constant accessor to the \a GlobalMatrix used along velocity in the model. GlobalMatrix& GetNonCstMatrixCurrentVelocity() noexcept; + //! Accessor to the mass matrix. const GlobalMatrix& GetMass() const noexcept; + //! Non constant accessor to the mass matrix. GlobalMatrix& GetNonCstMass() noexcept; + //! Accessor to the stiffness matrix. const GlobalMatrix& GetStiffness() const noexcept; + //! Non constant accessor to the stiffness matrix. GlobalMatrix& GetNonCstStiffness() noexcept; ///@} diff --git a/Sources/ModelInstances/Heat/HeatVariationalFormulation.hpp b/Sources/ModelInstances/Heat/HeatVariationalFormulation.hpp index bf1e4465fc..de0ec00526 100644 --- a/Sources/ModelInstances/Heat/HeatVariationalFormulation.hpp +++ b/Sources/ModelInstances/Heat/HeatVariationalFormulation.hpp @@ -101,6 +101,7 @@ namespace MoReFEM //! At each time iteration, compute the system Rhs. void ComputeDynamicSystemRhs(); + //! Accessor to the capacity matrix per time step. const GlobalMatrix& GetMatrixCapacityPerTimeStep() const; @@ -117,6 +118,7 @@ namespace MoReFEM * * StaticOrDynamic rhs is what changes between two time iterations, but toc ompute it the same matrices are used at * each time iteration; they are also computed there. + * \copydoc doxygen_hide_input_parameter_data_arg */ void PrepareDynamicRuns(const InputParameterList& input_parameter_data); @@ -162,6 +164,8 @@ namespace MoReFEM * \brief Get the only numbering subset relevant for this VariationalFormulation. * * There is a more generic accessor in the base class but is use is more unwieldy. + * + * \return The only relevant \a NumberingSubset. */ const NumberingSubset& GetNumberingSubset() const; @@ -177,7 +181,6 @@ namespace MoReFEM /*! * \brief Allocate the global matrices and vectors. */ - void AllocateMatricesAndVectors(); diff --git a/Sources/ModelInstances/Heat/InputParameterList.hpp b/Sources/ModelInstances/Heat/InputParameterList.hpp index 88eb9faf84..40392e53ce 100644 --- a/Sources/ModelInstances/Heat/InputParameterList.hpp +++ b/Sources/ModelInstances/Heat/InputParameterList.hpp @@ -95,6 +95,8 @@ namespace MoReFEM monolithic = 1 }; + + //! Index to tag the tensors involved. enum class TensorIndex { diffusion_tensor = 1 diff --git a/Sources/ModelInstances/Hyperelasticity/Model.hpp b/Sources/ModelInstances/Hyperelasticity/Model.hpp index 711d19bc19..95ac2d2af3 100644 --- a/Sources/ModelInstances/Hyperelasticity/Model.hpp +++ b/Sources/ModelInstances/Hyperelasticity/Model.hpp @@ -27,9 +27,7 @@ namespace MoReFEM { - /*! - * \brief Model for pre-stress cardiac mechanics. - */ + //! \copydoc doxygen_hide_simple_model class Model : public MoReFEM::Model { diff --git a/Sources/ModelInstances/Hyperelasticity/VariationalFormulation.hpp b/Sources/ModelInstances/Hyperelasticity/VariationalFormulation.hpp index da0a08319a..7d9dbfb2f3 100644 --- a/Sources/ModelInstances/Hyperelasticity/VariationalFormulation.hpp +++ b/Sources/ModelInstances/Hyperelasticity/VariationalFormulation.hpp @@ -44,6 +44,7 @@ namespace MoReFEM { + //! \copydoc doxygen_hide_simple_varf class VariationalFormulation : public MoReFEM::VariationalFormulation < @@ -86,10 +87,12 @@ namespace MoReFEM using ActiveStressPolicy = GlobalVariationalOperatorNS::SecondPiolaKirchhoffStressTensorNS::ActiveStressPolicyNS::None; + //! Alias to the hyperelasticity policy used. using hyperelasticity_policy = GlobalVariationalOperatorNS::SecondPiolaKirchhoffStressTensorNS::HyperelasticityPolicyNS ::Hyperelasticity; + //! Alias to the type of the source parameter. using force_parameter_type = Parameter; @@ -145,6 +148,8 @@ namespace MoReFEM * \brief Get the displacement numbering subset relevant for this VariationalFormulation. * * There is a more generic accessor in the base class but its use is more unwieldy. + * + * \return \a NumberingSubset related to displacement. */ const NumberingSubset& GetDisplacementNumberingSubset() const; @@ -191,12 +196,15 @@ namespace MoReFEM * * \param[in,out] snes SNES object. Not explicitly used but required by Petsc prototype. * \param[in,out] petsc_vec_displacement_at_newton_iteration State at which to evaluate residual. - * \param[in,out] residual Vector to put residual. What is used as residual in VariationalFormulation is #RHS(). + * \param[in,out] residual Vector to put residual. What is used as residual in \a VariationalFormulation is + * \a GetSystemRHS(). * \param[in,out] context_as_void Optional user-defined function context. In our case a pointer to the * VariationalFormulationT object. * + * \return Petsc error code. */ - static PetscErrorCode Function(SNES snes, Vec petsc_vec_displacement_at_newton_iteration, Vec residual, void* context_as_void); + static PetscErrorCode Function(SNES snes, Vec petsc_vec_displacement_at_newton_iteration, + Vec residual, void* context_as_void); /*! @@ -209,6 +217,8 @@ namespace MoReFEM * \param[in] norm Current L^2 norm. * \param[in] context_as_void Optional user-defined function context. In our case is is a pointer to a * VariationalFormulationT object. + * + * \return Petsc error code. */ static PetscErrorCode Viewer(SNES snes, PetscInt its, PetscReal norm, void* context_as_void); @@ -216,9 +226,12 @@ namespace MoReFEM /*! * \brief This function is supposed to be given to SNES to compute the jacobian. * - * However the jacobian has already been computed within SnesFunctionImpl, so this function is mostly a dummy one... + * \copydoc doxygen_hide_snes_interface_common_arg + * \param[in,out] evaluation_state Most recent value of the quantity the solver tries to compute. + * \param[in,out] jacobian Jacobian matrix. Actually unused in our wrapper. + * \param[in,out] preconditioner Preconditioner matrix. Actually unused in our wrapper. */ - static PetscErrorCode Jacobian(SNES snes, Vec evaluationState, Mat jacobian , Mat preconditioner, + static PetscErrorCode Jacobian(SNES snes, Vec evaluation_state, Mat jacobian , Mat preconditioner, void* context_as_void); private: @@ -302,6 +315,8 @@ namespace MoReFEM /*! * \brief Define the properties of all the static global variational operators involved. + * + * \copydoc doxygen_hide_input_parameter_data_arg */ void DefineStaticOperators(const InputParameterList& input_parameter_data); @@ -316,8 +331,9 @@ namespace MoReFEM //! Get the hyperelastic stiffness operator. const StiffnessOperatorType& GetStiffnessOperator() const noexcept; - //! - const GlobalVariationalOperatorNS::TransientSource& GetSurfacicForceOperator() const noexcept; + //! Accessor to the surfacic source operator. + const GlobalVariationalOperatorNS::TransientSource& + GetSurfacicForceOperator() const noexcept; private: @@ -401,6 +417,8 @@ namespace MoReFEM * \internal [internal] This accessor should not be used except in the Snes::Function() method: the point is to * store the value given by Petsc internal Newton algorithm. * Its value should be modified only through the call if \a UpdateDisplacementAtNewtonIteration(). + * + * \return Reference to the vector ernclosing displacement at newton iteration. */ GlobalVector& GetNonCstVectorDisplacementAtNewtonIteration() noexcept; diff --git a/Sources/ModelInstances/Laplacian/Model.hpp b/Sources/ModelInstances/Laplacian/Model.hpp index 22d16580e7..4d0eb0fc10 100644 --- a/Sources/ModelInstances/Laplacian/Model.hpp +++ b/Sources/ModelInstances/Laplacian/Model.hpp @@ -25,7 +25,7 @@ namespace MoReFEM { - //! Model that implements the heat problem in static and dynamic (backward Euler for time integration) + //! \copydoc doxygen_hide_simple_model class Model final : public MoReFEM::Model { diff --git a/Sources/ModelInstances/Laplacian/VariationalFormulation.hpp b/Sources/ModelInstances/Laplacian/VariationalFormulation.hpp index 925bd95aea..a35c0063cc 100644 --- a/Sources/ModelInstances/Laplacian/VariationalFormulation.hpp +++ b/Sources/ModelInstances/Laplacian/VariationalFormulation.hpp @@ -144,19 +144,6 @@ namespace MoReFEM //! Get the volumic source operator. const source_operator_type& GetVolumicSourceOperator() const noexcept; - private: - - /// \name Accessors to vectors and matrices specific to the problem. - ///@{ - - ///@} - - /// \name Material parameters. - ///@{ - - ///@} - - private: @@ -183,26 +170,6 @@ namespace MoReFEM - private: - - /// \name Global vectors and matrices specific to the problem. - ///@{ - - ///@} - - - private: - - //! \name Material parameters. - ///@{ - - ///@} - - - - private: - - }; diff --git a/Sources/ModelInstances/ModelInstances.doxygen b/Sources/ModelInstances/ModelInstances.doxygen new file mode 100644 index 0000000000..777d1a715a --- /dev/null +++ b/Sources/ModelInstances/ModelInstances.doxygen @@ -0,0 +1,14 @@ + +/*! + * \class doxygen_hide_simple_varf + * + * \brief Variational formulation used in the model. + */ + + + +/*! +* \class doxygen_hide_simple_model +* +* \brief Model class. +*/ diff --git a/Sources/ModelInstances/RivlinCube/Model.hpp b/Sources/ModelInstances/RivlinCube/Model.hpp index d3b64fbe5c..f475989907 100644 --- a/Sources/ModelInstances/RivlinCube/Model.hpp +++ b/Sources/ModelInstances/RivlinCube/Model.hpp @@ -27,6 +27,7 @@ namespace MoReFEM { + //! \copydoc doxygen_hide_simple_model class Model : public MoReFEM::Model { @@ -57,7 +58,7 @@ namespace MoReFEM /*! * \brief Constructor. * - * \copydetails doxygen_hide_mpi_param + * \copydoc doxygen_hide_input_parameter_data_arg */ Model(const morefem_data_type& input_parameter_data); diff --git a/Sources/ModelInstances/RivlinCube/VariationalFormulation.hpp b/Sources/ModelInstances/RivlinCube/VariationalFormulation.hpp index 7ee7b8e5b9..1040b445a9 100644 --- a/Sources/ModelInstances/RivlinCube/VariationalFormulation.hpp +++ b/Sources/ModelInstances/RivlinCube/VariationalFormulation.hpp @@ -63,6 +63,7 @@ namespace MoReFEM { + //! \copydoc doxygen_hide_simple_varf class VariationalFormulation : public MoReFEM::VariationalFormulation < @@ -97,18 +98,23 @@ namespace MoReFEM HyperelasticLawNS::MooneyRivlin >; + //! Alias to hyperelastic law used. using hyperelastic_law_type = HyperelasticLawNS::MooneyRivlin; + //! Alias to hyperelastic policy. using hyperelasticity_policy = GlobalVariationalOperatorNS::SecondPiolaKirchhoffStressTensorNS::HyperelasticityPolicyNS ::Hyperelasticity; + //! Alias to viscoelastic policy. using ViscoelasticityPolicy = GlobalVariationalOperatorNS::SecondPiolaKirchhoffStressTensorNS::ViscoelasticityPolicyNS::None; + //! Alias to acgtive stress policy. using ActiveStressPolicy = GlobalVariationalOperatorNS::SecondPiolaKirchhoffStressTensorNS::ActiveStressPolicyNS::None; + //! Alias to the type of the stiffness operator to use. using StiffnessOperatorType = GlobalVariationalOperatorNS::SecondPiolaKirchhoffStressTensor < @@ -158,6 +164,8 @@ namespace MoReFEM * \brief Get the only numbering subset relevant for this VariationalFormulation. * * There is a more generic accessor in the base class but is use is more unwieldy. + * + * \return Only \a NumberingSubset relevant for the variational formulation. */ const NumberingSubset& GetNumberingSubset() const; @@ -201,10 +209,12 @@ namespace MoReFEM * * \param[in,out] snes SNES object. Not explicitly used but required by Petsc prototype. * \param[in,out] evaluationState State at which to evaluate residual. - * \param[in,out] residual Vector to put residual. What is used as residual in VariationalFormulation is #RHS(). + * \param[in,out] residual Vector to put residual. What is used as residual in VariationalFormulation is + * \a GetSystemRHS(). * \param[in,out] context_as_void Optional user-defined function context. In our case a pointer to the * VariationalFormulationT object. * + * \return Petsc error code. */ static PetscErrorCode Function(SNES snes, Vec evaluationState, Vec residual, void* context_as_void); @@ -219,6 +229,8 @@ namespace MoReFEM * \param[in] norm Current L^2 norm. * \param[in] context_as_void Optional user-defined function context. In our case is is a pointer to a * VariationalFormulationT object. + * + * \return Petsc error code. */ static PetscErrorCode Viewer(SNES snes, PetscInt its, PetscReal norm, void* context_as_void); @@ -226,9 +238,12 @@ namespace MoReFEM /*! * \brief This function is supposed to be given to SNES to compute the jacobian. * - * However the jacobian has already been computed within SnesFunctionImpl, so this function is mostly a dummy one... + * \copydoc doxygen_hide_snes_interface_common_arg + * \param[in,out] evaluation_state Most recent value of the quantity the solver tries to compute. + * \param[in,out] jacobian Jacobian matrix. Actually unused in our wrapper. + * \param[in,out] preconditioner Preconditioner matrix. Actually unused in our wrapper. */ - static PetscErrorCode Jacobian(SNES snes, Vec evaluationState, Mat jacobian , Mat preconditioner, + static PetscErrorCode Jacobian(SNES snes, Vec evaluation_state, Mat jacobian , Mat preconditioner, void* context_as_void); @@ -343,6 +358,8 @@ namespace MoReFEM * \internal [internal] This accessor should not be used except in the Snes::Function() method: the point is to * store the value given by Petsc internal Newton algorithm. * Its value should be modified only through the call if \a UpdateEvaluationState(). + * + * \return Reference to the evaluation state vector. */ GlobalVector& GetNonCstEvaluationState() noexcept; @@ -375,9 +392,10 @@ namespace MoReFEM private: - /// \name NUmbering subsets used in the formulation. + /// \name Numbering subsets used in the formulation. ///@{ + //! Only relevant \a NumberingSubset const NumberingSubset& numbering_subset_; ///@} diff --git a/Sources/ModelInstances/Stokes/Model.hpp b/Sources/ModelInstances/Stokes/Model.hpp index 3cff47c249..cfb66994ca 100644 --- a/Sources/ModelInstances/Stokes/Model.hpp +++ b/Sources/ModelInstances/Stokes/Model.hpp @@ -25,6 +25,7 @@ namespace MoReFEM { + //! \copydoc doxygen_hide_simple_model class Model final : public MoReFEM::Model { diff --git a/Sources/ModelInstances/Stokes/VariationalFormulation.hpp b/Sources/ModelInstances/Stokes/VariationalFormulation.hpp index 6549f58695..5b799376e0 100644 --- a/Sources/ModelInstances/Stokes/VariationalFormulation.hpp +++ b/Sources/ModelInstances/Stokes/VariationalFormulation.hpp @@ -36,6 +36,7 @@ namespace MoReFEM { + //! \copydoc doxygen_hide_simple_varf class VariationalFormulation final : public MoReFEM::VariationalFormulation < @@ -54,6 +55,7 @@ namespace MoReFEM private: + //! Alias to the parent class. using parent = MoReFEM::VariationalFormulation < VariationalFormulation, @@ -72,6 +74,7 @@ namespace MoReFEM //! Alias to shared pointer. using unique_ptr = std::unique_ptr; + //! Alias to the convenient flavor of \a ScalarParameter. using scalar_parameter = ScalarParameter; public: @@ -116,6 +119,8 @@ namespace MoReFEM * Might be the same as the one for pressure for monolithic management. * * There is a more generic accessor in the base class but is use is more unwieldy. + * + * \return \a NumberingSubset in charge of the velocity unknown. */ const NumberingSubset& GetVelocityNumberingSubset() const; @@ -125,6 +130,8 @@ namespace MoReFEM * Might be the same as the one for velocity for monolithic management. * * There is a more generic accessor in the base class but is use is more unwieldy. + * + * \return \a NumberingSubset in charge of the pressure unknown. */ const NumberingSubset& GetPressureNumberingSubset() const; diff --git a/Sources/Operators/ConformInterpolator/Advanced/SourceOrTargetData.hpp b/Sources/Operators/ConformInterpolator/Advanced/SourceOrTargetData.hpp index bd23a73a83..5f53d85009 100644 --- a/Sources/Operators/ConformInterpolator/Advanced/SourceOrTargetData.hpp +++ b/Sources/Operators/ConformInterpolator/Advanced/SourceOrTargetData.hpp @@ -177,7 +177,7 @@ namespace MoReFEM //! Numbering subset. const NumberingSubset& numbering_subset_; - //! NUmber of unknown components considered in the felt space/numbering subset. + //! Number of unknown components considered in the felt space/numbering subset. int Nunknown_component_ = 0; /*! diff --git a/Sources/Test/Ondomatic/VariationalFormulation.hpp b/Sources/Test/Ondomatic/VariationalFormulation.hpp index 2a9235b9de..bc65557538 100644 --- a/Sources/Test/Ondomatic/VariationalFormulation.hpp +++ b/Sources/Test/Ondomatic/VariationalFormulation.hpp @@ -32,7 +32,7 @@ namespace MoReFEM //! \copydoc doxygen_hide_varf_4_test - class VariationalFormulation + class VariationalFormulation final : public MoReFEM::VariationalFormulation < VariationalFormulation, @@ -233,7 +233,7 @@ namespace MoReFEM private: - /// \name NUmbering subsets used in the formulation. + /// \name Numbering subsets used in the formulation. ///@{ const NumberingSubset& numbering_subset_; diff --git a/Sources/Utilities/Containers/BoolArray.hpp b/Sources/Utilities/Containers/BoolArray.hpp index ffc49cd4d1..60ac02881e 100644 --- a/Sources/Utilities/Containers/BoolArray.hpp +++ b/Sources/Utilities/Containers/BoolArray.hpp @@ -187,7 +187,7 @@ namespace MoReFEM //! Underlying dynamic bool array. bool* array_; - //! NUmber of elements in the array. + //! Number of elements in the array. unsigned int Nelt_; }; diff --git a/Sources/Utilities/LinearAlgebra/Storage/Local/LocalVectorStorage.hpp b/Sources/Utilities/LinearAlgebra/Storage/Local/LocalVectorStorage.hpp index b9aafe613a..eed8472998 100644 --- a/Sources/Utilities/LinearAlgebra/Storage/Local/LocalVectorStorage.hpp +++ b/Sources/Utilities/LinearAlgebra/Storage/Local/LocalVectorStorage.hpp @@ -30,7 +30,7 @@ namespace MoReFEM * \brief CRTP to give access to \a NlocalVectorT local vectors. * * \tparam DerivedT Name of the base class for which the CRTP is deployed. - * \tparam NlocalVectorT NUmber of local vectors to add. + * \tparam NlocalVectorT Number of local vectors to add. * * It is advised to declare in \a DerivedT an enum class to tag the local vectors, e.g.: * \code diff --git a/XCodeTemplates/VariationalFormulation.xctemplate/___FILEBASENAME___.hpp b/XCodeTemplates/VariationalFormulation.xctemplate/___FILEBASENAME___.hpp index ab0afb1458..3112c7ce60 100644 --- a/XCodeTemplates/VariationalFormulation.xctemplate/___FILEBASENAME___.hpp +++ b/XCodeTemplates/VariationalFormulation.xctemplate/___FILEBASENAME___.hpp @@ -31,6 +31,7 @@ namespace MoReFEM { + //! \copydoc doxygen_hide_simple_varf class VariationalFormulation : public MoReFEM::VariationalFormulation < -- GitLab From 06fca06fca7dbbbe8418a476b80268ded695e8f3 Mon Sep 17 00:00:00 2001 From: Sebastien Gilles Date: Mon, 15 Jan 2018 14:28:02 +0100 Subject: [PATCH 11/11] #1211 Doxygen: create three separate scripts for the different levels of details inside. Make the output directory portable. --- .gitignore | 9 +- Documentation/Doxygen/README.md | 16 + Documentation/Doxygen/advanced_dev_guide.dox | 2404 ++++++++++++++++ Documentation/Doxygen/basic_dev_guide.dox | 2405 +++++++++++++++++ .../{morefem.dox => complete_dev_guide.dox} | 6 +- 5 files changed, 4833 insertions(+), 7 deletions(-) create mode 100644 Documentation/Doxygen/README.md create mode 100644 Documentation/Doxygen/advanced_dev_guide.dox create mode 100644 Documentation/Doxygen/basic_dev_guide.dox rename Documentation/Doxygen/{morefem.dox => complete_dev_guide.dox} (99%) diff --git a/.gitignore b/.gitignore index fc6db98a45..989e864695 100644 --- a/.gitignore +++ b/.gitignore @@ -57,10 +57,6 @@ Sources/build_configuration_* # Documentation -Documentation/latex/Pdf -Documentation/Doxygen/html -Documentation/Doxygen/latex -Documentation/Doxygen/my_happy_heart.dox Documentation/*/*.out Documentation/*/*.pdf Documentation/*/*/*.pdf @@ -73,3 +69,8 @@ Documentation/Uml/Png # Typical model instance used to check XCode templates. Sources/ModelInstances/TestXCodeTemplate + +# Doxygen: ignore the generated documentation folder. +Documentation/Doxygen/Complete +Documentation/Doxygen/Advanced +Documentation/Doxygen/Basic diff --git a/Documentation/Doxygen/README.md b/Documentation/Doxygen/README.md new file mode 100644 index 0000000000..2e1bd2f2ee --- /dev/null +++ b/Documentation/Doxygen/README.md @@ -0,0 +1,16 @@ +There are three developer's guide present here: + +## Basic developer's guide + +This guide is for someone who intends to create a simple enough model, in which for instance all finite elements and all operators do already exist in the library. All the models given in ModelInstances qualify for this basic level! + +## Advanced developer's guide + +The following step is for developers already at ease with MoReFEM; in Advanced level you might for instance declare yourself a brand new operator. + +Within the code, all the new content is embraced in the _Advanced_ namespace. + +## Complete developer's guide + +This guide is intended to developers of Morefem library itself and documents anything related to MoReFEM, including under-the-hood mechanisms. It should be reserved only to developer who tinkers with the core of the library and to no use to a developer writing a Model. + diff --git a/Documentation/Doxygen/advanced_dev_guide.dox b/Documentation/Doxygen/advanced_dev_guide.dox new file mode 100644 index 0000000000..a3d2e7907c --- /dev/null +++ b/Documentation/Doxygen/advanced_dev_guide.dox @@ -0,0 +1,2404 @@ +# Doxyfile 1.8.11 + +# This file describes the settings to be used by the documentation system +# doxygen (www.doxygen.org) for a project. +# +# All text after a double hash (##) is considered a comment and is placed in +# front of the TAG it is preceding. +# +# All text after a single hash (#) is considered a comment and will be ignored. +# The format is: +# TAG = value [value, ...] +# For lists, items can also be appended using: +# TAG += value [value, ...] +# Values that contain spaces should be placed between quotes (\" \"). + +#--------------------------------------------------------------------------- +# Project related configuration options +#--------------------------------------------------------------------------- + +# This tag specifies the encoding used for all characters in the config file +# that follow. The default is UTF-8 which is also the encoding used for all text +# before the first occurrence of this tag. Doxygen uses libiconv (or the iconv +# built into libc) for the transcoding. See http://www.gnu.org/software/libiconv +# for the list of possible encodings. +# The default value is: UTF-8. + +DOXYFILE_ENCODING = UTF-8 + +# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by +# double-quotes, unless you are using Doxywizard) that should identify the +# project for which the documentation is generated. This name is used in the +# title of most generated pages and in a few other places. +# The default value is: My Project. + +PROJECT_NAME = "MoReFEM" + +# The PROJECT_NUMBER tag can be used to enter a project or revision number. This +# could be handy for archiving the generated documentation or if some version +# control system is used. + +PROJECT_NUMBER = + +# Using the PROJECT_BRIEF tag one can provide an optional one line description +# for a project that appears at the top of each page and should give viewer a +# quick idea about the purpose of the project. Keep the description short. + +PROJECT_BRIEF = + +# With the PROJECT_LOGO tag one can specify a logo or an icon that is included +# in the documentation. The maximum height of the logo should not exceed 55 +# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy +# the logo to the output directory. + +PROJECT_LOGO = + +# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path +# into which the generated documentation will be written. If a relative path is +# entered, it will be relative to the location where doxygen was started. If +# left blank the current directory will be used. + +OUTPUT_DIRECTORY = Advanced + +# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub- +# directories (in 2 levels) under the output directory of each output format and +# will distribute the generated files over these directories. Enabling this +# option can be useful when feeding doxygen a huge amount of source files, where +# putting all generated files in the same directory would otherwise causes +# performance problems for the file system. +# The default value is: NO. + +CREATE_SUBDIRS = YES + +# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII +# characters to appear in the names of generated files. If set to NO, non-ASCII +# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode +# U+3044. +# The default value is: NO. + +ALLOW_UNICODE_NAMES = NO + +# The OUTPUT_LANGUAGE tag is used to specify the language in which all +# documentation generated by doxygen is written. Doxygen will use this +# information to generate all constant output in the proper language. +# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, +# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), +# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, +# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), +# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, +# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, +# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, +# Ukrainian and Vietnamese. +# The default value is: English. + +OUTPUT_LANGUAGE = English + +# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member +# descriptions after the members that are listed in the file and class +# documentation (similar to Javadoc). Set to NO to disable this. +# The default value is: YES. + +BRIEF_MEMBER_DESC = YES + +# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief +# description of a member or function before the detailed description +# +# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the +# brief descriptions will be completely suppressed. +# The default value is: YES. + +REPEAT_BRIEF = YES + +# This tag implements a quasi-intelligent brief description abbreviator that is +# used to form the text in various listings. Each string in this list, if found +# as the leading text of the brief description, will be stripped from the text +# and the result, after processing the whole list, is used as the annotated +# text. Otherwise, the brief description is used as-is. If left blank, the +# following values are used ($name is automatically replaced with the name of +# the entity):The $name class, The $name widget, The $name file, is, provides, +# specifies, contains, represents, a, an and the. + +ABBREVIATE_BRIEF = + +# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then +# doxygen will generate a detailed section even if there is only a brief +# description. +# The default value is: NO. + +ALWAYS_DETAILED_SEC = NO + +# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all +# inherited members of a class in the documentation of that class as if those +# members were ordinary class members. Constructors, destructors and assignment +# operators of the base classes will not be shown. +# The default value is: NO. + +INLINE_INHERITED_MEMB = YES + +# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path +# before files name in the file list and in the header files. If set to NO the +# shortest path that makes the file name unique will be used +# The default value is: YES. + +FULL_PATH_NAMES = YES + +# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. +# Stripping is only done if one of the specified strings matches the left-hand +# part of the path. The tag can be used to show relative paths in the file list. +# If left blank the directory from which doxygen is run is used as the path to +# strip. +# +# Note that you can specify absolute paths here, but also relative paths, which +# will be relative from the directory where doxygen is started. +# This tag requires that the tag FULL_PATH_NAMES is set to YES. + +STRIP_FROM_PATH = + +# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the +# path mentioned in the documentation of a class, which tells the reader which +# header file to include in order to use a class. If left blank only the name of +# the header file containing the class definition is used. Otherwise one should +# specify the list of include paths that are normally passed to the compiler +# using the -I flag. + +STRIP_FROM_INC_PATH = + +# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but +# less readable) file names. This can be useful is your file systems doesn't +# support long names like on DOS, Mac, or CD-ROM. +# The default value is: NO. + +SHORT_NAMES = NO + +# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the +# first line (until the first dot) of a Javadoc-style comment as the brief +# description. If set to NO, the Javadoc-style will behave just like regular Qt- +# style comments (thus requiring an explicit @brief command for a brief +# description.) +# The default value is: NO. + +JAVADOC_AUTOBRIEF = NO + +# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first +# line (until the first dot) of a Qt-style comment as the brief description. If +# set to NO, the Qt-style will behave just like regular Qt-style comments (thus +# requiring an explicit \brief command for a brief description.) +# The default value is: NO. + +QT_AUTOBRIEF = NO + +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a +# multi-line C++ special comment block (i.e. a block of //! or /// comments) as +# a brief description. This used to be the default behavior. The new default is +# to treat a multi-line C++ comment block as a detailed description. Set this +# tag to YES if you prefer the old behavior instead. +# +# Note that setting this tag to YES also means that rational rose comments are +# not recognized any more. +# The default value is: NO. + +MULTILINE_CPP_IS_BRIEF = NO + +# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the +# documentation from any documented member that it re-implements. +# The default value is: YES. + +INHERIT_DOCS = YES + +# If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new +# page for each member. If set to NO, the documentation of a member will be part +# of the file/class/namespace that contains it. +# The default value is: NO. + +SEPARATE_MEMBER_PAGES = NO + +# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen +# uses this value to replace tabs by spaces in code fragments. +# Minimum value: 1, maximum value: 16, default value: 4. + +TAB_SIZE = 4 + +# This tag can be used to specify a number of aliases that act as commands in +# the documentation. An alias has the form: +# name=value +# For example adding +# "sideeffect=@par Side Effects:\n" +# will allow you to put the command \sideeffect (or @sideeffect) in the +# documentation, which will result in a user-defined paragraph with heading +# "Side Effects:". You can put \n's in the value part of an alias to insert +# newlines. + +ALIASES = "accessor{1}=\brief Constant accessor to \1 \n\n \return \1" \ + "non_cst_accessor{1}=\brief Non constant accessor to \1 \n\n \return Reference to \1" + +# This tag can be used to specify a number of word-keyword mappings (TCL only). +# A mapping has the form "name=value". For example adding "class=itcl::class" +# will allow you to use the command class in the itcl::class meaning. + +TCL_SUBST = + +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources +# only. Doxygen will then generate output that is more tailored for C. For +# instance, some of the names that are used will be different. The list of all +# members will be omitted, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_FOR_C = YES + +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or +# Python sources only. Doxygen will then generate output that is more tailored +# for that language. For instance, namespaces will be presented as packages, +# qualified scopes will look different, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_JAVA = NO + +# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran +# sources. Doxygen will then generate output that is tailored for Fortran. +# The default value is: NO. + +OPTIMIZE_FOR_FORTRAN = NO + +# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL +# sources. Doxygen will then generate output that is tailored for VHDL. +# The default value is: NO. + +OPTIMIZE_OUTPUT_VHDL = NO + +# Doxygen selects the parser to use depending on the extension of the files it +# parses. With this tag you can assign which parser to use for a given +# extension. Doxygen has a built-in mapping, but you can override or extend it +# using this tag. The format is ext=language, where ext is a file extension, and +# language is one of the parsers supported by doxygen: IDL, Java, Javascript, +# C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran: +# FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran: +# Fortran. In the later case the parser tries to guess whether the code is fixed +# or free formatted code, this is the default for Fortran type files), VHDL. For +# instance to make doxygen treat .inc files as Fortran files (default is PHP), +# and .f files as C (default is Fortran), use: inc=Fortran f=C. +# +# Note: For files without extension you can use no_extension as a placeholder. +# +# Note that for custom extensions you also need to set FILE_PATTERNS otherwise +# the files are not read by doxygen. + +EXTENSION_MAPPING = + +# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments +# according to the Markdown format, which allows for more readable +# documentation. See http://daringfireball.net/projects/markdown/ for details. +# The output of markdown processing is further processed by doxygen, so you can +# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in +# case of backward compatibilities issues. +# The default value is: YES. + +MARKDOWN_SUPPORT = YES + +# When enabled doxygen tries to link words that correspond to documented +# classes, or namespaces to their corresponding documentation. Such a link can +# be prevented in individual cases by putting a % sign in front of the word or +# globally by setting AUTOLINK_SUPPORT to NO. +# The default value is: YES. + +AUTOLINK_SUPPORT = YES + +# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want +# to include (a tag file for) the STL sources as input, then you should set this +# tag to YES in order to let doxygen match functions declarations and +# definitions whose arguments contain STL classes (e.g. func(std::string); +# versus func(std::string) {}). This also make the inheritance and collaboration +# diagrams that involve STL classes more complete and accurate. +# The default value is: NO. + +BUILTIN_STL_SUPPORT = YES + +# If you use Microsoft's C++/CLI language, you should set this option to YES to +# enable parsing support. +# The default value is: NO. + +CPP_CLI_SUPPORT = NO + +# Set the SIP_SUPPORT tag to YES if your project consists of sip (see: +# http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen +# will parse them like normal C++ but will assume all classes use public instead +# of private inheritance when no explicit protection keyword is present. +# The default value is: NO. + +SIP_SUPPORT = NO + +# For Microsoft's IDL there are propget and propput attributes to indicate +# getter and setter methods for a property. Setting this option to YES will make +# doxygen to replace the get and set methods by a property in the documentation. +# This will only work if the methods are indeed getting or setting a simple +# type. If this is not the case, or you want to show the methods anyway, you +# should set this option to NO. +# The default value is: YES. + +IDL_PROPERTY_SUPPORT = NO + +# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC +# tag is set to YES then doxygen will reuse the documentation of the first +# member in the group (if any) for the other members of the group. By default +# all members of a group must be documented explicitly. +# The default value is: NO. + +DISTRIBUTE_GROUP_DOC = NO + +# If one adds a struct or class to a group and this option is enabled, then also +# any nested class or struct is added to the same group. By default this option +# is disabled and one has to add nested compounds explicitly via \ingroup. +# The default value is: NO. + +GROUP_NESTED_COMPOUNDS = YES + +# Set the SUBGROUPING tag to YES to allow class member groups of the same type +# (for instance a group of public functions) to be put as a subgroup of that +# type (e.g. under the Public Functions section). Set it to NO to prevent +# subgrouping. Alternatively, this can be done per class using the +# \nosubgrouping command. +# The default value is: YES. + +SUBGROUPING = YES + +# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions +# are shown inside the group in which they are included (e.g. using \ingroup) +# instead of on a separate page (for HTML and Man pages) or section (for LaTeX +# and RTF). +# +# Note that this feature does not work in combination with +# SEPARATE_MEMBER_PAGES. +# The default value is: NO. + +INLINE_GROUPED_CLASSES = NO + +# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions +# with only public data fields or simple typedef fields will be shown inline in +# the documentation of the scope in which they are defined (i.e. file, +# namespace, or group documentation), provided this scope is documented. If set +# to NO, structs, classes, and unions are shown on a separate page (for HTML and +# Man pages) or section (for LaTeX and RTF). +# The default value is: NO. + +INLINE_SIMPLE_STRUCTS = NO + +# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or +# enum is documented as struct, union, or enum with the name of the typedef. So +# typedef struct TypeS {} TypeT, will appear in the documentation as a struct +# with name TypeT. When disabled the typedef will appear as a member of a file, +# namespace, or class. And the struct will be named TypeS. This can typically be +# useful for C code in case the coding convention dictates that all compound +# types are typedef'ed and only the typedef is referenced, never the tag name. +# The default value is: NO. + +TYPEDEF_HIDES_STRUCT = YES + +# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This +# cache is used to resolve symbols given their name and scope. Since this can be +# an expensive process and often the same symbol appears multiple times in the +# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small +# doxygen will become slower. If the cache is too large, memory is wasted. The +# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range +# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 +# symbols. At the end of a run doxygen will report the cache usage and suggest +# the optimal cache size from a speed point of view. +# Minimum value: 0, maximum value: 9, default value: 0. + +LOOKUP_CACHE_SIZE = 0 + +#--------------------------------------------------------------------------- +# Build related configuration options +#--------------------------------------------------------------------------- + +# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in +# documentation are documented, even if no documentation was available. Private +# class members and static file members will be hidden unless the +# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. +# Note: This will also disable the warnings about undocumented members that are +# normally produced when WARNINGS is set to YES. +# The default value is: NO. + +EXTRACT_ALL = NO + +# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will +# be included in the documentation. +# The default value is: NO. + +EXTRACT_PRIVATE = YES + +# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal +# scope will be included in the documentation. +# The default value is: NO. + +EXTRACT_PACKAGE = NO + +# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be +# included in the documentation. +# The default value is: NO. + +EXTRACT_STATIC = YES + +# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined +# locally in source files will be included in the documentation. If set to NO, +# only classes defined in header files are included. Does not have any effect +# for Java sources. +# The default value is: YES. + +EXTRACT_LOCAL_CLASSES = NO + +# This flag is only useful for Objective-C code. If set to YES, local methods, +# which are defined in the implementation section but not in the interface are +# included in the documentation. If set to NO, only methods in the interface are +# included. +# The default value is: NO. + +EXTRACT_LOCAL_METHODS = NO + +# If this flag is set to YES, the members of anonymous namespaces will be +# extracted and appear in the documentation as a namespace called +# 'anonymous_namespace{file}', where file will be replaced with the base name of +# the file that contains the anonymous namespace. By default anonymous namespace +# are hidden. +# The default value is: NO. + +EXTRACT_ANON_NSPACES = NO + +# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all +# undocumented members inside documented classes or files. If set to NO these +# members will be included in the various overviews, but no documentation +# section is generated. This option has no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_MEMBERS = NO + +# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all +# undocumented classes that are normally visible in the class hierarchy. If set +# to NO, these classes will be included in the various overviews. This option +# has no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_CLASSES = NO + +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend +# (class|struct|union) declarations. If set to NO, these declarations will be +# included in the documentation. +# The default value is: NO. + +HIDE_FRIEND_COMPOUNDS = NO + +# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any +# documentation blocks found inside the body of a function. If set to NO, these +# blocks will be appended to the function's detailed documentation block. +# The default value is: NO. + +HIDE_IN_BODY_DOCS = NO + +# The INTERNAL_DOCS tag determines if documentation that is typed after a +# \internal command is included. If the tag is set to NO then the documentation +# will be excluded. Set it to YES to include the internal documentation. +# The default value is: NO. + +INTERNAL_DOCS = NO + +# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file +# names in lower-case letters. If set to YES, upper-case letters are also +# allowed. This is useful if you have classes or files whose names only differ +# in case and if your file system supports case sensitive file names. Windows +# and Mac users are advised to set this option to NO. +# The default value is: system dependent. + +CASE_SENSE_NAMES = NO + +# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with +# their full class and namespace scopes in the documentation. If set to YES, the +# scope will be hidden. +# The default value is: NO. + +HIDE_SCOPE_NAMES = NO + +# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will +# append additional text to a page's title, such as Class Reference. If set to +# YES the compound reference will be hidden. +# The default value is: NO. + +HIDE_COMPOUND_REFERENCE= NO + +# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of +# the files that are included by a file in the documentation of that file. +# The default value is: YES. + +SHOW_INCLUDE_FILES = YES + +# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each +# grouped member an include statement to the documentation, telling the reader +# which file to include in order to use the member. +# The default value is: NO. + +SHOW_GROUPED_MEMB_INC = YES + +# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include +# files with double quotes in the documentation rather than with sharp brackets. +# The default value is: NO. + +FORCE_LOCAL_INCLUDES = NO + +# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the +# documentation for inline members. +# The default value is: YES. + +INLINE_INFO = YES + +# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the +# (detailed) documentation of file and class members alphabetically by member +# name. If set to NO, the members will appear in declaration order. +# The default value is: YES. + +SORT_MEMBER_DOCS = NO + +# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief +# descriptions of file, namespace and class members alphabetically by member +# name. If set to NO, the members will appear in declaration order. Note that +# this will also influence the order of the classes in the class list. +# The default value is: NO. + +SORT_BRIEF_DOCS = NO + +# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the +# (brief and detailed) documentation of class members so that constructors and +# destructors are listed first. If set to NO the constructors will appear in the +# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. +# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief +# member documentation. +# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting +# detailed member documentation. +# The default value is: NO. + +SORT_MEMBERS_CTORS_1ST = NO + +# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy +# of group names into alphabetical order. If set to NO the group names will +# appear in their defined order. +# The default value is: NO. + +SORT_GROUP_NAMES = NO + +# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by +# fully-qualified names, including namespaces. If set to NO, the class list will +# be sorted only by class name, not including the namespace part. +# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. +# Note: This option applies only to the class list, not to the alphabetical +# list. +# The default value is: NO. + +SORT_BY_SCOPE_NAME = NO + +# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper +# type resolution of all parameters of a function it will reject a match between +# the prototype and the implementation of a member function even if there is +# only one candidate or it is obvious which candidate to choose by doing a +# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still +# accept a match between prototype and implementation in such cases. +# The default value is: NO. + +STRICT_PROTO_MATCHING = NO + +# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo +# list. This list is created by putting \todo commands in the documentation. +# The default value is: YES. + +GENERATE_TODOLIST = YES + +# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test +# list. This list is created by putting \test commands in the documentation. +# The default value is: YES. + +GENERATE_TESTLIST = YES + +# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug +# list. This list is created by putting \bug commands in the documentation. +# The default value is: YES. + +GENERATE_BUGLIST = YES + +# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) +# the deprecated list. This list is created by putting \deprecated commands in +# the documentation. +# The default value is: YES. + +GENERATE_DEPRECATEDLIST= YES + +# The ENABLED_SECTIONS tag can be used to enable conditional documentation +# sections, marked by \if ... \endif and \cond +# ... \endcond blocks. + +ENABLED_SECTIONS = + +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the +# initial value of a variable or macro / define can have for it to appear in the +# documentation. If the initializer consists of more lines than specified here +# it will be hidden. Use a value of 0 to hide initializers completely. The +# appearance of the value of individual variables and macros / defines can be +# controlled using \showinitializer or \hideinitializer command in the +# documentation regardless of this setting. +# Minimum value: 0, maximum value: 10000, default value: 30. + +MAX_INITIALIZER_LINES = 30 + +# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at +# the bottom of the documentation of classes and structs. If set to YES, the +# list will mention the files that were used to generate the documentation. +# The default value is: YES. + +SHOW_USED_FILES = YES + +# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This +# will remove the Files entry from the Quick Index and from the Folder Tree View +# (if specified). +# The default value is: YES. + +SHOW_FILES = YES + +# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces +# page. This will remove the Namespaces entry from the Quick Index and from the +# Folder Tree View (if specified). +# The default value is: YES. + +SHOW_NAMESPACES = YES + +# The FILE_VERSION_FILTER tag can be used to specify a program or script that +# doxygen should invoke to get the current version for each file (typically from +# the version control system). Doxygen will invoke the program by executing (via +# popen()) the command command input-file, where command is the value of the +# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided +# by doxygen. Whatever the program writes to standard output is used as the file +# version. For an example see the documentation. + +FILE_VERSION_FILTER = + +# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed +# by doxygen. The layout file controls the global structure of the generated +# output files in an output format independent way. To create the layout file +# that represents doxygen's defaults, run doxygen with the -l option. You can +# optionally specify a file name after the option, if omitted DoxygenLayout.xml +# will be used as the name of the layout file. +# +# Note that if you run doxygen from a directory containing a file called +# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE +# tag is left empty. + +LAYOUT_FILE = + +# The CITE_BIB_FILES tag can be used to specify one or more bib files containing +# the reference definitions. This must be a list of .bib files. The .bib +# extension is automatically appended if omitted. This requires the bibtex tool +# to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info. +# For LaTeX the style of the bibliography can be controlled using +# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the +# search path. See also \cite for info how to create references. + +CITE_BIB_FILES = + +#--------------------------------------------------------------------------- +# Configuration options related to warning and progress messages +#--------------------------------------------------------------------------- + +# The QUIET tag can be used to turn on/off the messages that are generated to +# standard output by doxygen. If QUIET is set to YES this implies that the +# messages are off. +# The default value is: NO. + +QUIET = NO + +# The WARNINGS tag can be used to turn on/off the warning messages that are +# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES +# this implies that the warnings are on. +# +# Tip: Turn warnings on while writing the documentation. +# The default value is: YES. + +WARNINGS = YES + +# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate +# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag +# will automatically be disabled. +# The default value is: YES. + +WARN_IF_UNDOCUMENTED = YES + +# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for +# potential errors in the documentation, such as not documenting some parameters +# in a documented function, or documenting parameters that don't exist or using +# markup commands wrongly. +# The default value is: YES. + +WARN_IF_DOC_ERROR = YES + +# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that +# are documented, but have no documentation for their parameters or return +# value. If set to NO, doxygen will only warn about wrong or incomplete +# parameter documentation, but not about the absence of documentation. +# The default value is: NO. + +WARN_NO_PARAMDOC = YES + +# The WARN_FORMAT tag determines the format of the warning messages that doxygen +# can produce. The string should contain the $file, $line, and $text tags, which +# will be replaced by the file and line number from which the warning originated +# and the warning text. Optionally the format may contain $version, which will +# be replaced by the version of the file (if it could be obtained via +# FILE_VERSION_FILTER) +# The default value is: $file:$line: $text. + +WARN_FORMAT = "$file:$line: $text" + +# The WARN_LOGFILE tag can be used to specify a file to which warning and error +# messages should be written. If left blank the output is written to standard +# error (stderr). + +WARN_LOGFILE = "advanced.log" + +#--------------------------------------------------------------------------- +# Configuration options related to the input files +#--------------------------------------------------------------------------- + +# The INPUT tag is used to specify the files and/or directories that contain +# documented source files. You may enter file names like myfile.cpp or +# directories like /usr/src/myproject. Separate the files or directories with +# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING +# Note: If this tag is empty the current directory is searched. + +INPUT = ../../Sources \ + ../../README.md + +# This tag can be used to specify the character encoding of the source files +# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses +# libiconv (or the iconv built into libc) for the transcoding. See the libiconv +# documentation (see: http://www.gnu.org/software/libiconv) for the list of +# possible encodings. +# The default value is: UTF-8. + +INPUT_ENCODING = UTF-8 + +# If the value of the INPUT tag contains directories, you can use the +# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and +# *.h) to filter out the source-files in the directories. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# read by doxygen. +# +# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp, +# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, +# *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, +# *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, +# *.vhdl, *.ucf, *.qsf, *.as and *.js. + +FILE_PATTERNS = *.hpp \ + *.doxygen + +# The RECURSIVE tag can be used to specify whether or not subdirectories should +# be searched for input files as well. +# The default value is: NO. + +RECURSIVE = YES + +# The EXCLUDE tag can be used to specify files and/or directories that should be +# excluded from the INPUT source files. This way you can easily exclude a +# subdirectory from a directory tree whose root is specified with the INPUT tag. +# +# Note that relative paths are relative to the directory from which doxygen is +# run. + +EXCLUDE = + +# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or +# directories that are symbolic links (a Unix file system feature) are excluded +# from the input. +# The default value is: NO. + +EXCLUDE_SYMLINKS = NO + +# If the value of the INPUT tag contains directories, you can use the +# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude +# certain files from those directories. +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories for example use the pattern */test/* + +EXCLUDE_PATTERNS = *ThirdParty/Source* \ + */Internal/* + +# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names +# (namespaces, classes, functions, etc.) that should be excluded from the +# output. The symbol name can be a fully qualified name, a word, or if the +# wildcard * is used, a substring. Examples: ANamespace, AClass, +# AClass::ANamespace, ANamespace::*Test +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories use the pattern */test/* + +EXCLUDE_SYMBOLS = doxygen_hide_* + +# The EXAMPLE_PATH tag can be used to specify one or more files or directories +# that contain example code fragments that are included (see the \include +# command). + +EXAMPLE_PATH = + +# If the value of the EXAMPLE_PATH tag contains directories, you can use the +# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and +# *.h) to filter out the source-files in the directories. If left blank all +# files are included. + +EXAMPLE_PATTERNS = + +# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be +# searched for input files to be used with the \include or \dontinclude commands +# irrespective of the value of the RECURSIVE tag. +# The default value is: NO. + +EXAMPLE_RECURSIVE = NO + +# The IMAGE_PATH tag can be used to specify one or more files or directories +# that contain images that are to be included in the documentation (see the +# \image command). + +IMAGE_PATH = + +# The INPUT_FILTER tag can be used to specify a program that doxygen should +# invoke to filter for each input file. Doxygen will invoke the filter program +# by executing (via popen()) the command: +# +# +# +# where is the value of the INPUT_FILTER tag, and is the +# name of an input file. Doxygen will then use the output that the filter +# program writes to standard output. If FILTER_PATTERNS is specified, this tag +# will be ignored. +# +# Note that the filter must not add or remove lines; it is applied before the +# code is scanned, but not when the output code is generated. If lines are added +# or removed, the anchors will not be placed correctly. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# properly processed by doxygen. + +INPUT_FILTER = + +# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern +# basis. Doxygen will compare the file name with each pattern and apply the +# filter if there is a match. The filters are a list of the form: pattern=filter +# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how +# filters are used. If the FILTER_PATTERNS tag is empty or if none of the +# patterns match the file name, INPUT_FILTER is applied. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# properly processed by doxygen. + +FILTER_PATTERNS = + +# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using +# INPUT_FILTER) will also be used to filter the input files that are used for +# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). +# The default value is: NO. + +FILTER_SOURCE_FILES = NO + +# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file +# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and +# it is also possible to disable source filtering for a specific pattern using +# *.ext= (so without naming a filter). +# This tag requires that the tag FILTER_SOURCE_FILES is set to YES. + +FILTER_SOURCE_PATTERNS = + +# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that +# is part of the input, its contents will be placed on the main page +# (index.html). This can be useful if you have a project on for instance GitHub +# and want to reuse the introduction page also for the Doxygen output. + +USE_MDFILE_AS_MAINPAGE = ../../README.md + +#--------------------------------------------------------------------------- +# Configuration options related to source browsing +#--------------------------------------------------------------------------- + +# If the SOURCE_BROWSER tag is set to YES then a list of source files will be +# generated. Documented entities will be cross-referenced with these sources. +# +# Note: To get rid of all source code in the generated output, make sure that +# also VERBATIM_HEADERS is set to NO. +# The default value is: NO. + +SOURCE_BROWSER = NO + +# Setting the INLINE_SOURCES tag to YES will include the body of functions, +# classes and enums directly into the documentation. +# The default value is: NO. + +INLINE_SOURCES = NO + +# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any +# special comment blocks from generated source code fragments. Normal C, C++ and +# Fortran comments will always remain visible. +# The default value is: YES. + +STRIP_CODE_COMMENTS = YES + +# If the REFERENCED_BY_RELATION tag is set to YES then for each documented +# function all documented functions referencing it will be listed. +# The default value is: NO. + +REFERENCED_BY_RELATION = NO + +# If the REFERENCES_RELATION tag is set to YES then for each documented function +# all documented entities called/used by that function will be listed. +# The default value is: NO. + +REFERENCES_RELATION = NO + +# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set +# to YES then the hyperlinks from functions in REFERENCES_RELATION and +# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will +# link to the documentation. +# The default value is: YES. + +REFERENCES_LINK_SOURCE = YES + +# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the +# source code will show a tooltip with additional information such as prototype, +# brief description and links to the definition and documentation. Since this +# will make the HTML file larger and loading of large files a bit slower, you +# can opt to disable this feature. +# The default value is: YES. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +SOURCE_TOOLTIPS = YES + +# If the USE_HTAGS tag is set to YES then the references to source code will +# point to the HTML generated by the htags(1) tool instead of doxygen built-in +# source browser. The htags tool is part of GNU's global source tagging system +# (see http://www.gnu.org/software/global/global.html). You will need version +# 4.8.6 or higher. +# +# To use it do the following: +# - Install the latest version of global +# - Enable SOURCE_BROWSER and USE_HTAGS in the config file +# - Make sure the INPUT points to the root of the source tree +# - Run doxygen as normal +# +# Doxygen will invoke htags (and that will in turn invoke gtags), so these +# tools must be available from the command line (i.e. in the search path). +# +# The result: instead of the source browser generated by doxygen, the links to +# source code will now point to the output of htags. +# The default value is: NO. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +USE_HTAGS = NO + +# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a +# verbatim copy of the header file for each class for which an include is +# specified. Set to NO to disable this. +# See also: Section \class. +# The default value is: YES. + +VERBATIM_HEADERS = YES + +#--------------------------------------------------------------------------- +# Configuration options related to the alphabetical class index +#--------------------------------------------------------------------------- + +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all +# compounds will be generated. Enable this if the project contains a lot of +# classes, structs, unions or interfaces. +# The default value is: YES. + +ALPHABETICAL_INDEX = YES + +# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in +# which the alphabetical index list will be split. +# Minimum value: 1, maximum value: 20, default value: 5. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +COLS_IN_ALPHA_INDEX = 5 + +# In case all classes in a project start with a common prefix, all classes will +# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag +# can be used to specify a prefix (or a list of prefixes) that should be ignored +# while generating the index headers. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +IGNORE_PREFIX = + +#--------------------------------------------------------------------------- +# Configuration options related to the HTML output +#--------------------------------------------------------------------------- + +# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output +# The default value is: YES. + +GENERATE_HTML = YES + +# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a +# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of +# it. +# The default directory is: html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_OUTPUT = html + +# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each +# generated HTML page (for example: .htm, .php, .asp). +# The default value is: .html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FILE_EXTENSION = .html + +# The HTML_HEADER tag can be used to specify a user-defined HTML header file for +# each generated HTML page. If the tag is left blank doxygen will generate a +# standard header. +# +# To get valid HTML the header file that includes any scripts and style sheets +# that doxygen needs, which is dependent on the configuration options used (e.g. +# the setting GENERATE_TREEVIEW). It is highly recommended to start with a +# default header using +# doxygen -w html new_header.html new_footer.html new_stylesheet.css +# YourConfigFile +# and then modify the file new_header.html. See also section "Doxygen usage" +# for information on how to generate the default header that doxygen normally +# uses. +# Note: The header is subject to change so you typically have to regenerate the +# default header when upgrading to a newer version of doxygen. For a description +# of the possible markers and block names see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_HEADER = + +# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each +# generated HTML page. If the tag is left blank doxygen will generate a standard +# footer. See HTML_HEADER for more information on how to generate a default +# footer and what special commands can be used inside the footer. See also +# section "Doxygen usage" for information on how to generate the default footer +# that doxygen normally uses. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FOOTER = + +# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style +# sheet that is used by each HTML page. It can be used to fine-tune the look of +# the HTML output. If left blank doxygen will generate a default style sheet. +# See also section "Doxygen usage" for information on how to generate the style +# sheet that doxygen normally uses. +# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as +# it is more robust and this tag (HTML_STYLESHEET) will in the future become +# obsolete. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_STYLESHEET = + +# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined +# cascading style sheets that are included after the standard style sheets +# created by doxygen. Using this option one can overrule certain style aspects. +# This is preferred over using HTML_STYLESHEET since it does not replace the +# standard style sheet and is therefore more robust against future updates. +# Doxygen will copy the style sheet files to the output directory. +# Note: The order of the extra style sheet files is of importance (e.g. the last +# style sheet in the list overrules the setting of the previous ones in the +# list). For an example see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_STYLESHEET = + +# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or +# other source files which should be copied to the HTML output directory. Note +# that these files will be copied to the base HTML output directory. Use the +# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these +# files. In the HTML_STYLESHEET file, use the file name only. Also note that the +# files will be copied as-is; there are no commands or markers available. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_FILES = + +# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen +# will adjust the colors in the style sheet and background images according to +# this color. Hue is specified as an angle on a colorwheel, see +# http://en.wikipedia.org/wiki/Hue for more information. For instance the value +# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 +# purple, and 360 is red again. +# Minimum value: 0, maximum value: 359, default value: 220. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_HUE = 220 + +# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors +# in the HTML output. For a value of 0 the output will use grayscales only. A +# value of 255 will produce the most vivid colors. +# Minimum value: 0, maximum value: 255, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_SAT = 100 + +# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the +# luminance component of the colors in the HTML output. Values below 100 +# gradually make the output lighter, whereas values above 100 make the output +# darker. The value divided by 100 is the actual gamma applied, so 80 represents +# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not +# change the gamma. +# Minimum value: 40, maximum value: 240, default value: 80. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_GAMMA = 80 + +# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML +# page will contain the date and time when the page was generated. Setting this +# to YES can help to show when doxygen was last run and thus if the +# documentation is up to date. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_TIMESTAMP = YES + +# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML +# documentation will contain sections that can be hidden and shown after the +# page has loaded. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_DYNAMIC_SECTIONS = NO + +# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries +# shown in the various tree structured indices initially; the user can expand +# and collapse entries dynamically later on. Doxygen will expand the tree to +# such a level that at most the specified number of entries are visible (unless +# a fully collapsed tree already exceeds this amount). So setting the number of +# entries 1 will produce a full collapsed tree by default. 0 is a special value +# representing an infinite number of entries and will result in a full expanded +# tree by default. +# Minimum value: 0, maximum value: 9999, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_INDEX_NUM_ENTRIES = 100 + +# If the GENERATE_DOCSET tag is set to YES, additional index files will be +# generated that can be used as input for Apple's Xcode 3 integrated development +# environment (see: http://developer.apple.com/tools/xcode/), introduced with +# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a +# Makefile in the HTML output directory. Running make will produce the docset in +# that directory and running make install will install the docset in +# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at +# startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html +# for more information. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_DOCSET = YES + +# This tag determines the name of the docset feed. A documentation feed provides +# an umbrella under which multiple documentation sets from a single provider +# (such as a company or product suite) can be grouped. +# The default value is: Doxygen generated docs. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_FEEDNAME = "Doxygen generated docs" + +# This tag specifies a string that should uniquely identify the documentation +# set bundle. This should be a reverse domain-name style string, e.g. +# com.mycompany.MyDocSet. Doxygen will append .docset to the name. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_BUNDLE_ID = com.Inria.MoReFEM + +# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify +# the documentation publisher. This should be a reverse domain-name style +# string, e.g. com.mycompany.MyDocSet.documentation. +# The default value is: org.doxygen.Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_ID = com.Inria.M3DISIM + +# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. +# The default value is: Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_NAME = M3DISIM + +# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three +# additional HTML index files: index.hhp, index.hhc, and index.hhk. The +# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop +# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on +# Windows. +# +# The HTML Help Workshop contains a compiler that can convert all HTML output +# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML +# files are now used as the Windows 98 help format, and will replace the old +# Windows help format (.hlp) on all Windows platforms in the future. Compressed +# HTML files also contain an index, a table of contents, and you can search for +# words in the documentation. The HTML workshop also contains a viewer for +# compressed HTML files. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_HTMLHELP = NO + +# The CHM_FILE tag can be used to specify the file name of the resulting .chm +# file. You can add a path in front of the file if the result should not be +# written to the html output directory. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_FILE = + +# The HHC_LOCATION tag can be used to specify the location (absolute path +# including file name) of the HTML help compiler (hhc.exe). If non-empty, +# doxygen will try to run the HTML help compiler on the generated index.hhp. +# The file has to be specified with full path. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +HHC_LOCATION = + +# The GENERATE_CHI flag controls if a separate .chi index file is generated +# (YES) or that it should be included in the master .chm file (NO). +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +GENERATE_CHI = NO + +# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) +# and project file content. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_INDEX_ENCODING = + +# The BINARY_TOC flag controls whether a binary table of contents is generated +# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it +# enables the Previous and Next buttons. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +BINARY_TOC = NO + +# The TOC_EXPAND flag can be set to YES to add extra items for group members to +# the table of contents of the HTML help documentation and to the tree view. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +TOC_EXPAND = NO + +# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and +# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that +# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help +# (.qch) of the generated HTML documentation. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_QHP = NO + +# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify +# the file name of the resulting .qch file. The path specified is relative to +# the HTML output folder. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QCH_FILE = + +# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help +# Project output. For more information please see Qt Help Project / Namespace +# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace). +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_NAMESPACE = org.doxygen.Project + +# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt +# Help Project output. For more information please see Qt Help Project / Virtual +# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual- +# folders). +# The default value is: doc. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_VIRTUAL_FOLDER = doc + +# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom +# filter to add. For more information please see Qt Help Project / Custom +# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- +# filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_NAME = + +# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the +# custom filter to add. For more information please see Qt Help Project / Custom +# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- +# filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_ATTRS = + +# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this +# project's filter section matches. Qt Help Project / Filter Attributes (see: +# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_SECT_FILTER_ATTRS = + +# The QHG_LOCATION tag can be used to specify the location of Qt's +# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the +# generated .qhp file. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHG_LOCATION = + +# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be +# generated, together with the HTML files, they form an Eclipse help plugin. To +# install this plugin and make it available under the help contents menu in +# Eclipse, the contents of the directory containing the HTML and XML files needs +# to be copied into the plugins directory of eclipse. The name of the directory +# within the plugins directory should be the same as the ECLIPSE_DOC_ID value. +# After copying Eclipse needs to be restarted before the help appears. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_ECLIPSEHELP = NO + +# A unique identifier for the Eclipse help plugin. When installing the plugin +# the directory name containing the HTML and XML files should also have this +# name. Each documentation set should have its own identifier. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. + +ECLIPSE_DOC_ID = org.doxygen.Project + +# If you want full control over the layout of the generated HTML pages it might +# be necessary to disable the index and replace it with your own. The +# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top +# of each HTML page. A value of NO enables the index and the value YES disables +# it. Since the tabs in the index contain the same information as the navigation +# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +DISABLE_INDEX = NO + +# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index +# structure should be generated to display hierarchical information. If the tag +# value is set to YES, a side panel will be generated containing a tree-like +# index structure (just like the one that is generated for HTML Help). For this +# to work a browser that supports JavaScript, DHTML, CSS and frames is required +# (i.e. any modern browser). Windows users are probably better off using the +# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can +# further fine-tune the look of the index. As an example, the default style +# sheet generated by doxygen has an example that shows how to put an image at +# the root of the tree instead of the PROJECT_NAME. Since the tree basically has +# the same information as the tab index, you could consider setting +# DISABLE_INDEX to YES when enabling this option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_TREEVIEW = NO + +# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that +# doxygen will group on one line in the generated HTML documentation. +# +# Note that a value of 0 will completely suppress the enum values from appearing +# in the overview section. +# Minimum value: 0, maximum value: 20, default value: 4. +# This tag requires that the tag GENERATE_HTML is set to YES. + +ENUM_VALUES_PER_LINE = 4 + +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used +# to set the initial width (in pixels) of the frame in which the tree is shown. +# Minimum value: 0, maximum value: 1500, default value: 250. +# This tag requires that the tag GENERATE_HTML is set to YES. + +TREEVIEW_WIDTH = 250 + +# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to +# external symbols imported via tag files in a separate window. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +EXT_LINKS_IN_WINDOW = NO + +# Use this tag to change the font size of LaTeX formulas included as images in +# the HTML documentation. When you change the font size after a successful +# doxygen run you need to manually remove any form_*.png images from the HTML +# output directory to force them to be regenerated. +# Minimum value: 8, maximum value: 50, default value: 10. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_FONTSIZE = 10 + +# Use the FORMULA_TRANPARENT tag to determine whether or not the images +# generated for formulas are transparent PNGs. Transparent PNGs are not +# supported properly for IE 6.0, but are supported on all modern browsers. +# +# Note that when changing this option you need to delete any form_*.png files in +# the HTML output directory before the changes have effect. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_TRANSPARENT = YES + +# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see +# http://www.mathjax.org) which uses client side Javascript for the rendering +# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX +# installed or if you want to formulas look prettier in the HTML output. When +# enabled you may also need to install MathJax separately and configure the path +# to it using the MATHJAX_RELPATH option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +USE_MATHJAX = NO + +# When MathJax is enabled you can set the default output format to be used for +# the MathJax output. See the MathJax site (see: +# http://docs.mathjax.org/en/latest/output.html) for more details. +# Possible values are: HTML-CSS (which is slower, but has the best +# compatibility), NativeMML (i.e. MathML) and SVG. +# The default value is: HTML-CSS. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_FORMAT = HTML-CSS + +# When MathJax is enabled you need to specify the location relative to the HTML +# output directory using the MATHJAX_RELPATH option. The destination directory +# should contain the MathJax.js script. For instance, if the mathjax directory +# is located at the same level as the HTML output directory, then +# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax +# Content Delivery Network so you can quickly see the result without installing +# MathJax. However, it is strongly recommended to install a local copy of +# MathJax from http://www.mathjax.org before deployment. +# The default value is: http://cdn.mathjax.org/mathjax/latest. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest + +# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax +# extension names that should be enabled during MathJax rendering. For example +# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_EXTENSIONS = + +# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces +# of code that will be used on startup of the MathJax code. See the MathJax site +# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an +# example see the documentation. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_CODEFILE = + +# When the SEARCHENGINE tag is enabled doxygen will generate a search box for +# the HTML output. The underlying search engine uses javascript and DHTML and +# should work on any modern browser. Note that when using HTML help +# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) +# there is already a search function so this one should typically be disabled. +# For large projects the javascript based search engine can be slow, then +# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to +# search using the keyboard; to jump to the search box use + S +# (what the is depends on the OS and browser, but it is typically +# , /