From 783284326ecb6676945e51b250956bebf94261dd Mon Sep 17 00:00:00 2001 From: Irene Woyna <98172186+IreneWoyna@users.noreply.github.com> Date: Mon, 29 Apr 2024 17:01:39 +0200 Subject: [PATCH] =?UTF-8?q?added=20docstring=20examples=20to=20assign=5Fve?= =?UTF-8?q?ctor=5Fpotential=20and=20assign=5Fballoo=E2=80=A6=20(#4599)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- pyaedt/maxwell.py | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/pyaedt/maxwell.py b/pyaedt/maxwell.py index 2489fd112f0..f5bf992ebe9 100644 --- a/pyaedt/maxwell.py +++ b/pyaedt/maxwell.py @@ -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) @@ -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)