set_scope

VolumeControl.set_scope(scope)

Sets the scope for volume control to evaluate.

Volume control uses scope to evaluate entities for which volume mesh needs to be generated.

Parameters:

scopeScopeDefinition

ScopeDefinition to scope entities for volume mesh generation.

Returns:

SetScopeResults

Returns a SetScopeResults.

Return type:

SetScopeResults

Examples

>>> volume_control.set_scope(prime.ScopeDefinition(model=model,
>>>                        entity_type = ScopeEntity.VOLUMES,
>>>                        evaluation_type = ScopeEvaluationType.ZONES,
>>>                        zone_expression = "vol_in"))