Basic thermal example review #323

JackB-Ansys · 2024-06-13T15:04:40Z

Update to Thermal basic example to fix some issues and improve comments.

…ph method to work with new methods. Updated basic examples

PipKat · 2024-06-25T16:53:44Z

examples/basics/emag_basics.py

+# This script will change model parameter values (geometry, winding pattern and materials),
+# run magnetic calculations, extract and plot results.


Suggested change

# This script will change model parameter values (geometry, winding pattern and materials),

# run magnetic calculations, extract and plot results.

# This script changes model parameter values (geometry, winding pattern, and materials),

# runs magnetic calculations, and extracts and plots results.

Use present tense and Oxford comma.

PipKat · 2024-06-25T16:54:44Z

examples/basics/emag_basics.py

 #
 # Perform required imports
 # ~~~~~~~~~~~~~~~~~~~~~~~~
+# Import ``pymotorcad`` to access Motor-CAD. Import ``pyplot`` from ``matplotlib`` to display
+# graphics. Import ``os``, ``shutil``  and ``tempfile`` to open and save a temporary MOT


Suggested change

# graphics. Import ``os``, ``shutil`` and ``tempfile`` to open and save a temporary MOT

# graphics. Import ``os``, ``shutil``, and ``tempfile`` to open and save a temporary MOT

PipKat · 2024-06-25T16:55:45Z

examples/basics/emag_basics.py

 #
 # Perform required imports
 # ~~~~~~~~~~~~~~~~~~~~~~~~
+# Import ``pymotorcad`` to access Motor-CAD. Import ``pyplot`` from ``matplotlib`` to display


Suggested change

# Import ``pymotorcad`` to access Motor-CAD. Import ``pyplot`` from ``matplotlib`` to display

# Import ``pymotorcad`` to access Motor-CAD. Import ``pyplot`` from Matplotlib to display

Use the product name for Matplotlib to avoid a code entity of a code entity?

PipKat · 2024-06-25T16:56:19Z

examples/basics/emag_basics.py

+# after executing the script, use the ``MotorCAD(keep_instance_open=True)`` option when opening the
+# new instance.


Suggested change

# after executing the script, use the ``MotorCAD(keep_instance_open=True)`` option when opening the

# new instance.

# after executing the script, use ``MotorCAD(keep_instance_open=True`` when opening the

# new instance.

PipKat · 2024-06-25T16:58:13Z

examples/basics/emag_basics.py

+#    This will also disable crucial popups, for example prompts to save data or overwrite data, or
+#    dialogs used to reconcile differences in material data between the database and MOT file. In
+#    each case the default action will be taken. This setting will persist until Motor-CAD is
+#    closed.


Suggested change

# This will also disable crucial popups, for example prompts to save data or overwrite data, or

# dialogs used to reconcile differences in material data between the database and MOT file. In

# each case the default action will be taken. This setting will persist until Motor-CAD is

# closed.

# This also disables crucial popups, such as example prompts to save data or overwrite data and

# dialogs used to reconcile differences in material data between the database and MOT file. In

# each case, the default action is taken. This setting persists until Motor-CAD is

# closed.

PipKat · 2024-06-25T16:58:29Z

examples/basics/emag_basics.py

+# Set Motor-CAD to EMag
+# ~~~~~~~~~~~~~~~~~~~~~
+# Show the E-Magnetic context in Motor-CAD and ensure that the BPM
+# Motor Type is set.


Suggested change

# Motor Type is set.

# motor type is set.

PipKat · 2024-06-25T17:00:08Z

examples/basics/emag_basics.py

+# Setting up the analysis consists of setting the geometry, winding and material parameters, setting
+# the calculation options and operating point, and saving the file.


Suggested change

# Setting up the analysis consists of setting the geometry, winding and material parameters, setting

# the calculation options and operating point, and saving the file.

# Setting up the analysis consists of setting the geometry, winding and material parameters,

