Skip to content

Clean the implementation of temperature_or_pressure arguments somewhat #369

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
prehner wants to merge 1 commit into
base: development
Choose a base branch
from
Open

Clean the implementation of temperature_or_pressure arguments somewhat #369

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@ criterion = "0.8"
paste = "1.0"
rusqlite = "0.40"
csv = "1.0"
either = "1.0"

feos-core = { version = "0.10", path = "crates/feos-core" }
feos-dft = { version = "0.10", path = "crates/feos-dft" }
Expand Down
1 change: 1 addition & 0 deletions crates/feos-core/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ rayon = { workspace = true, optional = true }
csv = { workspace = true }
itertools = { workspace = true }
rusqlite = { workspace = true, features = ["bundled"], optional = true }
either = { workspace = true }

[dev-dependencies]
approx = { workspace = true }
Expand Down
187 changes: 84 additions & 103 deletions crates/feos-core/src/phase_equilibria/bubble_dew.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ use crate::state::{
DensityInitialization::{InitialDensity, Liquid, Vapor},
};
use crate::{Composition, ReferenceSystem, Residual, SolverOptions, State, Verbosity};
use either::Either;
use nalgebra::allocator::Allocator;
use nalgebra::{DMatrix, DVector, DefaultAllocator, Dim, Dyn, OVector, U1};
#[cfg(feature = "ndarray")]
Expand All @@ -31,10 +32,11 @@ pub trait TemperatureOrPressure<D: DualNum<f64> + Copy = f64>: Copy {
fn temperature(&self) -> Option<Temperature<D>>;
fn pressure(&self) -> Option<Pressure<D>>;

#[expect(clippy::type_complexity)]
fn temperature_pressure(
&self,
tp_init: Option<Self::Other>,
) -> (Option<Temperature<D>>, Option<Pressure<D>>, bool);
) -> Either<(Temperature<D>, Option<Pressure>), (Pressure<D>, Option<Temperature>)>;

fn from_state<E: Residual<N, D>, N: Gradients>(state: &State<E, N, D>) -> Self::Other
where
Expand All @@ -50,7 +52,7 @@ pub trait TemperatureOrPressure<D: DualNum<f64> + Copy = f64>: Copy {
}

