Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fixed Docstring #3970 #3985

Merged
merged 27 commits into from
Dec 22, 2023
Merged
Changes from 4 commits
Commits
Show all changes
27 commits
Select commit Hold shift + click to select a range
731a92a
Fixed Docstring #3970
DaveTwyman Dec 14, 2023
cab3a8e
Update pyaedt/maxwell.py
DaveTwyman Dec 15, 2023
171132e
Merge branch 'main' into fix/doc3970
gmalinve Dec 18, 2023
4e2c0fe
Merge branch 'main' into fix/doc3970
gmalinve Dec 20, 2023
ab63597
Merge branch 'main' into fix/doc3970
DaveTwyman Dec 20, 2023
e35a28c
Update pyaedt/maxwell.py
DaveTwyman Dec 20, 2023
ebd876f
Update pyaedt/maxwell.py
DaveTwyman Dec 20, 2023
bef6358
Update pyaedt/maxwell.py
DaveTwyman Dec 20, 2023
add25ce
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Dec 20, 2023
0e620b6
Update maxwell.py
DaveTwyman Dec 20, 2023
7e489cf
Update maxwell.py
DaveTwyman Dec 20, 2023
e7bbe18
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Dec 20, 2023
a474c4b
Merge branch 'main' into fix/doc3970
DaveTwyman Dec 20, 2023
5cc1f3a
Update pyaedt/maxwell.py
DaveTwyman Dec 21, 2023
2ea9761
Update pyaedt/maxwell.py
DaveTwyman Dec 21, 2023
88a5d42
Merge branch 'main' into fix/doc3970
DaveTwyman Dec 21, 2023
913a68c
Update pyaedt/maxwell.py
DaveTwyman Dec 21, 2023
28d9453
Fixed Docstring #3970 and removed reference to HFSS
DaveTwyman Dec 21, 2023
5ce3b2d
Fixed Docstring #3970 and removed reference to HFSS
DaveTwyman Dec 21, 2023
a4fc1d4
Title style reverted to Sentence-style capitalization.
DaveTwyman Dec 21, 2023
6655ecf
fix doc
gmalinve Dec 22, 2023
728d61f
fix doc
gmalinve Dec 22, 2023
a93f9dc
Reference to AC and DC Conduction templates removed
DaveTwyman Dec 22, 2023
1f97d9b
Merge branch 'main' into fix/doc3970
DaveTwyman Dec 22, 2023
9dba113
Merge branch 'main' into fix/doc3970
DaveTwyman Dec 22, 2023
00be6f4
Merge remote-tracking branch 'origin/fix/doc3970' into fix/doc3970
DaveTwyman Dec 22, 2023
9b29f46
remove blank line
DaveTwyman Dec 22, 2023
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
69 changes: 32 additions & 37 deletions pyaedt/maxwell.py
Original file line number Diff line number Diff line change
Expand Up @@ -1946,43 +1946,38 @@ def edit_external_circuit(self, netlist_file_path, schematic_design_name):
@pyaedt_function_handler()
def create_setup(self, setupname="MySetupAuto", setuptype=None, **kwargs):
"""Create an analysis setup for Maxwell 3D or 2D.
Optional arguments are passed along with ``setuptype`` and ``setupname``. Keyword
names correspond to the ``setuptype``
corresponding to the native AEDT API. The list of
keywords here is not exhaustive.

.. note::
This method overrides the ``Analysis.setup()`` method for the HFSS app.

Parameters
----------
setuptype : int, str, optional
Type of the setup. Based on the solution type, options are
``"HFSSDrivenAuto"``, ``"HFSSDrivenDefault"``,
``"HFSSEigen"``, ``"HFSSTransient"`` and ``"HFSSSBR"``.
The default is ``"HFSSDrivenAuto"``.
setupname : str, optional
Name of the setup. The default is ``"Setup1"``.
**kwargs : dict, optional
Available keys depend on the setup chosen.
For more information, see :doc:`../SetupTemplatesMaxwell`.

Returns
-------
:class:`pyaedt.modules.SolveSetup.SetupMaxwell`
3D Solver Setup object.

References
----------

>>> oModule.InsertSetup

Examples
--------

>>> from pyaedt import Maxwell3d
>>> app = Maxwell3d()
>>> app.create_setup(setupname="Setup1", setuptype="EddyCurrent", MaximumPasses=10,PercentError=2 )
Optional arguments are passed along with ``setuptype`` and ``setupname``. Keyword
names correspond to the ``setuptype``
corresponding to the native AEDT API. The list of
keywords here is not exhaustive.
``
DaveTwyman marked this conversation as resolved.
Show resolved Hide resolved
Parameters
----------
setuptype : int, str, optional
Type of the setup. Based on the solution type, options are
"Magnetostatic", "EddyCurrent", Transient" etc.
setupname : str, optional
Name of the setup. The default is ``"Setup1"``.
**kwargs : dict, optional
Available keys depend on the setup chosen.
For more information, see :doc:`../SetupTemplatesMaxwell`.

Returns
-------
:class:`pyaedt.modules.SolveSetup.SetupMaxwell`
3D Solver Setup object.

References
----------

DaveTwyman marked this conversation as resolved.
Show resolved Hide resolved
>>> oModule.InsertSetup

Examples
--------

DaveTwyman marked this conversation as resolved.
Show resolved Hide resolved
>>> from pyaedt import Maxwell3d
>>> app = Maxwell3d()
>>> app.create_setup(setupname="My_Setup", setuptype="EddyCurrent", MaximumPasses=10, PercentError=2 )

"""
if setuptype is None:
Expand Down
Loading