# calculation options and operating point, and then saving the file.

PipKat · 2024-06-25T17:00:30Z

examples/basics/emag_basics.py

+#
+# Geometry setup
+# ~~~~~~~~~~~~~~
+# Display the **Scripting** tab and set the ``Slot_Number``, ``Tooth_Width`` and


Suggested change

# Display the **Scripting** tab and set the ``Slot_Number``, ``Tooth_Width`` and

# Display the **Scripting** tab and set the ``Slot_Number``, ``Tooth_Width``, and

PipKat · 2024-06-25T17:02:56Z

examples/basics/emag_basics.py

+#    To set parameter values via automation with the GUI visible, a different tab must be displayed.
+#    The **Scripting** tab is chosen because no parameters on this tab will be changed in this
+#    script. It is best practice to display the **Scripting** tab when changing input parameters by


Suggested change

# To set parameter values via automation with the GUI visible, a different tab must be displayed.

# The **Scripting** tab is chosen because no parameters on this tab will be changed in this

# script. It is best practice to display the **Scripting** tab when changing input parameters by

# To set parameter values by automation with the GUI visible, a different tab must be displayed.

# The **Scripting** tab is chosen because no parameters on this tab are changed in this

# script. It is best practice to display the **Scripting** tab when changing input parameters by

Use present tense. Style guide says to avoid using "via" as a preposition.

PipKat · 2024-06-25T17:06:24Z

examples/basics/emag_basics.py

+# * Define parameters for coil 3 using the ``set_winding_coil()`` method. Set positions to a, b, c
+#   etc. when using Upper/Lower paths (when Left/Right paths are selected,  L or R should be used
+#   instead). Define the third coil to have 60 turns in the second phase.


Suggested change

# * Define parameters for coil 3 using the ``set_winding_coil()`` method. Set positions to a, b, c

# etc. when using Upper/Lower paths (when Left/Right paths are selected, L or R should be used

# instead). Define the third coil to have 60 turns in the second phase.

# * Define parameters for coil 3 using the ``set_winding_coil()`` method. Set positions to a, b, c, and so on

# when using Upper/Lower paths. (When Left/Right paths are selected, L or R should be used

# instead.) Define the third coil to have 60 turns in the second phase.

PipKat · 2024-06-25T17:08:19Z

examples/basics/emag_basics.py

+# Setting up the analysis consists of setting the geometry, winding and material parameters, setting
+# the calculation options and operating point, and saving the file.
+#
+# Geometry setup


All the section headings should be set up so that they start with a simple verb and then the action. For example, the heading here would be: Set up geometry. The heading for the next section would be: Set up winding. Please change the headings to follow this format.

PipKat · 2024-06-25T17:09:48Z

examples/basics/emag_basics.py

-mcad.set_component_material("Rotor Lam (Back Iron)", "M250-35A")
+# Materials setup
+# ~~~~~~~~~~~~~~~
+# Set the stator and rotor lamination materials. Component names are displayed in the


Suggested change

# Set the stator and rotor lamination materials. Component names are displayed in the

# Set the stator and rotor lamination materials. Component names are shown in the

An intransitive verb is necessary (because subject is not doing the action).

PipKat · 2024-06-25T17:11:42Z

examples/basics/emag_basics.py

+# *Materials* tab in Motor-CAD. Materials and their properties are defined in the Motor-CAD
+# *Material database*.


Suggested change

# *Materials* tab in Motor-CAD. Materials and their properties are defined in the Motor-CAD

# *Material database*.

# **Materials** tab in Motor-CAD. Materials and their properties are defined in the Motor-CAD

# **Material database**.

Double asterisks for bold (UI elements).

PipKat · 2024-06-25T17:11:59Z

examples/basics/emag_basics.py

+# Calculation options
+# ~~~~~~~~~~~~~~~~~~~


Suggested change

# Calculation options

