ansys / pyaedt

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

m2d.enable_harmonic_force does not have a complete set of inputs #4779

Open JuliusSaitz opened 1 month ago

JuliusSaitz commented 1 month ago

Before submitting the issue

Description of the bug

m2d.enable_harmonic_force should correspond to EnableHarmonicForceCalculation API. Currently, the inputs to enable_harmonic_force are:

assignment – List of object names for force calculations. force_type – Force type. Options are 0 for objects, 1 for surface, and 2 for volumetric. window_function – Windowing function. use_number_of_last_cycles – Use number of last cycles for force calculations. Default is True. last_cycles_number – Defines the number of cycles to compute if use_number_of_last_cycle is True. calculate_force – How to calculate force. The default is "Harmonic". Options are "Harmonic" and "Transient".

The API contains:

"EnabledObjects:=" , list, "ForceType:=" , 0, "WindowFunctionType:=" , "Rectangular", "NumberOfRepeatedSamples:=", "1", "UseNumberOfLastCycles:=", False, "NumberOfLastCycles:=" , 1, "StartTime:=" , "0s", "UseNumberOfCyclesForStopTime:=", False, "NumberOfCyclesForStopTime:=", 1, "StopTime:=" , "1.25ms", "OutputFreqRangeType:=" , "Use All",* "CaculateForceType:=" , "Harmonic Force", "EnableInverterFeedback:=", False

The parameters in the API list with indent are missing from the pyaedt method. Please, add the missing parameters, otherwise the function has a limited usability.

Steps To Reproduce

check m2d.enable_harmonic_force

Which Operating System are you using?

Windows

Which Python version are you using?

3.7

Installed packages

attrs==23.1.0 certifi==2021.10.8 cffi==1.15.1 charset-normalizer==2.0.12 click==8.1.3 click-plugins==1.1.1 cligj==0.7.2 clr-loader==0.2.5 colorama==0.4.6 contourpy==1.0.7 cycler==0.11.0 et-xmlfile==1.1.0 Fiona==1.9.3 fonttools==4.39.3 geopandas==0.12.2 idna==3.3 imageio==2.27.0 importlib-metadata==6.5.0 importlib-resources==5.12.0 kiwisolver==1.4.4 matplotlib==3.7.1 munch==2.5.0 networkx==3.1 numpy==1.24.1 openpyxl==3.0.10 osmnx==1.2.2 packaging==23.1 pandas==1.5.3 Pillow==9.5.0 platformdirs==3.2.0 plumbum==1.8.1 pooch==1.7.0 psutil==5.9.0 pyaedt==0.6.71 pycparser==2.21

Editable install with no version control (PyMotorCAD==0.0.1)

-e c:\ansys_motor-cad\15_1_3\python\rpc pyparsing==3.0.9 pyproj==3.5.0 python-dateutil==2.8.2 pythonnet==3.0.1 pytz==2023.3 pyvista==0.37.0 pywin32==304 requests==2.28.2 rpyc==5.3.0 Rtree==1.0.1 scikit-rf==0.26.0 scipy==1.8.0 scooby==0.7.1 Shapely==1.8.5.post1 six==1.16.0 SRTM.py==0.3.7 urllib3==1.26.9 utm==0.7.0 vtk==9.2.6 zipp==3.15.0