# FrequencyFDTDSettings

## Example

application = cf.Application.GetInstance()
project = application:NewProject()

-- Enable the FDTD solver

project.Contents.SolutionSettings.SolverSettings.FDTDSettings.FDTDEnabled = true

-- Set the initial frequency

frequency = project.Contents.SolutionConfigurations.GlobalFrequency
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()
frequency:SetProperties(properties)

## Inheritance

The FrequencyFDTDSettings object is derived from the CompositeValue object.

## Usage locations

The FrequencyFDTDSettings object can be accessed from the following locations:

## 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 ParametricExpression)
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 ParametricExpression)
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 ParametricExpression)
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
ParametricExpression
Access
ConvergenceThresholdEnabled
Apply a convergence threshold.
Type
boolean
Access
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
ParametricExpression
Access
MaximumTimeIntervalEnabled
Apply a maximum limit to the time interval duration.Only valid if TimeIntervalType is Periods or Seconds.
Type
boolean
Access
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
ParametricExpression
Access