# ~~~~~~~~~~~~~~~~~~~

# Set calculation options

# ~~~~~~~~~~~~~~~~~~~~~~~

PipKat · 2024-06-25T17:12:26Z

examples/basics/emag_basics.py

+# Operating point
+# ~~~~~~~~~~~~~~~


Suggested change

# Operating point

# ~~~~~~~~~~~~~~~

# Set operating point

# ~~~~~~~~~~~~~~~~~~~

PipKat · 2024-06-25T17:12:59Z

examples/basics/emag_basics.py

-mcad.set_variable("PhaseAdvance", 45)
+# Operating point
+# ~~~~~~~~~~~~~~~
+# Set the operating point of the machine, defined by the speed, current and phase advance. Ensure


Suggested change

# Set the operating point of the machine, defined by the speed, current and phase advance. Ensure

# Set the operating point of the machine, defined by the speed, current, and phase advance. Ensure

PipKat · 2024-06-25T17:13:36Z

examples/basics/emag_basics.py

-mcad.save_to_file(filename)
+# Save the file
+# ~~~~~~~~~~~~~
+# Save the file to the temporary folder and display a message that the initialisation in complete.


Suggested change

# Save the file to the temporary folder and display a message that the initialisation in complete.

# Save the file to the temporary folder and display a message that the initialization in complete.

American spelling.

PipKat · 2024-06-25T17:13:45Z

examples/basics/emag_basics.py

+# ~~~~~~~~~~~~~
+# Save the file to the temporary folder and display a message that the initialisation in complete.
+mc.save_to_file(working_folder + "/" + mot_name + ".mot")
+print("Initialisation completed.")


Suggested change

print("Initialisation completed.")

print("Initialization completed.")

PipKat · 2024-06-25T17:14:51Z

examples/basics/emag_basics.py

+# Export results to a CSV file. Results will be saved as *Export_EMag_Results.csv* in the temporary
+# working directory. A try and except block are used to raise an error in the case of the export


Suggested change

# Export results to a CSV file. Results will be saved as *Export_EMag_Results.csv* in the temporary

# working directory. A try and except block are used to raise an error in the case of the export

# Export results to a CSV file. Results are saved in a ``Export_EMag_Results.csv`` file in the temporary

# working directory. A try-and-except block is used to raise an error in the case of the export

PipKat · 2024-06-25T17:15:07Z

examples/basics/emag_basics.py


 # %%
-# Get and analyze results
+# Get and analyse results


Suggested change

# Get and analyse results

# Get and analyze results

American spelling.

PipKat · 2024-06-25T17:16:02Z

examples/basics/emag_basics.py

+# Retrieve the *Torque (VW)* graph data. The data type for this series is *E-Magnetics*, so use the
+# ``get_magnetic_graph()`` method.


The single asterisk results in italics font. Is this what you want? It seems that both of these are code entities and should be double backticks.

PipKat · 2024-06-25T17:19:21Z

examples/basics/emag_basics.py

+#    When retrieving graph data points, use the *Graph Viewer* under *Help* in the Motor-CAD
+#    interface to find the series names and data types.


Suggested change

# When retrieving graph data points, use the *Graph Viewer* under *Help* in the Motor-CAD

# interface to find the series names and data types.

# When retrieving graph data points, use the **Graph Viewer** under **Help** in the Motor-CAD

# interface to find the series names and data types.

Double asterisk for bold to indicate a UI element.

PipKat · 2024-06-25T17:20:28Z

examples/basics/emag_basics.py

+# Retrieve the airgap flux density graph data. This data can be found in the *Graph Viewer* in
+# Motor-CAD. The data type for this series is *FEA Path*, so use the ``get_fea_graph()`` method.


Suggested change

# Retrieve the airgap flux density graph data. This data can be found in the *Graph Viewer* in

# Motor-CAD. The data type for this series is *FEA Path*, so use the ``get_fea_graph()`` method.

