// This file is part of the Herezh++ application.
//
// The finite element software Herezh++ is dedicated to the field
// of mechanics for large transformations of solid structures.
// It is developed by Gérard Rio (APP: IDDN.FR.010.0106078.000.R.P.2006.035.20600)
// INSTITUT DE RECHERCHE DUPUY DE LÔME (IRDL) <https://www.irdl.fr/>.
//
// Herezh++ is distributed under GPL 3 license ou ultérieure.
//
// Copyright (C) 1997-2022 Université Bretagne Sud (France)
// AUTHOR : Gérard Rio
// E-MAIL  : gerardrio56@free.fr
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License,
// or (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty
// of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
// See the GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program. If not, see <https://www.gnu.org/licenses/>.
//
// For more information, please consult: <https://herezh.irdl.fr/>.

/************************************************************************
 *     DATE:        01/06/2016                                          *
 *                                                                $     *
 *     AUTEUR:      G RIO   (mailto:gerardrio56@free.fr)                *
 *                                                                $     *
 *     PROJET:      Herezh++                                            *

 *                                                                $     *
 ************************************************************************
 *    BUT:gestion des différentes fonctions multivariables enregistrées.*
 *                                                                $     *
 *     ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''     *
 *                                                                      *
 *     VERIFICATION:                                                    *
 *                                                                      *
 *     !  date  !   auteur   !       but                          !     *
 *     ------------------------------------------------------------     *
 *     !        !            !                                    !     *
 *                                                                $     *
 *     ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''     *
 *     MODIFICATIONS:                                                   *
 *     !  date  !   auteur   !       but                          !     *
 *     ------------------------------------------------------------     *
 *                                                                $     *
 ************************************************************************/
#ifndef LESFONCTIONS_ND_H
#define LESFONCTIONS_ND_H
#include "Fonction_nD.h"

#include <list>
#include "UtilLecture.h"
#include "MotCle.h"
#include <map>
#include "Enum_IO_XML.h"
#include "LesCourbes1D.h"
#ifdef UTILISATION_MPI
  #include <boost/mpi/environment.hpp>
  #include <boost/mpi/communicator.hpp>
  #include <boost/serialization/string.hpp>
  #include <boost/serialization/vector.hpp>
  #include <boost/mpi.hpp>
  namespace mpi = boost::mpi;
#endif


/// @addtogroup Les_fonctions_nD
///  @{
///

/**
*
* \author    Gérard Rio
* \version   1.0
* \date      01/06/2016
* \brief       gestion des différentes fonctions multivariables enregistrées.
*
*/

class LesFonctions_nD
{
  public :
    // CONSTRUCTEURS :
    // constructeur par défaut
    LesFonctions_nD (const LesCourbes1D* lesC1 = NULL );
    // DESTRUCTEUR :
    ~LesFonctions_nD ();
    // METHODES PUBLIQUES :
 
    // changement du pointeur sur LesCourbes1D: prévu une seule fois
    // sinon cela veut dire que lesCourbes1D n'est pas un singleton !!
    // donc n'est possible que si lesCourbes1D n'a pas été attribué
    // ok également si c'est le même pointeur qui est déjà enregistré
    void Attribut_pointeur_lesCourbes1D(const LesCourbes1D * lesC);

    // lecture des Fonctions
    void Lecture(UtilLecture & entreePrinc);
    
    // affichage et definition interactive des commandes 
    void Info_commande_lesFonctions_nD(UtilLecture & entreePrinc);
          
    // affichage des Fonctions
    void Affiche() const ;
        
    // test si la courbe de nom st1 existe reellement
    // retourne false si n'existe pas , true sinon
    bool Existe(const string & st1) const ;
    
    // retourne la courbe correspondant a une cle
    //const 
    Fonction_nD * Trouve(const string & st1) const ;
    
    // vérification que tout est ok, pres à l'emploi
    // ramène true si ok, false sinon
    bool Complet();
    
