GenerateRandomFields Class Reference
Last update: 16.07.2025an algorithm that computes new field samples from amplitudes and scatter shapes The algorithm is essentially the same is the class FieldDesignsFromAmplitudes, but it is based on the data structures stored in class RandomFieldContainer. More...
Public Member Functions | |
| check (Structure database) | |
| checks the settings More... | |
| compute (Structure database) | |
| computes the new objects More... | |
| GenerateRandomFields (DataObjectContainer selected_scalars, bool enforce_equal_idents=false) | |
| constructor More... | |
Public Attributes | |
| bool | accept_partial_subspace |
| if true, then one accepts that the set of random field amplitudes is incomplete. E.g. if no amplitude is selected, then one simly assumes a value of "zero" | |
| bool | overwrite_existing |
| if true, existing outut objects will be replaced, otherwise: error if it already exists | |
Detailed Description
an algorithm that computes new field samples from amplitudes and scatter shapes The algorithm is essentially the same is the class FieldDesignsFromAmplitudes, but it is based on the data structures stored in class RandomFieldContainer.
- Deprecated:
- This class is deprecated with SoS 3.3. It should be removed with SoS 3.4
Constructor & Destructor Documentation
◆ GenerateRandomFields()
| GenerateRandomFields | ( | DataObjectContainer | selected_scalars, |
| bool | enforce_equal_idents = false |
||
| ) |
constructor
- Parameters
-
selected_scalars the selected scalar quantities that are ALL amplitudes to be used enforce_equal_idents if true, then the same quantity idents are used as the input idents (is only used in optiSLang's simulation flow. Usually objects with that quantity ident already exist!)
Member Function Documentation
◆ check()
| check | ( | Structure | database | ) |
checks the settings
- Parameters
-
database the database we refer to
- Exceptions
-
an exception in case of an error
◆ compute()
| compute | ( | Structure | database | ) |
computes the new objects
- Parameters
-
database the database we refer to
