## On this page

  

 

 # CreateBOIParams

 Last update: 29.04.2026 

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

### *class* ansys.meshing.prime.CreateBOIParams(model=None, boi\_type=None, perform\_initial\_wrap=None, wrap\_size=None, flow\_dir=None, side\_scale=None, wake\_scale=None, wake\_levels=None, suggested\_part\_name=None, suggested\_label\_prefix=None, number\_of\_threads=None, json\_data=None, \*\*kwargs)

Parameters used for BOI surface creation in the given axis.

**Parameters:**

**model: Model**

Model to create a `CreateBOIParams` object with default parameters.

**boi\_type: BOIType, optional**

Type of BOI offsetting.

**perform\_initial\_wrap: bool, optional**

Perform an initial wrap to create a BOI if BOI type is OFFSETSURFACE.

**wrap\_size: float, optional**

Set wrap size greater than the largest gap size in the input when performing\_initial\_wrap is true.

**flow\_dir: FlowDirection, optional**

Assigns the offset direction of inflation.

**side\_scale: float, optional**

BOI side scaling factor.

**wake\_scale: float, optional**

BOI flow direction scaling factor.

**wake\_levels: int, optional**

BOI levels.

**suggested\_part\_name: str, optional**

Suggested part name for created BOI surfaces.

**suggested\_label\_prefix: str, optional**

Suggested label name for created BOI surfaces.

**number\_of\_threads: int, optional**

Number of threads for multithreading.

**json\_data: dict, optional**

JSON dictionary to create a `CreateBOIParams` object with provided parameters.

### Examples

```pycon
>>> create_boiparams = prime.CreateBOIParams(model = model)

```

### Methods

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

NameDescription[`CreateBOIParams.boi_type`](ansys.meshing.prime.CreateBOIParams.boi_type.md#ansys.meshing.prime.CreateBOIParams.boi_type)Type of BOI offsetting.[`CreateBOIParams.flow_dir`](ansys.meshing.prime.CreateBOIParams.flow_dir.md#ansys.meshing.prime.CreateBOIParams.flow_dir)Assigns the offset direction of inflation.[`CreateBOIParams.number_of_threads`](ansys.meshing.prime.CreateBOIParams.number_of_threads.md#ansys.meshing.prime.CreateBOIParams.number_of_threads)Number of threads for multithreading.[`CreateBOIParams.perform_initial_wrap`](ansys.meshing.prime.CreateBOIParams.perform_initial_wrap.md#ansys.meshing.prime.CreateBOIParams.perform_initial_wrap)Perform an initial wrap to create a BOI if BOI type is OFFSETSURFACE.[`CreateBOIParams.side_scale`](ansys.meshing.prime.CreateBOIParams.side_scale.md#ansys.meshing.prime.CreateBOIParams.side_scale)BOI side scaling factor.[`CreateBOIParams.suggested_label_prefix`](ansys.meshing.prime.CreateBOIParams.suggested_label_prefix.md#ansys.meshing.prime.CreateBOIParams.suggested_label_prefix)Suggested label name for created BOI surfaces.[`CreateBOIParams.suggested_part_name`](ansys.meshing.prime.CreateBOIParams.suggested_part_name.md#ansys.meshing.prime.CreateBOIParams.suggested_part_name)Suggested part name for created BOI surfaces.[`CreateBOIParams.wake_levels`](ansys.meshing.prime.CreateBOIParams.wake_levels.md#ansys.meshing.prime.CreateBOIParams.wake_levels)BOI levels.[`CreateBOIParams.wake_scale`](ansys.meshing.prime.CreateBOIParams.wake_scale.md#ansys.meshing.prime.CreateBOIParams.wake_scale)BOI flow direction scaling factor.[`CreateBOIParams.wrap_size`](ansys.meshing.prime.CreateBOIParams.wrap_size.md#ansys.meshing.prime.CreateBOIParams.wrap_size)Set wrap size greater than the largest gap size in the input when performing\_initial\_wrap is true.