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

#9 More Doxygen doc added.

parent d3ac718b
......@@ -4178,6 +4178,7 @@
BE2801E81C7F17C300FD01BC /* InvariantManager.cpp */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.cpp; path = InvariantManager.cpp; sourceTree = "<group>"; };
BE2801E91C7F17C300FD01BC /* InvariantManager.hpp */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.h; path = InvariantManager.hpp; sourceTree = "<group>"; };
BE2801EA1C7F17C300FD01BC /* InvariantManager.hxx */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.h; path = InvariantManager.hxx; sourceTree = "<group>"; };
BE2836601CA49390003E62CE /* Component.doxygen */ = {isa = PBXFileReference; explicitFileType = sourcecode.cpp.h; fileEncoding = 4; path = Component.doxygen; sourceTree = "<group>"; };
BE2B65FE1A2778C700E80864 /* BasicRefFElt.cpp */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.cpp; path = BasicRefFElt.cpp; sourceTree = "<group>"; };
BE2B65FF1A2778C700E80864 /* BasicRefFElt.hpp */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.h; path = BasicRefFElt.hpp; sourceTree = "<group>"; };
BE2B66001A2778C700E80864 /* BasicRefFElt.hxx */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.h; path = BasicRefFElt.hxx; sourceTree = "<group>"; };
......@@ -8946,6 +8947,7 @@
BEBEB1B919C8445300E4EA1D /* Component */ = {
isa = PBXGroup;
children = (
BE2836601CA49390003E62CE /* Component.doxygen */,
BEBEB1BA19C8445300E4EA1D /* Comp1.cpp */,
BEBEB1BB19C8445300E4EA1D /* Comp1.hpp */,
BEBEB1BC19C8445300E4EA1D /* Comp12.cpp */,
......
......@@ -37,7 +37,7 @@ namespace HappyHeart
//! Alias to unique_ptr.
using unique_ptr = std::unique_ptr<TimeManagerInstance>;
///! \name Special members.
/// \name Special members.
///@{
//! Constructor.
......
......@@ -44,16 +44,13 @@ namespace HappyHeart
/*!
* \brief Return the name of the component.
*
* This name will for instance what will be expected in the input parameter file to set the properties
* of the displacement.
* \copydoc doxygen_hide_component_static_name_method
*/
static std::string Name() { return "Comp1"; }
/*!
* \brief Tells whether each component is activated.
* \copydoc doxygen_hide_component_static_is_activated_method
*/
static std::bitset<3> IsActivated() { return std::bitset<3>("001"); }
......
......@@ -44,16 +44,13 @@ namespace HappyHeart
/*!
* \brief Return the name of the component.
*
* This name will for instance what will be expected in the input parameter file to set the properties
* of the displacement.
* \copydoc doxygen_hide_component_static_name_method
*/
static std::string Name() { return "Comp12"; }
/*!
* \brief Tells whether each component is activated.
* \copydoc doxygen_hide_component_static_is_activated_method
*/
static std::bitset<3> IsActivated() { return std::bitset<3>("011"); }
......
......@@ -44,16 +44,13 @@ namespace HappyHeart
/*!
* \brief Return the name of the component.
*
* This name will for instance what will be expected in the input parameter file to set the properties
* of the displacement.
* \copydoc doxygen_hide_component_static_name_method
*/
static std::string Name() { return "Comp123"; }
/*!
* \brief Tells whether each component is activated.
* \copydoc doxygen_hide_component_static_is_activated_method
*/
static std::bitset<3> IsActivated() { return std::bitset<3>("111"); }
......
......@@ -45,16 +45,13 @@ namespace HappyHeart
/*!
* \brief Return the name of the component.
*
* This name will for instance what will be expected in the input parameter file to set the properties
* of the displacement.
* \copydoc doxygen_hide_component_static_name_method
*/
static std::string Name() { return "Comp13"; }
/*!
* \brief Tells whether each component is activated.
* \copydoc doxygen_hide_component_static_is_activated_method
*/
static std::bitset<3> IsActivated() { return std::bitset<3>("101"); }
......
......@@ -45,16 +45,13 @@ namespace HappyHeart
/*!
* \brief Return the name of the component.
*
* This name will for instance what will be expected in the input parameter file to set the properties
* of the displacement.
* \copydoc doxygen_hide_component_static_name_method
*/
static std::string Name() { return "Comp2"; }
/*!
* \brief Tells whether each component is activated.
* \copydoc doxygen_hide_component_static_is_activated_method
*/
static std::bitset<3> IsActivated() { return std::bitset<3>("010"); }
......
......@@ -46,16 +46,13 @@ namespace HappyHeart
/*!
* \brief Return the name of the component.
*
* This name will for instance what will be expected in the input parameter file to set the properties
* of the displacement.
* \copydoc doxygen_hide_component_static_name_method
*/
static std::string Name() { return "Comp23"; }
/*!
* \brief Tells whether each component is activated.
* \copydoc doxygen_hide_component_static_is_activated_method
*/
static std::bitset<3> IsActivated() { return std::bitset<3>("110"); }
......
......@@ -46,16 +46,13 @@ namespace HappyHeart
/*!
* \brief Return the name of the component.
*
* This name will for instance what will be expected in the input parameter file to set the properties
* of the displacement.
* \copydoc doxygen_hide_component_static_name_method
*/
static std::string Name() { return "Comp3"; }
/*!
* \brief Tells whether each component is activated.
* \copydoc doxygen_hide_component_static_is_activated_method
*/
static std::bitset<3> IsActivated() { return std::bitset<3>("100"); }
......
......@@ -46,16 +46,13 @@ namespace HappyHeart
/*!
* \brief Return the name of the component.
*
* This name will for instance what will be expected in the input parameter file to set the properties
* of the displacement.
* \copydoc doxygen_hide_component_static_name_method
*/
static std::string Name() { return "CompNA"; }
/*!
* \brief Tells whether each component is activated.
* \copydoc doxygen_hide_component_static_is_activated_method
*/
static std::bitset<3> IsActivated() { return std::bitset<3>("000"); }
......
/*!
* \class doxygen_hide_component_static_name_method
*
* \brief Return the name of the component.
*
* This name will for instance what will be expected in the input parameter file to set the properties
* of the displacement.
*
* \return Name of the component.
*/
/*!
* \class doxygen_hide_component_static_is_activated_method
*
* \brief Bitset which specifies which component is active or not.
*
* \warning Be really careful as bitset constructor from is not exactly intuitive...
*
* \return Bitset which specifies which component is active or not.
*/
\ No newline at end of file
......@@ -238,6 +238,11 @@ namespace HappyHeart
* \brief Add a new finite element and returns a non-constant reference to it.
*
* \internal <b><tt>[internal]</tt></b> This method should only be called within friend CreateNodeListHelper.
*
* \param[in] ref_felt Description of a reference finite element associated to an \a Unknown, a \a NumberingSubset
* and a \a RefGeomElt.
*
* \return Reference to the newly created \a FElt.
*/
FElt& AddFElt(const RefFEltNS::Private::RefFEltInFEltSpace& ref_felt);
......
......@@ -65,6 +65,7 @@ namespace HappyHeart
* (e.g. 'displacement', 'pressure'). It is here an extended unknown because when it is created it is
* within a given numbering subset, however it's important to remember a given Node might be related to many
* numbering subsets in the end (some may be added through \a RegisterNumberingSubset().
* \param[in] node_bearer_ptr Pointer to the node bearer onto which the \a Node is created.
* \param[in] Ndof Number of dofs to create.
*/
explicit Node(const std::shared_ptr<const NodeBearer>& node_bearer_ptr,
......
......@@ -48,13 +48,13 @@ namespace HappyHeart
Node::shared_ptr NodeBearer::AddNode(const ExtendedUnknown& extended_unknown,
const unsigned int Ncomponent)
const unsigned int Ndof)
{
assert(Ncomponent > 0);
auto&& node_ptr = std::make_shared<Node>(shared_from_this(),
extended_unknown,
Ncomponent);
Ndof);
node_list_.push_back(node_ptr);
......
......@@ -149,7 +149,12 @@ namespace HappyHeart
/*!
* \brief Returns the list of Nodes matching the given unknown.
*
* \internal <b><tt>[internal]</tt></b> This method is expected to be used only in init phase, hence the brutal return by value of a vector.
* \internal <b><tt>[internal]</tt></b> This method is expected to be used only in init phase, hence the brutal
* return by value of a vector.
*
* \param[in] unknown Unknown for which the list of \a Node is sought.
*
* \return List of nodes related to \a unknown.
*/
Node::vector_shared_ptr GetNodeList(const Unknown& unknown) const;
......@@ -192,11 +197,16 @@ namespace HappyHeart
/*!
* \brief Add a new node.
*
* \internal <b><tt>[internal]</tt></b> It is assumed here the node does not exist yet; such liabilities are handled by the class in charge
* of actually calling such methods (\a CreateNodeListHelper).
* \internal <b><tt>[internal]</tt></b> It is assumed here the node does not exist yet; such liabilities are
* handled by the class in charge of actually calling such methods (\a CreateNodeListHelper).
*
* \param[in] extended_unknown Couple \a Unknown / \a Numbering subset for which the node is/are created.
* \param[in] Ndof Number of dofs to create on the node.
*
* \return Node newly created.
*/
Node::shared_ptr AddNode(const ExtendedUnknown& extended_unknown,
unsigned int Ncomponent);
unsigned int Ndof);
private:
......
......@@ -43,16 +43,44 @@ namespace HappyHeart
public:
/*!
* \class doxygen_hide_quadrature_rule_constructor_args
*
* \param[in] topology_id Topology identifier.
* \param[in] degree_of_exactness Degree of exactness of the rule.
*/
/*!
* \class doxygen_hide_quadrature_rule_constructor_name_arg
*
* \param[in] name Name of the quadrature rule.
*/
///! \name Constructors and destructor.
/// \name Constructors and destructor.
///@{
//! Constructor.
/*!
* Constructor.
*
* \copydetails doxygen_hide_quadrature_rule_constructor_args
* \copydetails doxygen_hide_quadrature_rule_constructor_name_arg
* \param[in] point_list List of quadrature points.
*/
explicit QuadratureRule(std::string&& name,
QuadraturePoint::vector_const_shared_ptr&& point_list,
GeoRefNS::TopologyNS::Type topology_id,
unsigned int degree_of_exactness);
//! Constructor.
/*!
* Constructor.
*
* In this overload, quadrature points aren't yet defined and must be added afterwards through
* \a AddQuadraturePoint() method.
*
* \copydetails doxygen_hide_quadrature_rule_constructor_args
* \copydetails doxygen_hide_quadrature_rule_constructor_name_arg
*/
explicit QuadratureRule(std::string&& name,
GeoRefNS::TopologyNS::Type topology_id,
unsigned int degree_of_exactness);
......@@ -64,7 +92,7 @@ namespace HappyHeart
*
* Should be used solely to ease definition of sorting functions.
*
* \param[in] degree_of_exactness Degree of exactness of the rule.
* \copydetails doxygen_hide_quadrature_rule_constructor_args
*
* \code
*
......@@ -80,7 +108,7 @@ namespace HappyHeart
*
* \endcode
*/
explicit QuadratureRule(GeoRefNS::TopologyNS::Type geom_elt_id,
explicit QuadratureRule(GeoRefNS::TopologyNS::Type topology_id,
unsigned int degree_of_exactness);
//! Destructor.
......@@ -106,6 +134,9 @@ namespace HappyHeart
* \brief Add a new quadrature point.
*
* The quadrature point is created inside the function from \a local_coords and \a weight.
*
* \param[in] local_coords Local coordinates of the quadrature point to create.
* \param[in] weight Weight of the quadrature point to create.
*/
void AddQuadraturePoint(LocalCoords&& local_coords, double weight);
......
......@@ -31,15 +31,16 @@ namespace HappyHeart
/*!
* \brief RefFEltInFEltSpace is the description of a finite element related to a specific RefGeomElt, a specific Unknown
* and a numbering subset.
* \brief RefFEltInFEltSpace is the description of a finite element related to a specific RefGeomElt,
* a specific Unknown and a numbering subset.
*
* For instance, RefFEltInFEltSpace could describe the tuple ('Triangle3', 'Scalar unknown', 'numbering subset 1').
* For instance, RefFEltInFEltSpace could describe the tuple ('Triangle3', 'Scalar unknown',
* 'numbering subset 1').
*
* \internal <b><tt>[internal]</tt></b> This class is intended to work within the FEltSpace and should be manipulated by a library
* developer; it basically enrich the BasicRefFElt with some data related to a FEltSpace. What a developer
* should rather use is a RefFEltInLocalOperator, which is built upon current class and adds several
* data related to the operator in which it is intended to be used.
* \internal <b><tt>[internal]</tt></b> This class is intended to work within the FEltSpace and should be
* manipulated by a library developer; it basically enrich the BasicRefFElt with some data related to a
* \a FEltSpace. What a developer should rather use is a RefFEltInLocalOperator, which is built upon
* current class and adds several data related to the operator in which it is intended to be used.
*
*/
class RefFEltInFEltSpace final
......
......@@ -134,10 +134,13 @@ namespace HappyHeart
public:
/*!
* \brief Return the (contiguous) list of node indexes related to RefFEltInFEltSpace in ElementaryData matrices or vectors.
* \brief Return the (contiguous) list of node indexes related to RefFEltInFEltSpace in ElementaryData matrices
* or vectors.
*
* Please treat this method as private and not use it: no class should required this save ElementaryDataImpl
* and the few free-functions that are used to build it.
*
* \return Reference to the list of local node indexes.
*/
const Seldon::Vector<int>& GetLocalNodeIndexList() const noexcept;
......@@ -147,6 +150,10 @@ namespace HappyHeart
*
* Please treat this method as private and not use it: no class should required this save ElementaryDataImpl
* and the few free-functions that are used to build it.
*
* \param[in] component_index Index of the component for which the list is sought.
*
* \return Reference to the list of local node indexes associated to \a component_index -th component.
*/
const Seldon::Vector<int>& GetLocalDofIndexList(unsigned int component_index) const noexcept;
......@@ -156,6 +163,8 @@ namespace HappyHeart
*
* Please treat this method as private and not use it: no class should required this save ElementaryDataImpl
* and the few free-functions that are used to build it.
*
* \return Reference to the list of local dof indexes.
*/
const Seldon::Vector<int>& GetLocalDofIndexList() const noexcept;
......
......@@ -24,6 +24,9 @@ namespace HappyHeart
{
/*!
* \brief Identifier of the topology.
*/
enum class Type
{
point,
......
......@@ -54,7 +54,7 @@ namespace HappyHeart
//! Vector of smart pointers.
using vector_const_shared_ptr = std::vector<const_shared_ptr>;
///! \name Special members.
/// \name Special members.
///@{
/*!
......
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