FEMLineMeshPort
A FEM line mesh 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() -- Create a 'FEMLineMeshPort' between the points (0,0,0) and (1,1,0) femLineMeshPort = project.Ports:AddFEMLineMeshPortBetweenPoints(cf.Point(0,0,0) ,cf.Point(1,1,0) )
Inheritance
The FEMLineMeshPort object is derived from the Port object.
Property List
- DefinitionMethod
- The FEM line mesh port type definition. (Read/Write FEMLineMeshPortDefinitionMethodEnum)
- End
- The end point of the port. Only valid if DefinitionMethod is UsingPoints. (Read/Write GlobalCoordinates)
- EndVertex
- The end vertex of the port. Only valid if DefinitionMethod is UsingVertices. (Read/Write MeshVertex)
- Faulty
- True if the port is faulty. (Read only boolean)
- Label
- The port label. (Read/Write string)
- Start
- The start point of the port. Only valid if DefinitionMethod is UsingPoints. (Read/Write GlobalCoordinates)
- StartVertex
- The start vertex of the port. Only valid if DefinitionMethod is UsingVertices. (Read/Write MeshVertex)
- 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 mesh port type definition.
- Type
- FEMLineMeshPortDefinitionMethodEnum
- Access
- Read/Write
- End
- The end point of the port. Only valid if DefinitionMethod is UsingPoints.
- Type
- GlobalCoordinates
- Access
- Read/Write
- EndVertex
- The end vertex of the port. Only valid if DefinitionMethod is UsingVertices.
- Type
- MeshVertex
- Access
- Read/Write
- Faulty
- True if the port is faulty.
- Type
- boolean
- Access
- Read only
- Label
- The port label.
- Type
- string
- Access
- Read/Write
- Start
- The start point of the port. Only valid if DefinitionMethod is UsingPoints.
- Type
- GlobalCoordinates
- Access
- Read/Write
- StartVertex
- The start vertex of the port. Only valid if DefinitionMethod is UsingVertices.
- Type
- MeshVertex
- 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.