#1443 Rename CommonInit1 and document it.

Sources/FiniteElement/FiniteElementSpace/GodOfDof.cpp

@@ -78,8 +78,8 @@ namespace MoReFEM
     }
 
 
-    void GodOfDof::CommonInit1(const FilesystemNS::Directory& output_directory,
-                               FEltSpace::vector_unique_ptr&& felt_space_list)
+    void GodOfDof::InitHelper_FEltSpace_Output(const FilesystemNS::Directory& output_directory,
+                                               FEltSpace::vector_unique_ptr&& felt_space_list)
     {
         assert(!HasInitBeenCalled() && "Must be called only once per GodOfDof!");
 

Sources/FiniteElement/FiniteElementSpace/GodOfDof.hpp

@@ -552,6 +552,20 @@ namespace MoReFEM
                    const std::map<unsigned int, std::vector<unsigned int>>& dof_list_per_felt_space,
                    const Internal::Parallelism* parallelism);
 
+        /*!
+         * \brief Init the output directories and the list of \a FEltSpace to consider.
+         *
+         * \param[in] felt_space_list List of all \a FEltSpace to consider in the \a GodOfDof.
+         * \copydetails doxygen_hide_do_consider_processor_wise_local_2_global
+         * \param[in] output_directory Output directory for data specific to the mesh covered by the \a GodOfDof.
+         *
+         * Prerequisite: none - this method can be called at the very beginning of the initialization process.
+         */
+
+        void InitHelper_FEltSpace_Output(const FilesystemNS::Directory& output_directory,
+                                         FEltSpace::vector_unique_ptr&& felt_space_list);
+
+
 
         // ============================
         //! \cond IGNORE_BLOCK_IN_DOXYGEN
@@ -575,9 +589,7 @@ namespace MoReFEM
                                   DoConsiderProcessorWiseLocal2Global do_consider_proc_wise_local_2_global,
                                   const Internal::Parallelism* parallelism);
 
-        void CommonInit1(const FilesystemNS::Directory& output_directory,
-                         FEltSpace::vector_unique_ptr&& felt_space_list);
-
+     
 
 
 

Sources/FiniteElement/FiniteElementSpace/GodOfDof.hxx

@@ -27,7 +27,7 @@ namespace MoReFEM
                         DoConsiderProcessorWiseLocal2Global do_consider_proc_wise_local_2_global,
                         const FilesystemNS::Directory& output_directory)
     {
-        CommonInit1(output_directory, std::move(a_felt_space_list));
+        InitHelper_FEltSpace_Output(output_directory, std::move(a_felt_space_list));
 
         if constexpr (!MoReFEMDataT::HasParallelismField())
         {
@@ -106,7 +106,7 @@ namespace MoReFEM
                                             DoConsiderProcessorWiseLocal2Global do_consider_processor_wise_local_2_global,
                                             const FilesystemNS::Directory& output_directory)
     {
-        CommonInit1(output_directory, std::move(felt_space_list));
+        InitHelper_FEltSpace_Output(output_directory, std::move(felt_space_list));
 
         PreprocessInitHelper(morefem_data,
                              do_consider_processor_wise_local_2_global);

Sources/FiniteElement/FiniteElementSpace/TwoStepsParallelism.cpp

@@ -275,7 +275,7 @@ namespace MoReFEM
                                             DoConsiderProcessorWiseLocal2Global do_consider_processor_wise_local_2_global,
                                             const Internal::Parallelism* parallelism)
     {
-        CommonInit1(output_directory, std::move(felt_space_list));
+        InitHelper_FEltSpace_Output(output_directory, std::move(felt_space_list));
 
         #ifndef NDEBUG
         do_consider_proc_wise_local_2_global_ = do_consider_processor_wise_local_2_global;