assign_tangential_h_field#

Maxwell3d.assign_tangential_h_field(assignment, x_component_real=0, x_component_imag=0, y_component_real=0, y_component_imag=0, coordinate_system='Global', origin=None, u_pos=None, reverse=False, bound_name=None)#

Assign a tangential H field boundary to a list of faces.

Available for Maxwell 3D Magnetostatic and AC Magnetic (Eddy Current).

Parameters:

assignmentlist of int or ansys.aedt.core.modeler.cad.object_3d.Object3d: List of objects to assign an end connection to.
x_component_realfloat, str, optional: X component value real part. The default is 0.
x_component_imagfloat, str, optional: X component value imaginary part. The default is 0.
y_component_realfloat, str, optional: Y component value real part. The default is 0.
y_component_imagfloat, str, optional: Y component value imaginary part. The default is 0.
coordinate_systemstr, optional: Coordinate system to use for the UV vector.
originlist, optional: Origin of the UV vector. The default is ``None`, in which case the bottom left vertex is used.
u_poslist, optional: Direction of the U vector. The default is None, in which case the top left vertex is used.
reversebool, optional: Whether the vector is reversed. The default is False.
bound_namestr, optional: Name of the end connection boundary. The default is None, in which case the default name is used.

Returns:

ansys.aedt.core.modules.boundary.common.BoundaryObject: Newly created object when successful, False when failed.

References

>>> oModule.AssignTangentialHField

Examples

Create a box and assign a tangential H field boundary to one of its faces.

>>> from ansys.aedt.core import Maxwell3d
>>> m3d = Maxwell3d(solution_type="Magnetostatic")
>>> box = m3d.modeler.create_box(origin=[0, 0, 0], sizes=[10, 10, 10])
>>> m3d.assign_tangential_h_field(assignment=box.bottom_face_x,
>>>                               x_component_real=1,
>>>                               x_component_imag=0,
>>>                               y_component_real=2,
>>>                               y_component_imag=0,
>>>                               bound_name="H_tangential"
>>>                              )
>>> m3d.desktop_class.close_desktop()