ImpressedCurrent

An impressed current may be defined as a source in a model.

Example

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

    -- Create an impressed current
    
configuration = project.SolutionConfigurations[1]
sourceCollection = configuration.Sources
impressedCurrent = sourceCollection:AddImpressedCurrent(cf.Point(0,0,0),cf.Point(1,1,0),0.01)

Inheritance

The ImpressedCurrent object is derived from the SolutionEntity object.

Property List

ConnectEndToClosestVertex
The option to connect the end point to the closest mesh vertex. (Read/Write boolean)
EndMagnitude
The magnitude at the end position. (Read/Write Expression)
EndPhase
The phase (degrees) at the end position. (Read/Write Expression)
EndPosition
The end position of the source. (Read/Write LocalCoordinates)
ImpressedCurrentSourceClosestVertexType
The mesh element type to connect to. (Read/Write ImpressedCurrentSourceClosestVertexTypeEnum)
Included
Specifies whether the solution entity must be included or excluded. (Read/Write boolean)
Label
The object label. (Read/Write string)
LocalWorkplane
The impressed current workplane. (Read only LocalWorkplane)
Radius
The radius of the impressed current. (Read/Write Expression)
StartMagnitude
The magnitude at the start position. (Read/Write Expression)
StartPhase
The phase (degrees) at the start position. (Read/Write Expression)
StartPosition
The start position of the source. (Read/Write LocalCoordinates)
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

ConnectEndToClosestVertex
The option to connect the end point to the closest mesh vertex.
Type
boolean
Access
Read/Write
EndMagnitude
The magnitude at the end position.
Type
Expression
Access
Read/Write
EndPhase
The phase (degrees) at the end position.
Type
Expression
Access
Read/Write
EndPosition
The end position of the source.
Type
LocalCoordinates
Access
Read/Write
ImpressedCurrentSourceClosestVertexType
The mesh element type to connect to.
Type
ImpressedCurrentSourceClosestVertexTypeEnum
Access
Read/Write
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 impressed current workplane.
Type
LocalWorkplane
Access
Read only
Radius
The radius of the impressed current.
Type
Expression
Access
Read/Write
StartMagnitude
The magnitude at the start position.
Type
Expression
Access
Read/Write
StartPhase
The phase (degrees) at the start position.
Type
Expression
Access
Read/Write
StartPosition
The start position of the source.
Type
LocalCoordinates
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.