Skip to main content

nominal_api/conjure/objects/scout/compute/api/
refprop_series.rs

1/// Computes the output property given input properties for the substance using REFPROP. Initial implementation
2/// only expects two input properties.
3#[derive(
4    Debug,
5    Clone,
6    conjure_object::serde::Serialize,
7    conjure_object::serde::Deserialize,
8    conjure_object::private::DeriveWith
9)]
10#[serde(crate = "conjure_object::serde")]
11#[derive_with(PartialEq, Eq, PartialOrd, Ord, Hash)]
12#[conjure_object::private::staged_builder::staged_builder]
13#[builder(crate = conjure_object::private::staged_builder, update, inline)]
14pub struct RefpropSeries {
15    #[builder(
16        default,
17        map(key(type = super::RefpropProperty), value(type = super::NumericSeries))
18    )]
19    #[serde(
20        rename = "inputs",
21        skip_serializing_if = "std::collections::BTreeMap::is_empty",
22        default
23    )]
24    inputs: std::collections::BTreeMap<super::RefpropProperty, super::NumericSeries>,
25    #[serde(rename = "outputProperty")]
26    output_property: super::RefpropProperty,
27    #[serde(rename = "substance")]
28    substance: super::RefpropSubstance,
29    #[builder(
30        default,
31        custom(
32            type = impl
33            Into<Option<super::InterpolationConfiguration>>,
34            convert = |v|v.into().map(Box::new)
35        )
36    )]
37    #[serde(
38        rename = "interpolationConfiguration",
39        skip_serializing_if = "Option::is_none",
40        default
41    )]
42    interpolation_configuration: Option<Box<super::InterpolationConfiguration>>,
43}
44impl RefpropSeries {
45    /// Constructs a new instance of the type.
46    #[inline]
47    pub fn new(
48        output_property: super::RefpropProperty,
49        substance: super::RefpropSubstance,
50    ) -> Self {
51        Self::builder().output_property(output_property).substance(substance).build()
52    }
53    /// A map that maps a REFPROP property to its numeric series.
54    #[inline]
55    pub fn inputs(
56        &self,
57    ) -> &std::collections::BTreeMap<super::RefpropProperty, super::NumericSeries> {
58        &self.inputs
59    }
60    /// The desired output property. This should not be one of the input properties.
61    #[inline]
62    pub fn output_property(&self) -> &super::RefpropProperty {
63        &self.output_property
64    }
65    /// The substance for REFPROP calculations.
66    #[inline]
67    pub fn substance(&self) -> &super::RefpropSubstance {
68        &self.substance
69    }
70    #[inline]
71    pub fn interpolation_configuration(
72        &self,
73    ) -> Option<&super::InterpolationConfiguration> {
74        self.interpolation_configuration.as_ref().map(|o| &**o)
75    }
76}