API - EMDtool

API reference

class : emdtool emdtool Main EMDtool utility class.
Analysis utilities

Folder with the following files / classes / subfolders:
class : Analysis utilities/Equivalent Circuits/InverseGammaCircuit InverseGammaCircuit methods:
class : /Equivalent Circuits/SynEquivalentCircuit SynEquivalentCircuit methods:
class : IMEquivalentCircuit IMEquivalentCircuit is a class.
class : /Grids/MTPAinterpolant MTPAinterpolant Interpolant for post-processing field-weakening
class : /Grids/NTGrid NTGrid methods:
class : /Grids/NTGridDQ NTGridDQ Speed-torque grid from d-q grid data.
class : /Grids/NTGridNT
class : /Grids/OPsimulator OPsimulator Class for analysing operating points.
class : /Grids/SMGridCalculator_DQ SMGridCalculator_DQ DQ-grid calculator for synchronous machines.
class : /Grids/SMGridCalculator_NT SMGridCalculator_NT (rpm, T) operating point grid calculator.
class : /Grids/SMGridCalculator_NTfromDQ SMGridCalculator_NTfromDQ methods:
class : MTPAinterpolant MTPAinterpolant Interpolant for post-processing field-weakening
class : OPiterator OPiterator Backward compatibility proxy class.
FE Functionality

