`FEMLinePort`

A FEM line port is used to define the location of an impressed current source and load in the FEM region.

Example

application = cf.Application.GetInstance()
project = application:NewProject()

corner = cf.Point(-0.25, -0.25, 0)
cube = project.Contents.Geometry:AddCuboid(corner, 0.5, 0.5, 1.25)

dielectric = project.Definitions.Media.Dielectric:AddDielectric()
project.Contents.Geometry[1].Regions[1].Medium = dielectric
project.Contents.Geometry[1].Regions[1].SolutionMethod = cf.Enums.RegionSolutionMethodEnum.FEM

    --  Add a 'FEMLinePort' to the edge of the cuboid

port = project.Contents.Ports:AddFEMLinePort({cube.Edges[1]})

Inheritance

The FEMLinePort object is derived from the AbstractFEMLinePort object.

Usage locations

The FEMLinePort object can be accessed from the following locations:

Methods
- PortCollection collection has method AddFEMLinePort(table).
- PortCollection collection has method AddFEMLinePortBetweenPoints(Point, Point).
- PortCollection collection has method AddFEMLinePort(List of Edge).

Property List

BoundingBox: A box indicating the bounding box of this entity. (Read only Box). (Read only Box)
DefinitionMethod: The FEM line port type definition. (Read/Write FEMLinePortDefinitionMethodEnum)
Edges: The collection of port edges. Only valid if DefinitionMethod is UsingEdges. (Read/Write ObjectReferenceList)
End: The end point. Only valid if DefinitionMethod is UsingPoints. (Read/Write GlobalCoordinates)
Label: The object label. (Read/Write string)
LocalWorkplane: The source workplane. (Read/Write LocalWorkplane)
PolarityReversed: The option to reverse polarity of the port. (Read/Write boolean)
Schematic: The schematic associated with this item. (Read only Schematic)
SchematicLocation: The location of the item on the schematic. (Read only GridLocation)
SchematicRotation: The rotation of the item on the schematic. (Read only SymbolRotationEnum)
Start: The start point. Only valid if DefinitionMethod is UsingPoints. (Read/Write GlobalCoordinates)
Terminals: The schematic terminals on this item. (Read only List of Terminal)
Type: The object type string. (Read only string)

Collection List

Transforms: The collection of transforms on the operator. (TransformCollection of Transform.)

Method List

CopyAndMirror (properties table): Apply a copy and mirror using a table defining the properties. (Returns a Object object.)
CopyAndRotate (properties table, count number): Apply a copy and rotate using a table defining the properties. (Returns a List of Object object.)
CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number): Copy and rotate the geometry. (Returns a List of Object object.)
CopyAndTranslate (properties table, count number): Apply a copy and translate using a table defining the properties. (Returns a List of Object object.)
CopyAndTranslate (from Point, to Point, count number): Copy and translate the geometry. (Returns a List of Object object.)
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.)
RotateSchematicSymbol (): Rotates the item on the schematic.
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.
SetSchematicLocation (location GridLocation): Sets the location of the item on the schematic.
SetSchematicRotation (rotation SymbolRotationEnum): Sets the rotation of the item on the schematic.

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

DefinitionMethod

The FEM line port type definition.

Type: FEMLinePortDefinitionMethodEnum
Access: Read/Write

Edges

The collection of port edges. Only valid if DefinitionMethod is UsingEdges.

Type: ObjectReferenceList
Access: Read/Write

End

The end point. Only valid if DefinitionMethod is UsingPoints.

Type: GlobalCoordinates
Access: Read/Write

Label

The object label.

Type: string
Access: Read/Write

LocalWorkplane

The source workplane.

Type: LocalWorkplane
Access: Read/Write

PolarityReversed

The option to reverse polarity of the port.

Type: boolean
Access: Read/Write

Schematic

The schematic associated with this item.

Type: Schematic
Access: Read only

SchematicLocation

The location of the item on the schematic.

Type: GridLocation
Access: Read only

SchematicRotation

The rotation of the item on the schematic.

Type: SymbolRotationEnum
Access: Read only

Start

The start point. Only valid if DefinitionMethod is UsingPoints.

Type: GlobalCoordinates
Access: Read/Write

Terminals

The schematic terminals on this item.

Access: Read only

Type

The object type string.

Type: string
Access: Read only

Collection Details

Transforms

The collection of transforms on the operator.

Type: TransformCollection

Method Details

CopyAndMirror (properties table)

Apply a copy and mirror using a table defining the properties.

Input Parameters

properties(table): A table of properties defining the mirror transform.

Return

Object: The mirrored geometry.

CopyAndRotate (properties table, count number)

Apply a copy and rotate using a table defining the properties.

Input Parameters

properties(table): A table of properties defining the rotate transform.
count(number): The number of transform copies.

Return

List of Object: The list of rotated geometry.

CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number)

Copy and rotate the geometry.

Input Parameters

origin(Point): The coordinates of the origin of the rotation.
rotationaxis(Vector): The axis of rotation.
angle(number): The angle of rotation (degrees).
count(number): The number of copies.

Return

List of Object: The list of rotated geometry.

CopyAndTranslate (properties table, count number)

Apply a copy and translate using a table defining the properties.

Input Parameters

properties(table): A table of properties defining the translate transform.
count(number): The number of transform copies.

Return

List of Object: The list of translated geometry.

CopyAndTranslate (from Point, to Point, count number)

Copy and translate the geometry.

Input Parameters

from(Point): Translate from coordinate.
to(Point): Translate to coordinate.
count(number): The number of copies.

Return

List of Object: The list of translated geometry.

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.

RotateSchematicSymbol ()

Rotates the item on the schematic.

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.

SetSchematicLocation (location GridLocation)

Sets the location of the item on the schematic.

Input Parameters

location(GridLocation): The schematic location the item should be moved to.

SetSchematicRotation (rotation SymbolRotationEnum)

Sets the rotation of the item on the schematic.

Input Parameters

rotation(SymbolRotationEnum): The rotation setting.

Static Function Details

GetDefaultProperties ()

Creates a table containing the default settings to create an object.

Return

table: A table containing the default properties.