@@ -51,15 +51,14 @@ class SwFunction:
5151 Defaults to zero.
5252 swmax: The maximum applied as asymptote in the equation.
5353 Defaults to 1.
54- method: How to look at cell geometry. There are three options: 'cell_center',
55- 'cell_center-above_ffl' and 'cell_corners_above_ffl'.
54+ method: How to look at cell geometry. There are three options:
55+ 'cell_center_above_ffl', 'cell_corners_above_ffl' and
56+ 'truncated_cell_corners_above_ffl'.
5657 gridname: Optional - only needed when debug keyword is True.
5758 project: Optional. Must be included when working in RMS.
5859 invert: Optional, will in case invert ``a`` and ``b`` in case the J function
5960 (or similar) is formulated as Sw = (J/A)^(1/B). This is the case in e.g.
6061 RMS
61- zdepth: Optional. May speed up computation if provided, in case the function
62- is called several time for the same grid.
6362 hcenter: Optional. May speed up computation if provided, in case the function
6463 is called several time for the same grid, or hcenter is pre-computed in a
6564 special way. The hcenter will work with direct method only, not integration.
@@ -294,7 +293,8 @@ def _compute_direct(self) -> None:
294293 def compute (
295294 self , compute_method : str = "integrated"
296295 ) -> dict [str , xtgeo .GridProperty ]:
297- """Common compute function for saturation, and returns the Sw property"""
296+ """Common compute function for saturation, and returns the Sw property,
297+ compute_method options: 'integrated' or 'direct'"""
298298 if compute_method == "integrated" :
299299 self ._compute_integrated ()
300300 else :
0 commit comments