Skip to content

Commit 2a7b140

Browse files
Apply suggestions from code review
Updates from @PipKat Co-authored-by: Kathy Pippert <[email protected]>
1 parent ec70424 commit 2a7b140

File tree

1 file changed

+11
-9
lines changed

1 file changed

+11
-9
lines changed

pyaedt/hfss.py

+11-9
Original file line numberDiff line numberDiff line change
@@ -3040,25 +3040,27 @@ def create_boundary(
30403040
self, boundary_type=BoundaryType.PerfectE, sheet_name=None, boundary_name="", is_infinite_gnd=False
30413041
):
30423042
"""Assign a boundary condition to a sheet or surface. This method is generally
3043-
used by other methods in the ``Hfss`` class such as :meth:``Hfss.assign_febi``
3044-
or :meth:``Hfss.assign_radiation_boundary_to_faces``.
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.
30453045
30463046
Parameters
30473047
----------
30483048
boundary_type : int, optional
3049-
Specifies the type of boundary condition to be assigned to a sheet or surface.
3050-
Options are properties of :class:``Hfss.BoundaryType``. For example,
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+
30513053
- ``Hfss.BoundaryType.PerfectE``
30523054
- ``Hfss.BoundaryType.PerfectH``
30533055
- ``Hfss.BoundaryType.Radiation``
30543056
- ``Hfss.BoundaryType.Impedance``
30553057
- ``Hfss.BoundaryType.LumpedRLC``
30563058
- ``Hfss.BoundaryType.FEBI``
3057-
The default is ``Hfss.BoundaryType.PerfectE``.
3058-
sheet_name : in, str, or list, optional
3059-
Name of the sheet or face to which the boundary condition will be assigned.
3060-
It can be an integer (face ID), a string (sheet), or a list of integers
3061-
and strings. The default is ``None``.
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.
30623064
boundary_name : str, optional
30633065
Name of the boundary. The default is ``""``.
30643066
is_infinite_gnd : bool, optional

0 commit comments

Comments
 (0)