ActiveField - QuickField API help

QuickField Student Edition free download Contacts

Objects

Properties

Methods

LabelBlockMS Object

Properties

Methods

Summary

Physical properties of a block for problems of DC and transient magnetics.

Details

The LabelBlockMS object represents physical data applicable to the block label for magnetostatic problems.

When you need to set or modify some physical parameters for the block label, you have to get the LabelBlockMS object using the Content property of the Label object, modify the LabelBlockMS object using its properties, and then put it back in the Label object assigning your LabelBlockMS to the Content property of your Label object.

The LabelBlockMS object inherits methods and properties from its base class LabelBlock. In addition, it provides properties specific for magnetostatic analysis. Those are:

Kxx (Absolute) Kyy (Absolute) properties as Double (read and write)	Get and set the components of magnetic permeability. If the optional parameter is False or omitted the value is considered as a relative permeability, otherwise as an absolute value. Absolute values of magnetic permeability are measured in (H/m) Alternatively you use the Spline property (see below) to describe the permeability as a function of the flux density.
Spline property as Spline (read and write)	Gets and sets a Spline object that represents the magnetic permeability as a function of the flux density. See Using Splines section for details.
Loading property as Double (read and write)	The value of the current density (A/m²) or total number of ampere turns (A), depending upon the TotalCurrent flag.
LoadingEx property Type Variant (read and write)	The same as Loading, but allows defining the current (current density) not only by a value but also by a formula of coordinates.
Coercive property as Point (read and write)	Gets and sets the vector of coercive force of the magnet.	Conductivity Type Double (read and write)	Returns and sets the value of electrical conductivity in Siemens. The electrical conductivity is used only with transient analysis. The conductivity value should be non-negative. Zero conductivity means that the eddy currents in the block are not calculated.
ConductivityEx Type Variant (read and write)	The same as Conductivity, but allows defining the electrical conductivity not only by a number but also by a formula of coordinates. The formula should always give a positive result.
ConductivitySpline Type Spline (read and write)	Returns/sets the curve representing the dependency of electrical conductivity on temperature.
NonLinearConductivity Type Boolean (read-only)	Returns True when the electrical conductivity depends on temperature and False otherwise.
TemperatureEx Type Variant (read and write)	Returns and sets the temperature value used for calculating the electrical conductivity. It can be either a number or a formula of coordinates. This value is only used when you do not employ importing temperature from a linked problem, or imported values are not available.
TotalCurrent property as Boolean (read and write)	Gets and sets the flag showing whether the Loading value specifies the total number of ampere-turns or the current density.
Serial property as Boolean (read and write)	When the TotalCurrent flag is set to True, the Serial flag specifies whether the conductors with total current applied are connected in series. Serial conductors are carrying the same current and calculated current density could be different if their squares are not equal.
Radial property as Boolean (read and write)	With axisymmetric problems, if the total number of ampere-turns is specified, that Boolean flag specifies that the current density in your coil varies inversely to the radius rather than being distributed uniformly.

You always have to set both Kxx and Kyy properties even for isotropic materials. If the Polar property is set to True, the Kxx component is considered as a radial and Kyy - as tangential component of the permeability tensor.

Using Splines

Spline is an object representing the functional dependency of one variable from another. The LabelBlockMS object can use the spline to represent the magnetic field intensity as a function of the flux density. That is a magnetization curve of the material. You use the Spline property to get or set the spline to the LabelBlockMS object.

To get an existing Spline object you use the Spline property. If the spline you need does not yet exist, the Spline property returns nothing. In that case you have to first create a new spline using the CreateBHCuve method.

With transient analysis the electrical conductivity may depend on temperature. Such dependency is described by the spline, which you can get and assign using the ConductivitySpline property. If the spline does not yet exist, create it by the CreateConductivityCurve method.

To enter or modify spline data you use methods and properties of the Spline object. When you are finished with spline data you have to assign the Spline object back to the LabelBlockMS object using the Spline property or the ConductivitySpline property respectively.

The TemperatureEx property of type Variant sets/returns a priory known temperature in the block given by a number or a formula of coordinates. The formula should always give positive value.