Repository files navigation

Rust crate providing formulae for air thermodynamic calculations.

This crate contains functions for computing thermodynamic quantities commonly used in atmospheric sciences. It is currently developed by one person soif there is a function you would like to be added do not hesitate to post an issue or pull request in theGithub repository.

The purpose of this crate is to be an academic reference of thermodynamic formulae,so that researchers looking for a particular formula do not need to search it in the literature.Therefore all functions documentation provides a reference to the paper from which formula is taken.

Also, check thecontributors guide of this crate.

To use this crate simply import it withuse statement and then use desired function from chosen module.

use floccus::vapour_pressure;//Set temperature and pressure in SI unitslet temperature =300.0;//in Klet pressure =101325.0;//in Pa//Compute vapour pressure using Buck (1981) formulalet vapour_pressure = vapour_pressure::buck1(temperature, pressure);//The result is 3550.662 (f32) or 3550.6603579471303 (f64)

Because some thermodynamic formulae are empirical there are several ways to compute a value of given quantity.Therefore there are multiple functions available to compute the same parameter, which are grouped into modules.

The naming of modules and functions follows this convention:

vapour_pressure::buck1(temperature, pressure);

Where the module name (vapour_pressure) indicates the computed quantity, function name (buck1) indicates the author of formulaand the function arguments (temperature, pressure) are variables used to compute the quantity.

By default floccus uses single-precision (32-bit) floating-point variables.If increased accuracy is needed (at the cost of performance)double_precision feature can be enabledto use double-precision (64-bit) floating point.

To prevent any unexpected behavior, all functions check whether provided inputs are within a reasonable range.Exact limits are specified in the documentation of each function.If the input is out of range the function will return anInputError::OutOfRange with erroneous input specified.

If additional information is needed about which function returns the error and why,debug feature can be enabled.With that feature when returning the error function will also print the error message tolog with additionalinformation about the error. This feature potentially is not zero-cost so it is optional.

Functions provided in this crate are intended for use in, i. a., numerical models. To provide the user information about performance overhead of each function all functions are benchmarked usingcriterion.rs. Github Actions automatically runs all benchmarks.

To check the latest benchmark results the newest workflow onGithub Actions page of floccus.