linear¶

openpnm.models.physics.source_terms.linear(target, X, A1='', A2='')[source]¶

Calculates the rate, as well as slope and intercept of the following function at the given value of X:

\[r = A_{1} X + A_{2}\]

Parameters

target (OpenPNM Base object) – Object with which this model is associated. This controls the length of the calculated array, and also provides access to other necessary properties.
X (str) – The dictionary key on the target object containing the the quantity of interest
A2 (A1 ->) – The dictionary keys on the target object containing the coefficients values to be used in the source term model

Returns

A dictionary containing the following three items:

’rate’
The value of the source term function at the given X.

’S1’
The slope of the source term function at the given X.

’S2’
The intercept of the source term function at the given X.

Return type

dict

Notes

The slope and intercept provide a linearized source term equation about the current value of X as follow:

\[rate = S_{1} X + S_{2}\]