Click or drag to resize

BreakdownRegion Class

A Breakdown Region object in EMA3D.
Inheritance Hierarchy
SystemObject
  ema3d.Api.V26APISimObjectBaseBreakdownRegion
    ema3d.Api.V26.Core.DomainBreakdownRegion

Namespace: ema3d.Api.V26.Core.Domain
Assembly: ema3d.Api.V26 (in ema3d.Api.V26.dll) Version: 0.0.0.0
Syntax
public sealed class BreakdownRegion : APISimObjectBase<BreakdownRegion>

The BreakdownRegion type exposes the following members.

Properties
 NameDescription
Public propertyBreakdownThreshold Gets/Sets the Breakdown Region's Breakdown Threshold (in V/m; part of a Threshold type Breakdown Region).
Public propertyDisplayName Gets/Sets the display name of the underlying sim object.
(Inherited from APISimObjectBaseTWrapper)
Public propertyMaximum Gets/Sets the maximum corner of the region.
Public propertyMinimum Gets/Sets the minimum corner of the region.
Public propertyRegionType Gets/Sets the Breakdown Region's type (either Air Chemistry or Threshold).
Public propertyRelativeAirDensity Gets/Sets the Relative Air Density setting, range from 0 to 1.
Public propertyRelativeHumidity Gets/Sets the Relative Humidity setting as a percent.
Public propertyTimeOff Gets/Sets the Breakdown Region's Time Off (in seconds).
Public propertyTimeOn Gets/Sets the Breakdown Region's Time On (in seconds).
Top
Methods
 NameDescription
Public methodStatic memberCreate Creates a new Breakdown Region.
Public methodDelete Deletes sim object.
(Inherited from APISimObjectBaseTWrapper)
Public methodEqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
Public methodStatic memberGetAll Retrieve all BreakdownRegion objects in the document.
Public methodGetHashCodeServes as the default hash function.
(Inherited from Object)
Public methodGetName Returns the name of the object.
(Inherited from APISimObjectBaseTWrapper)
Public methodGetSiblings Get all objects that share this object's type in the document.
(Overrides APISimObjectBaseTWrapperGetSiblings(Document))
Public methodGetTypeGets the Type of the current instance.
(Inherited from Object)
Public methodSetName Sets the name of the object
(Inherited from APISimObjectBaseTWrapper)
Public methodSetVisibility Sets the visibility status of the object.
(Inherited from APISimObjectBaseTWrapper)
Public methodToStringReturns a string that represents the current object.
(Inherited from Object)
Top
Remarks

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.

Example
Python
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
See Also