Skip to content

added docstring examples to assign_vector_potential and assign_balloo… #4599

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Apr 29, 2024
Merged

added docstring examples to assign_vector_potential and assign_balloo… #4599

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a351d79
added docstring examples to assign_vector_potential and assign_balloo…
IreneWoyna Apr 29, 2024
fc81cea
improved wording
IreneWoyna Apr 29, 2024
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
22 changes: 22 additions & 0 deletions pyaedt/maxwell.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3013,6 +3013,17 @@ def assign_balloon(self, assignment, boundary=None):
----------

>>> oModule.AssignBalloon


Examples
--------
Set balloon boundary condition in Maxwell 2D.

>>> from pyaedt import Maxwell2d
>>> m2d = Maxwell2d()
>>> region_id = m2d.modeler.create_region()
>>> region_edges = region_id.edges
>>> m2d.assign_balloon(edge_list=region_edges)
"""
assignment = self.modeler.convert_to_selections(assignment, True)

Expand Down Expand Up @@ -3052,6 +3063,17 @@ def assign_vector_potential(self, assignment, vector_value=0, boundary=None):
----------

>>> oModule.AssignVectorPotential


Examples
--------
Set vector potential to zero at the boundary edges in Maxwell 2D.

>>> from pyaedt import Maxwell2d
>>> m2d = Maxwell2d()
>>> region_id = m2d.modeler.create_region()
>>> region_edges = region_id.edges
>>> m2d.assign_vector_potential(input_edge=region_edges)
"""
assignment = self.modeler.convert_to_selections(assignment, True)

Expand Down