Class MotorEMForceAPI
Last update: 16.07.2025Namespace: VM.API.Pre.GearTrain
Assembly: VM.API.Pre.GearTrain.dll
This class implements APIs for
public static class MotorEMForceAPI
Inheritance
Extension Methods
LinkPropertyItemCache.GetLinkProperties(object, LinkPropertyType), LinkPropertyItemCache.GetLinkPropertiesAndValues(object, LinkPropertyType), LinkPropertyItemCache.GetLinkedObjects<T>(object, LinkPropertyType)
Methods
CreateMotorEMForce(GearTrainDocument, Obj, Obj, Vector, Vector, Vector, Obj, string)
Create
[NotNull(new string[] { "document" })]
[NotNullObj(new string[] { "statorBody", "rotorBody", "referenceOfRotational" })]
[NotZeroMagnitude(new string[] { "zAxis", "xAxis" })]
public static Obj CreateMotorEMForce(this GearTrainDocument document, Obj statorBody, Obj rotorBody, Vector position, Vector zAxis, Vector xAxis, Obj referenceOfRotational, string motorEMForceName = "")
Parameters
document GearTrainDocument
The document to create the motor em force.
statorBody Obj
The stator body. The type is
rotorBody Obj
The rotor body. The type is
position Vector
The position.
zAxis Vector
The z axis.
xAxis Vector
The x axis.
referenceOfRotational Obj
The reference of rotational. The type is
motorEMForceName string
The name of the motor em force. If empty, default name starts with 'Motor_' will be generated and used.
Returns
Obj
The new
Exceptions
Will be thrown if 'document' or 'statorBody' or 'rotorBody' or 'referenceOfRotational' arguments are empty.
Will be thrown if the magnitude of zAxis' or 'xAxis' is 0.
Will be thrown if type of 'statorBody' is not
Will be thrown if type of 'rotorBody' is not
Will be thrown if type of 'referenceOfRotational' is not
CreateMotorEMForceForANSYSMotion(GearTrainDocument, Obj, Obj, Vector, Vector, Vector, Obj, string)
Create
[NotNull(new string[] { "document" })]
[NotNullObj(new string[] { "statorBody", "rotorBody", "referenceOfRotational" })]
[NotZeroMagnitude(new string[] { "zAxis", "xAxis" })]
public static Obj CreateMotorEMForceForANSYSMotion(this GearTrainDocument document, Obj statorBody, Obj rotorBody, Vector position, Vector zAxis, Vector xAxis, Obj referenceOfRotational, string motorEMForceName = "")
Parameters
document GearTrainDocument
The document to create the motor em force for ANSYS Motion.
statorBody Obj
The stator body. The type is
rotorBody Obj
The rotor body. The type is
position Vector
The position.
zAxis Vector
The z axis.
xAxis Vector
The x axis.
referenceOfRotational Obj
The reference of rotational. The type is
motorEMForceName string
The name of the motor em force. If empty, default name starts with 'Motor_' will be generated and used.
Returns
Obj
The new
Exceptions
Will be thrown if 'document' or 'statorBody' or 'rotorBody' or 'referenceOfRotational' arguments are empty.
Will be thrown if the magnitude of zAxis' or 'xAxis' is 0.
Will be thrown if type of 'statorBody' is not
Will be thrown if type of 'rotorBody' is not
Will be thrown if type of 'referenceOfRotational' is not
CreateMotorEMForceForJMAG(GearTrainDocument, Obj, Obj, Vector, Vector, Vector, Obj, string)
Create
[NotNull(new string[] { "document" })]
[NotNullObj(new string[] { "statorBody", "rotorBody", "referenceOfRotational" })]
[NotZeroMagnitude(new string[] { "zAxis", "xAxis" })]
public static Obj CreateMotorEMForceForJMAG(this GearTrainDocument document, Obj statorBody, Obj rotorBody, Vector position, Vector zAxis, Vector xAxis, Obj referenceOfRotational, string motorEMForceName = "")
Parameters
document GearTrainDocument
The document to create the motor em force for JMAG.
statorBody Obj
The stator body. The type is
rotorBody Obj
The rotor body. The type is
position Vector
The position.
zAxis Vector
The z axis.
xAxis Vector
The x axis.
referenceOfRotational Obj
The reference of rotational. The type is
motorEMForceName string
The name of the motor em force. If empty, default name starts with 'Motor_' will be generated and used.
Returns
Obj
The new
Exceptions
Will be thrown if 'document' or 'statorBody' or 'rotorBody' or 'referenceOfRotational' arguments are empty.
Will be thrown if the magnitude of zAxis' or 'xAxis' is 0.
Will be thrown if type of 'statorBody' is not
Will be thrown if type of 'rotorBody' is not
Will be thrown if type of 'referenceOfRotational' is not
