Schema_Backward_Differentiation_base.h

/****************************************************************************
* Copyright (c) 2022, 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 Schema_Backward_Differentiation_base_included
#define Schema_Backward_Differentiation_base_included
 
 
#include <Schema_Implicite_Multi_TimeStep_base.h>
#include <TRUSTTab.h>
 
class Probleme_Couple;
class Matrice_Base;
 
/*! @brief Base class for Backward Differentiation Formula (BDF) time schemes.
 *
 * @sa Schema_Temps_base
 */
class Schema_Backward_Differentiation_base: public Schema_Implicite_Multi_TimeStep_base
{
 
  Declare_base(Schema_Backward_Differentiation_base);
 
public :
 
  double changer_temps(Equation_base& eqn, const double temps) override;
  void   update_time_derivative(Equation_base& eqn, const DoubleTab& data) override;
  void   mettre_a_jour_equation(Equation_base& eqn, const double temps) override;
  void   store_equation_parameters(Equation_base& eqn, DoubleTab& stored_parameters) override;
  void   modify_equation_parameters(Equation_base& eqn, DoubleTab& stored_parameters) override;
  void   compute_coefficients(double time_step, const DoubleTab& times) const override;
  void   add_multi_timestep_data(const Equation_base& eqn, Matrice_Base& mat_morse, DoubleTab& secmem) const override;
 
  inline const DoubleTab& coefficients() const override;
  inline DoubleTab& coefficients() override;
 
protected :
 
  virtual void   compute_backward_differentiation_coefficients(double time_step, const DoubleTab& times) const = 0  ;
  mutable DoubleTab backward_differentiation_coefficients_;
};
 
inline const DoubleTab& Schema_Backward_Differentiation_base::coefficients() const
{
  return backward_differentiation_coefficients_;
}
 
inline DoubleTab& Schema_Backward_Differentiation_base::coefficients()
{
  return backward_differentiation_coefficients_;
}
 
#endif