MOP 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 | |
| Matrix | activeInputCoP () |
| Returns the CoPs of each input quantity in this MOP. Ordered as in activeInputIdentsVector(), activeLowerBounds() and activeUpperBounds(). More... | |
| string | activeInputIdent (number i_input) |
| TStringVector | activeInputIdentsVector () |
| returns a string vector of all active scalar input parameters. Ordered as in activeLowerBounds(), activeUpperBounds(), activeInputCoP() | |
| std::vector< number > | activeInputIndices () |
| Active node indices. Use this to access active inputs in inputIdentsVector(), inputCoP() and centerInputValues() More... | |
| Matrix | activeLowerBounds () |
| Get a Vector of active input parameters' lower bounds of valid MOP evaluation values. Ordered as in activeInputIdentsVector(). More... | |
| Matrix | activeUpperBounds () |
| Get a Vector of active input parameters' upper bounds of valid MOP evaluation values. Ordered as in activeInputIdentsVector(). More... | |
| Matrix | centerInputValues () |
| copyFieldCoPToDatabase (Structure database, bool overwrite_existing) | |
| copies contained data to the database (being visible in data object table), restricted to basic FieldCoP-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 () |
| 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... | |
| Matrix | inputCoP () |
| Returns the CoPs of each input quantity in this MOP. Ordered as in inputIdentsVector() More... | |
| string | inputIdent (number i_input) |
| Get the ident of the i-th input parameter. More... | |
| TStringVector | inputIdentsVector () |
| returns a reference to a string vector of all scalar input parameters More... | |
| Matrix | lowerBounds () |
| Get a vector of input parameters' lower bounds of valid MOP evaulation values. Includes inactive input parameters with CoP equal to 0. Ordered as in inputIdentsVector(). More... | |
| DataObjectContainer | nodeResults () |
| returns a const-reference to m_node_data | |
| number | numActiveInputs () |
| number | numInputs () |
| Get the number of input parameters. More... | |
| bool | overlaps (MOP const field) |
| Checks if this instance contains a quantity with an ident that is the same as an ident of a quantity in the given field quantity. (if it overlaps with the field) More... | |
| RandomFieldGroup | rfGroup () |
| Returns read access to the underlying field models (a group of random fields) More... | |
| handler::ScalarMOPContainer | scalarMOPContainer () |
| Returns read access to the underlying scalar model (a group of scalar models/scalarMOP) More... | |
| DataObjectContainer | scalarResults () |
| returns a const-reference to m_scalar_data | |
| number | totalCoP () |
| Returns the total CoP of this MOP. More... | |
| Matrix | upperBounds () |
| Get a vector of input parameters' upper bounds of valid MOP evaulation values. Includes inactive input parameters with CoP equal to 0. Ordered as in inputIdentsVector(). More... | |
Detailed Description
a group of random fields belonging together (either a single random field, or multiple cross-correlated fields)
Member Function Documentation
◆ activeInputCoP()
| Matrix activeInputCoP | ( | ) |
Returns the CoPs of each input quantity in this MOP. Ordered as in activeInputIdentsVector(), activeLowerBounds() and activeUpperBounds().
- Returns
- A column vector containing all input CoPs
◆ 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 | ( | ) |
Active node indices. Use this to access active inputs in inputIdentsVector(), inputCoP() and centerInputValues()
- Returns
- the active node indices
◆ activeLowerBounds()
| Matrix activeLowerBounds | ( | ) |
Get a Vector of active input parameters' lower bounds of valid MOP evaluation values. Ordered as in activeInputIdentsVector().
- Returns
- a column vector of number precision lower bound values.
◆ activeUpperBounds()
| Matrix activeUpperBounds | ( | ) |
Get a Vector of active input parameters' upper bounds of valid MOP evaluation values. Ordered as in activeInputIdentsVector().
- Returns
- A column vector of number precision upper bound values.
◆ centerInputValues()
| Matrix centerInputValues | ( | ) |
- Returns
- the center values of all inputs
◆ copyFieldCoPToDatabase()
| copyFieldCoPToDatabase | ( | Structure | database, |
| bool | overwrite_existing | ||
| ) |
copies contained data to the database (being visible in data object table), restricted to basic FieldCoP-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()
| Matrix inputCoP | ( | ) |
Returns the CoPs of each input quantity in this MOP. Ordered as in inputIdentsVector()
- Returns
- A matrix contaiing all input CoPs
◆ inputIdent()
| string inputIdent | ( | number | i_input | ) |
Get the ident of the i-th input parameter.
- Parameters
-
i_input the index of the respective input parameter ranging from 0 to numInputs
- Returns
- the ident of a respective scalar input parameter
◆ inputIdentsVector()
| TStringVector inputIdentsVector | ( | ) |
returns a reference to a string vector of all scalar input parameters
- Returns
◆ lowerBounds()
| Matrix lowerBounds | ( | ) |
Get a vector of input parameters' lower bounds of valid MOP evaulation values. Includes inactive input parameters with CoP equal to 0. Ordered as in inputIdentsVector().
- Returns
- A column vector of number precision lower bound values.
◆ numActiveInputs()
| number numActiveInputs | ( | ) |
- Returns
- the number of active inputs
◆ numInputs()
| number numInputs | ( | ) |
Get the number of input parameters.
- Returns
- the number of input parameters
◆ overlaps()
| bool overlaps | ( | MOP const | field | ) |
Checks if this instance contains a quantity with an ident that is the same as an ident of a quantity in the given field quantity. (if it overlaps with the field)
- Parameters
-
field the other field to be tested
- Returns
- true iff any quantity of the other field has the same ident as a quantity in this object
◆ rfGroup()
| RandomFieldGroup rfGroup | ( | ) |
Returns read access to the underlying field models (a group of random fields)
- Returns
- a const-reference to the respective field container
◆ scalarMOPContainer()
| handler::ScalarMOPContainer scalarMOPContainer | ( | ) |
Returns read access to the underlying scalar model (a group of scalar models/scalarMOP)
- Returns
- a const-reference to the respective ScalarMOP object
◆ totalCoP()
◆ upperBounds()
| Matrix upperBounds | ( | ) |
Get a vector of input parameters' upper bounds of valid MOP evaulation values. Includes inactive input parameters with CoP equal to 0. Ordered as in inputIdentsVector().
- Returns
- A column vector of number precision upper bound values.
