feos-derive 0.9.5

Macros for the automatic implementation of traits in FeOs
Documentation
use super::{implement, OPT_IMPLS};
use quote::quote;
use syn::DeriveInput;

pub(crate) fn expand_residual(input: DeriveInput) -> syn::Result<proc_macro2::TokenStream> {
    let variants = match input.data {
        syn::Data::Enum(syn::DataEnum { ref variants, .. }) => variants,
        _ => panic!("this derive macro only works on enums"),
    };

    let residual = impl_residual(&input.ident, variants);
    let molar_weight = impl_molar_weight(&input.ident, variants)?;
    let parameter_info = impl_parameter_info(&input.ident, variants)?;
    let entropy_scaling = impl_entropy_scaling(&input.ident, variants)?;
    Ok(quote! {
        #residual
        #molar_weight
        #parameter_info
        #entropy_scaling
    })
}

fn impl_residual(
    ident: &syn::Ident,
    variants: &syn::punctuated::Punctuated<syn::Variant, syn::token::Comma>,
) -> proc_macro2::TokenStream {
    let components = variants.iter().map(|v| {
        let name = &v.ident;
        quote! {
            Self::#name(residual) => residual.components()
        }
    });
    let compute_max_density = variants.iter().map(|v| {
        let name = &v.ident;
        quote! {
            Self::#name(residual) => residual.compute_max_density(moles)
        }
    });
    let reduced_helmholtz_energy_density_contributions = variants.iter().map(|v| {
        let name = &v.ident;
        quote! {
            Self::#name(residual) => residual.reduced_helmholtz_energy_density_contributions(state)
        }
    });
    // let subset = variants.iter().map(|v| {
    //     let name = &v.ident;
    //     quote! {
    //         Self::#name(residual) => Self::#name(residual.subset(component_list).into())
    //     }
    // });

    quote! {
        impl ResidualDyn for #ident {
            fn components(&self) -> usize {
                match self {
                    #(#components,)*
                }
            }
            fn compute_max_density<D: DualNum<f64> + Copy>(&self, moles: &DVector<D>) -> D {
                match self {
                    #(#compute_max_density,)*
                }
            }
            fn reduced_helmholtz_energy_density_contributions<D: DualNum<f64> + Copy>(&self, state: &StateHD<D>) -> Vec<(&'static str, D)> {
                match self {
                    #(#reduced_helmholtz_energy_density_contributions,)*
                }
            }
            // fn subset(&self, component_list: &[usize]) -> Self {
            //     match self {
            //         #(#subset,)*
            //     }
            // }
        }
    }
}

fn impl_molar_weight(
    ident: &syn::Ident,
    variants: &syn::punctuated::Punctuated<syn::Variant, syn::token::Comma>,
) -> syn::Result<proc_macro2::TokenStream> {
    let mut molar_weight = Vec::new();
    let mut has_molar_weight = Vec::new();

    for v in variants.iter() {
        let name = &v.ident;
        if implement("molar_weight", v, &OPT_IMPLS)? {
            molar_weight.push(quote! {
                Self::#name(eos) => eos.molar_weight()
            });
            has_molar_weight.push(quote! {
                Self::#name(_) => true
            });
        } else {
            molar_weight.push(quote! {
                Self::#name(eos) => panic!("{} does not provide molar weights and can not be used to calculate mass-specific properties", stringify!(#name))
            });
            has_molar_weight.push(quote! {
                Self::#name(_) => false
            });
        }
    }

    Ok(quote! {
        impl Molarweight for #ident {
            fn molar_weight(&self) -> MolarWeight<DVector<f64>> {
                match self {
                    #(#molar_weight,)*
                }
            }
        }

        impl #ident {
            pub fn has_molar_weight(&self) -> bool {
                match self {
                    #(#has_molar_weight,)*
                }
            }
        }
    })
}

