Commit 9745b180 authored by Timo Koch's avatar Timo Koch
Browse files

[fix comment] Correct documentation for two methods.

git-svn-id: svn://svn.iws.uni-stuttgart.de/DUMUX/dumux/trunk@15349 2fb0f335-1f38-0410-981e-8018bf24f1b0
parent c443dcd2
......@@ -135,7 +135,9 @@ public:
}
/*!
* \brief Call the parameters function of the DGF grid pointer if available
* \brief Return the boundary domain marker (Gmsh physical entity number) of an intersection
Only available when using Gmsh with GridParameterGroup.DomainMarkers = 1.
* \param boundarySegmentIndex The boundary segment index of the intersection (intersection.boundarySegmentIndex()
*/
static const int getBoundaryDomainMarker(int boundarySegmentIndex)
{
......@@ -149,7 +151,9 @@ public:
}
/*!
* \brief Call the parameters function of the DGF grid pointer if available
* \brief Return the element domain marker (Gmsh physical entity number) of an element.
Only available when using Gmsh with GridParameterGroup.DomainMarkers = 1.
* \param elementIdx The element index
*/
static const int getElementDomainMarker(int elementIdx)
{
......@@ -336,13 +340,13 @@ protected:
static bool enableDgfGridPointer_;
/*!
* \brief A state variable if domain markers have been read from a gmsh file.
* \brief A state variable if domain markers have been read from a Gmsh file.
*/
static bool enableGmshDomainMarkers_;
/*!
* \brief Element and domain markers obtained from Gmsh physical entities
* They map from element indices / boundary ids to the physical entity mark
* \brief Element and boundary domain markers obtained from Gmsh physical entities
* They map from element indices / boundary ids to the physical entity number
*/
static std::vector<int> elementMarkers_;
static std::vector<int> boundaryMarkers_;
......
Supports Markdown
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