Skip to content

Commit 15f928c

Browse files
Clean up related to older class names for Twin Builder (#898)
1 parent d31ebac commit 15f928c

File tree

6 files changed

+23
-23
lines changed

6 files changed

+23
-23
lines changed

doc/source/API/Primitives.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ modeler, including all primitives methods and properties.
4949
* Modeler2D for ``Maxwell2D`` ``Q2d``
5050
* Modeler3DLayout for ``Hfss3dLayout``
5151
* ModelerNexxim for ``Circuit``
52-
* ModelerSimplorer for ``Simplorer``
52+
* ModelerTwinBuilder for ``TwinBuilder``
5353
* ModelerEmit for ``Emit``
5454

5555

@@ -63,7 +63,7 @@ modeler, including all primitives methods and properties.
6363
Model3D.Modeler3D
6464
Model3DLayout.Modeler3DLayout
6565
Circuit.ModelerNexxim
66-
Circuit.ModelerSimplorer
66+
Circuit.ModelerTwinBuilder
6767
Circuit.ModelerEmit
6868

6969

@@ -76,7 +76,7 @@ The ``Primitives`` module includes these classes:
7676
* Primitives2D for ``Maxwell2D`` ``Q2d``
7777
* Primitives3DLayout for ``Hfss3dLayout``
7878
* NexximComponents for ``Circuit``
79-
* SimplorerComponents for ``Simplorer``
79+
* TwinBuilderComponents for ``TwinBuilder``
8080
* CircuitComponents for ``Emit``
8181
Primives objects are accessible through ``modeler`` property for
8282
EM Solver and ``modeler.components`` for circuit solvers.
@@ -105,7 +105,7 @@ EM Solver and ``modeler.components`` for circuit solvers.
105105
Primitives3D.Primitives3D
106106
Primitives3DLayout.Primitives3DLayout
107107
PrimitivesNexxim.NexximComponents
108-
PrimitivesSimplorer.SimplorerComponents
108+
PrimitivesTwinBuilder.TwinBuilderComponents
109109
PrimitivesCircuit.CircuitComponents
110110

111111

doc/source/API/Setup.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ Setup
22
=====
33
This section lists setup modules:
44
* Setup for ``Hfss``, ``Maxwell2D``, ``Maxwell3d``, ``Q2d`` and ``Q3d``
5-
* SetupCircuit for ``Circuit`` and ``Simplorer``
5+
* SetupCircuit for ``Circuit`` and ``Twin Builder``
66
* Setup3DLayout for ``Hfss3dLayout``
77
Setup object is accessible through the ``create_setup`` method and ``setups`` object list.
88

pyaedt/application/AnalysisTwinBuilder.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
from pyaedt.generic.general_methods import aedt_exception_handler
2-
from pyaedt.modeler.Circuit import ModelerSimplorer
2+
from pyaedt.modeler.Circuit import ModelerTwinBuilder
33
from pyaedt.modules.SolveSetup import SetupCircuit
44
from pyaedt.application.Analysis import Analysis
55
from pyaedt.modules.PostProcessor import CircuitPostProcessor
@@ -68,7 +68,7 @@ def __init__(
6868
student_version,
6969
)
7070
self.solution_type = solution_type
71-
self._modeler = ModelerSimplorer(self)
71+
self._modeler = ModelerTwinBuilder(self)
7272
self._post = CircuitPostProcessor(self)
7373

7474
@property

pyaedt/modeler/Circuit.py

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
from pyaedt.modeler.Primitives3DLayout import Primitives3DLayout
66
from pyaedt.modeler.PrimitivesEmit import EmitComponents
77
from pyaedt.modeler.PrimitivesNexxim import NexximComponents
8-
from pyaedt.modeler.PrimitivesSimplorer import SimplorerComponents
8+
from pyaedt.modeler.PrimitivesTwinBuilder import TwinBuilderComponents
99
from pyaedt.modeler.PrimitivesMaxwellCircuit import MaxwellCircuitComponents
1010
from pyaedt.modeler.Object3d import CircuitComponent
1111
from pyaedt.modeler.Object3d import _dim_arg
@@ -314,25 +314,25 @@ def rotate(self, selections, degrees=90):
314314
return True
315315

316316

317-
class ModelerSimplorer(ModelerCircuit):
318-
"""ModelerSimplorer class.
317+
class ModelerTwinBuilder(ModelerCircuit):
318+
"""ModelerTwinBuilder class.
319319
320320
Parameters
321321
----------
322-
app : :class:`pyaedt.application.AnalysisSimplorer.FieldAnalysisSimplorer`
322+
app : :class:`pyaedt.application.AnalysisTwinBuilder.AnalysisTwinBuilder`
323323
324324
"""
325325

326326
def __init__(self, app):
327327
self._app = app
328328
ModelerCircuit.__init__(self, app)
329-
self._components = SimplorerComponents(self)
329+
self._components = TwinBuilderComponents(self)
330330

331331
@property
332332
def components(self):
333333
"""
334334
.. deprecated:: 0.4.13
335-
Use :func:`Simplorer.modeler.schematic` instead.
335+
Use :func:`TwinBuilder.modeler.schematic` instead.
336336
337337
"""
338338
return self._components
@@ -343,7 +343,7 @@ def schematic(self):
343343
344344
Returns
345345
-------
346-
:class:`pyaedt.modeler.PrimitivesSimplorer.SimplorerComponents`
346+
:class:`pyaedt.modeler.PrimitivesTwinBuilder.TwinBuilderComponents`
347347
348348
"""
349349
return self._components
@@ -354,7 +354,7 @@ class ModelerEmit(ModelerCircuit):
354354
355355
Parameters
356356
----------
357-
app : :class:`pyaedt.application.AnalysisSimplorer.FieldAnalysisSimplorer`
357+
app : :class:`pyaedt.application.AnalysisEmit`
358358
359359
"""
360360

pyaedt/modeler/PrimitivesCircuit.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
class CircuitComponents(object):
2121
"""CircutComponents class.
2222
23-
Manages all circuit components for Nexxim and Simplorer.
23+
Manages all circuit components for Nexxim and Twin Builder.
2424
2525
Examples
2626
--------

pyaedt/modeler/PrimitivesSimplorer.py renamed to pyaedt/modeler/PrimitivesTwinBuilder.py

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@
22
from pyaedt.modeler.PrimitivesCircuit import CircuitComponents, ComponentCatalog
33

44

5-
class SimplorerComponents(CircuitComponents):
6-
"""SimplorerComponents class.
5+
class TwinBuilderComponents(CircuitComponents):
6+
"""TwinBuilderComponents class.
77
8-
This class is for managing all circuit components for Simplorer.
8+
This class is for managing all circuit components for Twin Builder.
99
1010
Parameters
1111
----------
@@ -15,10 +15,10 @@ class SimplorerComponents(CircuitComponents):
1515
1616
Examples
1717
--------
18-
Basic usage demonstrated with a Simplorer design:
18+
Basic usage demonstrated with a Twin Builder design:
1919
20-
>>> from pyaedt import Simplorer
21-
>>> aedtapp = Simplorer()
20+
>>> from pyaedt import Twin Builder
21+
>>> aedtapp = TwinBuilder()
2222
>>> prim = aedtapp.modeler.schematic
2323
"""
2424

@@ -201,7 +201,7 @@ def create_capacitor(self, compname=None, value=50, location=[], angle=0, use_in
201201
def create_voltage_source(
202202
self, compname=None, type="E", amplitude=326, freq=50, location=[], angle=0, use_instance_id_netlist=False
203203
):
204-
"""Create a voltage source.
204+
"""Create a voltage source (conservative electrical output).
205205
206206
Parameters
207207
----------

0 commit comments

Comments
 (0)