Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update docstring for Hfss.create_boundary #4435

Merged
merged 5 commits into from
Apr 8, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 19 additions & 7 deletions pyaedt/hfss.py
Original file line number Diff line number Diff line change
Expand Up @@ -3039,16 +3039,28 @@ def create_impedance_between_objects(
def create_boundary(
self, boundary_type=BoundaryType.PerfectE, sheet_name=None, boundary_name="", is_infinite_gnd=False
):
"""Create a boundary given specific inputs.
"""Assign a boundary condition to a sheet or surface. This method is generally
used by other methods in the ``Hfss`` class such as the :meth:``Hfss.assign_febi``
or :meth:``Hfss.assign_radiation_boundary_to_faces`` method.

Parameters
----------
boundary_type : str, optional
Boundary type object. Options are ``"Perfect E"``, ``"Perfect H"``, ``"Aperture"``, and
``"Radiation"``. The default is ``PerfectE``.
sheet_name : in, str, or list, optional
Name of the sheet. It can be an integer (face ID), a string (sheet), or a list of integers
and strings. The default is ``None``.
boundary_type : int, optional
Type of boundary condition to assign to a sheet or surface. The
default is ``Hfss.BoundaryType.PerfectE``. Options are the properties of the
:class:``Hfss.BoundaryType`` class. For example:

- ``Hfss.BoundaryType.PerfectE``
- ``Hfss.BoundaryType.PerfectH``
- ``Hfss.BoundaryType.Radiation``
- ``Hfss.BoundaryType.Impedance``
- ``Hfss.BoundaryType.LumpedRLC``
- ``Hfss.BoundaryType.FEBI``

sheet_name : int, str, or list, optional
Name of the sheet or face to assign the boundary condition to. The
default is ``None``. You can provide an integer (face ID), a string (sheet),
or a list of integers and strings.
boundary_name : str, optional
Name of the boundary. The default is ``""``.
is_infinite_gnd : bool, optional
Expand Down
Loading