search

ansys / pyaedt

AEDT Python Client Package
https://aedt.docs.pyansys.com
MIT License
204 stars 125 forks source link

Parameter questions/issues #77

Closed PipKat closed 2 years ago

PipKat commented 3 years ago

Hffs.py file contains parameter descriptions that are a bit confusing or different from other files. We'd like to strive for consistency.

Lumped--The HFSS has a few function functions and parameter descriptions with lumped in them. Some of these seem like they might need to be rewritten.

For the parameter "sweeptype," choices are listed here have initial captial letters. I know in another file, I saw them as lower case. Can they standardized. If so, which form is preferred. Alex said that there may be an API variation between the different products.

For one occurrence, the description for the parameter "startobj" has this additional sentence: This is typically the reference plane. Should this sentence be added to the description of all occurrences of "startobj"?

maxcapodi78 commented 3 years ago

Hello @PipKat . Concerning first part of the issue, I agree, we should standardize it. This is result of different merging activities and needs a slight cosmetic refactor. Regarding the second question (startobj) the answer is no. Only the microstrip method needs that comment

MaxJPRey commented 2 years ago

@maxcapodi78 Do you want me to rename the sweeptype values in lower case. If we proceed so, "Interpolating" would become "interpolating".

Let me know what you think. Otherwise, I will close the issue as the second part of this issue is the expected behavior for the "startobj" parameter when dealing with microstrip.