Enumeration Functions
| Name | Description | Example |
|---|---|---|
| sumWellVariables(<variable>) | Sums all instances of the well completion variable <variable> from the Well Details tab for all wells drilled in the PetroVR Plan simulation or specified in an Econ Well Module. | PetroVR Plan: sumWellVariables('Initial Rate') PetroVR Econ: sumWellVariables("Well Level Data: Royalty Rate") |
Enumeration functions are calculated from simulation values, so, although they can be used in PetroVR Plan, their proper use is in the context of Econ modules. Thus, sumWellVariables has a different usage depending on whether it is used in PetroVR Plan or Econ. In PetroVR Plan it retrieves the values from the context in which it is used: a project-level variable will include all the wells in the project whose drilling job has finished, and a variable belonging to a reservoir or well group will include wells from that reservoir or well group only. In PetroVR Econ the context is given by the Well Module to which the variable belongs.
Since sumWellVariables works with simulation results, when used in PetroVR Plan its value will be undefined until the project is simulated. Similarly, if the values of the variables to which a sumWellVariables refers are modified, the value displayed will only be updated when the project is simulated again.
In PetroVR Plan, sumWellVariables should be used with 'single quotes' instead of double, since the <variable> parameter does not refer to one variable but to all the well variables that include that string.
sumWellVariables should not be used inside a Well Module, where each variable will be evaluated in each well.