CoolProp_to_TRUST_Sat_generique.h

/****************************************************************************
* Copyright (c) 2025, CEA
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
* 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
* 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
* IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
* OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
*****************************************************************************/
 
#ifndef CoolProp_to_TRUST_Sat_generique_included
#define CoolProp_to_TRUST_Sat_generique_included
 
#include <CoolProp_to_TRUST.h>
 
/*! @brief CoolProp interface for saturation properties as functions of temperature.
 *
 *  Common interface for TRUST and its baltiks to call CoolProp saturation-property methods.
 *
 *  @sa CoolProp_to_TRUST
 */
class CoolProp_to_TRUST_Sat_generique : public CoolProp_to_TRUST
{
public :
  void set_saturation_generique(const char *const model_name, const char *const fluid_name) override;
 
  int tppi_get_lambda_l_sat_p(const SpanD P, SpanD res, int ncomp = 1, int ind = 0) const override
  {
    return tppi_get_single_sat_p_(SAT::LAMBDA, P, res, 1, 0, true);
  }
 
  int tppi_get_lambda_v_sat_p(const SpanD P, SpanD res, int ncomp = 1, int ind = 0) const override
  {
    return tppi_get_single_sat_p_(SAT::LAMBDA, P, res, 1, 0, false);
  }
 
  int tppi_get_mu_l_sat_p(const SpanD P, SpanD res, int ncomp = 1, int ind = 0) const override
  {
    return tppi_get_single_sat_p_(SAT::MU, P, res, 1, 0, true);
  }
 
  int tppi_get_mu_v_sat_p(const SpanD P, SpanD res, int ncomp = 1, int ind = 0) const override
  {
    return tppi_get_single_sat_p_(SAT::MU, P, res, 1, 0, false);
  }
 
  // for users seeking sigma from the saturation object
  int tppi_get_sigma_pT(const SpanD P, const SpanD T, SpanD res, int ncomp, int ind) const override
  {
    return tppi_get_single_sat_p_(SAT::SIGMA, P, res, 1, 0, true);
  }
 
  int tppi_get_sigma_ph(const SpanD P, const SpanD H, SpanD res, int ncomp, int ind) const override
  {
    return tppi_get_single_sat_p_(SAT::SIGMA, P, res, 1, 0, true);
  }
 
  // application-specific methods to improve performance: used in Pb_Multiphase and F5 (for now)
  int tppi_get_all_flux_interfacial_pb_multiphase(const SpanD P, MSatSpanD sats, int ncomp = 1, int ind = 0) const override;
  int tppi_get_all_sat_loi_F5(const MSpanD input, MSatSpanD sats, int ncomp = 1, int ind = 0) const override;
 
  void set_user_uniform_sigma(const double sigma) override { user_uniform_sigma_ = sigma; }
 
private:
  int tppi_get_single_sat_p_(SAT , const SpanD , SpanD , int , int , bool is_liq = true) const override;
  int tppi_get_single_sat_p__(SAT , const SpanD , SpanD , bool is_liq = true) const;
  int FD_derivative_p(SAT , const SpanD , SpanD , bool is_liq = true) const;
  double user_uniform_sigma_ = -1.;
  std::string fld_name_sat_ = "NONE";
};
 
#endif /* CoolProp_to_TRUST_Sat_generique_included */