# Retrieve the airgap flux density graph data. This data can be found in the **Graph Viewer** in

# Motor-CAD. The data type for this series is **FEA Path**, so use the ``get_fea_graph()`` method.

Not sure if FEA Path in bold for UI element or double backticks for code entity?

PipKat · 2024-06-25T17:21:58Z

examples/basics/emag_basics.py

+# Only the most recently displayed harmonic graphs are available in Motor-CAD via the
+# *Graph Viewer*. To retrieve harmonic data by using Motor-CAD automation, first display the
+# relevant *Graphs -> Harmonics* tab. Use the ``initialise_tab_names()`` method to initialise the
+# available tabs in the Motor-CAD user interface. When the tabs have been initialised, the
+# ``display_screen()`` method can be used until either the Motor-CAD context is changed, or the
+# instance is closed.


Suggested change

# Only the most recently displayed harmonic graphs are available in Motor-CAD via the

# *Graph Viewer*. To retrieve harmonic data by using Motor-CAD automation, first display the

# relevant *Graphs -> Harmonics* tab. Use the ``initialise_tab_names()`` method to initialise the

# available tabs in the Motor-CAD user interface. When the tabs have been initialised, the

# ``display_screen()`` method can be used until either the Motor-CAD context is changed, or the

# instance is closed.

# Only the most recently displayed harmonic graphs are available in Motor-CAD using the

# **Graph Viewer**. To retrieve harmonic data by using Motor-CAD automation, first display the

# relevant **Graphs -> Harmonics** tab. Use the ``initialise_tab_names()`` method to initialize the

# available tabs in the Motor-CAD user interface. When the tabs have been initialized, you can use the

# ``display_screen()`` method until either the Motor-CAD context is changed or the

# instance is closed.

PipKat · 2024-06-25T17:22:18Z

examples/basics/emag_basics.py

+# ``display_screen()`` method can be used until either the Motor-CAD context is changed, or the
+# instance is closed.
+#
+# Open the *Graphs -> Harmonics -> Torque* tab to make the torque harmonic data available.


Suggested change

# Open the *Graphs -> Harmonics -> Torque* tab to make the torque harmonic data available.

# Open the **Graphs -> Harmonics -> Torque** tab to make the torque harmonic data available.

PipKat · 2024-06-25T17:23:25Z

examples/basics/emag_basics.py

-    except pymotorcad.MotorCADError:
-        print("Results failed to export.")
-
+# Retrieve the torque harmonic graph data. The data type for this series is *E-Magnetics*, so use


Suggested change

# Retrieve the torque harmonic graph data. The data type for this series is *E-Magnetics*, so use

# Retrieve the torque harmonic graph data. The data type for this series is **E-Magnetics**, so use

Double asterisk for bold for UI element, but double backticks if this is a code entity.

PipKat · 2024-06-25T17:23:41Z

examples/basics/emag_basics.py


 print("Simulation completed.")


 # %%
 # Plot results
 # ------------
-# Plot results from the simulation.
+# Use``pyplot`` from ``matplotlib`` (imported as ``plt``) to plot graphs of the simulation results.


Suggested change

# Use``pyplot`` from ``matplotlib`` (imported as ``plt``) to plot graphs of the simulation results.

# Use``pyplot`` from Matplotlib (imported as ``plt``) to plot graphs of the simulation results.

PipKat · 2024-06-25T17:24:03Z

examples/basics/emag_basics.py


 print("Simulation completed.")


 # %%
 # Plot results
 # ------------
-# Plot results from the simulation.
+# Use``pyplot`` from ``matplotlib`` (imported as ``plt``) to plot graphs of the simulation results.
+# Plot the Airgap Flux Density and the Torque (VW) results as subplots in the same figure.


Suggested change

# Plot the Airgap Flux Density and the Torque (VW) results as subplots in the same figure.

