FMOPGroup Class Reference
Last update: 16.07.2025a group of random fields belonging together (either a single random field, or multiple cross-correlated fields) More...
Public Types | |
| typedef std::vector< string > | TStringVector |
Public Member Functions | |
| string | activeInputIdent (number i_input) |
| std::vector< number > | activeInputIndices () const |
| Matrix | centerInputValues () const |
| copyFCoPToDatabase (Structure database, bool overwrite_existing) | |
| copies contained data to the database (being visible in data object table), restricted to basic FCoP-data (all except Rsigma) More... | |
| copyMostSensitiveToDatabase (Structure database, bool overwrite_existing) | |
| copies contained data to the database (being visible in data object table), restricted to objects names 'most sensitive inputs' More... | |
| copyRSigmaToDatabase (Structure database, bool overwrite_existing) | |
| copies contained data to the database (being visible in data object table), restricted to all Rsigma objects More... | |
| DataObjectContainer | elementResults () const |
| returns a const-reference to m_element_data | |
| eraseDatabaseCopies (Structure database) | |
| deletes all data objects contained in this data structure from the respective database. More... | |
| Matrix | evaluateAmplitudes (Matrix inputs, bool use_sampling_bounds=true) |
| evaluates the Field-MOP for the amplitudes only More... | |
| Eigen::VectorXd | inputCoP () const |
| string | inputIdent (number i_input) |
| TStringVector | inputIdentsVector () |
| returns a reference to a string vector of all scalar input parameters | |
| ::legacy::ScalarMOP2 | mop () const |
| MOQ | moq () |
| DataObjectContainer | nodeResults () const |
| returns a const-reference to m_node_data | |
| number | numActiveInputs () |
| number | numInputs () |
| bool | overlaps (FMOPGroup field) const |
| RandomFieldGroup | rfGroup () const |
| DataObjectContainer | scalarResults () const |
| returns a const-reference to m_scalar_data | |
| number | totalCoP () const |
| bool | useMOQ () const |
Detailed Description
a group of random fields belonging together (either a single random field, or multiple cross-correlated fields)
Member Function Documentation
◆ activeInputIdent()
| string activeInputIdent | ( | number | i_input | ) |
- Returns
- the ident of a respective scalar input parameter
- Parameters
-
i_input the index of the respective input parameter rangin from 0 to numActiveInputs(). Also the ordering refers to centerInputValues.
◆ activeInputIndices()
| std::vector<number> activeInputIndices | ( | ) | const |
- Returns
- the active node indices
◆ centerInputValues()
| Matrix centerInputValues | ( | ) | const |
- Returns
- the center values of all inputs
◆ copyFCoPToDatabase()
| copyFCoPToDatabase | ( | Structure | database, |
| bool | overwrite_existing | ||
| ) |
copies contained data to the database (being visible in data object table), restricted to basic FCoP-data (all except Rsigma)
- Parameters
-
database the target database overwrite_existing if true, then data objects with identical ident will be replaced, else an exception is thrown.
◆ copyMostSensitiveToDatabase()
| copyMostSensitiveToDatabase | ( | Structure | database, |
| bool | overwrite_existing | ||
| ) |
copies contained data to the database (being visible in data object table), restricted to objects names 'most sensitive inputs'
- Parameters
-
database the target database overwrite_existing if true, then data objects with identical ident will be replaced, else an exception is thrown.
◆ copyRSigmaToDatabase()
| copyRSigmaToDatabase | ( | Structure | database, |
| bool | overwrite_existing | ||
| ) |
copies contained data to the database (being visible in data object table), restricted to all Rsigma objects
- Parameters
-
database the target database overwrite_existing if true, then data objects with identical ident will be replaced, else an exception is thrown.
◆ eraseDatabaseCopies()
| eraseDatabaseCopies | ( | Structure | database | ) |
deletes all data objects contained in this data structure from the respective database.
- Parameters
-
database the database to be deleted
◆ evaluateAmplitudes()
evaluates the Field-MOP for the amplitudes only
- Parameters
-
inputs the column vector of the input parameters (ALL inputs!) use_sampling_bounds if true, then the method returns with an error if the input vector is outside of the original DOE boundaries; else it tries to extrapolate
- Returns
- the vector of amplitudes.
◆ inputCoP()
| Eigen::VectorXd inputCoP | ( | ) | const |
- Returns
- a const-reference to m_input_cop
◆ inputIdent()
| string inputIdent | ( | number | i_input | ) |
- Returns
- the ident of a respective scalar input parameter
- Parameters
-
i_input the index of the respective input parameter ranging from 0 to numInputs
◆ mop()
| ::legacy::ScalarMOP2 mop | ( | ) | const |
- Returns
- a const-reference to the respective ScalarMOP object
◆ numActiveInputs()
| number numActiveInputs | ( | ) |
- Returns
- the number of active inputs
◆ numInputs()
| number numInputs | ( | ) |
- Returns
- the number of input parameters
◆ overlaps()
| bool overlaps | ( | FMOPGroup | field | ) | const |
- Returns
- true if any quantity of the other field has the same ident as a quantity in this object
- Parameters
-
field the other field to be tested
◆ rfGroup()
| RandomFieldGroup rfGroup | ( | ) | const |
- Returns
- a const-reference to the respective field container
◆ totalCoP()
| number totalCoP | ( | ) | const |
- Returns
- a const-reference to m_total_cop
◆ useMOQ()
| bool useMOQ | ( | ) | const |
- Returns
- returns true if it used MOQ for approximation, else it uses MOP
