Breakdown |
The BreakdownRegion type exposes the following members.
| Name | Description | |
|---|---|---|
| BreakdownThreshold | Gets/Sets the Breakdown Region's Breakdown Threshold (in V/m; part of a Threshold type Breakdown Region). | |
| DisplayName |
Gets/Sets the display name of the underlying sim object.
(Inherited from APISimObjectBaseTWrapper) | |
| Maximum | Gets/Sets the maximum corner of the region. | |
| Minimum | Gets/Sets the minimum corner of the region. | |
| RegionType | Gets/Sets the Breakdown Region's type (either Air Chemistry or Threshold). | |
| RelativeAirDensity | Gets/Sets the Relative Air Density setting, range from 0 to 1. | |
| RelativeHumidity | Gets/Sets the Relative Humidity setting as a percent. | |
| TimeOff | Gets/Sets the Breakdown Region's Time Off (in seconds). | |
| TimeOn | Gets/Sets the Breakdown Region's Time On (in seconds). |
| Name | Description | |
|---|---|---|
| Create | Creates a new Breakdown Region. | |
| Delete |
Deletes sim object.
(Inherited from APISimObjectBaseTWrapper) | |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) | |
| GetAll | Retrieve all BreakdownRegion objects in the document. | |
| GetHashCode | Serves as the default hash function. (Inherited from Object) | |
| GetName |
Returns the name of the object.
(Inherited from APISimObjectBaseTWrapper) | |
| GetSiblings |
Get all objects that share this object's type in the document.
(Overrides APISimObjectBaseTWrapperGetSiblings(Document)) | |
| GetType | Gets the Type of the current instance. (Inherited from Object) | |
| SetName |
Sets the name of the object
(Inherited from APISimObjectBaseTWrapper) | |
| SetVisibility |
Sets the visibility status of the object.
(Inherited from APISimObjectBaseTWrapper) | |
| ToString | Returns a string that represents the current object. (Inherited from Object) |
Note that setting the Minimum and Maximum bounds of the Breakdown Region is affected by the Minimum, Maximum, and Step Size settings of the parent Domain Lattice.
from ema3d.Api.V26.Core.Domain import BreakdownRegion, Domain, BreakdownRegionType # Create a domain for the Breakdown Region, then create a Breakdown Region and modify its properties. domain = Domain.GetInstance(Window.ActiveWindow.Document) mbr = BreakdownRegion.Create(domain) print(mbr.RelativeAirDensity) print(mbr.RelativeHumidity) print(mbr.Minimum) print(mbr.Maximum) print(mbr.TimeOn) print(mbr.TimeOff) # Right-click edit on the Breakdown Region and verify its properties, then click the green checkmark. mbr.RelativeAirDensity = 0.5 mbr.TimeOn = 1e-12 mbr.TimeOff = 1e-4 mbr.Minimum = (MM(-90), MM(-90), MM(-90)) mbr.Maximum = (MM(-30), MM(-30), MM(-30)) # Right-click edit the Breakdown Region to again verify its properties. mbr.RelativeHumidity = 0.015 # Note: The Air Chemistry Settings of Relative Air Density, Relative Humidity, and Temperature are # linked physical properties and cannot be set in combination # unless the inputs satisfy this underlying physical linkage. mbr.RegionType = BreakdownRegionType.Threshold mbr.BreakdownThreshold = 2e2