Skip to content

Commit

Permalink
added docstring examples to assign_vector_potential and assign_balloo… (
Browse files Browse the repository at this point in the history
  • Loading branch information
IreneWoyna authored Apr 29, 2024
1 parent e296cc7 commit 7832843
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions pyaedt/maxwell.py
Original file line number Diff line number Diff line change
Expand Up @@ -3015,6 +3015,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 @@ -3054,6 +3065,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

0 comments on commit 7832843

Please sign in to comment.