Commit d958e490 authored by GILLES Sebastien's avatar GILLES Sebastien
Browse files

#9 Clean all Geometry-related Doxygen warnings.

parent c7d6cb36
......@@ -61,9 +61,11 @@ namespace HappyHeart
* \brief Constructor from a vector.
*
* T is expected to be std::vector<double>.
* \param[in] coordinates_as_double Value for each component of the object to build. Contrary to \a Coords,
* a \LocalCoords may encompass 1, 2 or 3 components.
*/
template<class T>
explicit LocalCoords(T&& coor);
explicit LocalCoords(T&& coordinates_as_double);
//! Constructor from an initializer list.
LocalCoords(std::initializer_list<double>&& coor);
......@@ -152,17 +154,26 @@ namespace HappyHeart
*
* It is assumed here (and asserted in debug) that all LocalCoords are the same dimension.
*
* \tparam ContainerT A contained to enclose several LocalCoords objects. Typically a std::vector<Advanced::LocalCoords>
* or std::array<LocalCoords, ...>.
* \param[in] coords_list List of \a Coords for which center of gravity is sought.
*
* \tparam ContainerT A contained to enclose several LocalCoords objects. Typically a
* std::vector<Advanced::LocalCoords> or std::array<LocalCoords, ...>.
*
* \return Computed center of gravity.
*/
template<class ContainerT>
LocalCoords ComputeCenterOfGravity(const ContainerT& coords_list);
/*!
* \brief Find how many components differ between two LocalCoords, and returns their index.
*
* \copydoc doxygen_hide_lhs_rhs_arg
*
* \return Indexes of the mismatched components. For instance if (0., 1., 0.) and (0., 4., 0.) are considered in
* \a coords_list, return {1}.
*/
std::vector<unsigned int> ExtractMismatchedComponentIndexes(const Advanced::LocalCoords& coords1,
const Advanced::LocalCoords& coords2);
std::vector<unsigned int> ExtractMismatchedComponentIndexes(const Advanced::LocalCoords& lhs,
const Advanced::LocalCoords& rhs);
/*!
......@@ -172,15 +183,24 @@ namespace HappyHeart
* vary inside an edge of a reference topology element that is quadrangular of hexahedronal.
*
* There is an assert here that requires only one value fits the bill.
*
* \copydoc doxygen_hide_lhs_rhs_arg
*
* \return Position of the mismatched component (unique by design of this function; if not the call was improper).
*/
unsigned int ExtractMismatchedComponentIndex(const Advanced::LocalCoords& coords1,
const Advanced::LocalCoords& coords2);
unsigned int ExtractMismatchedComponentIndex(const Advanced::LocalCoords& lhs,
const Advanced::LocalCoords& rhs);
/*!
* \brief Find how many components are identical for each of the input LocalCoords, and returns their index.
*
* \param[in] coords_list List of \a Coords under investigation.
*
* \return Indexes of the components that are equal. For instance if (0, 1, 0) and (0, 4, 0) are considered in
* \a coords_list, return (0, 2).
*/
std::vector<unsigned int> ExtractIdenticalComponentIndexes(const std::vector<Advanced::LocalCoords>& coords);
std::vector<unsigned int> ExtractIdenticalComponentIndexes(const std::vector<Advanced::LocalCoords>& coords_list);
/*!
......@@ -188,8 +208,10 @@ namespace HappyHeart
*
*
* There is an assert here that requires only one value fits the bill.
* \param[in] coords_list List of \a Coords under investigation.
* \return Key is the position of the identical component (assumed to be unique) and the value is its value.
*/
std::pair<unsigned int, double> ExtractIdenticalComponentIndex(const std::vector<Advanced::LocalCoords>& coords);
std::pair<unsigned int, double> ExtractIdenticalComponentIndex(const std::vector<Advanced::LocalCoords>& coords_list);
} // namespace Advanced
......
......@@ -106,6 +106,7 @@ namespace HappyHeart
* \tparam T Must be std::array<Floating-point type, 3>.
*
* \param[in] value Value of the array to set.
* \copydoc doxygen_hide_space_unit_arg
*/
template<typename T>
explicit Coords(T&& value, const double space_unit);
......@@ -118,6 +119,7 @@ namespace HappyHeart
* \param[in,out] stream Stream from which the point is read. Coordinates are expected to be separated by tabs
* or spaces.
* Stream is read until failbit is met; then it is put back at the position just before that failure.
* \copydoc doxygen_hide_space_unit_arg
*/
explicit Coords(unsigned int Ncoor, std::istream& stream, const double space_unit);
......@@ -203,6 +205,8 @@ namespace HappyHeart
*
* \tparam MpiScaleT If processor-wise, the position after mpi reduction is given. If program-wise, the one
* before is yielded.
*
* \return Position of the \a Coords in the mesh list.
*/
template<MpiScale MpiScaleT>
unsigned int GetPositionInCoordsListInMesh() const noexcept;
......@@ -220,6 +224,8 @@ namespace HappyHeart
*
* \tparam MpiScaleT If processor-wise, the position after mpi reduction is given. If program-wise, the one
* before is yielded.
*
* \param[in] position Position of the \a Coords in the mesh list.
*/
template<MpiScale MpiScaleT>
void SetPositionInCoordsListInMesh(unsigned int position) noexcept;
......@@ -253,7 +259,7 @@ namespace HappyHeart
MeshLabel::const_shared_ptr mesh_label_ = nullptr;
//! Friendship.
friend double Distance(const Coords& point1, const Coords& point2);
friend double Distance(const Coords& lhs, const Coords& rhs);
//! Location of the Coords (on edge, on face...). May be InterfaceNS::Nature::undefined.
InterfaceNS::Nature interface_nature_ = InterfaceNS::Nature::undefined;
......@@ -282,8 +288,12 @@ namespace HappyHeart
/*!
* \brief Calculates the distance between two points, using a L2 norm.
*
* \copydoc doxygen_hide_lhs_rhs_arg
*
* \return Distance between two points following L2 norm.
*/
double Distance(const Coords& point1, const Coords& point2);
double Distance(const Coords& lhs, const Coords& rhs);
/*!
......
......@@ -118,6 +118,8 @@ namespace HappyHeart
*
* Key is the identifier of the mesh.
* Value if the number of volumes built so far for each mesh.
*
* \return Number of \a Volume interfaces built for each mesh (represented here by their unique identifiers).
*/
static std::map<unsigned int, unsigned int>& NvolumePerMesh();
......
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