impl<D: DualNum<f64> + Copy> TemperatureOrPressure<D> for Temperature<D> {
type Other = Pressure<D>;
type Other = Pressure;
const IDENTIFIER: &'static str = "temperature";

fn temperature(&self) -> Option<Temperature<D>> {
Expand All @@ -64,27 +66,27 @@ impl<D: DualNum<f64> + Copy> TemperatureOrPressure<D> for Temperature<D> {
fn temperature_pressure(
&self,
tp_init: Option<Self::Other>,
) -> (Option<Temperature<D>>, Option<Pressure<D>>, bool) {
(Some(*self), tp_init, true)
) -> Either<(Temperature<D>, Option<Pressure>), (Pressure<D>, Option<Temperature>)> {
Either::Left((*self, tp_init))
}

fn from_state<E: Residual<N, D>, N: Gradients>(state: &State<E, N, D>) -> Self::Other
where
DefaultAllocator: Allocator<N>,
{
state.pressure(Contributions::Total)
state.pressure(Contributions::Total).re()
}

#[cfg(feature = "ndarray")]
fn linspace(
&self,
start: Pressure<D>,
end: Pressure<D>,
start: Pressure,
end: Pressure,
n: usize,
) -> (Temperature<Array1<f64>>, Pressure<Array1<f64>>) {
(
Temperature::linspace(self.re(), self.re(), n),
Pressure::linspace(start.re(), end.re(), n),
Pressure::linspace(start, end, n),
)
}
}
Expand All @@ -95,7 +97,7 @@ impl<D: DualNum<f64> + Copy> TemperatureOrPressure<D> for Temperature<D> {
impl<D: DualNum<f64> + Copy> TemperatureOrPressure<D>
for Quantity<D, SIUnit<-2, -1, 1, 0, 0, 0, 0>>
{
type Other = Temperature<D>;
type Other = Temperature;
const IDENTIFIER: &'static str = "pressure";

fn temperature(&self) -> Option<Temperature<D>> {
Expand All @@ -109,26 +111,26 @@ impl<D: DualNum<f64> + Copy> TemperatureOrPressure<D>
fn temperature_pressure(
&self,
tp_init: Option<Self::Other>,
) -> (Option<Temperature<D>>, Option<Pressure<D>>, bool) {
(tp_init, Some(*self), false)
) -> Either<(Temperature<D>, Option<Pressure>), (Pressure<D>, Option<Temperature>)> {
Either::Right((*self, tp_init))
}

fn from_state<E: Residual<N, D>, N: Dim>(state: &State<E, N, D>) -> Self::Other
where
DefaultAllocator: Allocator<N>,
{
state.temperature
state.temperature.re()
}

#[cfg(feature = "ndarray")]
fn linspace(
&self,
start: Temperature<D>,
end: Temperature<D>,
start: Temperature,
end: Temperature,
n: usize,
) -> (Temperature<Array1<f64>>, Pressure<Array1<f64>>) {
(
Temperature::linspace(start.re(), end.re(), n),
Temperature::linspace(start, end, n),
Pressure::linspace(self.re(), self.re(), n),
)
}
Expand Down Expand Up @@ -197,134 +199,113 @@ where
}
Ok(vle)
} else {
let (temperature, pressure, iterate_p) =
temperature_or_pressure.temperature_pressure(tp_init);
Self::bubble_dew_point_tp(
eos,
temperature,
pressure,
temperature_or_pressure,
tp_init,
vapor_molefracs,
liquid_molefracs,
bubble,
iterate_p,
options,
)
}
}

#[expect(clippy::too_many_arguments)]
fn bubble_dew_point_tp<X: Composition<D, N>>(
fn bubble_dew_point_tp<TP: TemperatureOrPressure<D>, X: Composition<D, N>>(
eos: &E,
temperature: Option<Temperature<D>>,
pressure: Option<Pressure<D>>,
temperature_or_pressure: TP,
tp_init: Option<TP::Other>,
composition: X,
molefracs_init: Option<&OVector<f64, N>>,
bubble: bool,
iterate_p: bool,
options: (SolverOptions, SolverOptions),
) -> FeosResult<Self> {
let eos_re = eos.re();
let mut temperature_re = temperature.map(|t| t.re());
let mut pressure_re = pressure.map(|p| p.re());
let iterate_p = temperature_or_pressure
.temperature_pressure(tp_init)
.is_left();
let (molefracs_spec, total_moles) = composition.into_molefracs(eos)?;
let molefracs_spec_re = molefracs_spec.map(|x| x.re());
let (v1, rho2) = if iterate_p {
// temperature is specified
let temperature_re = temperature_re.as_mut().ok_or(FeosError::Error(
"Temperature information is expected for bubble/dew calculation.".to_string(),
))?;

// First use given initial pressure if applicable
if let Some(p) = pressure_re.as_mut() {
PhaseEquilibrium::iterate_bubble_dew(
&eos_re,
temperature_re,
p,
&molefracs_spec_re,
molefracs_init,
bubble,
iterate_p,
options,
)?
} else {
// Next try to initialize with an ideal gas assumption
let x2 = PhaseEquilibrium::starting_pressure_ideal_gas(
&eos_re,
*temperature_re,
&molefracs_spec_re,
bubble,
)
.and_then(|(p, x)| {
let p = pressure_re.insert(p);
PhaseEquilibrium::iterate_bubble_dew(
let (mut t, mut p, v1, rho2) = match temperature_or_pressure.temperature_pressure(tp_init) {
Either::Left((t, mut p)) => {
// First use given initial pressure if applicable
let (p, v1, rho2) = if let Some(p) = p.as_mut() {
let (v1, rho2) = PhaseEquilibrium::iterate_bubble_dew(
&eos_re,
temperature_re,
&mut t.re(),
p,
&molefracs_spec_re,
molefracs_init.or(Some(&x)),
molefracs_init,
bubble,
iterate_p,
options,
)
});

// Finally use the spinodal to initialize the calculation
x2.or_else(|_| {
PhaseEquilibrium::starting_pressure_spinodal(
)?;
(*p, v1, rho2)
} else {
let x2 = PhaseEquilibrium::starting_pressure_ideal_gas(
&eos_re,
*temperature_re,
t.re(),
&molefracs_spec_re,
bubble,
)
.and_then(|p| {
let p = pressure_re.insert(p);
PhaseEquilibrium::iterate_bubble_dew(
.and_then(|(mut p, x)| {
let (v1, rho2) = PhaseEquilibrium::iterate_bubble_dew(
&eos_re,
temperature_re,
p,
&mut t.re(),
&mut p,
&molefracs_spec_re,
molefracs_init,
molefracs_init.or(Some(&x)),
bubble,
iterate_p,
options,
)?;
Ok((p, v1, rho2))
});

// Finally use the spinodal to initialize the calculation
x2.or_else(|_| {
PhaseEquilibrium::starting_pressure_spinodal(
&eos_re,
t.re(),
&molefracs_spec_re,
)
})
})?
.and_then(|mut p| {
let (v1, rho2) = PhaseEquilibrium::iterate_bubble_dew(
&eos_re,
&mut t.re(),
&mut p,
&molefracs_spec_re,
molefracs_init,
bubble,
iterate_p,
options,
)?;
Ok((p, v1, rho2))
})
})?
};
(t.into_reduced(), D::from(p.into_reduced()), v1, rho2)
}
} else {
// pressure is specified
let pressure_re = pressure_re.as_mut().ok_or(FeosError::Error(
"Pressure information is expected for bubble/dew calculation.".to_string(),
))?;

let temperature_re = temperature_re
.as_mut()
Either::Right((p, mut t)) => {
let mut pressure_re = p.re();
let t = t.as_mut()
.ok_or(FeosError::Error(
"An initial temperature is required for the calculation of bubble/dew points at given pressure.".to_string()))?;
PhaseEquilibrium::iterate_bubble_dew(
&eos.re(),
temperature_re,
pressure_re,
&molefracs_spec_re,
molefracs_init,
bubble,
iterate_p,
options,
)?
let (v1, rho2) = PhaseEquilibrium::iterate_bubble_dew(
&eos.re(),
t,
&mut pressure_re,
&molefracs_spec_re,
molefracs_init,
bubble,
iterate_p,
options,
)?;
(D::from(t.into_reduced()), p.into_reduced(), v1, rho2)
}
};

// implicit differentiation
// unwraps here are safe
let (mut t, mut p) = if iterate_p {
(
temperature.unwrap().into_reduced(),
D::from(pressure_re.unwrap().into_reduced()),
)
} else {
(
D::from(temperature_re.unwrap().into_reduced()),
pressure.unwrap().into_reduced(),
)
};
let mut molar_volume = D::from(v1);
let mut rho2 = rho2.map(D::from);
for _ in 0..D::NDERIV {
Expand Down
Loading
Loading