Lec_Diffuse_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 Lec_Diffuse_base_included
#define Lec_Diffuse_base_included
 
#include <communications.h>
#include <EFichier.h>
 
/*! @brief Base class for diffused inputs: the master processor reads data from get_entree_master() and broadcasts it
 *
 *    to all processors.
 *    Warning: the methods operator>>(), get(), eof(), good() and bad()
 *    must be called simultaneously on all processors.
 *    Derived classes must reimplement get_entree_master().
 *    The get_entree_master() method must return a reference to the input
 *    that serves as source on the master processor; it is never called
 *    on other processors.
 *    Warning: the source input must have set_error_action(ERROR_CONTINUE).
 *
 */
 
//    Since 1.7.0 version, Lec_Diffuse_base class inherits EFichier class not Entree class
class Lec_Diffuse_base: public EFichier
{
  Declare_base_sans_constructeur(Lec_Diffuse_base);
public:
  using Entree::operator>>;
 
  Entree& operator>>(int& ob) override;
  Entree& operator>>(long& ob) override;
  Entree& operator>>(long long& ob) override;
  Entree& operator>>(float& ob) override;
  Entree& operator>>(double& ob) override;
 
  int get(int *ob, std::streamsize n) override;
  int get(long *ob, std::streamsize n) override;
  int get(long long *ob, std::streamsize n) override;
  int get(float *ob, std::streamsize n) override;
  int get(double *ob, std::streamsize n) override;
  int get(char *buf, std::streamsize bufsize) override;
 
  int eof() override;
  int good() override;
  int fail() override;
 
  void set_bin(bool bin) override;
  void set_check_types(bool flag) override;
 
  void set_diffuse(bool diffuse) override;
 
protected:
  Lec_Diffuse_base();
  Lec_Diffuse_base(const Lec_Diffuse_base&) = default;
  Lec_Diffuse_base& operator=(const Lec_Diffuse_base&);
  virtual Entree& get_entree_master() = 0;
 
private:
  template <typename _TYPE_>
  int get_template(_TYPE_ *ob, std::streamsize n);
 
  template <typename _TYPE_>
  Entree& operator_template(_TYPE_&ob);
};
 
template <typename _TYPE_>
int Lec_Diffuse_base::get_template(_TYPE_ *ob, std::streamsize n)
{
  int ok = 0;
  if (Process::je_suis_maitre())
    {
      Entree& is = get_entree_master();
      assert(is.get_error_action() == ERROR_CONTINUE);
      ok = is.get(ob, n);
    }
  else if (!diffuse_)
    {
      Cerr << "Lec_Diffuse_base::get(...) can't be used with diffuse_=0 on non master process." << finl;
      Process::exit();
    }
  if (diffuse_)
    {
      envoyer_broadcast(ok, 0);
      assert(n < std::numeric_limits<int>::max());
      if (ok)
        envoyer_broadcast_array(ob, (int)n, 0);
    }
  return error_handle(!ok);
}
 
template <typename _TYPE_>
Entree& Lec_Diffuse_base::operator_template(_TYPE_& ob)
{
  int ok = 0;
  if (Process::je_suis_maitre())
    {
      Entree& is = get_entree_master();
      assert(is.get_error_action() == ERROR_CONTINUE);
      is >> ob;
      ok = is.good();
    }
  else if (!diffuse_)
    {
      Cerr << "Lec_Diffuse_base::operator>> can't be used with diffuse_=0 on non master process." << finl;
      Process::exit();
    }
  if (diffuse_)
    {
      envoyer_broadcast(ok, 0);
      if (ok)
        envoyer_broadcast(ob, 0);
    }
  error_handle(!ok);
  return *this;
}
 
#endif