Perte_Charge_Singuliere.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 Perte_Charge_Singuliere_included
#define Perte_Charge_Singuliere_included
 
#include <TRUSTTabs_forward.h>
#include <Perte_Charge.h>
#include <Parser_U.h>
#include <Domaine_forward.h>
 
class Domaine_dis_base;
class Equation_base;
class Source_base;
 
/*! @brief Classe Perte_Charge_Singuliere This class derived from Perte_Charge is used when one wants
 *
 *     to model a pressure drop over a surface (passage through a grid, for example).
 *
 * @sa Perte_Charge Perte_Charge_Reguliere
 */
class Perte_Charge_Singuliere : public Perte_Charge
{
 
public :
 
  virtual ~Perte_Charge_Singuliere() {}
  Entree& lire_regul(Entree&);
  Entree& lire_donnees(Entree&);
  /* by default, reads one { and two } */
  virtual void lire_surfaces(Entree&, const Domaine&, const Domaine_dis_base&, IntVect&, IntVect&, int lire_derniere_accolade = 1);
  inline double K() const;
  double calculate_Q(const Equation_base& eqn, const IntVect& num_faces, const IntVect& sgn) const; // updates and returns the flow rate through the surface
  void update_K(const Equation_base& eqn, double deb, DoubleVect& bilan);                  // regulates K_ from the flow rate computed by update_Q
 
protected :
 
  double K_ = 1; //default value if K is used as a regulation factor (for instance in Perte_Charge_Regulieres)
 
  // for K regulation;
  Nom identifiant_;          // name for the output file: that of the surface, or of the sub-domain and cut
  int regul_;                // 1 if regulation is enabled
  Parser_U deb_cible_, alpha_; // K_ can vary to reach deb_cible_(t)
};
 
 
/*! @brief
 *
 * @return (double)
 */
inline double Perte_Charge_Singuliere::K() const
{
  return K_;
}
 
#endif