Enums#
This utility module (found in ratapi.utils.enums) contains the Enum objects
which are used under the hood to represent arguments given as string options,
such as those for control parameters or background types.
The Enum values used in the parameters of various ratapi classes and functions.
- enum ratapi.utils.enums.BackgroundActions(value)#
Ways that the background can be applied to the model.
- Member Type:
str
Valid values are as follows:
- Add = <BackgroundActions.Add: 'add'>#
- Subtract = <BackgroundActions.Subtract: 'subtract'>#
- enum ratapi.utils.enums.BoundHandling(value)#
The available options for bound handling in DREAM.
- Member Type:
str
Valid values are as follows:
- Off = <BoundHandling.Off: 'off'>#
- Reflect = <BoundHandling.Reflect: 'reflect'>#
- Bound = <BoundHandling.Bound: 'bound'>#
- Fold = <BoundHandling.Fold: 'fold'>#
- enum ratapi.utils.enums.Calculations(value)#
Types of calculations that can be performed by RAT.
- Member Type:
str
Valid values are as follows:
- Normal = <Calculations.Normal: 'normal'>#
- Domains = <Calculations.Domains: 'domains'>#
- enum ratapi.utils.enums.Display(value)#
The available options for terminal output.
- Member Type:
str
Valid values are as follows:
- Off = <Display.Off: 'off'>#
- Iter = <Display.Iter: 'iter'>#
- Notify = <Display.Notify: 'notify'>#
- Final = <Display.Final: 'final'>#
- enum ratapi.utils.enums.Geometries(value)#
Where the substrate roughness is placed.
- Member Type:
str
Valid values are as follows:
- AirSubstrate = <Geometries.AirSubstrate: 'air/substrate'>#
- SubstrateLiquid = <Geometries.SubstrateLiquid: 'substrate/liquid'>#
- enum ratapi.utils.enums.Hydration(value)#
Options for the ‘hydrate with’ parameter of a Layer.
- Member Type:
str
Valid values are as follows:
- BulkIn = <Hydration.BulkIn: 'bulk in'>#
- BulkOut = <Hydration.BulkOut: 'bulk out'>#
- enum ratapi.utils.enums.Languages(value)#
Language options for custom files.
- Member Type:
str
Valid values are as follows:
- Cpp = <Languages.Cpp: 'cpp'>#
- Python = <Languages.Python: 'python'>#
- Matlab = <Languages.Matlab: 'matlab'>#
- enum ratapi.utils.enums.LayerModels(value)#
Types of layer model supported by RAT.
- Member Type:
str
Valid values are as follows:
- CustomLayers = <LayerModels.CustomLayers: 'custom layers'>#
- CustomXY = <LayerModels.CustomXY: 'custom xy'>#
- StandardLayers = <LayerModels.StandardLayers: 'standard layers'>#
- enum ratapi.utils.enums.Parallel(value)#
The available options for parallelisation.
- Member Type:
str
Valid values are as follows:
- Single = <Parallel.Single: 'single'>#
- Points = <Parallel.Points: 'points'>#
- Contrasts = <Parallel.Contrasts: 'contrasts'>#
- enum ratapi.utils.enums.Priors(value)#
Prior distributions for parameters.
- Member Type:
str
Valid values are as follows:
- Uniform = <Priors.Uniform: 'uniform'>#
- Gaussian = <Priors.Gaussian: 'gaussian'>#
- Jeffreys = <Priors.Jeffreys: 'jeffreys'>#
- enum ratapi.utils.enums.Procedures(value)#
The available options for procedures.
- Member Type:
str
Valid values are as follows:
- Calculate = <Procedures.Calculate: 'calculate'>#
- Simplex = <Procedures.Simplex: 'simplex'>#
- DE = <Procedures.DE: 'de'>#
- NS = <Procedures.NS: 'ns'>#
- DREAM = <Procedures.DREAM: 'dream'>#
- enum ratapi.utils.enums.RATEnum(value)#
A subclass of StrEnum with some adjustments for variable spellings.
- Member Type:
str
- enum ratapi.utils.enums.Strategies(value)#
The available strategies for generating base vectors in differential evolution.
- Member Type:
str
Valid values are as follows:
- Random = <Strategies.Random: 'random'>#
- LocalToBest = <Strategies.LocalToBest: 'local to best'>#
- BestWithJitter = <Strategies.BestWithJitter: 'best jitter'>#
- RandomWithPerVectorDither = <Strategies.RandomWithPerVectorDither: 'vector dither'>#
- RandomWithPerGenerationDither = <Strategies.RandomWithPerGenerationDither: 'generation dither'>#
- RandomEitherOrAlgorithm = <Strategies.RandomEitherOrAlgorithm: 'either or'>#