Changement_phase_base.h

/****************************************************************************
* Copyright (c) 2022, 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 Changement_phase_base_included
#define Changement_phase_base_included
 
#include <TRUSTTabs_forward.h>
#include <Correlation_base.h>
#include <Saturation_base.h>
 
/*! @brief Base class for phase change correlations.
 *
 *       G_{kl} = G(alpha, p, T) (to fill for k liquid, l vapor)
 *       This class defines a flux function with:
 *     inputs:
 *         k, l      -> pair of phases
 *         D_h       -> hydraulic diameter
 *         alpha[n]  -> void fraction of phase n
 *         T[n]      -> temperature of phase n
 *         p         -> pressure
 *         nv[n]     -> norm of velocity of phase n
 *         lambda[n], mu[n], rho[n], Cp[n] -> various physical properties of phase n
 *         sat       -> "saturation" object associated with the (k, l) pair
 *
 *     outputs:
 *     return  -> mass flux G from k to l
 *     dT_G(n) -> derivative of G w.r.t. T[n]
 *     da_G(n) -> derivative of G w.r.t. a[n]
 *     dp_G    -> derivative of G w.r.t. p
 *
 *
 */
 
class Changement_phase_base : public Correlation_base
{
  Declare_base(Changement_phase_base);
public:
  virtual double calculer(int k, int l, const double dh, const double *alpha, const double *T, const double p, const double *nv,
                          const double *lambda, const double *mu, const double *rho, const double *Cp, const Saturation_base& sat,
                          DoubleTab& dT_G, DoubleTab& da_G, double& dp_G) const = 0;
};
 
#endif