Convert Functional Group¶

Particula Index / Particula / Activity / Convert Functional Group

Auto-generated documentation for particula.activity.convert_functional_group module.

convert_to_oh_equivalent¶

Show source in convert_functional_group.py:17

Just a pass through now, but will add the oh equivalent conversion.

Arguments¶

oxygen2carbon : The oxygen to carbon ratio.
molar_mass_ratio : The molar mass ratio of water to organic matter.
functional_group : Optional functional group(s) of the organic compound, if applicable.

Returns¶

A tuple containing the converted oxygen to carbon ratio and molar mass ratio.

Signature¶

def convert_to_oh_equivalent(
    oxygen2carbon: Union[float, NDArray[np.float64]],
    molar_mass_ratio: Union[float, NDArray[np.float64]],
    functional_group: Optional[Union[list[str], str]] = None,
) -> Tuple[np.ndarray, np.ndarray]: ...