Constants

This section lists constants that are commonly used in PyAEDT.

Example of constants usage:

from pyaedt import constants
ipk = Icepak()
# Use of AXIS Constant
cylinder = ipk.modeler.primitives.create_cylinder(constants.AXIS.X, [0,0,0],10,3)
# Use of PLANE Constant
ipk.modeler.split(cylinder, constants.PLANE.YZ, sides="Both")
...
ipk.release_desktop()
class pyaedt.generic.constants.AXIS[source]

CoordinateSystemAxis Enumerator class.

class pyaedt.generic.constants.CROSSSECTION[source]

CROSSSECTION Enumerator class.

class pyaedt.generic.constants.CSMODE[source]

COORDINATE SYSTEM MODE Enumerator class.

class pyaedt.generic.constants.CoordinateSystemAxis[source]

CoordinateSystemAxis class.

Deprecated since version 0.4.8: Use AXIS() instead.

class pyaedt.generic.constants.CoordinateSystemPlane[source]

CoordinateSystemPlane class.

Deprecated since version 0.4.8: Use PLANE() instead.

class pyaedt.generic.constants.FILLET[source]

FilletType Enumerator class.

class pyaedt.generic.constants.FlipChipOrientation[source]

Chip orientation enumerator class.

class pyaedt.generic.constants.GLOBALCS[source]

GlobalCS Enumerator class.

class pyaedt.generic.constants.GRAVITY[source]

GravityDirection Enumerator class.

class pyaedt.generic.constants.GravityDirection[source]

GravityDirection class.

Deprecated since version 0.4.8: Use GRAVITY() instead.

class pyaedt.generic.constants.INFINITE_SPHERE_TYPE[source]

INFINITE_SPHERE_TYPE Enumerator class.

class pyaedt.generic.constants.PLANE[source]

CoordinateSystemPlane Enumerator class.

class pyaedt.generic.constants.Plane[source]

Plane class.

Deprecated since version 0.4.8: Use VIEW() instead.

class pyaedt.generic.constants.SEGMENTTYPE[source]

CROSSSECTION Enumerator class.

class pyaedt.generic.constants.SETUPS[source]

Provides constants for the default setup types.

class pyaedt.generic.constants.SOLUTIONS[source]

Provides the names of default solution types.

class Circuit[source]

Provides Circuit solution types.

class Hfss[source]

Provides HFSS solution types.

class Icepak[source]

Provides Icepak solution types.

class Maxwell2d[source]

Provides Maxwell 2D solution types.

class Maxwell3d[source]

Provides Maxwell 3D solution types.

class Mechanical[source]

Provides Mechanical solution types.

class pyaedt.generic.constants.SWEEPDRAFT[source]

SweepDraftType Enumerator class.

class pyaedt.generic.constants.SourceType[source]

Type of excitation enumerator.

class pyaedt.generic.constants.VIEW[source]

View Enumerator class.

pyaedt.generic.constants.cel2kel(val, inverse=True)[source]

Convert a temperature from Celsius to Kelvin.

Parameters
valfloat

Temperature value in Celsius.

inversebool, optional

The default is True.

Returns
float

Temperature value converted to Kelvin.

pyaedt.generic.constants.db10(x, inverse=True)[source]

Convert db10 to decimal and viceversa.

pyaedt.generic.constants.db20(x, inverse=True)[source]

Convert db20 to decimal and viceversa.

pyaedt.generic.constants.fah2kel(val, inverse=True)[source]

Convert a temperature from Fahrenheit to Kelvin.

Parameters
valfloat

Temperature value in Fahrenheit.

inversebool, optional

The default is True.

Returns
float

Temperature value converted to Kelvin.

pyaedt.generic.constants.unit_system(units)[source]

Retrieve the name of the unit system associated with a unit string.

Parameters
unitsstr

Units for retrieving the associated unit system name.

Returns
str

Key from the AEDT_units when successful. For example, "AngularSpeed".

False when the units specified are not defined in AEDT units.