Skip to content

GitLab

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

#9 Fix more Doxygen comments.

parent c5eb905c
Hide whitespace changes
Inline Side-by-side
HappyHeart.xcodeproj/project.pbxproj
View file @ d81cf844
......@@ -6436,6 +6436,7 @@
BEC526FA1CC58462000E9027 /* CoordIndexes.cpp */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.cpp; path = CoordIndexes.cpp; sourceTree = "<group>"; };
BEC526FB1CC58462000E9027 /* CoordIndexes.hpp */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.h; path = CoordIndexes.hpp; sourceTree = "<group>"; };
BEC526FC1CC58462000E9027 /* CoordIndexes.hxx */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.h; path = CoordIndexes.hxx; sourceTree = "<group>"; };
BEC77E361DDCAEFF00F8B444 /* ConformOperator.doxygen */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text; path = ConformOperator.doxygen; sourceTree = "<group>"; };
BECA4B941B1756DE00DC7265 /* libOperators.a */ = {isa = PBXFileReference; explicitFileType = archive.ar; includeInIndex = 0; path = libOperators.a; sourceTree = BUILT_PRODUCTS_DIR; };
BECA4CC81B1758B700DC7265 /* Enum.hpp */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.h; name = Enum.hpp; path = Sources/Operators/Enum.hpp; sourceTree = "<group>"; };
BECA4CCA1B1758B700DC7265 /* GlobalVariationalOperator.hpp */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.h; lineEnding = 0; path = GlobalVariationalOperator.hpp; sourceTree = "<group>"; xcLanguageSpecificationIdentifier = xcode.lang.cpp; };
......@@ -8508,6 +8509,7 @@
BE1ABAEA1B9DC9C500A7DBD8 /* ConformInterpolator */ = {
isa = PBXGroup;
children = (
BEC77E361DDCAEFF00F8B444 /* ConformOperator.doxygen */,
BEF1941B1BAAED830081602C /* Lagrangian */,
BEF1941A1BAAE6F60081602C /* Crtp */,
BECC34A51DCBA76400597517 /* Advanced */,
Sources/OperatorInstances/ConformInterpolator/Internal/P1_to_Phigher.hpp
View file @ d81cf844
......@@ -44,6 +44,7 @@ namespace HappyHeart
{
private:
//! Convenient alias.
using parent = LagrangianNS::LagrangianInterpolator
<
P1_to_Phigher<LocalInterpolatorT>,
......
Sources/OperatorInstances/ConformInterpolator/Local/Internal/Phigher_to_P1.hpp
View file @ d81cf844
......@@ -28,6 +28,9 @@ namespace HappyHeart
{
/*!
* \brief Local interpolator from P{n} to P1 when N > 1.
*/
class Phigher_to_P1 : public LagrangianNS::LocalLagrangianInterpolator
{
......@@ -53,7 +56,13 @@ namespace HappyHeart
/// \name Special members.
///@{
//! Constructor.
/*!
* \brief Constructor.
*
* \param[in] source_felt_space \a FEltSpace of the source.
* \param[in] target_ref_local_felt_space \a RefLocalFEltSpace considered for the target.
* \copydoc doxygen_conform_interpolator_interpolation_data_arg
*/
explicit Phigher_to_P1(const FEltSpace& source_felt_space,
const Internal::RefFEltNS::RefLocalFEltSpace& target_ref_local_felt_space,
const Advanced::ConformInterpolatorNS::InterpolationData& interpolation_data);
......
Sources/OperatorInstances/ConformInterpolator/Local/P1_to_P1b.hpp
View file @ d81cf844
......@@ -59,7 +59,7 @@ namespace HappyHeart
*
* \param[in] source_felt_space \a FEltSpace with the P1 unknown.
* \param[in] target_ref_local_felt_space \a RefLocalFEltSpace for the P1b unknown.
* \param[in] interpolation_data Convenient class with source and target data required to build
* \copydoc doxygen_conform_interpolator_interpolation_data_arg
* the interpolator.
*/
explicit P1_to_P1b(const FEltSpace& source_felt_space,
......
Sources/OperatorInstances/ConformInterpolator/Local/P1_to_P2.hpp
View file @ d81cf844
......@@ -27,6 +27,9 @@ namespace HappyHeart
{
/*!
* \brief Local operator to interpolate from P1 to P2.
*/
class P1_to_P2 : public LagrangianNS::LocalLagrangianInterpolator
{
private:
......
Sources/OperatorInstances/ConformInterpolator/SubsetOrSuperset.hpp
View file @ d81cf844
......@@ -25,6 +25,11 @@ namespace HappyHeart
{
/*!
* \brief Interpolate from a (\a FEltSpace, \a NumberingSubset) to either a larger or smaller target.
*
* Target must be either a subset or a superset of source.
*/
class SubsetOrSuperset final : public Crtp::LagrangianInterpolator<SubsetOrSuperset>
{
......@@ -50,7 +55,14 @@ namespace HappyHeart
/// \name Special members.
///@{
//! Constructor.
/*!
* \brief Constructor.
*
* \param[in] source_felt_space \a FEltSpace of the source.
* \param[in] source_numbering_subset \a NumberingSubset of the source.
* \param[in] target_felt_space \a FEltSpace of the target.
* \param[in] target_numbering_subset \a NumberingSubset of the target.
*/
explicit SubsetOrSuperset(const FEltSpace& source_felt_space,
const NumberingSubset& source_numbering_subset,
const FEltSpace& target_felt_space,
......
Sources/OperatorInstances/NonConformInterpolator/FromVertexMatching.hpp
View file @ d81cf844
......@@ -62,6 +62,7 @@ namespace HappyHeart
namespace NonConformInterpolatorNS
{
//! Convenient alias to pairing.
using pairing_type = Advanced::ConformInterpolatorNS::pairing_type;
......@@ -139,6 +140,8 @@ namespace HappyHeart
/*!
* \brief Construct the object. Should not be called outside of constructor.
*
* \param[in] vertex_matching Object which holds information about the \a geometric matching between both
* meshes.
* \copydetails doxygen_hide_from_vertex_matching_constructor_arg
*/
void Construct(const MeshNS::InterpolationNS::VertexMatching& vertex_matching,
......
Sources/Operators/ConformInterpolator/Advanced/SourceOrTargetData.hpp
View file @ d81cf844
......@@ -97,6 +97,13 @@ namespace HappyHeart
/// \name Special members.
///@{
/*!
* \class doxygen_hide_conform_interpolation_pairing_arg
*
* \param[in] pairing The list of pair source unknown/target unknown to consider. Depending on \a type,
* only either the first or the second element of each pair is actually considered in this class.
*/
/*!
* \brief Constructor.
......@@ -105,8 +112,7 @@ namespace HappyHeart
*
* \param[in] felt_space \a FEltSpace considered.
* \param[in] numbering_subset \a NumberingSubset considered.
* \param[in] pairing The list of pair source unknown/target unknown to consider. Depending on \a type,
* only either the first or the second element of each pair is actually considered in this class.
* \copydoc doxygen_hide_conform_interpolation_pairing_arg
* \param[in] type Whether the instantiated object deals with source or target data.
*
*/
......@@ -153,7 +159,9 @@ namespace HappyHeart
* extended unknowns of a given side source/target are expected to share the same numbering subset
* and shape function label.
*
* \param[in] ref_local_felt_pace \a RefLocalFEltSpace for which the \a BasicRefFElt is sought.
* \param[in] ref_local_felt_space \a RefLocalFEltSpace for which the \a BasicRefFElt is sought.
*
* \return \a BasicRefFElt matching the \a ref_local_felt_space.
*/
const Internal::RefFEltNS::BasicRefFElt&
GetCommonBasicRefFElt(const Internal::RefFEltNS::RefLocalFEltSpace& ref_local_felt_space) const;
......
Sources/Operators/ConformInterpolator/ConformOperator.doxygen 0 → 100644
View file @ d81cf844
/*!
* \class doxygen_conform_interpolator_interpolation_data_arg
*
* \param[in] interpolation_data Convenient class with source and target data required to build
* the interpolator.
*/
Sources/Operators/ConformInterpolator/Crtp/LagrangianInterpolator.hpp
View file @ d81cf844
......@@ -144,12 +144,13 @@ namespace HappyHeart
//! List of nodes eligible for boundary conditions.
NodeBearer::vector_shared_ptr node_for_boundary_condition_;
//! Object which stores most relevant data to actually perform the interpolation.
Advanced::ConformInterpolatorNS::InterpolationData::unique_ptr interpolation_data_ = nullptr;
//! Global matrix used for the interpolation.
GlobalMatrix::unique_ptr interpolation_matrix_ = nullptr;
//! The list of pair source unknown/target unknown to consider.
pairing_type pairing_;
......
Sources/Operators/ConformInterpolator/Lagrangian/LocalLagrangianInterpolator.hpp
View file @ d81cf844
......@@ -108,8 +108,7 @@ namespace HappyHeart
* \brief Constructor.
*
* \param[in] ref_geom_elt Reference geometric element being considered.
* \param[in] interpolation_data Helper objects which knows the source and target quantities required
* to actually perform the computation.
* \copydoc doxygen_conform_interpolator_interpolation_data_arg
*
*/
......@@ -135,28 +134,38 @@ namespace HappyHeart
///@}
//! Local projection matrix.
const LocalMatrix& GetProjectionMatrix() const noexcept;
//! Accessor to the RefGeomElt handled by current local operator.
const RefGeomElt& GetRefGeomElt() const noexcept;
protected:
//! Accessor to the local projection matrix.
LocalMatrix& GetNonCstProjectionMatrix() noexcept;
/*!
* \brief Get the \a RefLocalFEltSpace matching the given arguments.
*
* \param[in] felt_space \a FEltSpace considered.
* \param[in] ref_geom_elt \a RefGeomElt considered.
*
* \return \a RefLocalFEltSpace matching both arguments.
*/
const Internal::RefFEltNS::RefLocalFEltSpace& GetRefLocalFEltSpace(const FEltSpace& felt_space,
const RefGeomElt& ref_geom_elt) const;
//! Accessor to the object holding relevant interpolation data.
const Advanced::ConformInterpolatorNS::InterpolationData& GetInterpolationData() const noexcept;
/*!
* \brief Once the content for the matrix (Nnode_in_row, Nnode_in_col) has been computed, copy it
* as a block for all relevant components.
*
* \param[in] node_block Matrix which content should be reported as a block in larger matrix.
*/
void FillMatrixFromNodeBlock(LocalMatrix&& node_block);
......@@ -166,6 +175,7 @@ namespace HappyHeart
//! RefGeomElt handled by current local operator.
const RefGeomElt& ref_geom_elt_;
//! Convenient object which stores data relevant for interpolation.
const Advanced::ConformInterpolatorNS::InterpolationData& interpolation_data_;
//! Local matrix.
......
Sources/Operators/Miscellaneous/MatchDofInNumberingSubset.hpp
View file @ d81cf844
......@@ -122,9 +122,11 @@ namespace HappyHeart
///@}
/*!
* \brief Accessor to thematching data.
* \brief Accessor to the matching data.
*
* See explanation in the class documentation to see how to use it.
*
* \return Matching data.
*/
const std::vector<std::vector<unsigned int>>& GetData() const noexcept;
......
Sources/Operators/ParameterOperator/GlobalParameterOperator/GlobalParameterOperator.hpp
View file @ d81cf844
......@@ -94,7 +94,6 @@ namespace HappyHeart
* \param[in] args Variadic arguments that will be perfect-forwarded to the constructor of each
* LocalParameterOperator.
* \copydoc doxygen_hide_quadrature_rule_per_topology_nullptr_arg
* \copydetails doxygen_hide_do_compute_processor_wise_local_2_global_arg
* \copydoc doxygen_hide_operator_do_allocate_gradient_felt_phi_arg
*/
template
......@@ -245,9 +244,8 @@ namespace HappyHeart
* \brief Create a LocalParameterOperator for each RefFEltInFEltSpace and store it into the class.
*
* \param[in] geom_mesh_region_dimension Dimension of the geometric mesh region considered.
* \param[in] args List of variadic arguments given to the instance of the \a DerivedT
* constructor.
* \copydoc doxygen_hide_cplusplus_variadic_args
* \param[in,out] parameter The \a ParameterAtQuadraturePoint object to be updated by the current operator.
*/
template<typename... Args>
void CreateLocalOperatorList(unsigned int geom_mesh_region_dimension,
......
Sources/ParameterInstances/Fiber/FiberList.hpp
View file @ d81cf844
......@@ -129,7 +129,7 @@ namespace HappyHeart
* \param[in] fiber_file File at the Ensight format which will be interpreted. Its format is specified by
* Ensight specifications; typically scalar files get a 'scl' extension and their first line is 'Scalar per node'
* whereas vectorial get a 'vct' extension and first line is 'Vector per node'.
* \param[in] geometric_mesh_region Mesh considered for the parameters; in peculiar vertices to consider will
* \param[in] domain \a Domain considered for the parameters; in peculiar vertices to consider will
* be taken from there.
* \param[in] felt_space Finite element space upon which the Parameter should be defined.
* \param[in] unknown A scalar or vectorial unknown that acts a bit as a strawman: dofs are defined only
......
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