HighFrequencySettings

High frequency solver settings.

Example

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

    -- Set the maximum number of iterations

project.Contents.SolutionSettings.SolverSettings.HighFrequencySettings.MaxIterations = 10

Inheritance

The HighFrequencySettings object is derived from the CompositeValue object.

Usage locations

The HighFrequencySettings object can be accessed from the following locations:

Property List

AdaptiveRayLaunchingAccuracy
The adaptive RL-GO algorithm convergence criteria. Only valid if RLGOIncrementType is Automatic. (Read/Write RLGOConvergenceAccuracyTypeEnum)
DecoupleRLGOFromMoM
Specifies whether RLGO and MoM solutions should be decoupled. (Read/Write boolean)
DecoupleUTDFromMoM
Specifies whether UTD and MoM solutions should be decoupled. (Read/Write boolean)
HighFrequencyPOMoMCouplingType
The coupling between PO and MoM, specified by HighFrequencyPOMoMCouplingTypeEnum, eg. Iterative, Full, etc. (Read/Write HighFrequencyPOMoMCouplingTypeEnum)
MaxIterations
Maximum number of iterations. Only valid if HighFrequencyPOMoMCouplingType is Iterative. (Read/Write ParametricExpression)
MaxRLGORayInteractions
The maximum number of reflections/transmission interactions to be taken into account for each RL-GO ray. Only valid if MaxRLGORayInteractionsEnabled is true. (Read/Write ParametricExpression)
MaxRLGORayInteractionsEnabled
Specifies whether the number of ray interactions should be specified for RL-GO. (Read/Write boolean)
MaxUTDRayInteractions
The maximum number of reflections/transmission interactions to be taken into account for each UTD ray. (Read/Write ParametricExpression)
MaxUTDRayInteractionsEnabled
Specifies whether the number of ray interactions should be specified for UTD. (Read/Write boolean)
PhiIncrement
The phi increment in degrees (spherical ray launching). Only valid if RLGOIncrementType is SpecifyIncrements. (Read/Write ParametricExpression)
RLGOIncrementType
Specifies whether the ray launch increments are determined automatically or user specified, specified by RLGOIncrementTypeEnum, eg. Automatic or SpecifyIncrements. (Read/Write RLGOIncrementTypeEnum)
RayContributionsFacetedUTD
Ray contribution settings. (Read/Write RayContributionsFacetedUTD)
RayContributionsRLGO
Ray contribution settings. (Read/Write RayContributionsRLGO)
RayContributionsUTD
Ray contribution settings. (Read/Write RayContributionsUTD)
RayTraceSymmetryEnabled
Specifies whether symmetry should be used in ray-tracing (when possible). (Read/Write boolean)
StoppingCriterion
Stopping criterion for the residuum. Only valid if HighFrequencyPOMoMCouplingType is Iterative. (Read/Write ParametricExpression)
StoreShadowingInfoEnabled
Specifies whether the shadowing information should be stored / re-used. (Read/Write boolean)
ThetaIncrement
The theta increment in degrees (spherical ray launching). Only valid if RLGOIncrementType is SpecifyIncrements. (Read/Write ParametricExpression)
UIncrement
The U increment in metres (parallel ray front). Only valid if RLGOIncrementType is SpecifyIncrements. (Read/Write ParametricExpression)
UTDRayContributionsType
Specifies whether the ray contributions are determined automatically or user specified, specified by UTDRayContributionsTypeEnum, eg. Default or Advanced. (Read/Write UTDRayContributionsTypeEnum)
VIncrement
The V increment in metres (parallel ray front). Only valid if RLGOIncrementType is SpecifyIncrements. (Read/Write ParametricExpression)

Property Details

AdaptiveRayLaunchingAccuracy
The adaptive RL-GO algorithm convergence criteria. Only valid if RLGOIncrementType is Automatic.
Type
RLGOConvergenceAccuracyTypeEnum
Access
Read/Write
DecoupleRLGOFromMoM
Specifies whether RLGO and MoM solutions should be decoupled.
Type
boolean
Access
Read/Write
DecoupleUTDFromMoM
Specifies whether UTD and MoM solutions should be decoupled.
Type
boolean
Access
Read/Write
HighFrequencyPOMoMCouplingType
The coupling between PO and MoM, specified by HighFrequencyPOMoMCouplingTypeEnum, eg. Iterative, Full, etc.
Type
HighFrequencyPOMoMCouplingTypeEnum
Access
Read/Write
MaxIterations
Maximum number of iterations. Only valid if HighFrequencyPOMoMCouplingType is Iterative.
Type
ParametricExpression
Access
Read/Write
MaxRLGORayInteractions
The maximum number of reflections/transmission interactions to be taken into account for each RL-GO ray. Only valid if MaxRLGORayInteractionsEnabled is true.
Type
ParametricExpression
Access
Read/Write
MaxRLGORayInteractionsEnabled
Specifies whether the number of ray interactions should be specified for RL-GO.
Type
boolean
Access
Read/Write
MaxUTDRayInteractions
The maximum number of reflections/transmission interactions to be taken into account for each UTD ray.
Type
ParametricExpression
Access
Read/Write
MaxUTDRayInteractionsEnabled
Specifies whether the number of ray interactions should be specified for UTD.
Type
boolean
Access
Read/Write
PhiIncrement
The phi increment in degrees (spherical ray launching). Only valid if RLGOIncrementType is SpecifyIncrements.
Type
ParametricExpression
Access
Read/Write
RLGOIncrementType
Specifies whether the ray launch increments are determined automatically or user specified, specified by RLGOIncrementTypeEnum, eg. Automatic or SpecifyIncrements.
Type
RLGOIncrementTypeEnum
Access
Read/Write
RayContributionsFacetedUTD
Ray contribution settings.
Type
RayContributionsFacetedUTD
Access
Read/Write
RayContributionsRLGO
Ray contribution settings.
Type
RayContributionsRLGO
Access
Read/Write
RayContributionsUTD
Ray contribution settings.
Type
RayContributionsUTD
Access
Read/Write
RayTraceSymmetryEnabled
Specifies whether symmetry should be used in ray-tracing (when possible).
Type
boolean
Access
Read/Write
StoppingCriterion
Stopping criterion for the residuum. Only valid if HighFrequencyPOMoMCouplingType is Iterative.
Type
ParametricExpression
Access
Read/Write
StoreShadowingInfoEnabled
Specifies whether the shadowing information should be stored / re-used.
Type
boolean
Access
Read/Write
ThetaIncrement
The theta increment in degrees (spherical ray launching). Only valid if RLGOIncrementType is SpecifyIncrements.
Type
ParametricExpression
Access
Read/Write
UIncrement
The U increment in metres (parallel ray front). Only valid if RLGOIncrementType is SpecifyIncrements.
Type
ParametricExpression
Access
Read/Write
UTDRayContributionsType
Specifies whether the ray contributions are determined automatically or user specified, specified by UTDRayContributionsTypeEnum, eg. Default or Advanced.
Type
UTDRayContributionsTypeEnum
Access
Read/Write
VIncrement
The V increment in metres (parallel ray front). Only valid if RLGOIncrementType is SpecifyIncrements.
Type
ParametricExpression
Access
Read/Write