create_boi

SurfaceUtilities.create_boi(face_zonelet_ids, params)

Create BOI to input face zonelets.

Parameters:

face_zonelet_idsIterable[int]

List of input face zonelet IDs.

paramsCreateBOIParams

Parameters for controlling BOI creation.

Returns:

CreateBOIResults

Results from creating BOI.

Return type:

CreateBOIResults

Examples

>>> result = surf_utils.create_boi(zonelets, params)