Folder with the following files / classes / subfolders:
class : Elements {
class : IDfun IDfun is a class.
class : Nedelec2D Nedelec2D class for 2D Nedelec shape functions.
class : Nedelec3DPrism Nedelec3D class for 3D Nedelec shape functions.
class : /Elements and Shape Functions/Nodal Elements/Nodal2D Nodal2D Lagrange (nodal) shape function in 2D.
class : Operators {
class : /Matrix Assembly/MagneticsJacobian MagneticsJacobian methods:
class : /Matrix Assembly/MatrixConstructor MatrixConstructor Constructor for FE matrices.
class : BoundaryMatrixConstructor BoundaryMatrixConstructor is a class.
class : MatrixConstructorBase MatrixConstructorBase is a class.
class : MatrixConstructor_nonConforming MatrixConstructor_nonConforming is a class.
class : /Mesh/Boundary Boundary Base class for boundaries.
class : /Mesh/DirichletBoundary DirichletBoundary methods:
class : /Mesh/PeriodicBoundary PeriodicBoundary methods:
class : /Mesh/Airgap mesh/LinearSlidingAirgap LinearSlidingAirgap Airgap class for sliced AFM models.
class : /Mesh/Airgap mesh/SlidingAirgap SlidingAirgap Sliding airgap model for radial-flux machines.
class : /Mesh/Airgap mesh/SlidingAirgapBase SlidingAirgapBase methods:
class : Airgap Airgap Base class for airgap geometries.
class : MeshBase MeshBase is a class.
class : MeshView MeshView is a class.
class : /Mesh/Meshes_3D/TetMesh TetMesh minimal mesh of 3D tetrahedrons.
class : ExtrudedPrismMesh ExtrudedMachineMesh A base class for a MachineMesh extruded into 3D.
class : MeshBase3D MeshBase3D a base class for a 3D mesh.
class : Nodal3D Nodal3D is a class.
class : Nodal3D_UpExtruded Nodal3D_UpExtruded is a class.
class : Nodal3D_extruded Nodal3D_extruded is a class.
class : PrismMeshBase3D PrismMeshBase3D A base class for a 3D mesh with prismatic elements.
class : /Mesh/Other meshes/SimpleMesh SimpleMesh Basic mesh class.
class : Mesh Mesh Class for mesh objects.
class : RotatedMeshView RotatedMeshView is a class.
Geometry

Folder with the following files / classes / subfolders:
class : Geometry/Circle Circle Helper class for circular surfaces.
class : Domain Domain Domain class.
class : GeoBase GeoBase Base class for geometries.
class : LaminatedDomain LaminatedDomain Laminated domain.
class : Surface SURFACE Class for representing elementary surfaces.
class : / representation/Arc Arc methods:
class : / representation/Curve CURVE Abstract base class for representing line segments and circle arcs
class : / representation/Line Line methods:
class : / representation/geo enumeration
class : / representation/gw gw methods:
class : Point POINT Class for representing points in a geometry.
class : /Motor geometries/AxialGeometry AxialGeometry methods:
class : /Motor geometries/RadialGeometry RadialGeometry Base class for radial geometries.
Materials

Folder with the following files / classes / subfolders:
class : Materials/Material Material Basic isotropic material class.
class : MaterialBase MaterialBase Base class for materials.
class : /Hysteretic materials, WIP/HysteresisModel HysteresisModel Base class for hysteresis models.
class : /Hysteretic materials, WIP/HystereticMaterial HystereticMaterial Material class for hysteretic materials.
class : /Hysteretic materials, WIP/HysteronModel HysteronModel Base class for vector hysteron models
class : /Hysteretic materials, WIP/PlayModel PlayModel Play hysteron model.
class : /Hysteretic materials, WIP/StopModel StopModel Hysteresis model based on Stop hysteron.
class : MaterialSet MaterialSet Container class.
class : //SteelLibrary SteelLibrary Static class for creating electrical steel Material
class : Arnon7 Arnon7 Arnon7 Material object.
class : PMlibrary PMlibrary Static class for creating permanent-magnet Material objects.
class : deprecated_Vacodur49 Vacodur49 Vacodur49 Material object.
Problems

Folder with the following files / classes / subfolders:
class : Problems/Magnetics/MagneticsProblem MagneticsProblem Class for solving magnetics problems.
class : HarmonicSolution HarmonicSolution is a class.
class : MagneticsSolution MagneticsSolution Class for representing the solution to MagneticsProblem.
class : SimulationParameters SimulationParameters Parameters for MagneticsProblem solutions.
class : StaticSolution StaticSolution is a class.
class : SteppingSolution SteppingSolution is a class.
Templates

Folder with the following files / classes / subfolders:
class : Templates/AFmodel only types given?
class : LinearGeoBase LinearGeoBase methods:
class : RFmodel RFmodel Simple class for radial-flux machines.
class : /Rotors/BreadloafRotor BreadloafRotor methods:
class : /Rotors/CoatedRotor CoatedRotor methods:
class : /Rotors/FWRotor1 FWRotor1 methods:
class : /Rotors/HSIPM1 HSIPM1 methods:
class : /Rotors/HSIPM2 HSIPM2 methods:
class : /Rotors/LinearSPM LinearSPM methods:
class : /Rotors/MassivePM MassivePM methods:
class : /Rotors/PoledIPM1 PoledIPM1 methods:
class : /Rotors/SPM1 SPM1 Template for a surface-PM rotor.
class : SPM1 SPM1 Template for a surface-PM rotor.
class : /Rotors/SRMRotor1 SRMRotor1 methods:
class : /Rotors/ShieldedSPM ShieldedSPM methods:
class : /Rotors/SlottedRotor1 SlottedRotor1 methods:
class : /Rotors/SpokeRotor1 default dimensions
class : /Rotors/VIPM1 VIPM1 V-shape IPM rotor.
class : SlottedRotorBase SlottedRotorBase Base class for slotted radial-flux rotors.
class : SynRotorBase SynRotorBase Base class for synchronous machine rotors.
class : /Slots/CooledSlot1 CooledSlot1 methods:
class : /Slots/Slot1 Slot1 Basic stator slot shape.
class : /Slots/SlotShapeBase SlotShapeBase Base class for slot shapes.
class : SlotShapeWrapper SlotShapeWrapper is a class.
class : /Stators/FormWound1 FormWound1 methods:
class : /Stators/LinearStator LinearStator methods:
class : /Stators/OutrunnerFrame OutrunnerFrame methods:
class : /Stators/PCBStator PCBStator methods:
class : /Stators/SlotlessStator Stator General-purpose stator class for slotted stators.
class : /Stators/Standard Standard methods:
class : /Stators/Stator Stator General-purpose stator class for symmetric slotted stators.
class : /Stators/StatorBase StatorBase Base class for radial-flux stators.
class : /Stators/YASAStator YASAStator Axial yokeless stator.
Third-party
class : DXFtool DXFtool v1.0 for reading and plotting DXF files in Matlab figures.
Windings and Circuits
class : /Circuit Analysis/CircuitGraph CircuitGraph methods:
class : /Circuit Analysis/ConcentratedWindingSpec ConcentratedWindingSpec methods:
class : /Circuit Analysis/DistributedWindingSpec DistributedWindingSpec Winding specification class for distributed
class : /Circuit Analysis/FieldWindingSpec FieldWindingSpec methods:
class : /Circuit Analysis/PolyphaseWindingSpec PolyphaseWindingSpec Winding specification class.
class : /Circuit Analysis/SpaceVectors SpaceVectors Class for handling generalized Park-Clarke and inverse
class : /Circuit Analysis/WindingLayout WindingLayout Factory class for winding layout matrices.
class : ParkClarke ParkClarke Legacy compatibility class.
class : /FE Circuits/CageCircuit CageCircuit methods:
class : /FE Circuits/Circuit Circuit Simple base class for circuits modelled with the AVI
class : /FE Circuits/ExtrudedBlockCircuit ExtrudedBlockCircuit methods:
class : /FE Circuits/LaminatedCircuit LaminatedCircuit Class for modelling classical eddy currents in
class : /FE Circuits/PolyphaseCircuit PolyphaseCircuit Class for finite-element representation of polyphase
class : BlockCircuit BlockCircuit is a class.
class : CircuitBase CircuitBase Abstract base class for finite-element Circuits.
class : CircuitSet CircuitSet Class for handling operations on several circuits.
class : Circuits Circuits is a class.
class : /FE Circuits/Conductors/SolidConductor SolidConductor methods:
class : /FE Circuits/Conductors/SplitConductor SplitConductor methods:
class : /FE Circuits/Conductors/StrandedConductor StrandedConductor methods:
class : Conductor Conductor Base class for conductors.
class : SheetCircuit SheetCircuit is a class.
class : /FE Circuits/Sources/VoltageSource VoltageSource Voltage source class for MagneticsProblem.
class : /Modulators/SVPWM_Modulator SVPWM_Modulator Basic Modulator.
class : /Modulators/SinusoidalModulator SinusoidalModulator Sinusoidal voltage modulator.
class : /Modulators/SpaceVectorModulator SpaceVectorModulator Prototype multiphase space vector modulator.
class : Modulator Base class for modulators.
class : /Winding layouts/HairpinLayout HairpinLayout methods:
class : /Winding layouts/HollowConductorLayout HollowConductorLayout methods:
class : /Winding layouts/RectangularLayout RectangularLayout methods:
class : /Winding layouts/RoundWireLayout RoundWireLayout Winding layout class for random-wound coils.
class : /Winding layouts/UniformLayout UniformLayout Layout specification for non-specified layouts:
class : /Winding layouts/WindingLayoutBase WindingLayoutBase Base class for winding layouts. ## Folder with the following files / classes / subfolders:
class : defs defs is a class.
class : emdconstants emdconstants is a class.
to_be_relocated

Folder with the following files / classes / subfolders:
class : to_be_relocated/AFmodel2 AFmodel2 methods:
class : AirgapContainer AirgapContainer Container class for one or more airgap models.
class : GeoHelper GeoHelper methods:
class : GeoParser GeoParser methods:
class : GeometryReplicator GeometryReplicator methods:
class : MotorModelBase MotorModelBase Base class for magnetics models.
class : RFmodel2 RFmodel2 methods:
class : dxfreader dxfreader methods:
class : /Geometry3D/EdgeBoundaryMatrix EdgeBoundaryMatrix methods:
class : /Geometry3D/LinearAVSolver LinearAVSolver methods:
class : /Geometry3D/NodalBoundaryMatrix NodalBoundaryMatrix methods:
class : /Geometry3D/OctTree OctTree methods:
class : /Geometry3D/PointData PointData methods:
class : /Geometry3D/gw3D gw3D methods:
class : /Geometry3D/Geometry extrusion/AxialGeometryExtruder AxialGeometryExtruder methods:
class : /Geometry3D/Geometry extrusion/GeometryExtruder GeometryExtruder methods:
class : /Geometry3D/Geometry extrusion/GlueDomain GlueDomain methods:
class : /Geometry3D/Geometry extrusion/RadialGeometryExtruder RadialGeometryExtruder methods:
class : Nedelec3D Nedelec3D class for 3D Nedelec shape functions.
class : /Geometry3D/Objects_3D/eCurve eCurve methods:
class : /Geometry3D/Objects_3D/eObject eObject methods:
class : /Geometry3D/Objects_3D/ePoint ePoint methods:
class : /Geometry3D/Objects_3D/eSurface eSurface methods:
class : /Geometry3D/Objects_3D/eVolume eVolume methods:
class : /Mechanical analysis/MechMesh MechMesh methods:
class : /Mechanical analysis/MechUtil MechUtil methods:
class : /Mechanical analysis/ShellEdge ShellEdge methods:
class : Nodal2D_Quad Nodal2D_Quad is a class.
class : NodalBase NodalBase is a class.
class : Quad Quad - (Not recommended) Numerically evaluate integral, adaptive Simpson quadrature
class : SimpleMesh2 SimpleMesh2 is a class.
utilities

Miscellaneous utilities classes and functions.
class : HashMap HashMap is a class.
class : Indexable Indexable is a class.
class : SLContainer SLContainer A SMEKlib container class for key-value pairs.

API reference

Analysis utilities

FE Functionality

Geometry

Materials

Problems

Templates

Third-party

Windings and Circuits

to_be_relocated

utilities