CurrentSource

A current source, similar to a voltage source, but the current is impressed in the model.

Example

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

    -- Create a FEM line port

cuboid = project.Geometry:AddCuboid(cf.Point(0,0,0), 1, 1, 1)
dielectric = project.Media:AddDielectric()
cuboid.Regions[1].Medium = dielectric
FEMLinePort = project.Ports:AddFEMLinePort({cuboid.Edges[1]})

    -- Add a current source to the FEM line port
    
configuration = project.SolutionConfigurations[1]
source = configuration.Sources:AddCurrentSource(FEMLinePort)

Inheritance

The CurrentSource object is derived from the SolutionEntity object.

Property List

Impedance
The reference impedance (Ohm). (Read/Write Expression)
Included
Specifies whether the solution entity must be included or excluded. (Read/Write boolean)
Label
The object label. (Read/Write string)
Magnitude
The current source magnitude (A). (Read/Write Expression)
Phase
The current source phase (degrees). (Read/Write Expression)
Terminal
The FEM port terminal connected to the current source. (Read/Write TerminalType)
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

Impedance
The reference impedance (Ohm).
Type
Expression
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
Magnitude
The current source magnitude (A).
Type
Expression
Access
Read/Write
Phase
The current source phase (degrees).
Type
Expression
Access
Read/Write
Terminal
The FEM port terminal connected to the current source.
Type
TerminalType
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.