fn impl_parameter_info(
    ident: &syn::Ident,
    variants: &syn::punctuated::Punctuated<syn::Variant, syn::token::Comma>,
) -> syn::Result<proc_macro2::TokenStream> {
    let mut pure_parameters = Vec::new();
    let mut binary_parameters = Vec::new();
    let mut association_parameters_ab = Vec::new();
    let mut association_parameters_cc = Vec::new();

    for v in variants.iter() {
        let name = &v.ident;
        if implement("parameter_info", v, &OPT_IMPLS)? {
            pure_parameters.push(quote! {
                Self::#name(eos) => eos.parameters.pure_parameters()
            });
            binary_parameters.push(quote! {
                Self::#name(eos) => eos.parameters.binary_parameters()
            });
            association_parameters_ab.push(quote! {
                Self::#name(eos) => eos.parameters.association_parameters_ab()
            });
            association_parameters_cc.push(quote! {
                Self::#name(eos) => eos.parameters.association_parameters_cc()
            });
        } else {
            pure_parameters.push(quote! {
                Self::#name(eos) => panic!("{} does not provide parameters", stringify!(#name))
            });
            binary_parameters.push(quote! {
                Self::#name(eos) => panic!("{} does not provide parameters", stringify!(#name))
            });
            association_parameters_ab.push(quote! {
                Self::#name(eos) => panic!("{} does not provide parameters", stringify!(#name))
            });
            association_parameters_cc.push(quote! {
                Self::#name(eos) => panic!("{} does not provide parameters", stringify!(#name))
            });
        }
    }

    Ok(quote! {
        impl #ident {
            pub fn pure_parameters(&self) -> IndexMap<String, DVector<f64>> {
                match self {
                    #(#pure_parameters,)*
                }
            }
            pub fn binary_parameters(&self) -> IndexMap<String, DMatrix<f64>> {
                match self {
                    #(#binary_parameters,)*
                }
            }
            pub fn association_parameters_ab(&self) -> IndexMap<String, DMatrix<f64>> {
                match self {
                    #(#association_parameters_ab,)*
                }
            }
            pub fn association_parameters_cc(&self) -> IndexMap<String, DMatrix<f64>> {
                match self {
                    #(#association_parameters_cc,)*
                }
            }
        }
    })
}

fn impl_entropy_scaling(
    ident: &syn::Ident,
    variants: &syn::punctuated::Punctuated<syn::Variant, syn::token::Comma>,
) -> syn::Result<proc_macro2::TokenStream> {
    let mut etar = Vec::new();
    let mut etac = Vec::new();
    let mut dr = Vec::new();
    let mut dc = Vec::new();
    let mut thcr = Vec::new();
    let mut thcc = Vec::new();

    for v in variants.iter() {
        let name = &v.ident;
        if implement("entropy_scaling", v, &OPT_IMPLS)? {
            etar.push(quote! {
                Self::#name(eos) => eos.viscosity_reference(temperature, volume, moles)
            });
            etac.push(quote! {
                Self::#name(eos) => eos.viscosity_correlation(s_res, x)
            });
            dr.push(quote! {
                Self::#name(eos) => eos.diffusion_reference(temperature, volume, moles)
            });
            dc.push(quote! {
                Self::#name(eos) => eos.diffusion_correlation(s_res, x)
            });
            thcr.push(quote! {
                Self::#name(eos) => eos.thermal_conductivity_reference(temperature, volume, moles)
            });
            thcc.push(quote! {
                Self::#name(eos) => eos.thermal_conductivity_correlation(s_res, x)
            });
        } else {
            etar.push(quote! {
                Self::#name(eos) => panic!("{} does not implement entropy scaling for transport properties!", stringify!(#name))
            });
            etac.push(quote! {
                Self::#name(eos) => panic!("{} does not implement entropy scaling for transport properties!", stringify!(#name))
            });
            dr.push(quote! {
                Self::#name(eos) => panic!("{} does not implement entropy scaling for transport properties!", stringify!(#name))
            });
            dc.push(quote! {
                Self::#name(eos) => panic!("{} does not implement entropy scaling for transport properties!", stringify!(#name))
            });
            thcr.push(quote! {
                Self::#name(eos) => panic!("{} does not implement entropy scaling for transport properties!", stringify!(#name))
            });
            thcc.push(quote! {
                Self::#name(eos) => panic!("{} does not implement entropy scaling for transport properties!", stringify!(#name))
            });
        }
    }

    Ok(quote! {
        impl EntropyScaling for #ident {
            fn viscosity_reference(
                &self,
                temperature: Temperature,
                volume: Volume,
                moles: &Moles<DVector<f64>>,
            ) -> Viscosity {
                match self {
                    #(#etar,)*
                }
            }

            fn viscosity_correlation(&self, s_res: f64, x: &DVector<f64>) -> f64 {
                match self {
                    #(#etac,)*
                }
            }

            fn diffusion_reference(
                &self,
                temperature: Temperature,
                volume: Volume,
                moles: &Moles<DVector<f64>>,
            ) -> Diffusivity {
                match self {
                    #(#dr,)*
                }
            }

            fn diffusion_correlation(&self, s_res: f64, x: &DVector<f64>) -> f64 {
                match self {
                    #(#dc,)*
                }
            }

            fn thermal_conductivity_reference(
                &self,
                temperature: Temperature,
                volume: Volume,
                moles: &Moles<DVector<f64>>,
            ) -> ThermalConductivity {
                match self {
                    #(#thcr,)*
                }
            }

            fn thermal_conductivity_correlation(&self, s_res: f64, x: &DVector<f64>) -> f64 {
                match self {
                    #(#thcc,)*
                }
            }
        }
    })
}