# Plot the airgap flux density and the torque (VW) results as subplots in the same figure.

PipKat · 2024-06-25T17:24:13Z

examples/basics/emag_basics.py

-# --------------
-# Exit Motor-CAD.
-mcad.quit()
+# Plot the Torque harmonic results as a bar chart.


Suggested change

# Plot the Torque harmonic results as a bar chart.

# Plot the torque harmonic results as a bar chart.

PipKat · 2024-06-25T17:25:14Z

examples/basics/emag_basics.py

+# If you want to continue working with this instance of Motor-CAD, use the
+# ``MotorCAD(keep_instance_open=True)`` option when you launch Motor-CAD. If Motor-CAD is kept open,
+# it is useful to restore the popup messages that were disabled earlier, using the
+# ``set_variable()`` method ().


Suggested change

# If you want to continue working with this instance of Motor-CAD, use the

# ``MotorCAD(keep_instance_open=True)`` option when you launch Motor-CAD. If Motor-CAD is kept open,

# it is useful to restore the popup messages that were disabled earlier, using the

# ``set_variable()`` method ().

# If you want to continue working with this instance of Motor-CAD, use

# ``MotorCAD(keep_instance_open=True`` when you launch Motor-CAD. If Motor-CAD is kept open,

# it is useful to restore the popup messages that were disabled earlier using the

# ``set_variable()`` method.

PipKat · 2024-06-25T17:25:43Z

examples/basics/thermal_basics.py

 # Perform required imports
 # ~~~~~~~~~~~~~~~~~~~~~~~~
-# Import the required packages.
+# Import ``pymotorcad`` to access Motor-CAD. Import ``pyplot`` from ``matplotlib`` to display


Suggested change

# Import ``pymotorcad`` to access Motor-CAD. Import ``pyplot`` from ``matplotlib`` to display

# Import ``pymotorcad`` to access Motor-CAD. Import ``pyplot`` from Matplotlib to display

PipKat · 2024-06-25T17:26:01Z

examples/basics/thermal_basics.py

 # Perform required imports
 # ~~~~~~~~~~~~~~~~~~~~~~~~
-# Import the required packages.
+# Import ``pymotorcad`` to access Motor-CAD. Import ``pyplot`` from ``matplotlib`` to display
+# graphics. Import ``os``, ``shutil``  and ``tempfile`` to open and save a temporary MOT


Suggested change

# graphics. Import ``os``, ``shutil`` and ``tempfile`` to open and save a temporary MOT

# graphics. Import ``os``, ``shutil``, and ``tempfile`` to open and save a temporary MOT

PipKat · 2024-06-25T17:26:16Z

examples/basics/thermal_basics.py

+# %%
+# Specify working directory
+# ~~~~~~~~~~~~~~~~~~~~~~~~~
+# Save the file to a temporary folder


Suggested change

# Save the file to a temporary folder

# Save the file to a temporary folder.

PipKat · 2024-06-25T17:26:45Z

examples/basics/thermal_basics.py

-print("Starting initialization.")
-mcad = pymotorcad.MotorCAD()
+# Connect to Motor-CAD and open a new Motor-CAD instance. To keep a new Motor-CAD instance open
+# after executing the script, use the ``MotorCAD(keep_instance_open=True)`` option when opening the


Suggested change

# after executing the script, use the ``MotorCAD(keep_instance_open=True)`` option when opening the

# after executing the script, use ``MotorCAD(keep_instance_open=True)`` when opening the

PipKat · 2024-06-25T17:28:02Z

examples/basics/thermal_basics.py

+#    This will also disable crucial popups, for example prompts to save data or overwrite data, or
+#    dialogs used to reconcile differences in material data between the database and MOT file. In
+#    each case the default action will be taken. This setting will persist until Motor-CAD is


Suggested change

# This will also disable crucial popups, for example prompts to save data or overwrite data, or

