From 67e26391b03e53ce7dcdc2c52299a8583ce7b2dc Mon Sep 17 00:00:00 2001 From: Ian Bell Date: Sat, 13 Sep 2014 15:57:19 +0200 Subject: [PATCH] Killed off doxygen errors Signed-off-by: Ian Bell --- include/CoolPropLib.h | 151 ++++++++++-------- include/MatrixMath.h | 8 +- include/PolyMath.h | 12 +- src/Backends/Helmholtz/FlashRoutines.h | 2 +- src/Backends/Helmholtz/MixtureDerivatives.h | 44 +++++ .../Incompressible/IncompressibleBackend.h | 2 +- .../Incompressible/IncompressibleLibrary.cpp | 5 +- .../Incompressible/IncompressibleLibrary.h | 20 +-- 8 files changed, 150 insertions(+), 94 deletions(-) diff --git a/include/CoolPropLib.h b/include/CoolPropLib.h index 4719d996..5aeb8cad 100644 --- a/include/CoolPropLib.h +++ b/include/CoolPropLib.h @@ -1,3 +1,22 @@ +/** + * This file defines an interface for shared library (DLL) wrapping + * + * In general the functions defined here take strings which are 0-terminated (C-style), + * vectors of doubles are passed as double* and length + * These functions pass directly to equivalently named functions in CoolProp.h in the CoolProp namespace + * that take std::string, vector etc. + * + * Functions with the call type like + * EXPORT_CODE void CONVENTION AFunction(double, double); + * will be exported to the DLL + * + * The exact symbol that will be exported depends on the values of the preprocessor macros COOLPROP_LIB, EXPORT_CODE, CONVENTION, etc. + * + * In order to have 100% control over the export macros, you can specify EXPORT_CODE and CONVENTION directly. Check out + * CMakeLists.txt in the repo root to see some examples. + * + */ + #ifndef COOLPROPDLL_H #define COOLPROPDLL_H @@ -31,89 +50,52 @@ #if defined(__powerpc__) || defined(EXTERNC) # undef EXPORT_CODE # define EXPORT_CODE extern "C" - #endif - - // Functions with the call type like - // EXPORT_CODE void CONVENTION AFunction(double, double); - // will be exported to the DLL - - /* - #################################################################################### - Overloads for DLL wrapping purposes - - These functions take strings which are 0-terminated. These functions pass directly to - equivalently named functions in CoolProp.h that take std::string - #################################################################################### - */ + #endif /** - \overload - \sa \ref CoolProp::Props1SI(std::string, std::string) - */ + * \overload + * \sa \ref CoolProp::Props1SI(std::string, std::string) + */ EXPORT_CODE double CONVENTION Props1SI(const char *FluidName, const char* Output); /** - \overload - \sa \ref CoolProp::PropsSI(const std::string &, const std::string &, double, const std::string &, double, const std::string&) - */ + *\overload + *\sa \ref CoolProp::PropsSI(const std::string &, const std::string &, double, const std::string &, double, const std::string&) + */ EXPORT_CODE double CONVENTION PropsSI(const char *Output, const char *Name1, double Prop1, const char *Name2, double Prop2, const char *Ref); - /** - \overload - \sa \ref CoolProp::Props(std::string, std::string, double, std::string, double, std::string) - */ - EXPORT_CODE double CONVENTION PropsS(const char *Output, const char *Name1, double Prop1, const char *Name2, double Prop2, const char *Ref); - /** - \overload - \sa \ref CoolProp::Props(const std::string &, const std::string &, double, const std::string &, double, const std::string&) - */ - EXPORT_CODE double CONVENTION Props(const char *Output, const char Name1, double Prop1, const char Name2, double Prop2, const char *Ref); - /** - \overload - \sa \ref CoolProp::Props1(std::string &, std::string &) - */ - EXPORT_CODE double CONVENTION Props1(const char *FluidName, const char *Output); - /** - \overload - \sa \ref IsFluidType(std::string, std::string) - */ - EXPORT_CODE int CONVENTION IsFluidType(const char *Ref, const char *Type); + EXPORT_CODE long CONVENTION get_global_param_string(const char *param, char *Output); + /** + * \overload + * \sa \ref CoolProp::get_parameter_information_string + */ EXPORT_CODE long CONVENTION get_parameter_information_string(const char *key, char *Output); + /** + * \overload + * \sa \ref CoolProp::get_fluid_param_string + */ EXPORT_CODE long CONVENTION get_fluid_param_string(const char *fluid, const char *param, char *Output); /** - \overload - \sa \ref CoolProp::set_reference_stateS(const std::string &, const std::string&) - */ + * \overload + * \sa \ref CoolProp::set_reference_stateS + */ EXPORT_CODE int CONVENTION set_reference_stateS(const char *Ref, const char *reference_state); /** - \overload - \sa \ref CoolProp::set_reference_stateD(const std::string &, double, double, double, double) - */ + * \overload + * \sa \ref CoolProp::set_reference_stateD + */ EXPORT_CODE int CONVENTION set_reference_stateD(const char *Ref, double T, double rho, double h0, double s0); - /* - #################################################################################### - Implemented functions - These functions take inputs that are compatible with DLL passing and are - implemented in CoolPropDLL.cpp - #################################################################################### - */ - - /** - \brief FORTRAN 77 style wrapper of the PropsSI function - \sa \ref CoolProp::PropsSI(const std::string &, const std::string &, double, const std::string &, double, const std::string&) - */ + /** \brief FORTRAN 77 style wrapper of the PropsSI function + * \sa \ref CoolProp::PropsSI(const std::string &, const std::string &, double, const std::string &, double, const std::string&) + */ EXPORT_CODE void CONVENTION propssi_(const char *Output, const char *Name1, double *Prop1, const char *Name2, double *Prop2, const char * Ref, double *output); /** - - */ + * \overload + * \sa \ref CoolProp::PropsSIZ + */ EXPORT_CODE double CONVENTION PropsSIZ(const char *Output, const char *Name1, double Prop1, const char *Name2, double Prop2, const char *FluidName, const double *z, int n); - // This version uses the indices in place of the strings for speed. Get the parameter indices - // from get_param_index('D') for instance and the Fluid index from get_Fluid_index('Air') for instance - EXPORT_CODE double CONVENTION IPropsSI(long iOutput, long iName1, double Prop1, long iName2, double Prop2, long iFluid); - EXPORT_CODE double CONVENTION IProps(long iOutput, long iName1, double Prop1, long iName2, double Prop2, long iFluid); - /// Convert from degrees Fahrenheit to Kelvin (useful primarily for testing) EXPORT_CODE double CONVENTION F2K(double T_F); /// Convert from Kelvin to degrees Fahrenheit (useful primarily for testing) @@ -137,15 +119,44 @@ // Humid Air Properties // --------------------------------- - + /** \brief DLL wrapper of the HAPropsSI function + * \sa \ref HumidAir::HAPropsSI(const char *OutputName, const char *Input1Name, double Input1, const char *Input2Name, double Input2, const char *Input3Name, double Input3); + */ EXPORT_CODE double CONVENTION HAPropsSI(const char *Output, const char *Name1, double Prop1, const char *Name2, double Prop2, const char *Name3, double Prop3); - /** - \brief FORTRAN 77 style wrapper of the HAPropsSI function - * \sa \ref HumidAirProp::PropsSI(const char *OutputName, const char *Input1Name, double Input1, const char *Input2Name, double Input2, const char *Input3Name, double Input3); - */ + /** \brief FORTRAN 77 style wrapper of the HAPropsSI function + * \sa \ref HumidAir::HAPropsSI(const char *OutputName, const char *Input1Name, double Input1, const char *Input2Name, double Input2, const char *Input3Name, double Input3); + */ EXPORT_CODE void CONVENTION hapropssi_(const char *Output, const char *Name1, double *Prop1, const char *Name2, double *Prop2, const char *Name3, double *Prop3, double *output); + // ************************************************************************************* + // ************************************************************************************* + // ***************************** DEPRECATED ******************************************* + // ************************************************************************************* + // ************************************************************************************* + /** + \overload + \sa \ref Props(const char *Output, const char Name1, double Prop1, const char Name2, double Prop2, const char *Ref) + */ + EXPORT_CODE double CONVENTION PropsS(const char *Output, const char *Name1, double Prop1, const char *Name2, double Prop2, const char *Ref); + /** + Works just like \ref CoolProp::PropsSI, but units are in KSI system. This function is deprecated, no longer supported, and users should transition to using the PropsSI function + */ + EXPORT_CODE double CONVENTION Props(const char *Output, const char Name1, double Prop1, const char Name2, double Prop2, const char *Ref); + /** + Works just like \ref CoolProp::Props1SI, but units are in KSI system. This function is deprecated, no longer supported, and users should transition to using the Props1SI function + */ + EXPORT_CODE double CONVENTION Props1(const char *FluidName, const char *Output); + ///** + //\overload + // IsFluidType(std::string, std::string) + //*/ + //EXPORT_CODE int CONVENTION IsFluidType(const char *Ref, const char *Type); + + // This version uses the indices in place of the strings for speed. Get the parameter indices + // from get_param_index('D') for instance and the Fluid index from get_Fluid_index('Air') for instance + EXPORT_CODE double CONVENTION IPropsSI(long iOutput, long iName1, double Prop1, long iName2, double Prop2, long iFluid); + EXPORT_CODE double CONVENTION IProps(long iOutput, long iName1, double Prop1, long iName2, double Prop2, long iFluid); #endif diff --git a/include/MatrixMath.h b/include/MatrixMath.h index 98469746..8c0d3512 100644 --- a/include/MatrixMath.h +++ b/include/MatrixMath.h @@ -70,8 +70,9 @@ template std::size_t num_cols (std::vector > co /** Conversion functions for the different kinds of object-like * parameters. This might be obsolete at a later stage, but now * it is still needed. + * @param coefficients matrix containing the ordered coefficients + * @param axis axis along which to extract */ -/// @param coefficients matrix containing the ordered coefficients template std::vector eigen_to_vec1D(const Eigen::Matrix &coefficients, int axis = 0){ std::vector result; size_t r = coefficients.rows(), c = coefficients.cols(); @@ -120,7 +121,10 @@ template Eigen::Matrix vec_to_eigen(c } return result; } -/// @param coefficients matrix containing the ordered coefficients +/** + * @param coefficients matrix containing the ordered coefficients + * @param axis axis along which to extract data + */ template Eigen::Matrix vec_to_eigen(const std::vector &coefficients, int axis = 0){ size_t nRows = num_rows(coefficients); Eigen::Matrix result; diff --git a/include/PolyMath.h b/include/PolyMath.h index 7858af1a..ec4e7a34 100644 --- a/include/PolyMath.h +++ b/include/PolyMath.h @@ -183,8 +183,8 @@ protected: public: /// Residual of a polynomial - /// @param Polynomial2D &poly polynomial object used to evaluate the calls - /// @param const Eigen::MatrixXd &coefficients, + /// @param poly polynomial object used to evaluate the calls + /// @param coefficients /// @param in double value that represents the current input in x (1st dimension) or y (2nd dimension) /// @param z_in double value that represents the current output in the 3rd dimension /// @param axis unsigned integer value that represents the axis to solve for (0=x, 1=y) @@ -388,8 +388,8 @@ protected: public: /// Residual of a polynomial divided by the independent variable - /// @param Polynomial2DFrac &poly polynomial object used to evaluate the calls - /// @param const Eigen::MatrixXd &coefficients, + /// @param poly polynomial object used to evaluate the calls + /// @param coefficients /// @param in double value that represents the current input in x (1st dimension) or y (2nd dimension) /// @param z_in double value that represents the current output in the 3rd dimension /// @param axis unsigned integer value that represents the axis to solve for (0=x, 1=y) @@ -413,8 +413,8 @@ protected: public: /// Residual of an integrated polynomial divided by the independent variable - /// @param Polynomial2DFrac &poly polynomial object used to evaluate the calls - /// @param const Eigen::MatrixXd &coefficients, + /// @param poly polynomial object used to evaluate the calls + /// @param coefficients vector of coefficients /// @param in double value that represents the current input in x (1st dimension) or y (2nd dimension) /// @param z_in double value that represents the current output in the 3rd dimension /// @param axis unsigned integer value that represents the axis to solve for (0=x, 1=y) diff --git a/src/Backends/Helmholtz/FlashRoutines.h b/src/Backends/Helmholtz/FlashRoutines.h index c8d6ddc7..86e20342 100644 --- a/src/Backends/Helmholtz/FlashRoutines.h +++ b/src/Backends/Helmholtz/FlashRoutines.h @@ -58,7 +58,7 @@ public: /// @param HEOS The HelmholtzEOSMixtureBackend to be used /// @param other The index for the other input from CoolProp::parameters; allowed values are iHmolar, iSmolar, iUmolar /// @param T0 The initial guess value for the temperature [K] - /// @param rho0 The initial guess value for the density [mol/m^3] + /// @param rhomolar0 The initial guess value for the density [mol/m^3] static void HSU_P_flash_singlephase_Newton(HelmholtzEOSMixtureBackend &HEOS, parameters other, long double T0, long double rhomolar0); /// The single-phase flash routine for the pairs (P,H), (P,S), and (P,U). Similar analysis is needed diff --git a/src/Backends/Helmholtz/MixtureDerivatives.h b/src/Backends/Helmholtz/MixtureDerivatives.h index 94588343..17426faf 100644 --- a/src/Backends/Helmholtz/MixtureDerivatives.h +++ b/src/Backends/Helmholtz/MixtureDerivatives.h @@ -65,6 +65,8 @@ class MixtureDerivatives{ * n\left(\frac{\partial p}{\partial n_i} \right)_{T,V,n_j} = \rho RT\left[1+\delta\alpha_{\delta}^r\left[2- \frac{1}{\rho_r}\cdot n\left( \frac{\partial \rho_r}{\partial n_i}\right)_{n_j}\right] +\delta\cdot n\left(\frac{\partial\alpha_{\delta}^r}{\partial n_i}\right)_{T,V,n_j}\right] * \f] * @param HEOS The HelmholtzEOSMixtureBackend to be used + * @param i The index of interest + * @param xN_flag A flag specifying whether the all mole fractions are independent or only the first N-1 */ static long double ndpdni__constT_V_nj(HelmholtzEOSMixtureBackend &HEOS, std::size_t i, x_N_dependency_flag xN_flag); @@ -75,6 +77,8 @@ class MixtureDerivatives{ * \hat v_i = \left( \frac{\partial V}{\partial n_i}\right)_{T,p,n_j} = \frac{-\left(\dfrac{\partial p}{\partial n_i}\right)_{T,V,n_j}}{\left(\dfrac{\partial p}{\partial V}\right)_{T,\bar n}} * \f] * @param HEOS The HelmholtzEOSMixtureBackend to be used + * @param i The index of interest + * @param xN_flag A flag specifying whether the all mole fractions are independent or only the first N-1 */ static long double partial_molar_volume(HelmholtzEOSMixtureBackend &HEOS, std::size_t i, x_N_dependency_flag xN_flag); @@ -90,6 +94,8 @@ class MixtureDerivatives{ /** \brief Natural logarithm of the fugacity coefficient * * @param HEOS The HelmholtzEOSMixtureBackend to be used + * @param i The index of interest + * @param xN_flag A flag specifying whether the all mole fractions are independent or only the first N-1 */ static long double ln_fugacity_coefficient(HelmholtzEOSMixtureBackend &HEOS, std::size_t i, x_N_dependency_flag xN_flag); @@ -100,6 +106,8 @@ class MixtureDerivatives{ * \left(\frac{\partial \ln(f_i)}{\partial T} \right)_{\rho,x} = -\frac{1}{T}\left(1-\tau\alpha^r_{\tau}-\tau n\left(\frac{\partial\left(\frac{\partial \alpha^r}{\partial n_i}\right)_{T,V,n_j}}{\partial \tau}\right)_{\delta,\bar x} \right) * \f] * @param HEOS The HelmholtzEOSMixtureBackend to be used + * @param i The index of interest + * @param xN_flag A flag specifying whether the all mole fractions are independent or only the first N-1 */ static long double dln_fugacity_i_dT__constrho_n(HelmholtzEOSMixtureBackend &HEOS, std::size_t i, x_N_dependency_flag xN_flag); @@ -110,6 +118,8 @@ class MixtureDerivatives{ * \left(\frac{\partial \ln(f_i)}{\partial \rho} \right)_{T, x} = \frac{1}{\rho}\left(1+\delta\alpha^r_{\delta}+\delta n\left(\frac{\partial\left(\frac{\partial \alpha^r}{\partial n_i}\right)_{T,V,n_j}}{\partial \delta}\right)_{\tau,\bar x} \right) * \f] * @param HEOS The HelmholtzEOSMixtureBackend to be used + * @param i The index of interest + * @param xN_flag A flag specifying whether the all mole fractions are independent or only the first N-1 */ static long double dln_fugacity_i_drho__constT_n(HelmholtzEOSMixtureBackend &HEOS, std::size_t i, x_N_dependency_flag xN_flag); @@ -121,6 +131,8 @@ class MixtureDerivatives{ * \left(\frac{\partial \ln \phi_i}{\partial T} \right)_{p,\bar n} = \left(\frac{\partial^2n\alpha^r}{\partial T\partial n_i} \right)_{V,n_j} + \frac{1}{T}-\frac{\hat v}{RT}\left(\frac{\partial p}{\partial T}\right)_{V,\bar n} * \f] * @param HEOS The HelmholtzEOSMixtureBackend to be used + * @param i The index of interest + * @param xN_flag A flag specifying whether the all mole fractions are independent or only the first N-1 */ static long double dln_fugacity_coefficient_dT__constp_n(HelmholtzEOSMixtureBackend &HEOS, std::size_t i, x_N_dependency_flag xN_flag); @@ -144,6 +156,8 @@ class MixtureDerivatives{ * && +\phi^r_{x_i}-\sum_{k=1}^{N}x_k\phi^r_{x_k} * \f} * @param HEOS The HelmholtzEOSMixtureBackend to be used + * @param i The index of interest + * @param xN_flag A flag specifying whether the all mole fractions are independent or only the first N-1 */ static long double ndalphar_dni__constT_V_nj(HelmholtzEOSMixtureBackend &HEOS, std::size_t i, x_N_dependency_flag xN_flag); @@ -157,6 +171,8 @@ class MixtureDerivatives{ * \left(\frac{\partial \ln \phi_i}{\partial p} \right)_{T,\bar n} = \frac{\hat v_i}{RT}-\frac{1}{p} * \f] * @param HEOS The HelmholtzEOSMixtureBackend to be used + * @param i The index of interest + * @param xN_flag A flag specifying whether the all mole fractions are independent or only the first N-1 */ static long double dln_fugacity_coefficient_dp__constT_n(HelmholtzEOSMixtureBackend &HEOS, std::size_t i, x_N_dependency_flag xN_flag); @@ -171,6 +187,9 @@ class MixtureDerivatives{ * n\left(\frac{\partial \ln \phi_i}{\partial n_j}\right)_{T,p} = n\left(\frac{\partial^2n\alpha^r}{\partial n_j \partial n_i} \right)_{T,V}+1-\frac{\hat v_i}{RT}\left[n\left(\frac{\partial p}{\partial n_j}\right)_{T,V,n_i}\right] * \f] * @param HEOS The HelmholtzEOSMixtureBackend to be used + * @param i The index of interest + * @param j The second index of interest + * @param xN_flag A flag specifying whether the all mole fractions are independent or only the first N-1 */ static long double ndln_fugacity_coefficient_dnj__constT_p(HelmholtzEOSMixtureBackend &HEOS, std::size_t i, std::size_t j, x_N_dependency_flag xN_flag); @@ -181,6 +200,10 @@ class MixtureDerivatives{ * \left(\frac{\partial \ln \phi_i}{\partial x_j}\right)_{T,p,x_{k\neq j}} = \left(\frac{\partial^2n\alpha^r}{\partial x_j \partial n_i} \right)_{T,V}+\frac{1}{RT}\frac{\left(\frac{\partial p}{\partial n_i}\right)_{T,V,n_{k\neq i}}\left(\frac{\partial p}{\partial x_j}\right)_{T,V,x_{k\neq j}}}{\left(\frac{\partial p}{\partial V}\right)_{T,\bar n}} * \f] * @param HEOS The HelmholtzEOSMixtureBackend to be used + * @param i The first index of interest + * @param j The second index of interest + * @param xN_flag A flag specifying whether the all mole fractions are independent or only the first N-1 + * */ static long double dln_fugacity_coefficient_dxj__constT_p_xi(HelmholtzEOSMixtureBackend &HEOS, std::size_t i, std::size_t j, x_N_dependency_flag xN_flag); @@ -191,6 +214,8 @@ class MixtureDerivatives{ * \left(\frac{\partial p}{\partial x_j} \right)_{T,V,x_{k\neq j}} = \rho RT\left(-\frac{1}{\rho_r}\left(\frac{\partial \rho_r}{\partial x_j}\right)_{x_{k\neq j}} \delta\alpha_{\delta}^r + \delta\left(\frac{\partial}{\partial x_j}\left(\left( \frac{\partial \alpha^r}{\partial \delta}\right)_{\tau,\bar x}\right)\right)_{T,V,x_{k\neq j}}\right) * \f] * @param HEOS The HelmholtzEOSMixtureBackend to be used + * @param j The index of interest + * @param xN_flag A flag specifying whether the all mole fractions are independent or only the first N-1 */ static long double dpdxj__constT_V_xi(HelmholtzEOSMixtureBackend &HEOS, std::size_t j, x_N_dependency_flag xN_flag); @@ -201,6 +226,9 @@ class MixtureDerivatives{ * \left(\frac{\partial^2n\alpha^r}{\partial x_j\partial n_i} \right)_{T,V} = \left(\frac{\partial}{\partial x_j}\left(n\left(\frac{\partial \alpha^r}{\partial n_i}\right)_{T,V,n_{j\neq i}}\right)\right)_{T,V,x_{k\neq j}} +\left(\frac{\partial \alpha^r}{\partial x_j}\right)_{T,V,x_{k\neq j}} * \f] * @param HEOS The HelmholtzEOSMixtureBackend to be used + * @param j The first index of interest + * @param i The second index of interest + * @param xN_flag A flag specifying whether the all mole fractions are independent or only the first N-1 */ static long double d2nalphar_dxj_dni__constT_V(HelmholtzEOSMixtureBackend &HEOS, std::size_t j, std::size_t i, x_N_dependency_flag xN_flag){ return MixtureDerivatives::d_ndalphardni_dxj__constT_V_xi(HEOS, i, j, xN_flag) + MixtureDerivatives::dalphar_dxj__constT_V_xi(HEOS, j, xN_flag);}; @@ -234,6 +262,8 @@ class MixtureDerivatives{ * \left(\frac{\partial^2n\alpha^r}{\partial T\partial n_i} \right)_{V,n_j} = -\frac{\tau}{T}\left[\alpha_{\tau}^r +\left( \frac{\partial}{\partial \tau}\left(n\left(\frac{\partial \alpha^r}{\partial n_i}\right)_{T,V,n_j}\right)\right)_{\delta,\bar x}\right] * \f] * @param HEOS The HelmholtzEOSMixtureBackend to be used + * @param i The second index of interest + * @param xN_flag A flag specifying whether the all mole fractions are independent or only the first N-1 */ static long double d2nalphar_dni_dT(HelmholtzEOSMixtureBackend &HEOS, std::size_t i, x_N_dependency_flag xN_flag); @@ -246,6 +276,8 @@ class MixtureDerivatives{ * && +\phi^r_{x_i\tau}-\sum_{k=1}^{N}x_k\phi^r_{x_k\tau} * \f} * @param HEOS The HelmholtzEOSMixtureBackend to be used + * @param i The index of interest + * @param xN_flag A flag specifying whether the all mole fractions are independent or only the first N-1 */ static long double d_ndalphardni_dTau(HelmholtzEOSMixtureBackend &HEOS, std::size_t i, x_N_dependency_flag xN_flag); @@ -258,6 +290,8 @@ class MixtureDerivatives{ * &+&\phi^r_{\delta x_i}-\sum_{k=1}^{N}x_k\phi^r_{\delta x_k} * \f} * @param HEOS The HelmholtzEOSMixtureBackend to be used + * @param i The index of interest + * @param xN_flag A flag specifying whether the all mole fractions are independent or only the first N-1 */ static long double d_ndalphardni_dDelta(HelmholtzEOSMixtureBackend &HEOS, std::size_t i, x_N_dependency_flag xN_flag); @@ -279,6 +313,9 @@ class MixtureDerivatives{ * &+& \left( \frac{\partial}{\partial x_j}\left(n\left(\frac{\partial\alpha^r}{\partial n_i}\right)_{T,V,n_j}\right)\right)_{\delta,\tau,x_i}-\sum_{k=1}^{N}x_k \left( \frac{\partial}{\partial x_k}\left(n\left(\frac{\partial\alpha^r}{\partial n_i}\right)_{T,V,n_j}\right)\right)_{\delta,\tau,x_i}\\ * \f} * @param HEOS The HelmholtzEOSMixtureBackend to be used + * @param i The index of interest + * @param j The second index of interest + * @param xN_flag A flag specifying whether the all mole fractions are independent or only the first N-1 */ static long double nd2nalphardnidnj__constT_V(HelmholtzEOSMixtureBackend &HEOS, std::size_t i, std::size_t j, x_N_dependency_flag xN_flag); @@ -289,6 +326,8 @@ class MixtureDerivatives{ * n\left(\frac{\partial \delta}{\partial n_i} \right)_{T,V,n_j} = \delta - \frac{\delta}{\rho_r}\cdot n\left(\frac{\partial \rho_r}{\partial n_i} \right)_{n_j} * \f] * @param HEOS The HelmholtzEOSMixtureBackend to be used + * @param i The index of interest + * @param xN_flag A flag specifying whether the all mole fractions are independent or only the first N-1 */ static long double nddeltadni__constT_V_nj(HelmholtzEOSMixtureBackend &HEOS, std::size_t i, x_N_dependency_flag xN_flag); @@ -299,6 +338,8 @@ class MixtureDerivatives{ * n\left(\frac{\partial \tau}{\partial n_i} \right)_{T,V,n_j} = \frac{\tau}{T_r}\cdot n\left(\frac{\partial T_r}{\partial n_i} \right)_{n_j} * \f] * @param HEOS The HelmholtzEOSMixtureBackend to be used + * @param i The index of interest + * @param xN_flag A flag specifying whether the all mole fractions are independent or only the first N-1 */ static long double ndtaudni__constT_V_nj(HelmholtzEOSMixtureBackend &HEOS, std::size_t i, x_N_dependency_flag xN_flag); @@ -313,6 +354,9 @@ class MixtureDerivatives{ * &+& \alpha_{x_ix_j}^r-\alpha_{x_j}^r-\sum_{m=1}^Nx_m\alpha_{x_jx_m}^r * \f} * @param HEOS The HelmholtzEOSMixtureBackend to be used + * @param i The index of interest + * @param j The second index of interest + * @param xN_flag A flag specifying whether the all mole fractions are independent or only the first N-1 */ static long double d_ndalphardni_dxj__constdelta_tau_xi(HelmholtzEOSMixtureBackend &HEOS, std::size_t i, std::size_t j, x_N_dependency_flag xN_flag); diff --git a/src/Backends/Incompressible/IncompressibleBackend.h b/src/Backends/Incompressible/IncompressibleBackend.h index 7f23f54f..66765a5d 100644 --- a/src/Backends/Incompressible/IncompressibleBackend.h +++ b/src/Backends/Incompressible/IncompressibleBackend.h @@ -29,7 +29,7 @@ public: /// @param fluid_name the string with the fluid name IncompressibleBackend(const std::string &fluid_name); /// The instantiator - /// @param fluid_names The vector of strings of the fluid components, without file ending + /// @param component_names The vector of strings of the fluid components, without file ending IncompressibleBackend(const std::vector &component_names); // Incompressible backend uses different compositions diff --git a/src/Backends/Incompressible/IncompressibleLibrary.cpp b/src/Backends/Incompressible/IncompressibleLibrary.cpp index d8b58a50..02ed986b 100644 --- a/src/Backends/Incompressible/IncompressibleLibrary.cpp +++ b/src/Backends/Incompressible/IncompressibleLibrary.cpp @@ -534,10 +534,7 @@ void JSONIncompressibleLibrary::add_obj(IncompressibleFluid fluid_obj) { string_to_index_map[fluid.getName()] = index; } -/// Get an IncompressibleFluid instance stored in this library -/** - @param name Name of the fluid - */ +// Get an IncompressibleFluid instance stored in this library IncompressibleFluid& JSONIncompressibleLibrary::get(std::string key) { std::map::iterator it; // Try to find it diff --git a/src/Backends/Incompressible/IncompressibleLibrary.h b/src/Backends/Incompressible/IncompressibleLibrary.h index 6388b818..b474e53a 100644 --- a/src/Backends/Incompressible/IncompressibleLibrary.h +++ b/src/Backends/Incompressible/IncompressibleLibrary.h @@ -143,7 +143,7 @@ a rapidjson array of fluids to the add_many function. class JSONIncompressibleLibrary { /// Map from CAS code to JSON instance. - /** This is not practical for the incomressibles, the CAS may not be + /** This is not practical for the incompressibles, the CAS may not be * defined for blends of heat transfer fluids and solutions. */ std::map fluid_map; @@ -169,16 +169,16 @@ public: void add_one(rapidjson::Value &fluid_json); void add_obj(IncompressibleFluid fluid_obj); - /// Get an IncompressibleFluid instance stored in this library - /** - @param name Name of the fluid - */ - IncompressibleFluid& get(std::string key); + /** \brief Get an IncompressibleFluid instance stored in this library + * + * @param name Name of the fluid + */ + IncompressibleFluid& get(std::string name); - /// Get a CoolPropFluid instance stored in this library - /** - @param key The index of the fluid in the map - */ + /** \brief Get a CoolPropFluid instance stored in this library + * + * @param key The index of the fluid in the map + */ IncompressibleFluid& get(std::size_t key); /// Return a comma-separated list of incompressible pure fluid names