Boundary objects#

This section lists classes for creating and editing boundaries in the 3D tools. These objects are returned by app methods and can be used to edit or delete a boundary condition.

`BoundaryObject`	Manages boundary data and execution.
`BoundaryObject3dLayout`	Manages boundary data and execution for Hfss3dLayout.
`NetworkObject`	Manages networks in Icepak projects.
`FarFieldSetup`	Manages Far Field Component data and execution.
`Matrix`	Manages Matrix in Q3d and Q2d Projects.
`BoundaryObject3dLayout`	Manages boundary data and execution for Hfss3dLayout.
`Sources`	Manages sources in Circuit projects.
`Excitations`	Manages Excitations in Circuit Projects.

Native components#

When native components object are created, the NativeComponentObject class is returned. For PCB components, NativeComponentPCB is returned.

`NativeComponentObject`	Manages Native Component data and execution.
`NativeComponentPCB`	Manages native component PCB data and execution.

Native Component Object example:

from ansys.aedt.core import Icepak
ipk = Icepak()
component_name = "RadioBoard1"
pcb_comp = self.aedtapp.create_ipk_3dcomponent_pcb(
    component_name, link_data, solution_freq, resolution, custom_x_resolution=400, custom_y_resolution=500
)
 # pcb_comp is a NativeComponentPCB
...
ipk.release_desktop()

Icepak transient assignments#

To facilitate transient assignment handling in Icepak, it is possible to use one of the following classes:

`LinearDictionary`	Manages linear conditions assignments, which are children of the `BoundaryDictionary` class.
`PowerLawDictionary`	Manages power law condition assignments, which are children of the `BoundaryDictionary` class.
`ExponentialDictionary`	Manages exponential condition assignments, which are children of the `BoundaryDictionary` class.
`SinusoidalDictionary`	Manages sinusoidal condition assignments, which are children of the `BoundaryDictionary` class.
`SquareWaveDictionary`	Manages square wave condition assignments, which are children of the `BoundaryDictionary` class.
`PieceWiseLinearDictionary`	Manages dataset condition assignments, which are children of the `BoundaryDictionary` class.

It is possible to initialize the class manually or through a method:

bc_transient = ipk.create_sinusoidal_transient_assignment(vertical_offset="1W", vertical_scaling="3",
                                                              period="2", period_offset="0.5s")
# bc_transient will be SinusoidalDictionary type
ipk.assign_solid_block("Cylinder1", bc_transient)

#or

bc_transient = SinusoidalDictionary(vertical_offset="1W", vertical_scaling="3",
                                        period="2", period_offset="0.5s")
ipk.assign_solid_block("Cylinder1", bc_transient)