Tokens & Modifiers (Cash Formulas)

<< Click to Display Table of Contents >>

Navigation:  Editing Case Data > Fiscal Models > Cash Formulas >

Tokens & Modifiers (Cash Formulas)

Navigation: Editing Case Data > Fiscal Models > Cash Formulas >

hm_btn_navigate_prevhm_btn_navigate_tophm_btn_navigate_next

Show/Hide Hidden Text

When writing cash formulas, users can grab certain elements and attach one or more 'modifiers' or 'parameters' to them in order to generate the values needed. For example, to grab the Net Gas Revenue or Gas Price in a cash formula it would look like this: Gas[Rev, Net] or Gas[Price]. Tokens are formula variables and are the data elements that the program allows the user to access to make their calculations in the model. Tokens represent an economic stream and can be accessed in formulas.

This section describes how to add modifiers to a product to access certain values. These can be used in combination with the standard functions and special PHDwin functions to write cash formula models.

html toggle_plus1 Basic Syntax for Cash Formula Products & Modifiers

Modifiers can be attached after a product using square brackets [ ] such as:

Product [Modifier]

The product can be:

oany product that has been defined as monthly in the phase configurations. This will include standard products like oil, gas, or NGL.

othe word "All" to grab values such as all revenue, costs, etc.

oanother formula name - if there is a need to reference another formula (especially if using ring-fence cases to pass values back and forth).

The modifiers allow users to specify things like:

oan interest - such as gross, net, or ECL

oa stream or a stream category - like revenue, expenses, op costs, etc.

oa time period - such as monthly, the last 12 months, annual, etc.

othe scope - parent or child values if using ring-fence cases

 

The order of modifiers should not matter, but the program may rearrange them after saving. If no modifier is added, the program assumes it is the gross, un-shrunk, monthly volume for the chosen product.

hmtoggle_plus1 All Modifiers

Interest Modifiers

If interest modifiers are not specified, gross values are assumed.

Grs - Gross, 8/8ths value.

Net - the net value based on the 'Net Interest'. The interest, used to generate the net value, is determined in the Streams Editor under the database settings.

WI - the value net to the working interest specified on the case.

 

Stream Modifiers

If no stream modifier is specified, the value returned will always be the 'base value' or gross input numbers.

Stream modifiers should only be used with product names, not as a modifier after another formula name. Always use the abbreviation when inputting the modifiers. When a stream modifier is selected, an option to grab either a specific stream or the general category that it falls into becomes available.

The stream categories and abbreviations used are:

BA - Base

Rev - Revenue

Cost - Expense

Tax - Tax

Vol - Volume

For example - Gas[Rev] or Gas[Cost]. Modifiers can be used in combination with other modifiers such as Gas[Rev, Net].

Each stream can also be set up individually. All available streams can be viewed in the Streams Editor in the Database Settings. Again, enter the abbreviation for the stream that is entered in the Streams Editor to call up the values for that stream.

The default streams and abbreviations used are:

BV - Base Value

Shr - Shrunk Volume

RevStr - Revenue

OpCost - Op Cost

TrnCost - Trans Cost

OthCost - Other Cost

WellCost - Well Cost

FixCost - Fixed Cost

StTax - Production Tax

LocTax - Local Tax

 

Timing Modifiers

If a timing multiplier is not specified, monthly values are assumed. The other options are:

Annual - the value for current year. The value will be presented on the first month of the fiscal year and will not repeat.

Cum - the cumulative value up until the current date.

ECLRem - the remaining value from the current date until the economic limit.

Monthly - the value for the current month.

Prior - the value from the prior month.  

Prior12 - the value for the prior 12 months from the current month - not necessarily the calendar year.

Quarterly - the value for the current quarter. The value will be presented on the first month of the quarter and will not repeat.

StartToECL - the value from the case start date to the economic limit.

TechEUR - the value from the case start date up until the technical EUR.

TechRem - the remaining value from the current date until the technical EUR.

hmtoggle_plus1 Sample Syntax

The following are examples of the syntax that can be used in cash formulas.

Syntax

Description of what is returned

Oil

Gross, monthly, un-shrunk oil production. This would be the same as using Oil[BV, Grs, Monthly].

Gas[Net, Annual]

The gas production for the entire year net to the revenue interest(by default). It will be presented on the first month of the fiscal year.

All[Rev, Grs]

All gross monthly revenue.

NGL[Quarterly, TrnCost, WI]

The NGL transportation costs net to the working interest. They will be presented as a total at the beginning of each quarter for the remainder of the quarter.

Oil[ECLRem]

The remaining oil production up until the economic limit. A new value will be presented each month.

Gas[Shr, TechEUR]

The shrunk gas volumes from the first production up until the technical EUR.

All[Cost, Grs, Child]

All gross costs(fixed, other, well, trans, op). This formula would be used when working with ring-fence cases. It would pull the sum of all costs from the child cases that are included in the ring-fence. They will be presented monthly.

FormulaName[Parent]

The values from the parent(ring-fence case) for the formula that have been defined at the parent case.

Related topics:

Cash Formulas

Standard Functions

Custom PHDwin Functions

Static Variables