FrequencyFDTDSettings
Advanced FDTD time interval properties.
Example
app = cf.GetApplication() project = app:NewProject() -- Enable the FDTD solver project.SolutionSettings.SolverSettings.FDTDSettings.FDTDEnabled = true -- Set the initial frequency frequency = project.SolutionConfigurations[1].Frequency frequency.Start = 100e6 -- Modify the FDTD time interval settings -- A properties table is used as both the modifications -- must be done together properties = frequency:GetProperties() properties.Advanced.FDTD.TimeIntervalType = cf.Enums.FrequencyFDTDTimeIntervalTypeEnum.Seconds properties.Advanced.FDTD.TimeInterval = 1e-5 frequency:SetProperties(properties)
Usage locations (object properties)
The following objects have properties using the FrequencyFDTDSettings object:
Property List
- ConvergenceThreshold
- Specify a value between (0,1). The simulation will be terminated if the threshold has been reached and the simulation time is larger or equal to the MinimumTimeInterval. Only valid if ConvergenceThresholdEnabled. . (Read/Write Expression)
- ConvergenceThresholdEnabled
- Apply a convergence threshold. (Read/Write boolean)
- MaximumTimeInterval
- Set the maximum time interval duration for which the model is simulated. Only valid if MaximumTimeIntervalEnabled and TimeIntervalType is Periods or Seconds, which implies a unit of either (dimensionless) or (s). (Read/Write Expression)
- MaximumTimeIntervalEnabled
- Apply a maximum limit to the time interval duration.Only valid if TimeIntervalType is Periods or Seconds. (Read/Write boolean)
- MinimumTimeInterval
- Set the minimum time interval duration for which the model is simulated. Only valid if MinimumTimeIntervalEnabled and TimeIntervalType is Periods or Seconds, which implies a unit of either (dimensionless) or (s). (Read/Write Expression)
- MinimumTimeIntervalEnabled
- Apply a minimum limit to the time interval duration.Only valid if TimeIntervalType is Periods or Seconds. (Read/Write boolean)
- TimeIntervalType
- Control the determination of the time duration for which the model is simulated. (Read/Write FrequencyFDTDTimeIntervalTypeEnum)
Property Details
- ConvergenceThreshold
- Specify a value between (0,1). The simulation will be terminated if the threshold has been reached and the simulation time is larger or equal to the MinimumTimeInterval. Only valid if ConvergenceThresholdEnabled. .
- Type
- Expression
- Access
- Read/Write
- ConvergenceThresholdEnabled
- Apply a convergence threshold.
- Type
- boolean
- Access
- Read/Write
- MaximumTimeInterval
- Set the maximum time interval duration for which the model is simulated. Only valid if MaximumTimeIntervalEnabled and TimeIntervalType is Periods or Seconds, which implies a unit of either (dimensionless) or (s).
- Type
- Expression
- Access
- Read/Write
- MaximumTimeIntervalEnabled
- Apply a maximum limit to the time interval duration.Only valid if TimeIntervalType is Periods or Seconds.
- Type
- boolean
- Access
- Read/Write
- MinimumTimeInterval
- Set the minimum time interval duration for which the model is simulated. Only valid if MinimumTimeIntervalEnabled and TimeIntervalType is Periods or Seconds, which implies a unit of either (dimensionless) or (s).
- Type
- Expression
- Access
- Read/Write
- MinimumTimeIntervalEnabled
- Apply a minimum limit to the time interval duration.Only valid if TimeIntervalType is Periods or Seconds.
- Type
- boolean
- Access
- Read/Write
- TimeIntervalType
- Control the determination of the time duration for which the model is simulated.
- Type
- FrequencyFDTDTimeIntervalTypeEnum
- Access
- Read/Write