@@ -3040,25 +3040,27 @@ def create_boundary(
3040
3040
self , boundary_type = BoundaryType .PerfectE , sheet_name = None , boundary_name = "" , is_infinite_gnd = False
3041
3041
):
3042
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 :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 .
3045
3045
3046
3046
Parameters
3047
3047
----------
3048
3048
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
+
3051
3053
- ``Hfss.BoundaryType.PerfectE``
3052
3054
- ``Hfss.BoundaryType.PerfectH``
3053
3055
- ``Hfss.BoundaryType.Radiation``
3054
3056
- ``Hfss.BoundaryType.Impedance``
3055
3057
- ``Hfss.BoundaryType.LumpedRLC``
3056
3058
- ``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 .
3062
3064
boundary_name : str, optional
3063
3065
Name of the boundary. The default is ``""``.
3064
3066
is_infinite_gnd : bool, optional
0 commit comments