Skip to content
GitLab
Projects
Groups
Snippets
/
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
Menu
Open sidebar
MoReFEM
CoreLibrary
MoReFEM
Commits
eda11b01
Commit
eda11b01
authored
Apr 04, 2016
by
GILLES Sebastien
Browse files
#9
Doxygen: add a FElt module, and pour into it the FiniteElementSpace group content.
parent
6b248cec
Changes
23
Hide whitespace changes
Inline
Side-by-side
Sources/FiniteElement/FiniteElement.doxygen
0 → 100644
View file @
eda11b01
/*!
* \defgroup FElt Finite element
*
* \brief Large module to encompass stuff closely related to finite elements: nodes and dofs,
* boundary conditions, finite element spaces, unknowns and so forth...
*
*/
/// \addtogroup FElt
///@{
/// \namespace HappyHeart::Private::ComponentNS
/// \brief Namespace that enclose the different possible components involved in boundary conditions.
///@}
Sources/FiniteElement/FiniteElementSpace/FEltSpace.hpp
View file @
eda11b01
...
...
@@ -97,7 +97,11 @@ namespace HappyHeart
// End of forward declarations.
//! \endcond IGNORE_BLOCK_IN_DOXYGEN
// ============================
/// \addtogroup FElt
///@{
/*!
* \brief The class in charge of most of the interation with nodes, dofs and unknowns.
...
...
@@ -502,6 +506,9 @@ namespace HappyHeart
};
///@} // \addtogroup
}
// namespace HappyHeart
...
...
Sources/FiniteElement/FiniteElementSpace/GodOfDof.hpp
View file @
eda11b01
//! \file
//
//! \addtogroup FElt
//
// GodOfDof.hpp
// HappyHeart
...
...
@@ -52,6 +53,10 @@ namespace HappyHeart
//! \endcond IGNORE_BLOCK_IN_DOXYGEN
// ============================
/// \addtogroup FElt
///@{
/*!
* \brief Object in charge of all the dofs related to a given GeometricMeshRegion.
...
...
@@ -672,6 +677,8 @@ namespace HappyHeart
// const GodOfDof& god_of_dof)
///@} // \addtogroup
}
// namespace HappyHeart
...
...
Sources/FiniteElement/FiniteElementSpace/GodOfDofManager.hpp
View file @
eda11b01
...
...
@@ -20,6 +20,10 @@
namespace
HappyHeart
{
/// \addtogroup FElt
///@{
/*!
...
...
@@ -106,6 +110,9 @@ namespace HappyHeart
//! Clear temporary data for each god of dof.
void
ClearGodOfDofTemporaryData
();
///@} // \addtogroup
}
// namespace HappyHeart
...
...
Sources/FiniteElement/FiniteElementSpace/Private/BreakCircularDependancy.hpp
View file @
eda11b01
...
...
@@ -38,6 +38,11 @@ namespace HappyHeart
namespace
Private
{
/// \addtogroup FElt
///@{
/*!
* \class doxygen_hide_break_circular_dependancy_text
*
...
...
@@ -78,6 +83,9 @@ namespace HappyHeart
const
Wrappers
::
Mpi
&
GetMpi
(
const
GodOfDof
&
god_of_dof
);
///@} // \addtogroup
}
// namespace Private
...
...
Sources/FiniteElement/FiniteElementSpace/Private/ComputeMatrixPattern.hpp
View file @
eda11b01
...
...
@@ -51,6 +51,9 @@ namespace HappyHeart
{
/// \addtogroup FElt
///@{
/*!
* \brief Computes the matrix pattern.
...
...
@@ -85,6 +88,9 @@ namespace HappyHeart
};
///@} // \addtogroup
}
// namespace Private
...
...
Sources/FiniteElement/FiniteElementSpace/Private/Connectivity.hpp
View file @
eda11b01
...
...
@@ -25,6 +25,10 @@ namespace HappyHeart
{
/// \addtogroup FElt
///@{
//! Enum class to make the call to ComputeNodeConnectivity() more readable than with a mere boolean.
enum
class
KeepSelfConnexion
{
yes
,
no
};
...
...
@@ -59,6 +63,8 @@ namespace HappyHeart
const
std
::
size_t
Nnode_bearer
,
KeepSelfConnexion
KeepSelfConnexion
);
///@} // \addtogroup
}
// namespace Private
...
...
Sources/FiniteElement/FiniteElementSpace/Private/CreateNodeListHelper.hpp
View file @
eda11b01
...
...
@@ -48,6 +48,10 @@ namespace HappyHeart
{
/// \addtogroup FElt
///@{
/*!
* \brief Helper object used in \a Node creation.
*/
...
...
@@ -167,10 +171,12 @@ namespace HappyHeart
};
///@} // \addtogroup
}
// namespace Private
}
// namespace HappyHeart
...
...
Sources/FiniteElement/FiniteElementSpace/Private/DofComputations.hpp
View file @
eda11b01
...
...
@@ -44,6 +44,10 @@ namespace HappyHeart
//! \endcond IGNORE_BLOCK_IN_DOXYGEN
// ============================
/// \addtogroup FElt
///@{
/*!
*
...
...
@@ -96,6 +100,8 @@ namespace HappyHeart
Dof
::
vector_shared_ptr
&
complete_dof_list
);
///@} // \addtogroup
}
// namespace Private
...
...
Sources/FiniteElement/FiniteElementSpace/Private/DofProgramWiseIndexListPerVertexCoordIndex.hpp
View file @
eda11b01
...
...
@@ -59,6 +59,10 @@ namespace HappyHeart
/// \addtogroup FElt
///@{
/*!
* \brief An internal class used to init correctly a VertexMatching interpolator.
*
...
...
@@ -196,6 +200,9 @@ namespace HappyHeart
};
///@} // \addtogroup
}
// namespace Private
...
...
Sources/FiniteElement/FiniteElementSpace/Private/DofProgramWiseIndexListPerVertexCoordIndexManager.hpp
View file @
eda11b01
...
...
@@ -44,6 +44,10 @@ namespace HappyHeart
{
/// \addtogroup FElt
///@{
/*!
* \brief This class is used to create and retrieve GodOfDof objects.
*
...
...
@@ -142,6 +146,9 @@ namespace HappyHeart
};
///@} // \addtogroup
}
// namespace Private
...
...
Sources/FiniteElement/FiniteElementSpace/Private/FEltSpace.hpp
View file @
eda11b01
...
...
@@ -33,6 +33,10 @@ namespace HappyHeart
{
/// \addtogroup FElt
///@{
/*!
* \brief Return the domain that is associated to a given finite element space.
*
...
...
@@ -67,7 +71,7 @@ namespace HappyHeart
ExtractExtendedUnknownList
(
const
SectionT
&
section
);
///@} // \addtogroup
}
// namespace Private
...
...
Sources/FiniteElement/FiniteElementSpace/Private/FEltSpaceStorage.hpp
View file @
eda11b01
...
...
@@ -57,6 +57,9 @@ namespace HappyHeart
{
/// \addtogroup FElt
///@{
/*!
* \brief The class in charge of storing finite elements and dofs structure of a given finite element space.
...
...
@@ -155,6 +158,9 @@ namespace HappyHeart
};
///@} // \addtogroup
}
// namespace FEltSpaceNS
...
...
Sources/FiniteElement/FiniteElementSpace/Private/Impl/AttributeProcessorHelper.hpp
View file @
eda11b01
...
...
@@ -51,6 +51,10 @@ namespace HappyHeart
namespace
Impl
{
/// \addtogroup FElt
///@{
//! Helper class to decide which processor should handle each finite element.
class
AttributeProcessorHelper
final
...
...
@@ -123,7 +127,8 @@ namespace HappyHeart
};
///@} // \addtogroup
}
// namespace Impl
...
...
Sources/FiniteElement/FiniteElementSpace/Private/Impl/ComputeDofIndexes.hpp
View file @
eda11b01
...
...
@@ -42,6 +42,10 @@ namespace HappyHeart
{
/// \addtogroup FElt
///@{
//! Helper enum for ComputeDofIndexesHelper (see below).
enum
class
DoProduceDofList
{
yes
,
no
};
...
...
@@ -92,6 +96,9 @@ namespace HappyHeart
};
///@} // \addtogroup
}
// namespace Impl
...
...
Sources/FiniteElement/FiniteElementSpace/Private/Impl/FEltSpaceInternalStorage.hpp
View file @
eda11b01
...
...
@@ -66,6 +66,10 @@ namespace HappyHeart
{
/// \addtogroup FElt
///@{
/*!
* \brief Helper class that holds finite element and dof informations about either a FEltSpace
* or a couple FEltSpace/Domain.
...
...
@@ -125,6 +129,9 @@ namespace HappyHeart
};
///@} // \addtogroup
}
// namespace Impl
...
...
Sources/FiniteElement/FiniteElementSpace/Private/Impl/InterfaceSpecialization.hpp
View file @
eda11b01
...
...
@@ -49,6 +49,10 @@ namespace HappyHeart
{
/// \addtogroup FElt
///@{
/*!
* \brief Helper struct that acts as a dispatcher depending on the type of the interface considered.
*
...
...
@@ -167,6 +171,10 @@ namespace HappyHeart
//! \endcond IGNORE_BLOCK_IN_DOXYGEN
// ============================
///@} // \addtogroup
}
// namespace Impl
...
...
Sources/FiniteElement/FiniteElementSpace/Private/MatrixPattern.hpp
View file @
eda11b01
...
...
@@ -52,6 +52,10 @@ namespace HappyHeart
{
/// \addtogroup FElt
///@{
/*!
* \brief Intermediate object used to create and store the pattern of a GlobalMatrix.
*
...
...
@@ -143,6 +147,9 @@ namespace HappyHeart
};
///@} // \addtogroup
}
// namespace Private
...
...
Sources/FiniteElement/FiniteElementSpace/Private/MovemeshHelper.hpp
View file @
eda11b01
...
...
@@ -49,6 +49,10 @@ namespace HappyHeart
{
/// \addtogroup FElt
///@{
/*!
* \brief Stores relevant data if the mesh may be moved at some point.
*
...
...
@@ -164,6 +168,9 @@ namespace HappyHeart
};
///@} // \addtogroup
}
// namespace Private
...
...
Sources/FiniteElement/FiniteElementSpace/Private/NdofHolder.hpp
View file @
eda11b01
...
...
@@ -23,6 +23,10 @@ namespace HappyHeart
namespace
Private
{
/// \addtogroup FElt
///@{
/*!
...
...
@@ -113,6 +117,9 @@ namespace HappyHeart
};
///@} // \addtogroup
}
// namespace Private
...
...
Prev
1
2
Next
Write
Preview
Supports
Markdown
0%
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment