Interface Material

Built-in Material object

interface Material {
    conductor(): ConductorMaterial;
    custom(color?: Color): CustomMaterial;
    empty(): EmptyMaterial;
    endturn(): EndturnMaterial;
    general(): GeneralMaterial;
    iron(fillCoefs?: number[], dsomaloy?: number): IronMaterial;
    magnetParallel(
        angle?: number,
        segmentRadiuses?: number[],
        savePoleBorder?: boolean,
    ): MagnetParallelMaterial;
    magnetRadial(
        direction?: Magnetization,
        center?: Point2,
        segmentRadiuses?: number[],
    ): MagnetRadialMaterial;
    winding(layer?: number, turn?: number, strand?: number): WindingMaterial;
}

Index

Methods

conductor custom empty endturn general iron magnetParallel magnetRadial winding

Methods

conductor

conductor(): ConductorMaterial
Conductor material.

Returns ConductorMaterial
ConductorMaterial object
- Defined in MotorXP-Doc/MotorXP-AFM_AutoDocs/API/MotorXP-AFM.en.d.ts:1676

custom

custom(color?: Color): CustomMaterial
Custom material with the specified color.
Parameters
- Optionalcolor: Color
  color [default=Qt.red] - Material color.
Returns CustomMaterial
CustomMaterial object.
- Defined in MotorXP-Doc/MotorXP-AFM_AutoDocs/API/MotorXP-AFM.en.d.ts:1683

empty

empty(): EmptyMaterial
Empty material.

Returns EmptyMaterial
EmptyMaterial object
- Defined in MotorXP-Doc/MotorXP-AFM_AutoDocs/API/MotorXP-AFM.en.d.ts:1689

endturn

endturn(): EndturnMaterial
Endturn material.

Returns EndturnMaterial
EndturnMaterial object
- Defined in MotorXP-Doc/MotorXP-AFM_AutoDocs/API/MotorXP-AFM.en.d.ts:1695

general

general(): GeneralMaterial
Material for the surrounding air.

Returns GeneralMaterial
GeneralMaterial object
- Defined in MotorXP-Doc/MotorXP-AFM_AutoDocs/API/MotorXP-AFM.en.d.ts:1701

iron

iron(fillCoefs?: number[], dsomaloy?: number): IronMaterial
Iron material.
Parameters
- OptionalfillCoefs: number[]
  fillCoefs [default=[]] - Material fill factor.
- Optionaldsomaloy: number
  dsomaloy [default=0] - Smallest transverse dimension of the component [m] for Somaloy material.
Returns IronMaterial
IronMaterial object.
- Defined in MotorXP-Doc/MotorXP-AFM_AutoDocs/API/MotorXP-AFM.en.d.ts:1709

magnetParallel

magnetParallel(
    angle?: number,
    segmentRadiuses?: number[],
    savePoleBorder?: boolean,
): MagnetParallelMaterial
Material for a magnet with parallel magnetization.
Parameters
- Optionalangle: number
  angle [default=0] - Parallel magnetization angle.
- OptionalsegmentRadiuses: number[]
  segmentRadiuses [default=[]] - Array of magnet segment radii.
- OptionalsavePoleBorder: boolean
  savePoleBorder [default=true] - If true, preserves the boundary between magnets of adjacent poles.
Returns MagnetParallelMaterial
MagnetParallelMaterial object.
- Defined in MotorXP-Doc/MotorXP-AFM_AutoDocs/API/MotorXP-AFM.en.d.ts:1719

magnetRadial

magnetRadial(
    direction?: Magnetization,
    center?: Point2,
    segmentRadiuses?: number[],
): MagnetRadialMaterial
Material for a magnet with radial magnetization.
Parameters
- Optionaldirection: Magnetization
  direction [default=Magnetization.From] - Magnetization direction.
- Optionalcenter: Point2
  center [default=Qt.point(0, 0)] - Magnetization center.
- OptionalsegmentRadiuses: number[]
  segmentRadiuses [default=[]] - Array of magnet segment radii.
Returns MagnetRadialMaterial
MagnetRadialMaterial object.
- Defined in MotorXP-Doc/MotorXP-AFM_AutoDocs/API/MotorXP-AFM.en.d.ts:1733

winding

winding(layer?: number, turn?: number, strand?: number): WindingMaterial
Winding material.
Parameters
- Optionallayer: number
  layer [default=Winding.Auto] - Layer number: Winding.Auto, Winding.First, or Winding.Second.
- Optionalturn: number
  turn [default=0] - Turn number.
- Optionalstrand: number
  strand [default=0] - Strand number within a turn.
Returns WindingMaterial
WindingMaterial object.
- Defined in MotorXP-Doc/MotorXP-AFM_AutoDocs/API/MotorXP-AFM.en.d.ts:1746