FDTDBoundaryConditions
An FDTDBoundaryConditions request.
Example
application = cf.Application.getInstance() project = application:Load({FEKO_HOME..[[/shared/Resources/Automation/Dipole_Example.cfx]]}) -- Enable the FDTD solver project.Contents.SolutionSettings.SolverSettings.FDTDSettings.FDTDEnabled = true -- Access the 'FDTDBoundaryConditions' object and adjust the PositiveX boundary project.Contents.SolutionSettings.FDTDBoundary.PositiveX.BoundaryType = cf.Enums.BoundaryFaceDefinitionEnum.PEC
Inheritance
The FDTDBoundaryConditions object is derived from the Object object.
Usage locations
The FDTDBoundaryConditions object can be accessed from the following locations:
- Properties
- SolutionSettings object has property FDTDBoundary.
Property List
- BoundingBox
- A box indicating the bounding box of this entity. (Read only Box). (Read only Box)
- Label
- The object label. (Read/Write string)
- NegativeX
- The -X boundary settings. (Read/Write FDTDBoundarySettings)
- NegativeY
- The -Y boundary settings. (Read/Write FDTDBoundarySettings)
- NegativeZ
- The bottom (-Z) boundary settings. (Read/Write FDTDBoundarySettings)
- PositiveX
- The +X boundary settings. (Read/Write FDTDBoundarySettings)
- PositiveY
- The +Y boundary settings. (Read/Write FDTDBoundarySettings)
- PositiveZ
- The top (+Z) boundary settings. (Read/Write FDTDBoundarySettings)
- Type
- The object type string. (Read only string)
Method List
- 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
- Label
- The object label.
- Type
- string
- Access
- Read/Write
- NegativeX
- The -X boundary settings.
- Type
- FDTDBoundarySettings
- Access
- Read/Write
- NegativeY
- The -Y boundary settings.
- Type
- FDTDBoundarySettings
- Access
- Read/Write
- NegativeZ
- The bottom (-Z) boundary settings.
- Type
- FDTDBoundarySettings
- Access
- Read/Write
- PositiveX
- The +X boundary settings.
- Type
- FDTDBoundarySettings
- Access
- Read/Write
- PositiveY
- The +Y boundary settings.
- Type
- FDTDBoundarySettings
- Access
- Read/Write
- PositiveZ
- The top (+Z) boundary settings.
- Type
- FDTDBoundarySettings
- Access
- Read/Write
- Type
- The object type string.
- Type
- string
- Access
- Read only
Method Details
- 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.