Solveur_Masse_base.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 Solveur_Masse_base_included
#define Solveur_Masse_base_included
 
#include <TRUSTTabs_forward.h>
#include <Interface_blocs.h>
 
#include <TRUST_Deriv.h>
#include <MorEqn.h>
 
class Domaine_Cl_dis_base;
class Domaine_dis_base;
class Matrice_Morse;
class Matrice_Base;
 
/*! @brief Solveur_Masse_base Represents the mass matrix of an equation.
 *
 * An equation
 *      contains a reference to a mass matrix.
 *      This class is the base of the mass matrix hierarchy.
 *
 * @sa SolveurMasse Equation_base, Abstract class., Abstract methods:, DoubleTab& appliquer(DoubleTab&) const, void associer_domaine_dis_base(const Domaine_dis_base& ), void associer_domaine_cl_dis_base(const Domaine_Cl_dis_base& )
 */
 
class Solveur_Masse_base : public Objet_U, public MorEqn
{
  Declare_base(Solveur_Masse_base);
 
public :
 
  virtual DoubleTab& appliquer(DoubleTab&) const;
 
  virtual void mettre_a_jour(double temps);
  virtual void resetTime(double temps);
  virtual void associer_domaine_dis_base(const Domaine_dis_base& ) =0;
  virtual void associer_domaine_cl_dis_base(const Domaine_Cl_dis_base& ) =0;
  virtual void assembler();
 
  virtual Matrice_Base& ajouter_masse(double dt, Matrice_Base& matrice, int penalisation=1) const;
  virtual DoubleTab& ajouter_masse(double dt, DoubleTab& x, const DoubleTab& y, int penalisation=1, bool use_old_volumes=false) const;
  virtual Matrice_Base& ajouter_masse_dt_local(DoubleVect& dt_locaux, Matrice_Base& matrice, int penalisation=1) const;
  virtual DoubleTab& ajouter_masse_dt_local(DoubleVect& dt_locaux, DoubleTab& x, const DoubleTab& y, int penalisation=1) const;
  virtual void get_masse_dt_local(DoubleVect& m_dt_locaux, DoubleVect& dt_locaux, int penalisation=1);
  virtual void get_masse_divide_by_local_dt(DoubleVect& m_dt_locaux, DoubleVect& dt_locaux, int penalisation=1);
 
  virtual DoubleTab& corriger_solution(DoubleTab& x, const DoubleTab& y, int incr = 0) const;
  void set_name_of_coefficient_temporel(const Nom&);
  int has_coefficient_temporel() const
  {
    return has_coefficient_temporel_;
  }
  const Nom& get_name_of_coefficient_temporel() const
  {
    return name_of_coefficient_temporel_;
  }
 
  // this method replaces the appliquer method from versions before 154
  virtual DoubleTab& appliquer_impl(DoubleTab& x) const =0;
 
  // adding a dimensionner() method
  // that dimensions the matrix for the case where all operators are negligible
  virtual void dimensionner(Matrice_Morse& matrix) const;
 
  /* interface {dimensionner,ajouter}_blocs -> cf Equation_base.h */
  virtual int has_interface_blocs() const
  {
    return 0;
  };
  virtual void dimensionner_blocs(matrices_t matrices, const tabs_t& semi_impl = {}) const;
  virtual void ajouter_blocs(matrices_t matrices, DoubleTab& secmem, double dt, const tabs_t& semi_impl, int resoudre_en_increments) const;
 
  // adding a completer() method
  // called by the completer() method of equations.
  // Default implementation does nothing.
  virtual void completer();
 
  // adding a preparer_calcul() method
  // called by the preparer_calcul method of equations
  // Default implementation does nothing
  virtual void preparer_calcul();
 
  inline void set_penalisation_flag(int pen) { penalisation_flag_ = pen;  }
 
 
protected :
  Nom name_of_coefficient_temporel_; // name of the temporal coefficient
  int has_coefficient_temporel_;
  mutable int penalisation_flag_;
private:
  mutable double penalisation_;
};
 
#endif /* Solveur_Masse_base_included */