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

FEAT: Twinbuilder excitation component #4752

Draft
wants to merge 9 commits into
base: main
Choose a base branch
from

Conversation

gmalinve
Copy link
Collaborator

No description provided.

@ansys-reviewer-bot
Copy link
Contributor

Thanks for opening a Pull Request. If you want to perform a review write a comment saying:

@ansys-reviewer-bot review

@gmalinve gmalinve changed the title initial commits for twinbuilder add excitation model FEAT: Twinbuilder excitation component May 31, 2024
@github-actions github-actions bot added the enhancement New features or code improvements label May 31, 2024
Copy link

codecov bot commented May 31, 2024

Codecov Report

Attention: Patch coverage is 30.00000% with 56 lines in your changes missing coverage. Please review.

Project coverage is 77.98%. Comparing base (d3aa856) to head (6035e1d).
Report is 1 commits behind head on main.

Current head 6035e1d differs from pull request most recent head 4e98a84

Please upload reports for the commit 4e98a84 to get more accurate results.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #4752      +/-   ##
==========================================
- Coverage   82.67%   77.98%   -4.69%     
==========================================
  Files         117      117              
  Lines       54186    54249      +63     
==========================================
- Hits        44797    42308    -2489     
- Misses       9389    11941    +2552     

Use the excitation component to assign output quantities in a Twin Builder design to a windings
in a Maxwell design.

This method works only with AEDT versions > 2024 R2.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
This method works only with AEDT versions > 2024 R2.
This method works only with AEDT 2024 R2 and later.

start : float, optional
Start time.
The default value is ``None``.
If not provided and ``use_default_values`` is ``True`` the value is chosen from the TR setup.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
If not provided and ``use_default_values`` is ``True`` the value is chosen from the TR setup.
If not provided and ``use_default_values=True``, the value is chosen from the TR setup.

stop : float, optional
Stop time.
The default value is ``None``.
If not provided and ``use_default_values`` is ``True`` the value is chosen from the TR setup.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
If not provided and ``use_default_values`` is ``True`` the value is chosen from the TR setup.
If not provided and ``use_default_values=True``, the value is chosen from the TR setup.

Comment on lines +619 to +620
If ``True``, Twin Builder performs linear interpolation to uniformly space out time and data points.
The interpolation is based on the step size provided.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
If ``True``, Twin Builder performs linear interpolation to uniformly space out time and data points.
The interpolation is based on the step size provided.
Whether Twin Builder is to perform linear interpolation to uniformly space out time and data points.
The interpolation is based on the step size provided. The default is ``False``.

Comment on lines +622 to +623
Step size used for the uniform interpolation.
The default value is ``1E-5``.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Step size used for the uniform interpolation.
The default value is ``1E-5``.
Step size to use for the uniform interpolation.
The default value is ``1E-5``.

>>> oComponentManager.AddExcitationModel
"""
if self.aedt_version_id < "2024.2":
self.logger.error("This method only work for AEDT versions > 2024 R2.")
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
self.logger.error("This method only work for AEDT versions > 2024 R2.")
self.logger.error("This method only work for AEDT 2024 R2 and later.")

twin_app = dkp[[project, self.design_name]]
project_selection = 0
else:
raise ValueError("Invalid project name or path provided.")
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
raise ValueError("Invalid project name or path provided.")
raise ValueError("Invalid project name or path is provided.")

Messages should have subject, verb, and concluding punctuation.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New features or code improvements
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants