Skip to content

Commit 6a44d95

Browse files
Update docstring for Hfss.create_boundary (#4435)
Co-authored-by: Samuel Lopez <[email protected]>
1 parent 90f0caa commit 6a44d95

File tree

1 file changed

+19
-7
lines changed

1 file changed

+19
-7
lines changed

pyaedt/hfss.py

+19-7
Original file line numberDiff line numberDiff line change
@@ -3039,16 +3039,28 @@ def create_impedance_between_objects(
30393039
def create_boundary(
30403040
self, boundary_type=BoundaryType.PerfectE, sheet_name=None, boundary_name="", is_infinite_gnd=False
30413041
):
3042-
"""Create a boundary given specific inputs.
3042+
"""Assign a boundary condition to a sheet or surface. This method is generally
3043+
used by other methods in the ``Hfss`` class such as the :meth:``Hfss.assign_febi``
3044+
or :meth:``Hfss.assign_radiation_boundary_to_faces`` method.
30433045
30443046
Parameters
30453047
----------
3046-
boundary_type : str, optional
3047-
Boundary type object. Options are ``"Perfect E"``, ``"Perfect H"``, ``"Aperture"``, and
3048-
``"Radiation"``. The default is ``PerfectE``.
3049-
sheet_name : in, str, or list, optional
3050-
Name of the sheet. It can be an integer (face ID), a string (sheet), or a list of integers
3051-
and strings. The default is ``None``.
3048+
boundary_type : int, optional
3049+
Type of boundary condition to assign to a sheet or surface. The
3050+
default is ``Hfss.BoundaryType.PerfectE``. Options are the properties of the
3051+
:class:``Hfss.BoundaryType`` class. For example:
3052+
3053+
- ``Hfss.BoundaryType.PerfectE``
3054+
- ``Hfss.BoundaryType.PerfectH``
3055+
- ``Hfss.BoundaryType.Radiation``
3056+
- ``Hfss.BoundaryType.Impedance``
3057+
- ``Hfss.BoundaryType.LumpedRLC``
3058+
- ``Hfss.BoundaryType.FEBI``
3059+
3060+
sheet_name : int, str, or list, optional
3061+
Name of the sheet or face to assign the boundary condition to. The
3062+
default is ``None``. You can provide an integer (face ID), a string (sheet),
3063+
or a list of integers and strings.
30523064
boundary_name : str, optional
30533065
Name of the boundary. The default is ``""``.
30543066
is_infinite_gnd : bool, optional

0 commit comments

Comments
 (0)