Commit f896837b authored by GILLES Sebastien's avatar GILLES Sebastien

#1443 Rename a GodOfDof method and improve its documentation.

parent 535bb8a6
......@@ -78,7 +78,7 @@ namespace MoReFEM
}
void GodOfDof::InitHelper_FEltSpace_Output(const FilesystemNS::Directory& output_directory,
void GodOfDof::BeginInitialization(const FilesystemNS::Directory& output_directory,
FEltSpace::vector_unique_ptr&& felt_space_list)
{
assert(!HasInitBeenCalled() && "Must be called only once per GodOfDof!");
......
......@@ -561,7 +561,12 @@ namespace MoReFEM
void Init3(const std::map<unsigned int, std::vector<unsigned int>>& dof_list_per_felt_space);
/*!
* \brief Init the output directories and the list of \a FEltSpace to consider.
* \brief First method to be called in an initialization process (\a Init()).
*
* This one:
* - Set the list of \a FEltSpace
* - Prepare the adequate output directories.
* - Set the list of \a NumberingSubset (through computation from the \a felt_space_list.
*
* \param[in] felt_space_list List of all \a FEltSpace to consider in the \a GodOfDof.
* \param[in] output_directory Output directory for data specific to the mesh covered by the \a GodOfDof.
......@@ -569,8 +574,8 @@ namespace MoReFEM
* <b>Prerequisite:</b> 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);
void BeginInitialization(const FilesystemNS::Directory& output_directory,
FEltSpace::vector_unique_ptr&& felt_space_list);
/*!
......
......@@ -27,7 +27,7 @@ namespace MoReFEM
DoConsiderProcessorWiseLocal2Global do_consider_proc_wise_local_2_global,
const FilesystemNS::Directory& output_directory)
{
InitHelper_FEltSpace_Output(output_directory, std::move(a_felt_space_list));
BeginInitialization(output_directory, std::move(a_felt_space_list));
if constexpr (!MoReFEMDataT::HasParallelismField())
{
......
......@@ -157,7 +157,7 @@ namespace MoReFEM::TestNS::LoadPrepartitionedGodOfDofNS
// The purpose here is truly to check the internal without incurring a new Lua file; in a proper model
// you should NEVER do what is done here (and requires anyway friendship to \a GodOfDof class).
{
reconstructed_god_of_dof.InitHelper_FEltSpace_Output(output_directory, std::move(felt_space_list));
reconstructed_god_of_dof.BeginInitialization(output_directory, std::move(felt_space_list));
#ifndef NDEBUG
reconstructed_god_of_dof.do_consider_proc_wise_local_2_global_ = DoConsiderProcessorWiseLocal2Global::yes;
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment