Restructure Flux Linkage and Inductance Analyzers #343

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

Open

dmnewman3 wants to merge 27 commits into develop from user/dmnewman3/restructure_inductance_analyzer

docs/source/EM_analyzers/Images/FluxLinkageExampleCircuit.png

Sorry, something went wrong. Reload?

Sorry, we cannot display this file.

Sorry, this file is invalid so it cannot be displayed.

docs/source/EM_analyzers/Images/a_b_c_inductances.svg

Sorry, something went wrong. Reload?

Sorry, we cannot display this file.

Sorry, this file is invalid so it cannot be displayed.

docs/source/EM_analyzers/Images/alpha_beta_inductances.svg

Sorry, something went wrong. Reload?

Sorry, we cannot display this file.

Sorry, this file is invalid so it cannot be displayed.

docs/source/EM_analyzers/Images/d_q_inductances.svg

Sorry, something went wrong. Reload?

Sorry, we cannot display this file.

Sorry, this file is invalid so it cannot be displayed.

docs/source/EM_analyzers/flux_linkage_analyzer.rst

-Original file line number
+Diff line change
@@ -0,0 +1,147 @@
+    Flux Linkage Analyzer
+    ########################################################################
+    This analyzer enables the flux linkage evaluation of a mutli-phase electric machine after running 2D FEA simulations using JMAG.
+    Model Background
+    ****************
+    The flux linkage of a coil is defined as the amount of flux linking together for a multi-coil arrangment with electric current flowing
+    through them. The flux linkage of a coil within an electric machine comes from all coils present in the machine and has a profound
+    impact on the machine characteristics. Calculating coil flux linkages over time can lead to inductance calculations for an electric
+    machine, which are also important for characterizing that machine. The flux linkage is an important parameter for inductance calculations
+    as can be seen in the following equation:
+    .. math::
+        L = \lambda I \\
+    where :math:`\lambda` is the flux linkage, :math:`L` is the inductance, and :math:`I` is the coil current.
+    The code is structured such that the ``flux_linkage_analyzer`` contains the code for setting up and running the JMAG simulations based on
+) the machine inputs and conditions of the user and 2) the conditions required of the machine to be able to calculate the
+    necessary parameters. In the case of each machine, DC excitement of each phase coil occurs with all other coils open. This repeats for
+    each coil until all of the coils have been excited with DC current and all of the flux linkages have been captured.
+    This analyzer calculates the self and mutual flux linkages of each coil using JMAG's transient solver. It models an electric machine
+    under synchronous operation. The following information document will provide a description of the analyzer inputs and outputs.
+    Input from User
+    *********************************
+    Users are utilizing a single Problem class to interface with this analyzer. This class requires the user to provide an instance of the
+    JMAG FEA application being used, a the model of the current project which needs to be in a file that is already open, a dedicated filepath
+    for the results, the name of the phases, and the rated current of the machine. The specific requirements are summarized below:
+    .. csv-table:: `flux_linkage_analyzer Inputs`
+       :file: input_flux_linkage_analyzer.csv
+       :widths: 70, 70, 30
+       :header-rows: 1
+    With regards to the model properties, there are several aspects of the JMAG FEA model that must be specific such that this analyzer works
+    properly. Those properties are as follows
+. Must be transient model (can be 2D or 3D)
+. The model must be named "Machine_FluxLinkage_Project"
+. The study must be named "Machine_FluxLinkage_Study"
+. The motion condition must be specified and MUST be rotating 1 full mechanincal revolution
+. "FEM Coils" must be applied to the winding and linked to the circuit
+. The study properties must be fully defined, except for the csv output, which is defined by the analyzer
+. The circuit must appear similar to the following image, where the current sources are titled "cs_PhaseName"
+. Under case control, the "cs_PhaseName" amplitudes MUST be the first cases AND listed in order of excitation
+    .. figure:: ./Images/FluxLinkageExampleCircuit.png
+       :alt: Stator Diagram
+       :align: center
+       :width: 250
+    Example Code
+    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+    The following example demonstrates how to initialize instances of ``Flux_Linkage_Problem`` and ``Flux_Linkage_Analyzer``. An instance of
+    JMAG FEA is used in this example and is stored in the ``fluxlinkage_inductance_eval`` folder of the ``mach_eval_examples`` in ``eMach``.
+    An example file containing the example code is also found in that folder. The following code runs the flux linkage analyzer using the
+    aforementioned example file:
+    .. code-block:: python
+        import os
+        import sys
+        import numpy as np
+        import matplotlib.pyplot as plt
+        from time import time as clock_time
+        os.chdir(os.path.dirname(__file__))
+        sys.path.append("../../../")
+        from mach_eval.analyzers.electromagnetic.flux_linkage_analyzer import FluxLinkageJMAG_Problem, FluxLinkageJMAG_Analyzer
+        from mach_cad.tools import jmag as JMAG
+        filepath = "eMach_location/eMach/examples/mach_eval_examples/fluxlinkage_inductance_eval"
+        phasenames = ['U', 'V', 'W']
+        rated_current = 20
+        ####################################################
+        # 01 Setting project name and output folder
+        ####################################################
+        toolJmag = JMAG.JmagDesigner()
+        toolJmag.visible = True
+        toolJmag.open(filepath + "/Example_FluxLinkage_Machine.jproj")
+        toolJmag.save()
+    This example code does the following:
+. Initializes all of the required libraries and classes
+. Defines the necessary inputs of the ``problem`` and ``analyzer`` classes
+. Opens a fully-defined instance of JMAG
+. Defines the output file location based
+. Names project accordingly
+    Output to User
+    **********************************
+    The ``flux_linkage_analyzer`` returns a directory holding the results obtained from the transient analysis of the machine. The elements
+    of this dictionary and their descriptions are provided below:
+    .. csv-table:: `flux_linkage_analyzer Output`
+       :file: output_flux_linkage_analyzer.csv
+       :widths: 70, 70
+       :header-rows: 1
+    The following code should be used to run the example analysis:
+    .. code-block:: python
+        ############################ Create Evaluator #####################
+        tic = clock_time()
+        flux_linkage_prob = FluxLinkageJMAG_Problem(toolJmag, phasenames, rated_current)
+        flux_linkage_analyzer = FluxLinkageJMAG_Analyzer()
+        flux_linkages, currents = flux_linkage_analyzer.analyze(flux_linkage_prob)
+        toc = clock_time()
+        print("Time spent on the flux linkage evaluation is %g min." % ((toc- tic)/60))
+        linkages = flux_linkages["linkages"]
+        phase_currents = currents
+        rotor_angle = flux_linkages["rotor_angle"][0]
+        name_of_phases = flux_linkages["name_of_phases"]
+        print("\n************************ FLUX LINKAGE RESULTS ************************")
+        print("Linkages = ", linkages)
+        print("phase_currents = ", phase_currents, " A")
+        print("rotor_angle = ", rotor_angle, " deg")
+        print("name_of_phases = ", name_of_phases)
+        print("*************************************************************************\n")
+    This example, contained in the aforementioned ``fluxlinkage_inductance_eval`` folder, should produce the following results:
+    .. csv-table:: `flux_linkage_analyzer Results`
+       :file: results_flux_linkage_analyzer.csv
+       :widths: 70, 70, 30
+       :header-rows: 1
+    One should expect the ``/run_data/`` working folder location to differ depending on where the workspace is. Within ``/run_data/`` there should be a
+    total of 4 csv files that contains the flux linkage calculations for a 3 phase machine, there should be 7 csv files for a 6 phase machine, etc. Each
+    csv files should contain a total number of columns that equals the phase count of the machine. All of the code shown exists in the
+    ``fluxlinkage_inductance_evaluator.py`` file in the ``eMach/examples/mach_eval_examples/fluxlinkage_inductance_eval`` folder. This analyzer serves
+    as a first step in conjunction with the  `Inductance Analyzer <https://emach.readthedocs.io/en/latest/EM_analyzers/inductance_analyzer.html>`_.

docs/source/EM_analyzers/index.rst

-Original file line number
+Diff line change
@@ Expand Up @@
         BSPM JMAG 2D FEA <bspm_jmag2d_analyzer>
         Winding Factors <winding_factors>
         SynR JMAG 2D FEA <SynR_jmag2d_analyzer>
-        Inductance/Saliency <inductance_analyzer>
+        Flux Linkage <flux_linkage_analyzer>
+        Inductance <inductance_analyzer>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Restructure Flux Linkage and Inductance Analyzers #343

Uh oh!

Diff view

Diff view

There are no files selected for viewing

Uh oh!

Restructure Flux Linkage and Inductance Analyzers #343

Are you sure you want to change the base?

Uh oh!

Restructure Flux Linkage and Inductance Analyzers #343

Uh oh!

Uh oh!

Diff view

Diff view

There are no files selected for viewing

Uh oh!