utilitaires.h

/*
 *  Prototypes of various utilities for Lorene
 *
 */

/*
 *   Copyright (c) 1999-2001 Eric Gourgoulhon
 *
 *   This file is part of LORENE.
 *
 *   LORENE 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 2 of the License, or
 *   (at your option) any later version.
 *
 *   LORENE 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 LORENE; if not, write to the Free Software
 *   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 */


#ifndef __UTILITAIRES_H_
#define __UTILITAIRES_H_


/*
 * $Id: utilitaires.h,v 1.21 2024/07/03 09:53:00 j_novak Exp $
 * $Log: utilitaires.h,v $
 * Revision 1.21  2024/07/03 09:53:00  j_novak
 * Added the declaration of admissible_fft.
 *
 * Revision 1.20  2024/02/22 16:51:35  j_novak
 * Added new function to read CompOSE table.
 *
 * Revision 1.19  2022/04/15 13:39:24  j_novak
 * New class Eos_compose_fit to generate fitted EoSs from CompOSE tables.
 *
 * Revision 1.18  2022/03/22 13:36:00  j_novak
 * Added declaration of compute_derivative to utilitaires.h
 *
 * Revision 1.17  2018/12/05 15:03:20  j_novak
 * New Mg3d constructor from a formatted file.
 *
 * Revision 1.16  2015/01/09 15:28:52  j_novak
 * New integration function for general non-equally-spaced grids.
 *
 * Revision 1.15  2014/10/13 08:52:37  j_novak
 * Lorene classes and functions now belong to the namespace Lorene.
 *
 * Revision 1.14  2014/10/06 15:09:40  j_novak
 * Modified #include directives to use c++ syntax.
 *
 * Revision 1.13  2014/07/04 12:09:06  j_novak
 * New argument in zerosec(): a boolean (false by default) for aborting if the number of iteration is greater than the max.
 *
 * Revision 1.12  2014/04/25 10:43:50  j_novak
 * The member 'name' is of type string now. Correction of a few const-related issues.
 *
 * Revision 1.11  2008/08/19 06:41:59  j_novak
 * Minor modifications to avoid warnings with gcc 4.3. Most of them concern
 * cast-type operations, and constant strings that must be defined as const char*
 *
 * Revision 1.10  2004/09/01 09:47:55  r_prix
 * fixed/improved string-reading with read_variable(): allocates returned string
 *
 * Revision 1.9  2004/03/22 13:12:44  j_novak
 * Modification of comments to use doxygen instead of doc++
 *
 * Revision 1.8  2003/12/17 23:12:30  r_prix
 * replaced use of C++ <string> by standard ANSI char* to be backwards compatible
 * with broken compilers like MIPSpro Compiler 7.2 on SGI Origin200. ;-)
 *
 * Revision 1.7  2003/12/05 15:05:53  r_prix
 * added read_variable() for (C++-type) strings.
 *
 * Revision 1.6  2003/12/04 12:33:21  r_prix
 * added prototypes and documentation for variable-reading functions
 * (read_variable, load_file, load_file_buffered)
 *
 * Revision 1.5  2002/05/02 15:16:22  j_novak
 * Added functions for more general bi-fluid EOS
 *
 * Revision 1.4  2002/04/16 08:06:44  j_novak
 * Addition of zerosec_borne
 *
 * Revision 1.3  2002/04/11 09:19:46  j_novak
 * Back to old version of zerosec
 *
 * Revision 1.2  2001/12/04 21:24:33  e_gourgoulhon
 *
 * New functions fwrite_be and fread_be for writing/reading in a
 * binary file according to the big endian convention.
 *
 * Revision 1.1.1.1  2001/11/20 15:19:27  e_gourgoulhon
 * LORENE
 *
 * Revision 1.6  2001/09/14  14:23:53  eric
 * Ajout de la fonction zero_list.
 *
 * Revision 1.5  2001/05/29  16:11:21  eric
 * Modif commentaires (mise en conformite Doc++ 3.4.7).
 *
 * Revision 1.4  1999/12/24  12:59:54  eric
 * Ajout de la routine zero_premier.
 *
 * Revision 1.3  1999/12/15  15:39:42  eric
 * *** empty log message ***
 *
 * Revision 1.2  1999/12/15  15:17:03  eric
 * *** empty log message ***
 *
 * Revision 1.1  1999/12/15  09:41:47  eric
 * Initial revision
 *
 *
 * $Header: /cvsroot/Lorene/C++/Include/utilitaires.h,v 1.21 2024/07/03 09:53:00 j_novak Exp $
 *
 */
 
#include <cstring>
#include "headcpp.h"

namespace Lorene {
class Param ;
class Tbl ;

void arrete(int a = 0) ;

bool zero_premier(double (*f)(double, const Param&), const Param& par,
          double a, double b, int n, double& a0, double& b0) ;



double zerosec( double (*f)(double, const Param&), const Param& par, 
        double a, double b, double precis, int nitermax, 
        int& niter, bool abort=true) ;

double zerosec_b( double (*f)(double, const Param&),const Param& par, 
          double a, double b, double precis, int nitermax, 
          int& niter) ;

void zero_list( double (*f)(double, const Param&), const Param& par,
        double xmin, double xmax, int nsub, 
        Tbl*& az, Tbl*& bz ) ;  
        
 Tbl integ1D(const Tbl& xx, const Tbl& ff) ;

  void compute_derivative(const Tbl& xx, const Tbl& ff, Tbl& dfdx) ;

  Tbl poly_regression(const Tbl&, const Tbl&, int) ;

 

int fwrite_be(const int* aa, int size, int nb, FILE* fich) ;

int fwrite_be(const double* aa, int size, int nb, FILE* fich) ;

int fread_be(int* aa, int size, int nb, FILE* fich) ;

int fread_be(double* aa, int size, int nb, FILE* fich) ;


char *load_file(char *fname);

char *load_file_buffered(char *fname);

int read_variable(const char *fname, const char *var_name, char *fmt, void *varp);

int read_variable(const char *fname, const char *var_name, int &var);
int read_variable(const char *fname, const char *var_name, bool &var);
int read_variable(const char *fname, const char *var_name, double &var);
int read_variable (const char *fname, const char *var_name, char **str);

void *MyMalloc (long bytes);

int FS_filelength (FILE *f);

void c_est_pas_fait(const char * ) ;

 bool search_file(ifstream& infile, const string& pattern) ;
 
  bool read_compose_table(const string& tablename, Tbl*& p_ental, Tbl*& p_entro,
              Tbl*& p_press, Tbl*& p_ener, Tbl*& p_nb, Tbl*& p_temp,
              Tbl*& p_ye) ;
  
  bool admissible_fft(int ) ; 

}
#endif