# dialogs used to reconcile differences in material data between the database and MOT file. In

# each case the default action will be taken. This setting will persist until Motor-CAD is

# This also disables crucial popups, such as prompts to save data or overwrite data and

# dialogs used to reconcile differences in material data between the database and MOT file. In

# each case, the default action is taken. This setting persists until Motor-CAD is

PipKat · 2024-06-25T17:29:22Z

examples/basics/thermal_basics.py

+# Set Motor-CAD to Thermal
+# ~~~~~~~~~~~~~~~~~~~~~~~~
+# Show the Thermal context in Motor-CAD and ensure that the BPM
+# Motor Type is set.


Suggested change

# Set Motor-CAD to Thermal

# ~~~~~~~~~~~~~~~~~~~~~~~~

# Show the Thermal context in Motor-CAD and ensure that the BPM

# Motor Type is set.

# Set Motor-CAD to thermal

# ~~~~~~~~~~~~~~~~~~~~~~~~

# Show the thermal context in Motor-CAD and ensure that the BPM

# motor type is set.

PipKat · 2024-06-25T17:30:57Z

examples/basics/thermal_basics.py

+# .. note::
+#    To set parameter values via automation with the GUI visible, a different tab must be displayed.
+#    The **Scripting** tab is chosen because no parameters on this tab will be changed in this


Suggested change

# .. note::

# To set parameter values via automation with the GUI visible, a different tab must be displayed.

# The **Scripting** tab is chosen because no parameters on this tab will be changed in this

# .. note::

# To set parameter values by automation with the GUI visible, a different tab must be shown.

# The **Scripting** tab is chosen because no parameters on this tab are changed in this

PipKat · 2024-06-25T17:31:40Z

examples/basics/thermal_basics.py

+# Thermal input data setup
+# ~~~~~~~~~~~~~~~~~~~~~~~~


Suggested change

# Thermal input data setup

# ~~~~~~~~~~~~~~~~~~~~~~~~

# Set up thermal input data

# ~~~~~~~~~~~~~~~~~~~~~~~~~

Again, start all headings starting with the simple verb form.

PipKat · 2024-06-25T17:32:33Z

examples/basics/thermal_basics.py

+mc.set_fluid("HousingWJFluid", "Dynalene HF-LO")
+
+# %%
+# Disable the option for *Active Cooling Only*, so that the HWJ channel also cools the front and


Suggested change

# Disable the option for *Active Cooling Only*, so that the HWJ channel also cools the front and

# Disable the option for **Active Cooling Only** so that the HWJ channel also cools the front and

PipKat · 2024-06-25T17:32:47Z

examples/basics/thermal_basics.py

+mc.set_variable("Water_Jacket_Active_Cooling_Only", 0)
+
+# %%
+# Enable the *Input h* option to allow user input of the heat transfer coefficients for HWJ cooling


Suggested change

# Enable the *Input h* option to allow user input of the heat transfer coefficients for HWJ cooling

# Enable the **Input h** option to allow user input of the heat transfer coefficients for HWJ cooling

PipKat · 2024-06-25T17:33:02Z

examples/basics/thermal_basics.py

+mc.set_array_variable("HousingWJ_CalcInputH_A", 0, 1)
+
+# %%
+# Get fluid properties (thermal conductivity, density and dynamic viscosity) and the fluid


Suggested change

# Get fluid properties (thermal conductivity, density and dynamic viscosity) and the fluid

# Get fluid properties (thermal conductivity, density, and dynamic viscosity) and the fluid

PipKat · 2024-06-25T17:34:14Z

examples/basics/thermal_basics.py

+#    Outputs will be updated when a steady state thermal calculation runs. Alternatively, the
+#    relevant tab (for example, *Input Data -> Housing Water Jacket -> Heat Transfer*) can be
+#    displayed - however this may not be suitable when running Motor-CAD without the GUI.


Suggested change

