Skip to content

Commit 45af13c

Browse files
AxMeNilachlangrose
authored andcommitted
Modified the documentation of set_normal_constraints
1 parent bc21228 commit 45af13c

1 file changed

Lines changed: 6 additions & 2 deletions

File tree

LoopStructural/interpolators/_geological_interpolator.py

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -154,16 +154,20 @@ def set_normal_constraints(self, points: np.ndarray):
154154
----------
155155
points : np.ndarray
156156
array containing the value constraints usually 7-8 columns.
157-
X,Y,Z,nx,ny,nz,weight
157+
X,Y,Z,nx,ny,nz,(weight)
158158
159159
Returns
160160
-------
161161
162+
Notes
163+
-------
164+
If no weights are provided, w = 1 is assigned to each normal constraint.
165+
162166
"""
163167
if points.shape[1] == self.dimensions * 2:
164168
points = np.hstack([points, np.ones((points.shape[0], 1))])
165169
if points.shape[1] < self.dimensions * 2 + 1:
166-
raise ValueError("Nonrmal constraints must at least have X,Y,Z,nx,ny,nz")
170+
raise ValueError("Normal constraints must at least have X,Y,Z,nx,ny,nz")
167171
self.n_n = points.shape[0]
168172
self.data["normal"] = points
169173
self.up_to_date = False

0 commit comments

Comments
 (0)