Skip to content

Commit dcd1812

Browse files
committed
(DOC) updating documentation for fold
1 parent c8d6046 commit dcd1812

File tree

1 file changed

+8
-1
lines changed
  • LoopStructural/modelling/fold

1 file changed

+8
-1
lines changed

LoopStructural/modelling/fold/fold.py

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ def get_fold_axis_orientation(self, points):
6161

6262
def get_deformed_orientation(self, points):
6363
"""
64-
Calculate the normal to the folded foliation at locations
64+
Calculate the direction vectors of the fold
6565
6666
Parameters
6767
----------
@@ -70,6 +70,13 @@ def get_deformed_orientation(self, points):
7070
7171
Returns
7272
-------
73+
fold_direction : np.array
74+
a vector parallel to the fold
75+
fold axis : np.array
76+
the fold axis
77+
dgz : np.array
78+
the X direction of the finite strain ellipsoid, perpendicular to both
79+
fold axis and fold direction
7380
7481
"""
7582
fold_axis = self.get_fold_axis_orientation(points)

0 commit comments

Comments
 (0)