Struct StateBuilder

pub struct StateBuilder<'a, E, const IG: bool> { /* private fields */ }

A simple tool to construct States with arbitrary input parameters.

Examples

// Create a state for given T,V,N
let eos = Arc::new(PengRobinson::new(Arc::new(PengRobinsonParameters::new_simple(&[369.8], &[41.9 * 1e5], &[0.15], &[15.0])?)));
let state = StateBuilder::new(&eos)
                .temperature(300.0 * KELVIN)
                .volume(12.5 * METER.powi::<P3>())
                .moles(&(arr1(&[2.5]) * MOL))
                .build()?;
assert_eq!(state.density, 0.2 * MOL / METER.powi::<P3>());

// For a pure component, the composition does not need to be specified.
let eos = Arc::new(PengRobinson::new(Arc::new(PengRobinsonParameters::new_simple(&[369.8], &[41.9 * 1e5], &[0.15], &[15.0])?)));
let state = StateBuilder::new(&eos)
                .temperature(300.0 * KELVIN)
                .volume(12.5 * METER.powi::<P3>())
                .total_moles(2.5 * MOL)
                .build()?;
assert_eq!(state.density, 0.2 * MOL / METER.powi::<P3>());

// The state can be constructed without providing any extensive property.
let eos = Arc::new(PengRobinson::new(
    Arc::new(PengRobinsonParameters::new_simple(
        &[369.8, 305.4],
        &[41.9 * 1e5, 48.2 * 1e5],
        &[0.15, 0.10],
        &[15.0, 30.0]
    )?)
));
let state = StateBuilder::new(&eos)
                .temperature(300.0 * KELVIN)
                .partial_density(&(arr1(&[0.2, 0.6]) * MOL / METER.powi::<P3>()))
                .build()?;
assert_relative_eq!(state.molefracs, arr1(&[0.25, 0.75]));
assert_relative_eq!(state.density, 0.8 * MOL / METER.powi::<P3>());

Implementations

impl<E: Residual> StateBuilder<'_, E, false>

pub fn new(eos: &Arc<E>) -> Self

Create a new StateBuilder for the given equation of state.

impl<'a, E: Residual, const IG: bool> StateBuilder<'a, E, IG>

pub fn temperature(self, temperature: Temperature) -> Self

Provide the temperature for the new state.

pub fn volume(self, volume: Volume) -> Self

Provide the volume for the new state.

pub fn density(self, density: Density) -> Self

Provide the density for the new state.

pub fn partial_density(self, partial_density: &'a Density<Array1<f64>>) -> Self

Provide partial densities for the new state.

pub fn total_moles(self, total_moles: Moles) -> Self

Provide the total moles for the new state.

pub fn moles(self, moles: &'a Moles<Array1<f64>>) -> Self

Provide the moles for the new state.

pub fn molefracs(self, molefracs: &'a Array1<f64>) -> Self

Provide the molefracs for the new state.

pub fn pressure(self, pressure: Pressure) -> Self

Provide the pressure for the new state.

pub fn vapor(self) -> Self

Specify a vapor state.

pub fn liquid(self) -> Self

Specify a liquid state.

pub fn initial_density(self, initial_density: Density) -> Self

Provide an initial density used in density iterations.

impl<'a, E: Residual + IdealGas, const IG: bool> StateBuilder<'a, E, IG>

pub fn molar_enthalpy( self, molar_enthalpy: MolarEnergy, ) -> StateBuilder<'a, E, true>

Provide the molar enthalpy for the new state.

pub fn molar_entropy( self, molar_entropy: MolarEntropy, ) -> StateBuilder<'a, E, true>

Provide the molar entropy for the new state.

pub fn molar_internal_energy( self, molar_internal_energy: MolarEnergy, ) -> StateBuilder<'a, E, true>

Provide the molar internal energy for the new state.

pub fn initial_temperature( self, initial_temperature: Temperature, ) -> StateBuilder<'a, E, true>

Provide an initial temperature used in the Newton solver.

impl<E: Residual> StateBuilder<'_, E, false>

pub fn build(self) -> EosResult<State<E>>

Try to build the state with the given inputs.

impl<E: Residual + IdealGas> StateBuilder<'_, E, true>

pub fn build(self) -> EosResult<State<E>>

Try to build the state with the given inputs.

Trait Implementations

impl<E, const IG: bool> Clone for StateBuilder<'_, E, IG>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.