Load
A solution load.
Example
application = cf.Application.getInstance() project = application:NewProject() dielectric = project.Definitions.Media.Dielectric:AddDielectric() cube = project.Contents.Geometry:AddCuboid(cf.Point(0, 0, 0), 1, 1, 1) cube.Regions[1].Medium = dielectric cube.Regions[1].SolutionMethod = cf.Enums.RegionSolutionMethodEnum.FEM femLinePort = project.Contents.Ports:AddFEMLinePortBetweenPoints(cf.Point(0,0,0) ,cf.Point(1,1,0) ) -- Add a complex load to the terminal of the line port. complexLoad = project.Contents.SolutionConfigurations.GlobalLoads:AddComplex(femLinePort,"220","0") -- Do not include the load complexLoad.Included = false
Inheritance
Usage locations
The Load object can be accessed from the following locations:
- Methods
- LoadCollection collection has method AddComplex(Port, Expression, Expression).
- LoadCollection collection has method AddLoad(table).
- LoadCollection collection has method AddParallel(Port, Expression, Expression, Expression).
- LoadCollection collection has method AddSeries(Port, Expression, Expression, Expression).
- LoadCollection collection has method AddSinglePortTouchstone(Port, string).
- LoadCollection collection has method AddSpiceCircuit(Port, string).
- LoadCollection collection has method Item(number).
- LoadCollection collection has method Item(string).
Property List
- BoundingBox
- A box indicating the bounding box of this entity. (Read only Box). (Read only Box)
- Capacitance
- The capacitive aspect of the series or parallel circuit load definition (F). Changing this property will set CapacitanceEnabled to true. (Read/Write ParametricExpression)
- CapacitanceEnabled
- Specifies if the Capacitance property should be used. (Read/Write boolean)
- CircuitName
- The SPICE Circuit name. Setting disables the automatic generation of the name. (Read/Write string)
- Filename
- The single port Touchstone or SPICE filename that describes the load. (Read/Write FileReference)
- ImpedanceImaginary
- The reactive part of the complex impedance (Ohm). (Read/Write ParametricExpression)
- ImpedanceReal
- The real part of the complex impedance (Ohm). (Read/Write ParametricExpression)
- Inductance
- The inductive aspect of the series or parallel circuit load definition (H). Changing this property will set InductanceEnabled to true. (Read/Write ParametricExpression)
- InductanceEnabled
- Specifies if the Inductance property should be used. (Read/Write boolean)
- Label
- The object label. (Read/Write string)
- LoadType
- The load construction type. (Read/Write LoadTypeEnum)
- Resistance
- The resistive aspect of the series or parallel circuit load definition (Ohm). Changing this property will set ResistanceEnabled to true. (Read/Write ParametricExpression)
- ResistanceEnabled
- Specifies if the Resistance property should be used. (Read/Write boolean)
- Type
- The object type string. (Read only string)
Method List
- Delete ()
- Deletes the entity.
- Duplicate ()
- Duplicates the entity. (Returns a Object 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 Object)
- 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
- BoundingBox
- A box indicating the bounding box of this entity. (Read only Box).
- Type
- Box
- Access
- Read only
- Capacitance
- The capacitive aspect of the series or parallel circuit load definition (F). Changing this property will set CapacitanceEnabled to true.
- Type
- ParametricExpression
- Access
- Read/Write
- CapacitanceEnabled
- Specifies if the Capacitance property should be used.
- Type
- boolean
- Access
- Read/Write
- CircuitName
- The SPICE Circuit name. Setting disables the automatic generation of the name.
- Type
- string
- Access
- Read/Write
- Filename
- The single port Touchstone or SPICE filename that describes the load.
- Type
- FileReference
- Access
- Read/Write
- ImpedanceImaginary
- The reactive part of the complex impedance (Ohm).
- Type
- ParametricExpression
- Access
- Read/Write
- ImpedanceReal
- The real part of the complex impedance (Ohm).
- Type
- ParametricExpression
- Access
- Read/Write
- Inductance
- The inductive aspect of the series or parallel circuit load definition (H). Changing this property will set InductanceEnabled to true.
- Type
- ParametricExpression
- Access
- Read/Write
- InductanceEnabled
- Specifies if the Inductance property should be used.
- Type
- boolean
- Access
- Read/Write
- Label
- The object label.
- Type
- string
- Access
- Read/Write
- LoadType
- The load construction type.
- Type
- LoadTypeEnum
- Access
- Read/Write
- Resistance
- The resistive aspect of the series or parallel circuit load definition (Ohm). Changing this property will set ResistanceEnabled to true.
- Type
- ParametricExpression
- Access
- Read/Write
- ResistanceEnabled
- Specifies if the Resistance property should be used.
- Type
- boolean
- Access
- Read/Write
- Type
- The object type string.
- Type
- string
- Access
- Read only
Method Details
- Delete ()
- Deletes the entity.
- Duplicate ()
- Duplicates the entity.
- Return
- Object
- The new (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 table defining the properties.
- SetProperties (properties Object)
- 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(Object)
- 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
- A table containing the default properties.