DP_Impose.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 DP_Impose_included
#define DP_Impose_included
 
#include <Perte_Charge_Singuliere.h>
 
class Champ_Don_base;
 
/*! @brief Classe DP_Impose This class derived from Perte_Charge_Singuliere is used when one wants
 *
 *     to impose a Delta P (to simulate a pump) from an external field.
 *
 * @sa Perte_Charge Perte_Charge_Reguliere
 */
class DP_Impose: public Perte_Charge_Singuliere
{
public:
  ~DP_Impose() override { }
  Entree& lire_donnees(Entree&);
  void mettre_a_jour(double temps);
  void update_dp_regul(const Equation_base& eqn, double deb, DoubleVect& bilan); //regulates dp_regul_ from the flow rate computed by update_Q
 
protected:
  OWN_PTR(Champ_Don_base) DP_; // the delta P field to impose
  mutable Parser_U f_DP_; // DP to regulate via fac_regul_ (may depend on t)
  double fac_regul_ = 1;
};
 
#endif /* DP_Impose_included */