# Outputs will be updated when a steady state thermal calculation runs. Alternatively, the

# relevant tab (for example, *Input Data -> Housing Water Jacket -> Heat Transfer*) can be

# displayed - however this may not be suitable when running Motor-CAD without the GUI.

# Outputs are updated when a steady state thermal calculation runs. Alternatively, the

# relevant tab (for example, **Input Data -> Housing Water Jacket -> Heat Transfer**) can be

# shown. However, this might not be suitable when running Motor-CAD without the GUI.

PipKat · 2024-06-25T17:35:32Z

src/ansys/motorcad/core/methods/rpc_methods_graphs.py

+            Slice number to get x and y coordinate values from.
+        time_step_number : int
+            Time step number to get x and y coordinate values from.
+        Returns


Suggested change

Returns

Returns

Blank line is necessary for rendering correctly in the doc.

PipKat · 2024-06-25T17:35:52Z

src/ansys/motorcad/core/methods/rpc_methods_graphs.py

+            Value of x coordinates from graph
+        y_values : list
+            Value of y coordinates from graph


Suggested change

Value of x coordinates from graph

y_values : list

Value of y coordinates from graph

Value of x coordinates from graph.

y_values : list

Value of y coordinates from graph.

PipKat · 2024-06-25T17:36:14Z

src/ansys/motorcad/core/methods/rpc_methods_graphs.py

+            Slice number to get x and y coordinate values from.
+        time_step_number : int
+            Time step number to get x and y coordinate values from.
+        Returns


Suggested change

Returns

Returns

PipKat · 2024-06-25T17:36:23Z

src/ansys/motorcad/core/methods/rpc_methods_graphs.py

+            Value of x coordinates from graph
+        y_values : list
+            Value of y coordinates from graph


Suggested change

Value of x coordinates from graph

y_values : list

Value of y coordinates from graph

Value of x coordinates from graph.

y_values : list

Value of y coordinates from graph.

codecov · 2024-07-29T20:04:53Z

Codecov Report

Attention: Patch coverage is 57.14286% with 3 lines in your changes missing coverage. Please review.

Project coverage is 84.37%. Comparing base (bae7688) to head (da07dd0).

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #323      +/-   ##
==========================================
- Coverage   84.47%   84.37%   -0.11%     
==========================================
  Files          20       20              
  Lines        2003     2009       +6     
==========================================
+ Hits         1692     1695       +3     
- Misses        311      314       +3

JackB-Ansys added 7 commits June 11, 2024 10:19

reformatting

e0749bb

Added new methods for getting fea and magnetic 3D graphs. updated gra…

dccccbd

…ph method to work with new methods. Updated basic examples

Updates to thermal_basics.py

ffff557

Updates to thermal_basics.py rolled back

4539834

Updates to thermal_basics.py example

32dc007

Updates to thermal_basics.py example

9c53810

Updates to thermal_basics.py example

e8cdf39

JackB-Ansys linked an issue Jun 13, 2024 that may be closed by this pull request

Review the PyMotorCAD Basic Examples #319

Open

PipKat reviewed Jun 25, 2024

View reviewed changes

Merge branch 'main' into Basic_Thermal_Example_Review

1d9c587

jgsdavies added 2 commits August 20, 2024 10:59

Merge branch 'main' into Basic_Thermal_Example_Review

2554483

Merge branch 'main' into Basic_Thermal_Example_Review

