SubstrateDataBlock

class ansys.aedt.core.modules.substrate_circuit.SubstrateDataBlock(app, name: str | None, substrate_type: SubstrateType, dielectric: list, metal_material: str = 'copper', metal_thickness: str = '0.7mil', bottom_metal_material: str = '', bottom_metal_thickness: str = '', cover_metal_material: str = '', cover_metal_thickness: str = '', roughness: str = '', metal_specify_type: int = 0, metal_temp_material: str = '', dielectric_temp_materials: list | None = None)

Represents a substrate data block and provides the API to create it.

Use the class-level factory methods (microstrip, stripline, …) to instantiate a correctly-configured object and immediately push it to AEDT. Alternatively, pass all raw keyword arguments directly to the constructor for full control, then call create() explicitly.

Parameters:

appansys.aedt.core.circuit.Circuit

Circuit application instance.

namestr

Unique name for the substrate data block.

substrate_typeint

One of the integer constants defined in SubstrateType.

dielectriclist of str

List of dielectric parameters whose content depends on substrate_type.

metal_materialstr, optional

Name of the primary conductor material. The default is "copper".

metal_thicknessstr, optional

Primary conductor thickness including units. The default is "0.7mil".

bottom_metal_materialstr, optional

Name of the second (bottom) conductor material. The default is "" (not specified).

bottom_metal_thicknessstr, optional

Second conductor thickness. The default is "" (not specified).

cover_metal_materialstr, optional

Name of the third (cover) conductor material. The default is "" (not specified).

cover_metal_thicknessstr, optional

Third conductor thickness. The default is "" (not specified).

roughnessstr, optional

Surface roughness of the conductor including units. The default is "" (not specified).

metal_specify_typeint, optional

Metal specification type flag used by AEDT. The default is 0.

metal_temp_materialstr, optional

Temporary metal material name used by AEDT during parameter sweeps. The default is "" (not specified).

dielectric_temp_materialslist of str, optional

List of up to five temporary dielectric material names used by AEDT during parameter sweeps. The default is five empty strings.

Examples

Create and immediately push a microstrip substrate:

>>> from ansys.aedt.core import Circuit
>>> cir = Circuit()
>>> sub = SubstrateDataBlock.microstrip(
...     cir,
...     name="MySub",
...     dielectric_height="10mil",
...     dielectric_constant=4.4,
...     loss_tangent=0.02,
...     air_height="25mm",
...     roughness="1pm",
... )

Methods

SubstrateDataBlock.coplanar_waveguide(app[, ...])	Create and push a coplanar waveguide (CPW) substrate (Type 4) to AEDT.
SubstrateDataBlock.create()	Push the substrate data block to the active Circuit design.
SubstrateDataBlock.from_dict(app, data)	Build SubstrateDataBlock from design_properties dict entry.
SubstrateDataBlock.grounded_coplanar_waveguide(app)	Create and push a grounded coplanar waveguide (GCPW) substrate (Type 5) to AEDT.
SubstrateDataBlock.microstrip(app[, ...])	Create and push a microstrip substrate to AEDT.
SubstrateDataBlock.offset_stripline(app[, ...])	Create and push an offset stripline substrate (Type 3) to AEDT.
SubstrateDataBlock.rectangular_waveguide(app)	Create and push a rectangular waveguide substrate (Type 9) to AEDT.
SubstrateDataBlock.slotline(app[, ...])	Create and push a slotline substrate (Type 6) to AEDT.
SubstrateDataBlock.stripline(app[, ...])	Create and push a stripline substrate (Type 1) to AEDT.
SubstrateDataBlock.substrate_reference(app)	Create and push a substrate reference (Type 10) to AEDT.
SubstrateDataBlock.suspended_stripline(app)	Create and push a suspended stripline substrate (Type 2) to AEDT.
SubstrateDataBlock.update()	Push the current state of this substrate data block to AEDT.

Attributes

SubstrateDataBlock.auto_update	Whether to push changes to AEDT immediately when a property is set.
SubstrateDataBlock.bottom_metal_material	Bottom conductor material name.
SubstrateDataBlock.bottom_metal_thickness	Bottom conductor thickness.
SubstrateDataBlock.cover_metal_material	Cover conductor material name.
SubstrateDataBlock.cover_metal_thickness	Cover conductor thickness.
SubstrateDataBlock.dielectric	Dielectric parameters.
SubstrateDataBlock.dielectric_temp_materials	Temporary dielectric material names (list of 5).
SubstrateDataBlock.metal_material	Primary conductor material name.
SubstrateDataBlock.metal_specify_type	Metal specification type flag.
SubstrateDataBlock.metal_temp_material	Temporary metal material name.
SubstrateDataBlock.metal_thickness	Primary conductor thickness.
SubstrateDataBlock.name	Substrate name.
SubstrateDataBlock.public_dir	Shortcut for dir(self).
SubstrateDataBlock.roughness	Conductor surface roughness.
SubstrateDataBlock.substrate_type	Substrate type.