FEMLinePort
A FEM line port is used to define the location of an impressed current source and load in the FEM region.
Example
app = cf.GetApplication() project = app:NewProject() corner = cf.Point(-0.25, -0.25, 0) cube = project.Geometry:AddCuboid(corner, 0.5, 0.5, 1.25) dielectric = project.Media:AddDielectric() project.Geometry[1].Regions[1].Medium = dielectric -- Add a 'FEMLinePort' to the edge of the cuboid port = project.Ports:AddFEMLinePort({cube.Edges[1]})
Inheritance
The FEMLinePort object is derived from the Port object.
Property List
- DefinitionMethod
- The FEM line port type definition. (Read/Write FEMLinePortDefinitionMethodEnum)
- Edges
- The collection of port edges. Only valid if DefinitionMethod is UsingEdges. (Read/Write List of Edge)
- End
- The end point. Only valid if DefinitionMethod is UsingPoints. (Read/Write GlobalCoordinates)
- Faulty
- True if the port is faulty. (Read only boolean)
- Label
- The port label. (Read/Write string)
- PolarityReversed
- The option to reverse polarity of the port. (Read/Write boolean)
- Start
- The start point. Only valid if DefinitionMethod is UsingPoints. (Read/Write GlobalCoordinates)
- Suspect
- True if the port is suspect. (Read only boolean)
- Terminal
- The port terminal. (Read only Terminal)
- Type
- The object type string. (Read only string)
- Visible
- Specifies whether the port must be shown or hidden. (Read/Write boolean)
Method List
- Delete ()
- Delete the port.
- 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
- DefinitionMethod
- The FEM line port type definition.
- Type
- FEMLinePortDefinitionMethodEnum
- Access
- Read/Write
- Edges
- The collection of port edges. Only valid if DefinitionMethod is UsingEdges.
- Access
- Read/Write
- End
- The end point. Only valid if DefinitionMethod is UsingPoints.
- Type
- GlobalCoordinates
- Access
- Read/Write
- Faulty
- True if the port is faulty.
- Type
- boolean
- Access
- Read only
- Label
- The port label.
- Type
- string
- Access
- Read/Write
- PolarityReversed
- The option to reverse polarity of the port.
- Type
- boolean
- Access
- Read/Write
- Start
- The start point. Only valid if DefinitionMethod is UsingPoints.
- Type
- GlobalCoordinates
- Access
- Read/Write
- Suspect
- True if the port is suspect.
- Type
- boolean
- Access
- Read only
- Terminal
- The port terminal.
- Type
- Terminal
- Access
- Read only
- Type
- The object type string.
- Type
- string
- Access
- Read only
- Visible
- Specifies whether the port must be shown or hidden.
- Type
- boolean
- Access
- Read/Write
Method Details
- Delete ()
- Delete the port.
- 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.