From a351d7974247764d5add9997c75385ea2eb4ee81 Mon Sep 17 00:00:00 2001 From: IreneWoyna Date: Mon, 29 Apr 2024 13:25:00 +0200 Subject: [PATCH 1/2] added docstring examples to assign_vector_potential and assign_balloon functions --- pyaedt/maxwell.py | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/pyaedt/maxwell.py b/pyaedt/maxwell.py index 1c0e4df5195..8e9d01fe3fb 100644 --- a/pyaedt/maxwell.py +++ b/pyaedt/maxwell.py @@ -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) @@ -3052,6 +3063,17 @@ def assign_vector_potential(self, assignment, vector_value=0, boundary=None): ---------- >>> oModule.AssignVectorPotential + + + Examples + -------- + Set vector potential = 0 boundary condition 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) From fc81ceaad9a00263127a3bba74d37d9cd2b8b3e7 Mon Sep 17 00:00:00 2001 From: IreneWoyna Date: Mon, 29 Apr 2024 15:37:36 +0200 Subject: [PATCH 2/2] improved wording --- pyaedt/maxwell.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pyaedt/maxwell.py b/pyaedt/maxwell.py index 8e9d01fe3fb..ad205b4fe4f 100644 --- a/pyaedt/maxwell.py +++ b/pyaedt/maxwell.py @@ -3067,7 +3067,7 @@ def assign_vector_potential(self, assignment, vector_value=0, boundary=None): Examples -------- - Set vector potential = 0 boundary condition in Maxwell 2D. + Set vector potential to zero at the boundary edges in Maxwell 2D. >>> from pyaedt import Maxwell2d >>> m2d = Maxwell2d()