ComponentArray#

class ansys.aedt.core.modeler.cad.component_array.ComponentArray(app, name=None)#

Manages object attributes for a 3D component array.

Parameters:
appansys.aedt.core.Hfss

HFSS PyAEDT object.

namestr, optional

Array name. The default is None, in which case a random name is assigned.

Examples

Basic usage demonstrated with an HFSS design with an existing array:

>>> from ansys.aedt.core import Hfss
>>> aedtapp = Hfss(project="Array.aedt")
>>> array_names = aedtapp.component_array_names[0]
>>> array = aedtapp.component_array[array_names[0]]

Methods

ComponentArray.delete()

Delete the component array.

ComponentArray.edit_array()

Edit component array.

ComponentArray.export_array_info([output_file])

Export array information to a CSV file.

ComponentArray.get_cell(row, col)

Get cell object corresponding to a row and column.

ComponentArray.get_cell_position()

Get cell position.

ComponentArray.get_component_objects()

Get 3D component center.

ComponentArray.lattice_vector()

Get model lattice vector.

ComponentArray.parse_array_info_from_csv(...)

Parse component array information from the CSV file.

ComponentArray.update_properties()

Update component array properties.

Attributes

ComponentArray.a_length

Length of the array in A direction.

ComponentArray.a_size

Number of cells in the vector A direction.

ComponentArray.a_vector_choices

List of name choices for vector A.

ComponentArray.a_vector_name

Name of vector A.

ComponentArray.b_length

Length of the array in B direction.

ComponentArray.b_size

Number of cells in the vector B direction.

ComponentArray.b_vector_choices

List of name choices for vector B.

ComponentArray.b_vector_name

Name of vector B.

ComponentArray.cells

List of ansys.aedt.core.modeler.cad.component_array.CellArray objects.

ComponentArray.component_names

List of component names.

ComponentArray.coordinate_system

Coordinate system name.

ComponentArray.name

Name of the array.

ComponentArray.padding_cells

Number of padding cells.

ComponentArray.post_processing_cells

Dictionary of each component's postprocessing cells.

ComponentArray.properties

Ordered dictionary of the properties of the component array.

ComponentArray.render

Array rendering.

ComponentArray.render_choices

List of rendered name choices.

ComponentArray.render_id

Array rendering ID.

ComponentArray.show_cell_number

Flag indicating if the array cell number is shown.

ComponentArray.visible

Flag indicating if the array is visible.