Cumulative values within a given scope and including any prior, historical cumulative values.
Syntax
HistoryCumulative("Signal Name" in "unit")
The HistoryCumulative("signal name" in "unit") function returns the cumulative sum of the given signal within a given scope, and also automatically includes any historical signal values prior to the start of the given scope.
Note that due to the potentially large amount of data involved in computing the prior history, HistoryCumulative can have a significant performance cost when used on large contexts. Consider using Cumulative instead where applicable or storing prior cumulative results as a separate signal if needed frequently.
Example
In the following P# example, the HistoryCumulative() function includes data prior to the January 2, 2008 start of the scope:
HistoryCumulative("produced water per time increment" in "STB")
As you see in the following table the Cumulative function which produces following output based on the 'original signal' as input:
// This P# script illustrates how to use the HistoryCumulative() function
Context "Example Context"
Entity Set "Example Well"
Scope "Example Scope"
End Context
Entity Set "Example Well"
"Well A"
End Set
Scope "Example Scope"
Between #1/2/2008#
And #1/9/2008#
Step Daily
End Scope
Table "HistoryCumulative Example"
// This column is not necessary, but is included here for clarity
Column "Produced Oil" in "STB"
"produced oil per time increment" in "STB"
End Column
// This column is where the results are computed
Column "HistoryCumulative Oil" in "STB"
HistoryCumulative("produced oil per time increment" in "STB")
End Column
End Table