scaled

openpnm.models.misc.basic_math.scaled(target, prop, factor)

Scales an existing value by a factor.

Useful for constricting some throat property.

Parameters

• target (Base) – The object which this model is associated with. This controls the length of the calculated array, and also provides access to other necessary properties.

• prop (str) – The dictionary key of the array containing the values to be scaled.

• factor (str) – The factor by which the values should be scaled.

Returns

value – Array containing target[prop] values scaled by factor.

Return type

ndarray