Commit e5c29fd0 authored by Mike Kremer's avatar Mike Kremer
Browse files

Changed docu

git-svn-id: http://www.openvolumemesh.org/svnrepo/OpenVolumeMesh/trunk@77 66977474-1d4b-4f09-8fe9-267525286df2
parent 3c666dd9
...@@ -23,13 +23,20 @@ The following sections provide a concise overview of the iterators that come alo ...@@ -23,13 +23,20 @@ The following sections provide a concise overview of the iterators that come alo
\section intrinsic_iterators Intrinsic Iterators \section intrinsic_iterators Intrinsic Iterators
\li OpenVolumeMesh::VertexIter: Iterate over all vertices of a mesh. \li OpenVolumeMesh::VertexIter:
\li OpenVolumeMesh::EdgeIter: Iterate over all edges of a mesh. Iterate over all vertices of a mesh.
\li OpenVolumeMesh::HalfEdgeIter: Iterate over all half-edges of a mesh. \li OpenVolumeMesh::EdgeIter:
\li OpenVolumeMesh::FaceIter: Iterate over all faces of a mesh. Iterate over all edges of a mesh.
\li OpenVolumeMesh::HalfFaceIter: Iterate over all half-faces of a mesh. \li OpenVolumeMesh::HalfEdgeIter:
\li OpenVolumeMesh::CellIter: Iterate over all cells of a mesh. Iterate over all half-edges of a mesh.
\li OpenVolumeMesh::CellVertexIter: Iterate over all vertices of a given cell. \li OpenVolumeMesh::FaceIter:
Iterate over all faces of a mesh.
\li OpenVolumeMesh::HalfFaceIter:
Iterate over all half-faces of a mesh.
\li OpenVolumeMesh::CellIter:
Iterate over all cells of a mesh.
\li OpenVolumeMesh::CellVertexIter:
Iterate over all vertices of a given cell.
\section adjacency_depending_iterators Bottom-Up Adjacency Dependent Iterators and Circulators \section adjacency_depending_iterators Bottom-Up Adjacency Dependent Iterators and Circulators
...@@ -45,8 +52,10 @@ The following sections provide a concise overview of the iterators that come alo ...@@ -45,8 +52,10 @@ The following sections provide a concise overview of the iterators that come alo
\subsection hexahedral_mesh_iterators Specializations for Hexahedral Meshes \subsection hexahedral_mesh_iterators Specializations for Hexahedral Meshes
\li OpenVolumeMesh::CellSheetCellIter \li OpenVolumeMesh::CellSheetCellIter: Iterate over all adjacent hexahedra in the same sheet of a given hexahedron. Also see \ref tutorial_02, last example.
\li OpenVolumeMesh::HalfFaceSheetHalfFaceIter \li OpenVolumeMesh::HalfFaceSheetHalfFaceIter: Iterate over all adjacent half-faces of a given half-face in the same sheet of hexahedra.
\li OpenVolumeMesh::OutsideNeighborHalfFaceIter \li OpenVolumeMesh::OutsideNeighborHalfFaceIter: Iterate over all adjacent boundary half-faces (outside) of a given boundary half-face.
\todo Make figures for all iterators.
**/ **/
...@@ -2,4 +2,15 @@ ...@@ -2,4 +2,15 @@
\page property_system Property System \page property_system Property System
In %OpenVolumeMesh it is possible to attach properties of any data type to
each of the entity types. This is accomplished by using template programming concepts
of C++. All properties are instances of the class OpenVolumeMesh::OpenVolumeMeshPropertyT
that expects a data type as template parameter. This class is derived from the non-generic
base class OpenVolumeMesh::OpenVolumeMeshBaseProperty. Class OpenVolumeMesh::OpenVolumeMeshPropertyContainer
encapsulates these properties in a vector. The base class the polyhedral mesh class,
OpenVolumeMesh::OpenVolumeMeshBaseKernel holds one of these containers for each entity type.
All properties are accessed via so-called property handles. A property handle is a generic class
that expects the respective property's data type as template parameter. See Section \ref tutorial_03
for an example on how to use properties in practice.
**/ **/
...@@ -77,7 +77,7 @@ class OpenVolumeMeshPropertyT: public OpenVolumeMeshBaseProperty { ...@@ -77,7 +77,7 @@ class OpenVolumeMeshPropertyT: public OpenVolumeMeshBaseProperty {
public: public:
typedef T Value; typedef T Value;
typedef std::vector<T> vector_type; typedef std::vector<T> vector_type;
typedef T value_type; typedef T value_type;
typedef typename vector_type::reference reference; typedef typename vector_type::reference reference;
typedef typename vector_type::const_reference const_reference; typedef typename vector_type::const_reference const_reference;
......
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