Skip to content
Snippets Groups Projects
Commit ea1637b0 authored by Nicolas Marsic's avatar Nicolas Marsic
Browse files

Doc...

parent b9508b8f
Branches
Tags
No related merge requests found
...@@ -7,12 +7,11 @@ ...@@ -7,12 +7,11 @@
@class QuadNodeBasis @class QuadNodeBasis
@brief A Node Basis for Quads @brief A Node Basis for Quads
This class can instantiate a Node-Based Basis This class can instantiate a Node-Based Basis (high or low order) for Quads.
(high or low order) for Quads.@n
It uses a variation of It uses a variation of
<a href="http://www.hpfem.jku.at/publications/szthesis.pdf">Zaglmayr's</a> <a href="http://www.hpfem.jku.at/publications/szthesis.pdf">Zaglmayr's</a>
Basis for @em high @em order Polynomial%s generation.@n Basis for high order Polynomial%s generation.@n
The following mapping has been applied to Zaglmayr's Basis for Quads: The following mapping has been applied to Zaglmayr's Basis for Quads:
@li @f$x = \frac{u + 1}{2}@f$ @li @f$x = \frac{u + 1}{2}@f$
......
...@@ -224,14 +224,14 @@ class ReferenceSpace{ ...@@ -224,14 +224,14 @@ class ReferenceSpace{
Deletes this ReferenceSpace Deletes this ReferenceSpace
** **
@fn ReferenceSpace::getNReferenceSpace @fn ReferenceSpace::getNOrientation
@returns Returns the number of ABC reference spaces @returns Returns the number of orientations
** **
@fn ReferenceSpace::getReferenceSpace @fn ReferenceSpace::getOrientation
@param element A MElement @param element A MElement
@returns Returns a natural number defining on which ABC space @returns
the given element can be mapped Returns a natural number defining the orientation of the given element
If no space is found (e.g. the given element does not belong If no space is found (e.g. the given element does not belong
the same geometrical entity as this ReferenceSpace) an Exception is thrown the same geometrical entity as this ReferenceSpace) an Exception is thrown
......
...@@ -13,7 +13,7 @@ ...@@ -13,7 +13,7 @@
/** /**
@class ReferenceSpaceManager @class ReferenceSpaceManager
@biref A way to handel ReferenceSpace%s @brief A way to handel ReferenceSpace%s
This class implements class method to handel and access ReferenceSpace%s This class implements class method to handel and access ReferenceSpace%s
*/ */
......
...@@ -8,11 +8,11 @@ ...@@ -8,11 +8,11 @@
@brief An Edge Basis for Tetrahedra @brief An Edge Basis for Tetrahedra
This class can instantiate an Edge-Based Basis This class can instantiate an Edge-Based Basis
(high or low order) for Tetrahedra.@n (high or low order) for Tetrahedra
It uses It uses
<a href="http://www.hpfem.jku.at/publications/szthesis.pdf">Zaglmayr's</a> <a href="http://www.hpfem.jku.at/publications/szthesis.pdf">Zaglmayr's</a>
Basis for @em high @em order Polynomial%s generation.@n Basis for high order Polynomial%s generation.
*/ */
class TetEdgeBasis: public BasisHierarchical1Form{ class TetEdgeBasis: public BasisHierarchical1Form{
......
...@@ -7,8 +7,8 @@ ...@@ -7,8 +7,8 @@
@class TetLagrangeBasis @class TetLagrangeBasis
@brief Lagrange Basis for Tetrahedra @brief Lagrange Basis for Tetrahedra
This class can instantiate a @em Lagrange @em Basis This class can instantiate a Lagrange Basis
for a Tetrahedron and for a given Order.@n for a Tetrahedron and for a given order.
It uses It uses
<a href="http://geuz.org/gmsh/">gmsh</a> Basis. <a href="http://geuz.org/gmsh/">gmsh</a> Basis.
...@@ -18,8 +18,7 @@ class TetLagrangeBasis: public BasisLagrange{ ...@@ -18,8 +18,7 @@ class TetLagrangeBasis: public BasisLagrange{
public: public:
//! @param order A natural number //! @param order A natural number
//! //!
//! Returns a new TetLagrangeBasis //! Returns a new TetLagrangeBasis of the given order
//! of the given Order
TetLagrangeBasis(size_t order); TetLagrangeBasis(size_t order);
//! Deletes this Basis //! Deletes this Basis
......
...@@ -8,11 +8,11 @@ ...@@ -8,11 +8,11 @@
@brief A Node Basis for Tetrahedra @brief A Node Basis for Tetrahedra
This class can instantiate a Node-Based Basis This class can instantiate a Node-Based Basis
(high or low order) for Tetrahedra.@n (high or low order) for Tetrahedra.
It uses It uses
<a href="http://www.hpfem.jku.at/publications/szthesis.pdf">Zaglmayr's</a> <a href="http://www.hpfem.jku.at/publications/szthesis.pdf">Zaglmayr's</a>
Basis for @em high @em order Polynomial%s generation.@n Basis for high order Polynomial%s generation.@n
*/ */
class TetNodeBasis: public BasisHierarchical0Form{ class TetNodeBasis: public BasisHierarchical0Form{
......
...@@ -8,11 +8,11 @@ ...@@ -8,11 +8,11 @@
@brief An Edge Basis for Triangles @brief An Edge Basis for Triangles
This class can instantiate an Edge-Based Basis This class can instantiate an Edge-Based Basis
(high or low order) for Triangles.@n (high or low order) for Triangles.
It uses It uses
<a href="http://www.hpfem.jku.at/publications/szthesis.pdf">Zaglmayr's</a> <a href="http://www.hpfem.jku.at/publications/szthesis.pdf">Zaglmayr's</a>
Basis for @em high @em order Polynomial%s generation.@n Basis for high order Polynomial%s generation.
*/ */
class TriEdgeBasis: public BasisHierarchical1Form{ class TriEdgeBasis: public BasisHierarchical1Form{
......
...@@ -7,8 +7,8 @@ ...@@ -7,8 +7,8 @@
@class TriLagrangeBasis @class TriLagrangeBasis
@brief Lagrange Basis for Triangles @brief Lagrange Basis for Triangles
This class can instantiate a @em Lagrange @em Basis This class can instantiate a Lagrange Basis
for a Triangle and for a given Order.@n for a Triangle and for a given order.
It uses It uses
<a href="http://geuz.org/gmsh/">gmsh</a> Basis. <a href="http://geuz.org/gmsh/">gmsh</a> Basis.
...@@ -18,8 +18,7 @@ class TriLagrangeBasis: public BasisLagrange{ ...@@ -18,8 +18,7 @@ class TriLagrangeBasis: public BasisLagrange{
public: public:
//! @param order A natural number //! @param order A natural number
//! //!
//! Returns a new TriLagrangeBasis //! Returns a new TriLagrangeBasis of the given order
//! of the given Order
TriLagrangeBasis(size_t order); TriLagrangeBasis(size_t order);
//! Deletes this Basis //! Deletes this Basis
......
...@@ -7,8 +7,7 @@ ...@@ -7,8 +7,7 @@
@class TriNedelecBasis @class TriNedelecBasis
@brief Nedelec Basis for Triangles @brief Nedelec Basis for Triangles
This class can instantiate a Nedelec Basis This class can instantiate a Nedelec Basis for Triangles.
for Triangles.@n
*/ */
class TriNedelecBasis: public BasisHierarchical1Form{ class TriNedelecBasis: public BasisHierarchical1Form{
......
...@@ -8,11 +8,11 @@ ...@@ -8,11 +8,11 @@
@brief A Node Basis for Triangles @brief A Node Basis for Triangles
This class can instantiate a Node-Based Basis This class can instantiate a Node-Based Basis
(high or low order) for Triangles.@n (high or low order) for Triangles.
It uses It uses
<a href="http://www.hpfem.jku.at/publications/szthesis.pdf">Zaglmayr's</a> <a href="http://www.hpfem.jku.at/publications/szthesis.pdf">Zaglmayr's</a>
Basis for @em high @em order Polynomial%s generation.@n Basis for high order Polynomial%s generation.
*/ */
class TriNodeBasis: public BasisHierarchical0Form{ class TriNodeBasis: public BasisHierarchical0Form{
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment