## On this page

  

 

 # SubtractVolumesParams

 Last update: 17.07.2025 

<a id="ansys.meshing.prime.SubtractVolumesParams"></a>

### *class* ansys.meshing.prime.SubtractVolumesParams(model=None, ignore\_face\_zonelets=None, check\_cutters=None, keep\_cutters=None, json\_data=None, \*\*kwargs)

Parameters to control the volume subtract operation.

- **Parameters:**
    
    **model: Model**: Model to create a `SubtractVolumesParams` object with default parameters.
    
    **ignore\_face\_zonelets: Iterable\[int\], optional**: Face zonelet ids that subtract volumes should not remove (for example, periodic or fluid cap zonelets). If ignore face zonelets are provided, then the target volumes after subtract operation need to be recomputed.
    
    **check\_cutters: bool, optional**: Option to manage intersecting cutter volumes. When check cutters is False an error message is provided if multiple cutters intersect. Overlapping cutter volumes are not supported.
    
    **keep\_cutters: bool, optional**: Option to retain cutter volumes.   
    **This is a beta parameter**. **The behavior and name may change in the future**.
    
    **json\_data: dict, optional**: JSON dictionary to create a `SubtractVolumesParams` object with provided parameters.

### Examples

```pycon
&gt;&gt;&gt; subtract_volumes_params = prime.SubtractVolumesParams(model = model)

```

### Methods

NameDescription[`SubtractVolumesParams.print_default`](ansys.meshing.prime.SubtractVolumesParams.print_default.md#ansys.meshing.prime.SubtractVolumesParams.print_default)()Print the default values of `SubtractVolumesParams` object.[`SubtractVolumesParams.set_default`](ansys.meshing.prime.SubtractVolumesParams.set_default.md#ansys.meshing.prime.SubtractVolumesParams.set_default)(\[...\])Set the default values of the `SubtractVolumesParams` object.### Attributes

NameDescription[`SubtractVolumesParams.check_cutters`](ansys.meshing.prime.SubtractVolumesParams.check_cutters.md#ansys.meshing.prime.SubtractVolumesParams.check_cutters)Option to manage intersecting cutter volumes.[`SubtractVolumesParams.ignore_face_zonelets`](ansys.meshing.prime.SubtractVolumesParams.ignore_face_zonelets.md#ansys.meshing.prime.SubtractVolumesParams.ignore_face_zonelets)Face zonelet ids that subtract volumes should not remove (for example, periodic or fluid cap zonelets).[`SubtractVolumesParams.keep_cutters`](ansys.meshing.prime.SubtractVolumesParams.keep_cutters.md#ansys.meshing.prime.SubtractVolumesParams.keep_cutters)Option to retain cutter volumes.