Vitesse_derive_base.h

/****************************************************************************
* Copyright (c) 2026, 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 Vitesse_derive_base_included
#define Vitesse_derive_base_included
 
#include <Vitesse_relative_base.h>
#include <TRUSTTab.h>
 
/*! @brief classe Vitesse_derive_base
 *
 *  correlations de vitesse de derive de la forme
 *
 *  ur = ((C0 - 1) * v_l + vg0) / (1 - C0 alpha_g)
 *
 */
class Vitesse_derive_base : public Vitesse_relative_base
{
  Declare_base(Vitesse_derive_base);
public:
  void vitesse_relative(const input_t& input, output_t& output) const override;
  void set_param(Param& param) const override;
 
protected:
  virtual void evaluate_C0_vg0(const input_t& input) const = 0;
 
  mutable double C0 = -1;  // distribution parameter
  mutable ArrOfDouble vg0; // drift velocity
  double alpha_min_ = 0.0;
};
 
#endif /* Vitesse_derive_base */