Champ_Don_base.h

/****************************************************************************
* Copyright (c) 2024, 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 Champ_Don_base_included
#define Champ_Don_base_included
 
#include <type_traits>
#include <Champ_base.h>
#include <TRUSTTab.h>
 
/*! @brief class Champ_Don_base base class of Given Fields (not calculated)
 *
 *      physical properties are Given Fields
 *      but can be variable in time and space
 *      functions of other fields ...
 *
 * @sa Champ_base OWN_PTR(Champ_Don_base) Champ_Fonc_base
 */
class Champ_Don_base : public Champ_base
{
  Declare_base(Champ_Don_base);
public:
  using Champ_Proto::valeurs;
 
  void mettre_a_jour(double temps) override;
  void dimensionner(int, int);
  int imprime(Sortie&, int) const override;
  int fixer_nb_valeurs_nodales(int nb_noeuds) override;
  int reprendre(Entree&) override;
  int sauvegarder(Sortie&) const override;
  void resetTime(double time) override;
 
  /*! @brief Overrides Champ_base::valeurs() Returns the array of values
   *
   * @return (DoubleTab&) the array of field values
   */
  inline DoubleTab& valeurs() override { return valeurs_; }
  const inline DoubleTab& valeurs() const override { return valeurs_; }
 
  Champ_base& affecter_compo(const Champ_base&, int) override;
 
  virtual int initialiser(const double temps);
  virtual void set_instationnaire(bool flag) { instationnaire_ = flag; }
  virtual bool instationnaire() const { return instationnaire_; }
  /*! @brief Returns the number of degrees of freedom per component: the number of nodes.
   *
   */
  inline int nb_valeurs_nodales() const override { return valeurs_.dimension(0); }
 
  // forbidden
  operator DoubleTab& () = delete;
  operator const DoubleTab& () const = delete;
 
protected :
  DoubleTab valeurs_;
 
  /* XXX Elie Saikali : make this method protected! Forbidden to call it publicly */
  Champ_base& affecter_(const Champ_base&) override;
 
private:
  bool instationnaire_ = false; // By default, stationary field
};
 
inline void erreur_champ_(const char *nom_methode)
{
  Cerr << "TRUST Error !!! Verify the method " << nom_methode << " !!!" << finl;
  Process::exit();
}
 
template <typename _TYPE_RETURN_>
inline _TYPE_RETURN_ not_implemented_champ_(const char *nom_methode)
{
  Cerr << "TRUST Error !!! The method " << nom_methode << " is not implemented !!!" << finl;
  throw;
}
 
#endif /* Champ_Don_base_included */