FEAT: VSin, ISin Sources added to Maxwell Circuit Primitives

src/ansys/aedt/core/modeler/circuits/primitives_maxwell_circuit.py

@@ -85,8 +85,8 @@
 
         Parameters
         ----------
-        name : str, optional
-            Name of the resistor. The default is ``None``.
+        name : str, int, float or optional
+            Name of the resistor. The default is ``None`` which adds a resistor without a name.
         value : float, optional
             Value for the resistor. The default is ``50``.
         location : list of float, optional
@@ -109,27 +109,27 @@
         if location == None:
             location = []
 
-        id = self.create_component(
+        component = self.create_component(
             name,
             component_library="Passive Elements",
             component_name="Res",
             location=location,
             angle=angle,
             use_instance_id_netlist=use_instance_id_netlist,
         )
-
-        id.set_property("R", value)
-        id.set_property("Name", name)
-        return id
+        component.set_property("R", value)
+        if isinstance(name, (str, int, float)):
+            component.parameters["Name"] = name
+        return component
 
     @pyaedt_function_handler(compname="name")
     def create_inductor(self, name=None, value=50, location=None, angle=0, use_instance_id_netlist=False):
         """Create an inductor.
 
         Parameters
         ----------
-        name : str, optional
-            Name of the inductor. The default is ``None``.
+        name : str, int, float or optional
+            Name of the inductor. The default is ``None`` which adds an inductor without a name.
         value : float, optional
             Value for the inductor. The default is ``50``.
         location : list of float, optional
@@ -152,7 +152,7 @@
         if location == None:
             location = []
 
-        id = self.create_component(
+        component = self.create_component(
             name,
             component_library="Passive Elements",
             component_name="Ind",
@@ -161,18 +161,19 @@
             use_instance_id_netlist=use_instance_id_netlist,
         )
 
-        id.set_property("L", value)
-        id.set_property("Name", name)
-        return id
+        component.set_property("L", value)
+        if isinstance(name, (str, int, float)):
+            component.parameters["Name"] = name
+        return component
 
     @pyaedt_function_handler(compname="name")
     def create_capacitor(self, name=None, value=50, location=None, angle=0, use_instance_id_netlist=False):
         """Create a capacitor.
 
         Parameters
         ----------
-        name : str, optional
-            Name of the capacitor. The default is ``None``.
+        name : str, int, float or optional
+            Name of the capacitor. The default is ``None`` which adds a capacitor without a name.
         value : float, optional
             Value for the capacitor. The default is ``50``.
         location : list of float, optional
@@ -194,7 +195,7 @@
         """
         if location is None:
             location = []
-        id = self.create_component(
+        component = self.create_component(
             name,
             component_library="Passive Elements",
             component_name="Cap",
@@ -203,18 +204,19 @@
             use_instance_id_netlist=use_instance_id_netlist,
         )
 
-        id.set_property("C", value)
-        id.set_property("Name", name)
-        return id
+        component.set_property("C", value)
+        if isinstance(name, (str, int, float)):
+            component.parameters["Name"] = name
+        return component
 
     @pyaedt_function_handler(compname="name")
     def create_diode(self, name=None, location=None, angle=0, use_instance_id_netlist=False):
         """Create a diode.
 
         Parameters
         ----------
-        name : str, optional
-            Name of the diode. The default is ``None``.
+        name : str, int, float or optional
+            Name of the diode. The default is ``None`` which adds a diode without a name.
         location : list of float, optional
             Position on the X axis and Y axis. The default is ``None``.
         angle : float, optional
@@ -235,7 +237,7 @@
         if location is None:
             location = []
 
-        id = self.create_component(
+        component = self.create_component(
             name,
             component_library="Passive Elements",
             component_name="DIODE",
@@ -244,17 +246,18 @@
             use_instance_id_netlist=use_instance_id_netlist,
         )
 
-        id.set_property("Name", name)
-        return id
+        if isinstance(name, (str, int, float)):
+            component.parameters["Name"] = name
+        return component
 
     @pyaedt_function_handler(compname="name")
     def create_winding(self, name=None, location=None, angle=0, use_instance_id_netlist=False):
         """Create a winding linked to a Maxwell design.
 
         Parameters
         ----------
-        name : str, optional
-            Name of the winding. The default is ``None``.
+        name : str, int, float or optional
+            Name of the winding. The default is ``None`` which adds a winding without a name.
         location : list of float, optional
             Position on the X axis and Y axis.
         angle : float, optional
@@ -274,13 +277,109 @@
         """
         if location is None:
             location = []
-        id = self.create_component(
+        component = self.create_component(
             name,
             component_library="Dedicated Elements",
             component_name="Winding",
             location=location,
             angle=angle,
             use_instance_id_netlist=use_instance_id_netlist,
         )
-        id.set_property("Name", name)
-        return id
+        if isinstance(name, (str, int, float)):
+            component.parameters["Name"] = name
+        return component
+
+    @pyaedt_function_handler()
+    def create_i_sin(self, name=None, value=1, location=None, angle=0, use_instance_id_netlist=False):
+        """Create a sinusoidal current source.
+
+        Parameters
+        ----------
+        name : str, int, float or optional
+            Name of the current source. The default is ``None`` which adds a current source without a name.
+        value : float, optional
+            Value for the amplitude of current. The default is ``1``.
+        location : list of float, optional
+            Position on the X axis and Y axis.
+        angle : float, optional
+            Angle of rotation in degrees. The default is ``0``.
+        use_instance_id_netlist : bool, optional
+            Whether to use the instance ID in the net list or not. The default is ``False``.
+
+        Returns
+        -------
+        :class:`ansys.aedt.core.modeler.cad.object_3dcircuit.CircuitComponent`
+            Circuit Component Object.
+
+        References
+        ----------
+        >>> oEditor.CreateComponent
+
+        Examples
+        --------
+        >>>from ansys.aedt.core import MaxwellCircuit
+        >>>app=MaxwellCircuit()
+        >>>component=app.modeler.schematic.create_i_sin(name="new_current_source", value = 100)
+        """
+        if location is None:
+            location = []
+        component = self.create_component(
+            name,
+            component_library="Sources",
+            component_name="ISin",
+            location=location,
+            angle=angle,
+            use_instance_id_netlist=use_instance_id_netlist,
+        )
+        component.parameters["Ia"] = value
+        if isinstance(name, (str, int, float)):
+            component.parameters["Name"] = name
+        return component
+
+    @pyaedt_function_handler()
+    def create_v_sin(self, name=None, value=1, location=None, angle=0, use_instance_id_netlist=False):
+        """Create a sinusoidal voltage source.
+
+        Parameters
+        ----------
+        name : str, int, float or optional
+            Name of the voltage source. The default is ``None`` which adds a voltage source without a name.
+        value : float, optional
+            Value for the amplitude of voltage. The default is ``1``.
+        location : list of float, optional
+            Position on the X axis and Y axis.
+        angle : float, optional
+            Angle of rotation in degrees. The default is ``0``.
+        use_instance_id_netlist : bool, optional
+            Whether to use the instance ID in the net list or not. The default is ``False``.
+
+        Returns
+        -------
+        :class:`ansys.aedt.core.modeler.cad.object_3dcircuit.CircuitComponent`
+            Circuit Component Object.
+
+        References
+        ----------
+
+        >>> oEditor.CreateComponent
+
+        Examples
+        --------
+        >>>from ansys.aedt.core import MaxwellCircuit
+        >>>app=MaxwellCircuit()
+        >>>component=app.modeler.schematic.create_v_sin(name="new_voltage_source", value = 240)
+        """
+        if location is None:
+            location = []
+        component = self.create_component(
+            name,
+            component_library="Sources",
+            component_name="VSin",
+            location=location,
+            angle=angle,
+            use_instance_id_netlist=use_instance_id_netlist,
+        )
+        component.parameters["Va"] = value
+        if isinstance(name, (str, int, float)):
+            component.parameters["Name"] = name
+        return component

src/ansys/aedt/core/modeler/schematic.py

@@ -477,6 +477,42 @@
             val = f"{value}{units}"
         return val
 
+    @pyaedt_function_handler()
+    def create_page(self, name):
+        """Add a new circuit schematic page.
+
+        Parameters
+        ----------
+        name : str, int or float
+            Name to be used when creating the new circuit schematic.
+
+        Returns
+        -------
+        bool
+            ``True`` when successful, ``False`` when failed.
+
+        References
+        ----------
+        >>> oEditor.CreatePage()
+
+        Examples
+        --------
+        >>>from ansys.aedt.core import MaxwellCircuit
+        >>>app=MaxwellCircuit ()
+        >>>component=app.modeler.schematic.create_page(name=page_name)
+
+        """
+        if not isinstance(name, (str, int, float)):
+            self.logger.error("Wrong type for argument ``name``.")
+            return False
+        self.oeditor.CreatePage(name)
+        return True
+
+    @property
+    def nb_pages(self):
+        """Number of circuit schematic pages."""
+        return self.oeditor.GetNumPages()
+
 
 class ModelerNexxim(ModelerCircuit):
     """ModelerNexxim class.

tests/system/general/test_21_Circuit.py

@@ -367,9 +367,9 @@ def test_25_import_model(self):
 
     def test_25_zoom_to_fit(self):
         self.aedtapp.insert_design("zoom_test")
-        myind = self.aedtapp.modeler.schematic.create_inductor("L100", 1e-9)
-        myres = self.aedtapp.modeler.components.create_resistor("R100", 50)
-        mycap = self.aedtapp.modeler.components.create_capacitor("C100", 1e-12)
+        self.aedtapp.modeler.schematic.create_inductor("L100", 1e-9)
+        self.aedtapp.modeler.components.create_resistor("R100", 50)
+        self.aedtapp.modeler.components.create_capacitor("C100", 1e-12)
         self.aedtapp.modeler.zoom_to_fit()
 
     def test_26_component_catalog(self):

tests/system/general/test_35_MaxwellCircuit.py

@@ -115,3 +115,26 @@ def test_08_import_netlist(self):
         self.aedtapp.insert_design("SchematicImport")
         self.aedtapp.modeler.schematic.limits_mils = 5000
         assert self.aedtapp.create_schematic_from_netlist(self.netlist_file1)
+
+    def test_09_create_voltage_source(self):
+        name_type = ["voltage_source", 123, 1.23]
+        for item in name_type:
+            component = self.aedtapp.modeler.schematic.create_v_sin(name=item, value=3.14, angle=90)
+            assert component.parameters["Name"] == item
+        assert component.parameters["Va"] == 3.14
+
+    def test_10_create_current_source(self):
+        name_type = ["current_source", 456, 4.56]
+        for item in name_type:
+            component = self.aedtapp.modeler.schematic.create_i_sin(name=item, value=2.72, angle=90)
+            assert component.parameters["Name"] == item
+        assert component.parameters["Ia"] == 2.72
+
+    def test_11_create_page(self):
+        assert self.aedtapp.modeler.create_page("string_test")
+        assert self.aedtapp.modeler.nb_pages == 2
+        assert self.aedtapp.modeler.create_page(123)
+        assert self.aedtapp.modeler.nb_pages == 3
+        assert self.aedtapp.modeler.create_page(3.14)
+        assert self.aedtapp.modeler.nb_pages == 4
+        assert not self.aedtapp.modeler.create_page(["create_page_test"])