FEMModalPort
A FEM modal port is used to apply a modal port boundary condition on the boundary of a finite element (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) cube.Regions[1].SolutionMethod = cf.Enums.RegionSolutionMethodEnum.FEM -- Add a 'FEMModalPort' around the top face of the cube. port = project.Contents.Ports:AddFEMModalPort({cube.Faces[1]})
Inheritance
The FEMModalPort object is derived from the Port object.
Usage locations
The FEMModalPort object can be accessed from the following locations:
- Methods
- PortCollection collection has method AddFEMModalPort(table).
- PortCollection collection has method AddFEMModalPort(List of Face).
- PortCollection collection has method AddFEMModalPortFromPoints(Point, Point, Point).
Property List
- BoundingBox
- A box indicating the bounding box of this entity. (Read only Box). (Read only Box)
- Corner1
- The first construction point of the port. Only valid if DefinitionMethod is UsingPoints. (Read/Write LocalCoordinate)
- Corner2
- The second construction point of the port. Only valid if DefinitionMethod is UsingPoints. (Read/Write LocalCoordinate)
- Corner3
- The third construction point of the port. Only valid if DefinitionMethod is UsingPoints. (Read/Write LocalCoordinate)
- DefinitionMethod
- The FEM modal port definition type. (Read/Write FEMModalPortDefinitionMethodEnum)
- Faces
- The collection of port faces. Only valid if DefinitionMethod is UsingFaces. (Read/Write ObjectReferenceList)
- Label
- The object label. (Read/Write string)
- LocalWorkplane
- The source workplane. (Read/Write LocalWorkplane)
- Type
- The object type string. (Read only string)
- Visible
- Specifies whether the geometry must be shown or hidden. (Read/Write boolean)
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 List of 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.)
- 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
- Corner1
- The first construction point of the port. Only valid if DefinitionMethod is UsingPoints.
- Type
- LocalCoordinate
- Access
- Read/Write
- Corner2
- The second construction point of the port. Only valid if DefinitionMethod is UsingPoints.
- Type
- LocalCoordinate
- Access
- Read/Write
- Corner3
- The third construction point of the port. Only valid if DefinitionMethod is UsingPoints.
- Type
- LocalCoordinate
- Access
- Read/Write
- DefinitionMethod
- The FEM modal port definition type.
- Type
- FEMModalPortDefinitionMethodEnum
- Access
- Read/Write
- Faces
- The collection of port faces. Only valid if DefinitionMethod is UsingFaces.
- Type
- ObjectReferenceList
- Access
- Read/Write
- Label
- The object label.
- Type
- string
- Access
- Read/Write
- LocalWorkplane
- The source workplane.
- Type
- LocalWorkplane
- Access
- Read/Write
- Type
- The object type string.
- Type
- string
- Access
- Read only
- Visible
- Specifies whether the geometry must be shown or hidden.
- Type
- boolean
- Access
- Read/Write
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.
- CopyAndRotate (properties table, count number)
- Apply a copy and rotate using a table defining the properties.
- CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number)
- Copy and rotate the geometry.
- CopyAndTranslate (properties table, count number)
- Apply a copy and translate using a table defining the properties.
- CopyAndTranslate (from Point, to Point, count number)
- Copy and translate the 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.
- 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.