Added description for HelicalChain class

NEFM-TUDresden · Jul 23, 2020 · e88b387 · e88b387
1 parent 7667988
commit e88b387
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 0 deletions.
diff --git a/docs/gmshModel/Model/HelicalChain.rst b/docs/gmshModel/Model/HelicalChain.rst
@@ -0,0 +1,17 @@
+HelicalChain
+============
+The HelicalChain class provides a class definition for a generation of unit
+cells with inclusions distributed in a helical chain. The class inherits from
+the InclusionRVE class and extends it in order to specify the remaining
+placeholder methods of the GenericModel.
+
+Currently, the class is restricted to circular and spherical inclusions which
+are arranged in a helical chain that is parallel to one of the coordinate axes.
+
+
+Class Definition
+----------------
+
+.. autoclass:: gmshModel.Model.HexagonalCell.HexagonalCell
+   :show-inheritance:
+   :members:
diff --git a/docs/gmshModel/Model/index.rst b/docs/gmshModel/Model/index.rst
@@ -20,3 +20,4 @@ children of GenericModel
    BodyCenteredCubicCell
    FaceCenteredCubicCell
    HexagonalCell
+   HelicalChain