    // utilitaire pour lire une courbe, soit qui ne sera pas stocké par LesFonctions_nD
    // dans ce cas sont nom est "_", soit son nom correspond à une ref de nom de Fonctions existante
    // dans tous les cas on lit un nom et un type de courbe c-a-d un string et un EnumFonction_nD
    //                 -----     différents cas  -------
    // ptcourbe: soit == NULL, : on lit un nom, et on lit un type de courbe
    //                           1) si celui-ci est "_", cela signifie que la courbe à lire
    //                           est interne à l'utilisateur, on crée une courbe, on lit la courbe
    //                           avec Lecture_base_info de la courbe et on ramène un pointeur sur la 
    //                           nouvelle courbe 
    //                           2) si celui-ci est différent de "_", c'est une référence de courbe
    //                           on lit la référence et on ramène un pointeur sur la courbe de 
    //                           LesFonctions_nD correspondant
    //                           
    // soit == une courbe existante: on lit un nom, et on regarde le nom actuel de la courbe pointée
    //                               par ptcourbe que l'on appelera nom_ref
    //    1) nom = "_" et nom_ref = "_" 
    //                 1-a les deux Fonctions sont du même type on relie les données avec Lecture_base_info
    //                     et on ramène ptcourbe
    //                 1-b les deux Fonctions sont de type différent, on supprime la courbe pointée par
    //                     ptcourbe, on en crée une nouvelle adoc, et on ramène un pointeur dessus
    //    2) nom != "_" et nom_ref == "_" 
    //                  la Fonctions pointé par ptcourbe est supprimé, et on associe le pointeur de retour
    //                  a la courbe correspondant à nom de LesFonctions_nD 
    //    3) nom == "_" et nom_ref != "_" 
    //                  on crée une nouvelle courbe adoc, on lie avec Lecture_base_info, et on ramène
    //                  un pointeur sur la courbe ainsi crée
    
    Fonction_nD * Lecture_pour_base_info(istream& ent,const int cas,Fonction_nD * ptcourbe);
    
    // écriture pour base info
    // c'est le pendant de  Lecture_pour_base_info, de manière à être cohérent
    static void Ecriture_pour_base_info(ostream& sort,const int cas,Fonction_nD * ptcourbe);
	 
	   //----- lecture écriture dans base info -----
	   // cas donne le niveau de la récupération
    // = 1 : on récupère tout
    // = 2 : on récupère uniquement les données variables (supposées comme telles)
	   void Lecture_base_info(istream& ent,const int cas);
    // cas donne le niveau de sauvegarde
    // = 1 : on sauvegarde tout
    // = 2 : on sauvegarde uniquement les données variables (supposées comme telles)
	   void Ecriture_base_info(ostream& sort,const int cas);
         
#ifdef UTILISATION_MPI
    // retour de la taille globale des sorties retardées
    // concernant les sorties sur .BI
    MPI_Offset Taille_buffer_sortie_BI();
    // récupération de l'offset global sur .BI pour la classe
    // et mise à jour des offsets de classes dérivées si besoin
    void Mise_a_jour_Offset_BI_ecriture(MPI_Offset offset,const int cas);
    // idem en lecture, mais là il s'agit uniquement de la mise à jour
    // de l'offset seul puis c'est la classe qui s'en débrouille
    void Mise_a_jour_Offset_BI_lecture(MPI_Offset offset,const int cas);

    // lecture MPI des infos bufferisées
    void Lecture_base_info_MPI_IO(MPI_File * ent_MPI,const int cas);
    // écriture MPI des infos bufferisées
    void Ecriture_base_info_MPI_IO(MPI_File * sort_MPI, const int cas);
#endif

    // sortie du schemaXML: en fonction de enu
    void SchemaXML_lesFonctions_nD(ostream& sort,const Enum_IO_XML enu)  ;

  protected :

    // VARIABLES PROTEGEES :
  //  list <Ref_Fonction_nD> listeDeFonction_nD; // liste des Fonctions 1D
    // liste de Fonctions sous forme d'un arbre pour faciliter la recherche
//    map < string, Ref_Fonction_nD , std::less <string> > listeDeFonction_nD;
    map < string, Fonction_nD * , std::less <string> > listeDeFonction_nD;
 
    // un pointeur sur LesCourbes1D ce qui permet de définir des fonctions avec des courbes 1D
    // ici on considère que LesCourbes1D n'a qu'un membre sinon erreur:
    // l'instance est donc un singleton, mais on n'utilise pas une variable static pour éviter les
    // pb en multistreading
    const LesCourbes1D * lesCourbes1D;
    
    static MotCle motCle; // liste des mots clés
                  
 #ifdef UTILISATION_MPI
    // cas d'un calcul parallèle: // passage des infos entre process
    // pour les i/o
    MPI_Offset nb_buffer; // ici = 1 seul buffer
    Tableau <std::string > buffer_ioBI_MPI; // les buffers pour la sortie retardée
      // uniquement les buffers propres : ici taille 1 pour tous les proc
    std::vector<MPI_Offset>  tailles_buffer_ioBI_MPI; // tailles des buffers
      // size 1 pour tous les proc
    // offsets , offset_LesFonctions_nD[0] est l'offset de début (premier char)
    // [1] : position de la fin
    std::vector<MPI_Offset> offset_LesFonctions_nD;
    MPI_Offset taille_offset; // = 2 ici
 #endif
                  

    // METHODES PROTEGEES :

 };
 /// @}  // end of group

#endif  
