create_waveguide

Modeler3D.create_waveguide(origin, wg_direction_axis, wgmodel='WG0', wg_length=100, wg_thickness=None, wg_material='aluminum', parametrize_w=False, parametrize_h=False, create_sheets_on_openings=False, name=None)

Create a standard waveguide and optionally parametrize W and H.

Available models are WG0.0, WG0, WG1, WG2, WG3, WG4, WG5, WG6, WG7, WG8, WG9, WG9A, WG10, WG11, WG11A, WG12, WG13, WG14, WG15, WR102, WG16, WG17, WG18, WG19, WG20, WG21, WG22, WG24, WG25, WG26, WG27, WG28, WG29, WG29, WG30, WG31, and WG32.

Parameters
originlist

List of [x, y, z] coordinates for the original position.

wg_direction_axisint

Coordinate system axis (integer 0 for X, 1 for Y, 2 for Z) or the Application.CoordinateSystemAxis enumerator.

wgmodelstr, optional

Waveguide model. The default is "WG0".

wg_lengthfloat, optional

Waveguide length. The default is 100.

wg_thicknessfloat, optional

Waveguide thickness. The default is None, in which case the thickness is wg_height/20.

wg_materialstr, optional

Waveguide material. The default is "aluminum".

parametrize_wbool, optional

Whether to parametrize W. The default is False.

parametrize_hbool, optional

Whether to parametrize H. The default is False.

create_sheets_on_openingsbool, optional

Whether to create sheets on both openings. The default is False.

namestr, optional

Name of the waveguide. The default is None.

Returns
tuple

Tuple of Object3d objects created by the waveguide.

References

>>> oEditor.CreateBox
>>> oEditor.AssignMaterial

Examples

This example shows how to create a WG9 waveguide.

>>> from pyaedt import Hfss
>>> app = Hfss()
>>> position = [0, 0, 0]
>>> wg1 = app.modeler.create_waveguide(position, app.AXIS.,
...                                    wgmodel="WG9", wg_length=2000)