Currents

A solution currents request.

Example

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

    -- Request the calculation of all currents
    
currentsRequest = project.SolutionConfigurations[1].Currents:Add()

Inheritance

The Currents object is derived from the SolutionEntity object.

Property List

CalculationScope
The calculation scope. (Read/Write CurrentsScopeTypeEnum)
ExportSettings
Currents export options. (Read only CurrentsExportSettings)
Included
Specifies whether the solution entity must be included or excluded. (Read/Write boolean)
Label
The object label. (Read/Write string)
ScopedGeometryEntities
The geometry entities for which the currents calculation will be done. (Read/Write List of GeometryEntity)
ScopedMeshEntities
The mesh entities for which the currents calculation will be done. (Read/Write List of MeshEntity)
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

CalculationScope
The calculation scope.
Type
CurrentsScopeTypeEnum
Access
Read/Write
ExportSettings
Currents export options.
Type
CurrentsExportSettings
Access
Read only
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
ScopedGeometryEntities
The geometry entities for which the currents calculation will be done.
Access
Read/Write
ScopedMeshEntities
The mesh entities for which the currents calculation will be done.
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.