fronts.as_o¶
-
fronts.
as_o
(r=None, t=None, o=None)¶ Transform to the Boltzmann variable if called with r and t. Passes the values through if called with o only. On other combinations of arguments, it raises a TypeError with a message explaining valid usage.
This function is a helper to define other functions that may be called either with r and t, or with just o.
- Parameters
r (float or numpy.ndarray, optional) – Location(s). If a numpy.ndarray, it must have a shape broadcastable with t. If this parameter is used, you must also pass t and cannot pass o.
t (float or numpy.ndarray, optional) – Time(s). If a numpy.ndarray, it must have a shape broadcastable with r. Values must be positive. If this parameter is used, you must also pass r and cannot pass o.
o (float or numpy.ndarray, optional) – Value(s) of the Boltzmann variable. If this parameter is used, you cannot pass r or t.
- Returns
o – Passes o through if it is given. Otherwise, it returns
o(r,t)
.- Return type
float or numpy.ndarray
See also