MagneticDipole

A magnetic dipole source can be either an electric ring current or a magnetic line current.

Example

app = cf.GetApplication()
project = app:NewProject()

    -- Create a magnetic dipole
    
configuration = project.SolutionConfigurations[1]
magneticDipole = configuration.Sources:AddMagneticDipole(cf.Point(0,0,0),0,0)

Inheritance

The MagneticDipole object is derived from the SolutionEntity object.

Property List

Included
Specifies whether the solution entity must be included or excluded. (Read/Write boolean)
Label
The object label. (Read/Write string)
LocalWorkplane
The magnetic dipole workplane. (Read only LocalWorkplane)
Magnitude
The source magnitude. (Read/Write Expression)
Phase
The source phase (degrees). (Read/Write Expression)
Phi
The phi angle (degrees). (Read/Write Expression)
Position
The position of the source. (Read/Write LocalCoordinates)
SourceType
The magnetic source type. (Read/Write MagneticDipoleCurrentTypeEnum)
Theta
The theta angle (degrees). (Read/Write Expression)
Type
The object type string. (Read only string)
Visible
Specifies whether the solution entity must be shown or hidden. (Read/Write boolean)

Method List

Delete ()
Delete the solution entity.
Duplicate ()
Duplicate the solution entity. (Returns a SolutionEntity object.)
GetProperties ()
Returns a table of properties representing the state of the object. The properties table can be used with the SetProperties method to change multiple properties of the object in one step. (Returns a table object.)
SetProperties (properties table)
Modifies the state of the object using the provided table of properties. This method is used to modify multiple properties of the object in a single step.

Static Function List

GetDefaultProperties ()
Creates a table containing the default settings to create an object. (Returns a table object.)

Property Details

Included
Specifies whether the solution entity must be included or excluded.
Type
boolean
Access
Read/Write
Label
The object label.
Type
string
Access
Read/Write
LocalWorkplane
The magnetic dipole workplane.
Type
LocalWorkplane
Access
Read only
Magnitude
The source magnitude.
Type
Expression
Access
Read/Write
Phase
The source phase (degrees).
Type
Expression
Access
Read/Write
Phi
The phi angle (degrees).
Type
Expression
Access
Read/Write
Position
The position of the source.
Type
LocalCoordinates
Access
Read/Write
SourceType
The magnetic source type.
Type
MagneticDipoleCurrentTypeEnum
Access
Read/Write
Theta
The theta angle (degrees).
Type
Expression
Access
Read/Write
Type
The object type string.
Type
string
Access
Read only
Visible
Specifies whether the solution entity must be shown or hidden.
Type
boolean
Access
Read/Write

Method Details

Delete ()
Delete the solution entity.
Duplicate ()
Duplicate the solution entity.
Return
SolutionEntity
The duplicated entity.
GetProperties ()
Returns a table of properties representing the state of the object. The properties table can be used with the SetProperties method to change multiple properties of the object in one step.
Return
table
A properties table.
SetProperties (properties table)
Modifies the state of the object using the provided table of properties. This method is used to modify multiple properties of the object in a single step.
Input Parameters
properties(table)
A table of properties defining the new state of the object.

Static Function Details

GetDefaultProperties ()
Creates a table containing the default settings to create an object.
Return
table
The default properties table.