FEMModalMeshPort

A FEM modal mesh port is used to apply a modal port boundary condition on the boundary of a finite element (FEM) region.

Example

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

    -- Create a 'FEMModalMeshPort' spanning the points (0,0,0), (0,1,0) and (1,1,0)

femLineMeshPort = project.Ports:AddFEMModalMeshPortFromPoints(
cf.Point(0,0,0) ,cf.Point(0,1,0), cf.Point(1,1,0) )

Inheritance

The FEMModalMeshPort object is derived from the Port object.

Property List

Corner1
The first construction point of the port. Only valid if DefinitionMethod is UsingPoints. (Read/Write LocalCoordinates)
Corner2
The second construction point of the port. Only valid if DefinitionMethod is UsingPoints. (Read/Write LocalCoordinates)
Corner3
The third construction point of the port. Only valid if DefinitionMethod is UsingPoints. (Read/Write LocalCoordinates)
DefinitionMethod
The FEM modal port definition type. (Read/Write FEMModalMeshPortDefinitionMethodEnum)
Faulty
True if the port is faulty. (Read only boolean)
Label
The port label. (Read/Write string)
LocalWorkplane
The FEM modal mesh port workplane. (Read only LocalWorkplane)
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)
Vertex1
The first construction vertex of the port. Only valid if DefinitionMethod is UsingVertices. (Read/Write MeshVertex)
Vertex2
The second construction vertex of the port. Only valid if DefinitionMethod is UsingVertices. (Read/Write MeshVertex)
Vertex3
The third construction vertex of the port. Only valid if DefinitionMethod is UsingVertices. (Read/Write MeshVertex)
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

Corner1
The first construction point of the port. Only valid if DefinitionMethod is UsingPoints.
Type
LocalCoordinates
Access
Read/Write
Corner2
The second construction point of the port. Only valid if DefinitionMethod is UsingPoints.
Type
LocalCoordinates
Access
Read/Write
Corner3
The third construction point of the port. Only valid if DefinitionMethod is UsingPoints.
Type
LocalCoordinates
Access
Read/Write
DefinitionMethod
The FEM modal port definition type.
Type
FEMModalMeshPortDefinitionMethodEnum
Access
Read/Write
Faulty
True if the port is faulty.
Type
boolean
Access
Read only
Label
The port label.
Type
string
Access
Read/Write
LocalWorkplane
The FEM modal mesh port workplane.
Type
LocalWorkplane
Access
Read only
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
Vertex1
The first construction vertex of the port. Only valid if DefinitionMethod is UsingVertices.
Type
MeshVertex
Access
Read/Write
Vertex2
The second construction vertex of the port. Only valid if DefinitionMethod is UsingVertices.
Type
MeshVertex
Access
Read/Write
Vertex3
The third construction vertex of the port. Only valid if DefinitionMethod is UsingVertices.
Type
MeshVertex
Access
Read/Write
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.