da07dd0

		# This script will change model parameter values (geometry, winding pattern and materials),
		# run magnetic calculations, extract and plot results.

	# graphics. Import ``os``, ``shutil`` and ``tempfile`` to open and save a temporary MOT
	# graphics. Import ``os``, ``shutil``, and ``tempfile`` to open and save a temporary MOT

	# Import ``pymotorcad`` to access Motor-CAD. Import ``pyplot`` from ``matplotlib`` to display
	# Import ``pymotorcad`` to access Motor-CAD. Import ``pyplot`` from Matplotlib to display

		# after executing the script, use the ``MotorCAD(keep_instance_open=True)`` option when opening the
		# new instance.

		# Setting up the analysis consists of setting the geometry, winding and material parameters, setting
		# the calculation options and operating point, and saving the file.

	# Display the Scripting tab and set the ``Slot_Number``, ``Tooth_Width`` and
	# Display the Scripting tab and set the ``Slot_Number``, ``Tooth_Width``, and

	# Set the stator and rotor lamination materials. Component names are displayed in the
	# Set the stator and rotor lamination materials. Component names are shown in the

		# Materials tab in Motor-CAD. Materials and their properties are defined in the Motor-CAD
		# Material database.

	# Set the operating point of the machine, defined by the speed, current and phase advance. Ensure
	# Set the operating point of the machine, defined by the speed, current, and phase advance. Ensure

	# Save the file to the temporary folder and display a message that the initialisation in complete.
	# Save the file to the temporary folder and display a message that the initialization in complete.

	print("Initialisation completed.")
	print("Initialization completed.")

		# Export results to a CSV file. Results will be saved as Export_EMag_Results.csv in the temporary
		# working directory. A try and except block are used to raise an error in the case of the export

		# Retrieve the Torque (VW) graph data. The data type for this series is E-Magnetics, so use the
		# ``get_magnetic_graph()`` method.

		# When retrieving graph data points, use the Graph Viewer under Help in the Motor-CAD
		# interface to find the series names and data types.

		# Retrieve the airgap flux density graph data. This data can be found in the Graph Viewer in
		# Motor-CAD. The data type for this series is FEA Path, so use the ``get_fea_graph()`` method.

	# Open the Graphs -> Harmonics -> Torque tab to make the torque harmonic data available.
	# Open the Graphs -> Harmonics -> Torque tab to make the torque harmonic data available.

	# Retrieve the torque harmonic graph data. The data type for this series is E-Magnetics, so use
	# Retrieve the torque harmonic graph data. The data type for this series is E-Magnetics, so use

	# Use``pyplot`` from ``matplotlib`` (imported as ``plt``) to plot graphs of the simulation results.
	# Use``pyplot`` from Matplotlib (imported as ``plt``) to plot graphs of the simulation results.

	# Plot the Airgap Flux Density and the Torque (VW) results as subplots in the same figure.
	# Plot the airgap flux density and the torque (VW) results as subplots in the same figure.

	# Plot the Torque harmonic results as a bar chart.
	# Plot the torque harmonic results as a bar chart.

Basic thermal example review #323

Are you sure you want to change the base?

Basic thermal example review #323

Conversation

JackB-Ansys commented Jun 13, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

PipKat Jun 25, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

PipKat Jun 25, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

PipKat Jun 25, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

codecov bot commented Jul 29, 2024 • edited Loading

Codecov Report

PipKat Jun 25, 2024 •

edited

Loading

PipKat Jun 25, 2024 •

edited

Loading

PipKat Jun 25, 2024 •

edited

Loading

codecov bot commented Jul 29, 2024 •

edited

Loading

	# Save the file to a temporary folder
	# Save the file to a temporary folder.

	# after executing the script, use the ``MotorCAD(keep_instance_open=True)`` option when opening the
	# after executing the script, use ``MotorCAD(keep_instance_open=True)`` when opening the

	# Disable the option for Active Cooling Only, so that the HWJ channel also cools the front and
	# Disable the option for Active Cooling Only so that the HWJ channel also cools the front and

	# Enable the Input h option to allow user input of the heat transfer coefficients for HWJ cooling
	# Enable the Input h option to allow user input of the heat transfer coefficients for HWJ cooling

	# Get fluid properties (thermal conductivity, density and dynamic viscosity) and the fluid
	# Get fluid properties (thermal conductivity, density, and dynamic viscosity) and the fluid