WaveguideMeshPort
A waveguide mesh port is used to define a plane of excitation for a waveguide structure.
Example
app = cf.GetApplication() project = app:NewProject() app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/MeshPorts.cfx]]) union1 = project.Geometry['Union1'] -- Unlink the Mesh. 'WaveguideMeshPorts' are generated automatically from 'WaveguidePorts' union1:UnlinkMesh() -- Get the 'WaveguideMeshPort' associated with 'WaveguidePort' labelled 'WaveguidePort1' waveguideMeshPort = project.Ports['WaveguidePort1_1'] -- Query whether the mesh port is faulty isFaulty = waveguideMeshPort.Faulty
Inheritance
The WaveguideMeshPort object is derived from the Port object.
Property List
- DirectionReversed
- The option to set the propagation direction opposite to the normal direction. (Read/Write boolean)
- Face
- The face to which the waveguide port is applied. (Read/Write MeshEntity)
- Faulty
- True if the port is faulty. (Read only boolean)
- Label
- The port label. (Read/Write string)
- MaxModalExpansionEnabled
- The option to specify the maximum modal expansion indices manually. (Read/Write boolean)
- MaxModalExpansionIndexM
- The option to specify the maximum modal expansion index m manually. This is only valid if MaxModalExpansionEnabled is true. (Read/Write Expression)
- MaxModalExpansionIndexN
- The option to specify the maximum modal expansion index n manually. This is only valid if MaxModalExpansionEnabled is true. (Read/Write Expression)
- ReferenceVector
- The components for the reference vector. (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
- DirectionReversed
- The option to set the propagation direction opposite to the normal direction.
- Type
- boolean
- Access
- Read/Write
- Face
- The face to which the waveguide port is applied.
- Type
- MeshEntity
- Access
- Read/Write
- Faulty
- True if the port is faulty.
- Type
- boolean
- Access
- Read only
- Label
- The port label.
- Type
- string
- Access
- Read/Write
- MaxModalExpansionEnabled
- The option to specify the maximum modal expansion indices manually.
- Type
- boolean
- Access
- Read/Write
- MaxModalExpansionIndexM
- The option to specify the maximum modal expansion index m manually. This is only valid if MaxModalExpansionEnabled is true.
- Type
- Expression
- Access
- Read/Write
- MaxModalExpansionIndexN
- The option to specify the maximum modal expansion index n manually. This is only valid if MaxModalExpansionEnabled is true.
- Type
- Expression
- Access
- Read/Write
- ReferenceVector
- The components for the reference vector.
- 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.