Terme_Source_Acceleration.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 Terme_Source_Acceleration_included
#define Terme_Source_Acceleration_included
 
#include <Champ_Fonc_base.h>
#include <Source_base.h>
 
#include <TRUST_Ref.h>
#include <Motcle.h>
 
class Navier_Stokes_std;
class Probleme_base;
class Domaine_VF;
class Champ_Don_base;
 
class Terme_Source_Acceleration : public Source_base
{
  // This is a base class: see Terme_Source_Acceleration_VDF_Faces
  Declare_base_sans_constructeur(Terme_Source_Acceleration);
public:
 
  Terme_Source_Acceleration();
  void associer_pb(const Probleme_base&) override;
  DoubleTab& calculer(DoubleTab&) const override;
  int a_pour_Champ_Fonc(const Motcle& mot, OBS_PTR(Champ_base) &ch_ref) const override;
  inline const Champ_Don_base& champ_vitesse() const { return champ_vitesse_; }
  bool has_champ_vitesse() const { return bool(champ_vitesse_); }
  inline const Champ_Don_base& omega() const { return omega_; }
  bool has_omega() const { return bool(omega_); }
 
protected:
  virtual void lire_data(Entree& s);
  virtual const Champ_Fonc_base& get_terme_source_post() const;
  virtual Champ_Fonc_base& get_set_terme_source_post() const;
  virtual const DoubleTab& calculer_vitesse_faces(DoubleTab& stockage) const = 0;
  const DoubleTab& calculer_la_source(DoubleTab& src_faces) const;
  virtual const Navier_Stokes_std& get_eq_hydraulique() const;
  void mettre_a_jour(double temps) override;
 
 
private:
// The source term, homogeneous to d/dt(rho*v) and discretized like velocity,
// stored for post-processing purposes.
// It is computed by ajouter() (see comments in a_pour_champ_fonc)
  mutable OWN_PTR(Champ_Fonc_base)  terme_source_post_;
 
  // **********************************************************************
  // velocity field imposed in the moving frame (optionally read
  // from the data file, not used by the source term but potentially
  // by the code to compute the velocity in the fixed frame)
  OWN_PTR(Champ_Don_base) champ_vitesse_;
 
  // imposed acceleration field (read from the data file)
  // OWN_PTR(Champ_Don_base) read from the data file, homogeneous to d/dt(v) in m/(s^2).
  // Must be a uniform vector field with "dimension" components.
  OWN_PTR(Champ_Don_base) champ_acceleration_;
 
  // unsteady rotation field:
 
  // Rotation velocity: uniform field with three components
  // (note: in 2D, vector oriented along Z)
  OWN_PTR(Champ_Don_base) omega_;
  // Time derivative of the rotation velocity:
  //  uniform field with three components
  OWN_PTR(Champ_Don_base) domegadt_;
  // Position of the rotation center:
  //  uniform field with "dimension" components
  OWN_PTR(Champ_Don_base) centre_rotation_;
 
 
  enum Option_TSA { TERME_COMPLET, CORIOLIS_SEUL, ENTRAINEMENT_SEUL };
  Option_TSA option_ = TERME_COMPLET;
  // *****************************************************************
};
 
#endif