Commit 731b5c76 authored by GILLES Sebastien's avatar GILLES Sebastien
Browse files

#1443 Fix Doxygen comments.

parent 6b64730b
......@@ -7,6 +7,16 @@
*/
/*!
* \class doxygen_hide_god_of_dof_prepartitioned_data_param
*
* \param[in] god_of_dof_prepartitioned_data Lua file which gives the data needed to reconstruct the data related
* to \a GodOfDof from pre-computed partitioned data. Note: it is not const as such objects relies on a Lua stack which is modified for
* virtually each operation but it should not be considered as an output parameter.
*/
/// \addtogroup FiniteElementGroup
///@{
......
......@@ -442,10 +442,23 @@ namespace MoReFEM
/*!
* \brief Create all the dofs for each node bearer.
*
* \attention This method does NOT compute the indexes for each \a NumberingSubset (a subsequent call to
* \a ComputeProcessorWiseAndGhostDofIndexPerNumberingSubset will do so.
*
* Prerequisite: It is assumed the \a Dof were created first (it is done within \a CreateNodeList().
*/
void ComputeProcessorWiseAndGhostDofIndex();
// Make that more cleverly... or explain how it should be called!
/*!
* \brief Create all the dofs for each node bearer for each \a NumberingSubset.
*
* Prerequisite:
* -\a ComputeProcessorWiseAndGhostDofIndex() should have been called first.
* - It is assumed that the program-wise indexes per \a NumberingSubset are already properly attributed. In a normal run it already is (so you may
* call this immediately after \a ComputeProcessorWiseAndGhostDofIndex()) but for a run from prepartitioned data you will need first to
* reassign the indexes used in the original run.
*/
void ComputeProcessorWiseAndGhostDofIndexPerNumberingSubset();
......
......@@ -41,8 +41,6 @@ namespace MoReFEM
}
std::map<unsigned int, std::vector<unsigned int>>
ComputeDofIndexListPerFEltSpace(const FEltSpace::vector_unique_ptr& felt_space_list)
{
......
......@@ -133,7 +133,16 @@ namespace MoReFEM
public:
//! The static method which does the job.
/*!
* \brief The static method which does the job of the struct (which is a struct mostly to make friendship declaration easier).
*
* \copydoc doxygen_hide_god_of_dof_prepartitioned_data_param
* \param[in] processor_wise_dof_list List of processor-wise \a Dof for a given \a GodOfDof. When this method is called
* it is expected the \a Dof are already put back in the same ordering as in the original run and that their indexes not related to
* \a NumberingSubset are already properly set.
* \param[in] ghost_dof_list Same as \a processor_wise_dof_list for ghost \a Dof on the current mpi rank.
* \param[in] numbering_subset_list List of all \a NumberingSubset for which the indexes must be reassigned,
*/
static void Do(LuaOptionFile& god_of_dof_prepartitioned_data,
const Dof::vector_shared_ptr& processor_wise_dof_list,
const Dof::vector_shared_ptr& ghost_dof_list,
......@@ -141,6 +150,16 @@ namespace MoReFEM
private:
/*!
* \brief Helper method of \a Do which does the job for one given \a NumberingSubset.
*
* \param[in] numbering_subset The \a NumberingSubset which readsignment is under way.
* \param[in] dof_list One of the two \a Dof arguments given in \a Do() method (this method is called twice per
* \a NumberingSubset : once per list).
* \param[in,out] dof_index_it Iterator which progress in the list of indexes to assign (this list was read from the prepartition
* data file).
* \param[in] dof_index_end Iterator to the end of the list of indexes mentioned in \a dof_index_it.
*/
static void ReassignNumberingSubsetIndex(const NumberingSubset& numbering_subset,
const Dof::vector_shared_ptr& dof_list,
std::vector<unsigned int>::const_iterator& dof_index_it,
......
......@@ -106,7 +106,7 @@ namespace MoReFEM
/*!
* \brief Constructor.
*
* \param[in] node_bearer_ptr Pointer to the \a Node onto which the dof will be created.
* \param[in] node_ptr Pointer to the \a Node onto which the dof will be created.
*/
explicit Dof(const std::shared_ptr<const Node>& node_ptr);
......
......@@ -153,7 +153,7 @@ namespace MoReFEM
//! Return the list of numbering subset.
const NumberingSubset::vector_const_shared_ptr& GetNumberingSubsetList() const noexcept;
/* \brief Return a pointer to the \a NodeBearer to which the current \a Node belongs to.
/*! \brief Return a pointer to the \a NodeBearer to which the current \a Node belongs to.
*
* \internal <b><tt>[internal]</tt></b> No reference on purpose here: node_bearer_ is stored as a weak_ptr not
* to introduce circular dependancy.
......@@ -181,6 +181,7 @@ namespace MoReFEM
std::weak_ptr<const NodeBearer> node_bearer_;
# ifndef NDEBUG
//! This variable is initialized to true once \a Init() method has beenc called.
bool init_called_ = false;
# endif // NDEBUG
};
......
......@@ -74,6 +74,7 @@ namespace MoReFEM
inline std::shared_ptr<const NodeBearer> Node::GetNodeBearerFromWeakPtr() const
{
assert(init_called_ && "Init() should be called!");
assert(!node_bearer_.expired());
return node_bearer_.lock();
}
......
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