## On this page

  

 

 # FMOPGroup Class Reference

 Last update: 16.07.2025 

a group of random fields belonging together (either a single random field, or multiple cross-correlated fields) [More...](class_f_m_o_p_group.xhtml#details)

## <a name="pub-types"></a>Public Types

<a id="ac2bbd20b9306bfa8295d8f7be7f50c60"></a>typedef std::vector&lt; string &gt; **TStringVector** ## <a name="pub-methods"></a>Public Member Functions

string [activeInputIdent](class_f_m_o_p_group.xhtml#ab19fdf8d3eb67cc0d77cbbff38ff4b83) (number i\_input) std::vector&lt; number &gt; [activeInputIndices](class_f_m_o_p_group.xhtml#a97d8c95149fcbad589a47edda7312f95) () const [Matrix](class_matrix.xhtml) [centerInputValues](class_f_m_o_p_group.xhtml#a9ca3566a6a41c169f8a05ac86398ae86) () const  [copyFCoPToDatabase](class_f_m_o_p_group.xhtml#a6e7525a2108e3ba5f8e84849d5f3a812) ([Structure](class_structure.xhtml) [database](group__data.xhtml#gaebcac3a2836ec9fdf2e47bd812994b6b), bool overwrite\_existing) copies contained data to the database (being visible in data object table), restricted to basic FCoP-data (all except Rsigma) [More...](#a6e7525a2108e3ba5f8e84849d5f3a812)  
  [copyMostSensitiveToDatabase](class_f_m_o_p_group.xhtml#af90a5eb5a4aed2af1bbd69207298a721) ([Structure](class_structure.xhtml) [database](group__data.xhtml#gaebcac3a2836ec9fdf2e47bd812994b6b), bool overwrite\_existing) copies contained data to the database (being visible in data object table), restricted to objects names 'most sensitive inputs' [More...](#af90a5eb5a4aed2af1bbd69207298a721)  
  [copyRSigmaToDatabase](class_f_m_o_p_group.xhtml#afab06d15908af8a8ad391c3c62f1ef1b) ([Structure](class_structure.xhtml) [database](group__data.xhtml#gaebcac3a2836ec9fdf2e47bd812994b6b), bool overwrite\_existing) copies contained data to the database (being visible in data object table), restricted to all Rsigma objects [More...](#afab06d15908af8a8ad391c3c62f1ef1b)  
 <a id="aac50f586ee1030fe28f7ceb82596d843"></a>[DataObjectContainer](class_data_object_container.xhtml) [elementResults](class_f_m_o_p_group.xhtml#aac50f586ee1030fe28f7ceb82596d843) () const returns a const-reference to m\_element\_data   
  [eraseDatabaseCopies](class_f_m_o_p_group.xhtml#a37662babd77d3217b300cc31a4ddf4af) ([Structure](class_structure.xhtml) [database](group__data.xhtml#gaebcac3a2836ec9fdf2e47bd812994b6b)) deletes all data objects contained in this data structure from the respective database. [More...](#a37662babd77d3217b300cc31a4ddf4af)  
 [Matrix](class_matrix.xhtml) [evaluateAmplitudes](class_f_m_o_p_group.xhtml#a7c58b7d50ad5676db022df82715e5156) ([Matrix](class_matrix.xhtml) inputs, bool use\_sampling\_bounds=true) evaluates the Field-MOP for the amplitudes only [More...](#a7c58b7d50ad5676db022df82715e5156)  
 Eigen::VectorXd [inputCoP](class_f_m_o_p_group.xhtml#ab31984f5281c2b1663f4e2d0e2a2a867) () const string [inputIdent](class_f_m_o_p_group.xhtml#a8f7106d9165b855c958678be43c9e4f5) (number i\_input) <a id="a90e1ef91ed7f9d7c3448cb01d7bab656"></a>TStringVector [inputIdentsVector](class_f_m_o_p_group.xhtml#a90e1ef91ed7f9d7c3448cb01d7bab656) () returns a reference to a string vector of all scalar input parameters   
 ::legacy::ScalarMOP2 [mop](class_f_m_o_p_group.xhtml#a4b3fc118553a130abbc8bd565e563184) () const <a id="ad736e09662cf743b9f7b4513d8eee114"></a>MOQ **moq** () <a id="a3d6b0f14ad9c641ec27d77f7440b17cb"></a>[DataObjectContainer](class_data_object_container.xhtml) [nodeResults](class_f_m_o_p_group.xhtml#a3d6b0f14ad9c641ec27d77f7440b17cb) () const returns a const-reference to m\_node\_data   
 number [numActiveInputs](class_f_m_o_p_group.xhtml#ac8434f6aa78120ee35c1e32423589f74) () number [numInputs](class_f_m_o_p_group.xhtml#a2556eb3339693ac4a80b79c2a93c2990) () bool [overlaps](class_f_m_o_p_group.xhtml#aab5e2780b896d345d6aca1405d7a18d6) ([FMOPGroup](class_f_m_o_p_group.xhtml) field) const [RandomFieldGroup](class_random_field_group.xhtml) [rfGroup](class_f_m_o_p_group.xhtml#a3f590a32d0900910a06cb38e521e3c06) () const <a id="a5fadc1fe1dfaeb5abab01182e9cb6fad"></a>[DataObjectContainer](class_data_object_container.xhtml) [scalarResults](class_f_m_o_p_group.xhtml#a5fadc1fe1dfaeb5abab01182e9cb6fad) () const returns a const-reference to m\_scalar\_data   
 number [totalCoP](class_f_m_o_p_group.xhtml#a2d040ac739a6e430c7e75137975004c2) () const bool [useMOQ](class_f_m_o_p_group.xhtml#a2052120d018f605d07dc78a14069463f) () const <a id="details" name="details"></a>## Detailed Description

a group of random fields belonging together (either a single random field, or multiple cross-correlated fields)



## Member Function Documentation

<a id="ab19fdf8d3eb67cc0d77cbbff38ff4b83"></a>## [◆ ](#ab19fdf8d3eb67cc0d77cbbff38ff4b83)activeInputIdent()

 string activeInputIdent  ( number  *i\_input*) 

Returnsthe ident of a respective scalar input parameter Parameters i\_inputthe index of the respective input parameter rangin from 0 to [numActiveInputs()](class_f_m_o_p_group.xhtml#ac8434f6aa78120ee35c1e32423589f74). Also the ordering refers to centerInputValues. 



<a id="a97d8c95149fcbad589a47edda7312f95"></a>## [◆ ](#a97d8c95149fcbad589a47edda7312f95)activeInputIndices()

 std::vector&lt;number&gt; activeInputIndices  ( )  const

Returnsthe active node indices 



<a id="a9ca3566a6a41c169f8a05ac86398ae86"></a>## [◆ ](#a9ca3566a6a41c169f8a05ac86398ae86)centerInputValues()

 [Matrix](class_matrix.xhtml) centerInputValues  ( )  const

Returnsthe center values of all inputs 



<a id="a6e7525a2108e3ba5f8e84849d5f3a812"></a>## [◆ ](#a6e7525a2108e3ba5f8e84849d5f3a812)copyFCoPToDatabase()

 copyFCoPToDatabase  ( [Structure](class_structure.xhtml)  *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 databasethe target database overwrite\_existingif true, then data objects with identical ident will be replaced, else an exception is thrown. 



<a id="af90a5eb5a4aed2af1bbd69207298a721"></a>## [◆ ](#af90a5eb5a4aed2af1bbd69207298a721)copyMostSensitiveToDatabase()

 copyMostSensitiveToDatabase  ( [Structure](class_structure.xhtml)  *database*,    bool  *overwrite\_existing*   ) 

copies contained data to the database (being visible in data object table), restricted to objects names 'most sensitive inputs'

Parameters databasethe target database overwrite\_existingif true, then data objects with identical ident will be replaced, else an exception is thrown. 



<a id="afab06d15908af8a8ad391c3c62f1ef1b"></a>## [◆ ](#afab06d15908af8a8ad391c3c62f1ef1b)copyRSigmaToDatabase()

 copyRSigmaToDatabase  ( [Structure](class_structure.xhtml)  *database*,    bool  *overwrite\_existing*   ) 

copies contained data to the database (being visible in data object table), restricted to all Rsigma objects

Parameters databasethe target database overwrite\_existingif true, then data objects with identical ident will be replaced, else an exception is thrown. 



<a id="a37662babd77d3217b300cc31a4ddf4af"></a>## [◆ ](#a37662babd77d3217b300cc31a4ddf4af)eraseDatabaseCopies()

 eraseDatabaseCopies  ( [Structure](class_structure.xhtml)  *database*) 

deletes all data objects contained in this data structure from the respective database.

Parameters databasethe database to be deleted 



<a id="a7c58b7d50ad5676db022df82715e5156"></a>## [◆ ](#a7c58b7d50ad5676db022df82715e5156)evaluateAmplitudes()

 [Matrix](class_matrix.xhtml) evaluateAmplitudes  ( [Matrix](class_matrix.xhtml)  *inputs*,    bool  *use\_sampling\_bounds* = `true`   ) 

evaluates the Field-MOP for the amplitudes only

Parameters inputsthe column vector of the input parameters (ALL inputs!) use\_sampling\_boundsif true, then the method returns with an error if the input vector is outside of the original DOE boundaries; else it tries to extrapolate Returnsthe vector of amplitudes. 



<a id="ab31984f5281c2b1663f4e2d0e2a2a867"></a>## [◆ ](#ab31984f5281c2b1663f4e2d0e2a2a867)inputCoP()

 Eigen::VectorXd inputCoP  ( )  const

Returnsa const-reference to m\_input\_cop 



<a id="a8f7106d9165b855c958678be43c9e4f5"></a>## [◆ ](#a8f7106d9165b855c958678be43c9e4f5)inputIdent()

 string inputIdent  ( number  *i\_input*) 

Returnsthe ident of a respective scalar input parameter Parameters i\_inputthe index of the respective input parameter ranging from 0 to numInputs 



<a id="a4b3fc118553a130abbc8bd565e563184"></a>## [◆ ](#a4b3fc118553a130abbc8bd565e563184)mop()

 ::legacy::ScalarMOP2 mop  ( )  const

Returnsa const-reference to the respective [ScalarMOP](struct_scalar_m_o_p.xhtml "This is only a sketch of the possible ScalarMOPApproximate API Implementation shall be refined if mor...") object 



<a id="ac8434f6aa78120ee35c1e32423589f74"></a>## [◆ ](#ac8434f6aa78120ee35c1e32423589f74)numActiveInputs()

 number numActiveInputs  ( ) 

Returnsthe number of active inputs 



<a id="a2556eb3339693ac4a80b79c2a93c2990"></a>## [◆ ](#a2556eb3339693ac4a80b79c2a93c2990)numInputs()

 number numInputs  ( ) 

Returnsthe number of input parameters 



<a id="aab5e2780b896d345d6aca1405d7a18d6"></a>## [◆ ](#aab5e2780b896d345d6aca1405d7a18d6)overlaps()

 bool overlaps  ( [FMOPGroup](class_f_m_o_p_group.xhtml)  *field*)  const

Returnstrue if any quantity of the other field has the same ident as a quantity in this object Parameters fieldthe other field to be tested 



<a id="a3f590a32d0900910a06cb38e521e3c06"></a>## [◆ ](#a3f590a32d0900910a06cb38e521e3c06)rfGroup()

 [RandomFieldGroup](class_random_field_group.xhtml) rfGroup  ( )  const

Returnsa const-reference to the respective field container 



<a id="a2d040ac739a6e430c7e75137975004c2"></a>## [◆ ](#a2d040ac739a6e430c7e75137975004c2)totalCoP()

 number totalCoP  ( )  const

Returnsa const-reference to m\_total\_cop 



<a id="a2052120d018f605d07dc78a14069463f"></a>## [◆ ](#a2052120d018f605d07dc78a14069463f)useMOQ()

 bool useMOQ  ( )  const

Returnsreturns true if it used MOQ for approximation, else it uses [MOP](class_m_o_p.xhtml "a group of random fields belonging together (either a single random field, or multiple cross-correlat...")