Struct Composition 

#[repr(C)]
pub struct Composition {

    pub methane: f64,
    pub nitrogen: f64,
    pub carbon_dioxide: f64,
    pub ethane: f64,
    pub propane: f64,
    pub isobutane: f64,
    pub n_butane: f64,
    pub isopentane: f64,
    pub n_pentane: f64,
    pub hexane: f64,
    pub heptane: f64,
    pub octane: f64,
    pub nonane: f64,
    pub decane: f64,
    pub hydrogen: f64,
    pub oxygen: f64,
    pub carbon_monoxide: f64,
    pub water: f64,
    pub hydrogen_sulfide: f64,
    pub helium: f64,
    pub argon: f64,
}

A complete gas composition made up of gas components.

A gas composition contains 21 gas components named by the field names in the struct. The unit for each component is mole fraction, so the sum of all components should be 1.0. If the initial sum of components is not 1.0, you can use the normalize function to scale it to 1.0.

Example

let air = aga8::composition::Composition {
    nitrogen: 0.78,
    oxygen: 0.21,
    argon: 0.009,
    carbon_dioxide: 0.000_4,
    water: 0.000_6,
    ..Default::default()
    };

assert!((air.sum() - 1.0).abs() < 1.0e-10);

Fields

methane: f64

Methane CH₄

nitrogen: f64

Nitrogen N

carbon_dioxide: f64

Carbon Dioxide CO₂

ethane: f64

Ethane C₂H₆

propane: f64

Propane C₃H₈

isobutane: f64

Isobutane C₄H₁₀

n_butane: f64

Butane C₄H₁₀

isopentane: f64

Isopentane C₅H₁₂

n_pentane: f64

Pentane C₅H₁₂

hexane: f64

Isopentane C₆H₁₄

heptane: f64

Heptane C₇H₁₆

octane: f64

Octane C₈H₁₈

nonane: f64

Nonane C₉H₂₀

decane: f64

Decane C₁₀H₂₂

hydrogen: f64

Hydrogen H

oxygen: f64

Oxygen O

carbon_monoxide: f64

Carbon monoxide CO

water: f64

Water H₂O

hydrogen_sulfide: f64

Hydrogen sulfide H₂S

helium: f64

Helium He

argon: f64

Argon Ar

Implementations

impl Composition

pub fn sum(&self) -> f64

Compute the sum of all components.

Example

let comp = aga8::composition::Composition {
    methane: 50.0,
    ethane: 25.0,
    carbon_dioxide: 25.0,
    ..Default::default()
};

assert!((comp.sum() - 100.0).abs() < 1.0e-10);

pub fn normalize(&mut self) -> Result<(), CompositionError>

Normalizes the composition sum to 1.0.

Example

let mut comp = aga8::composition::Composition {
    methane: 50.0,
    ethane: 50.0,
    ..Default::default()
};

comp.normalize();

assert!((comp.ethane - 0.5).abs() < 1.0e-10);
assert!((comp.methane - 0.5).abs() < 1.0e-10);

pub fn check(&self) -> Result<(), CompositionError>

Checks that the composition is valid.

Example

let mut comp = aga8::composition::Composition {
    methane: 0.5,
    ethane: 0.5,
    ..Default::default()
};

assert_eq!(comp.check(), Ok(()));

Trait Implementations

impl Clone for Composition

fn clone(&self) -> Composition

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Default for Composition

fn default() -> Composition

Returns the “default value” for a type.

impl Copy for Composition