LORENE
utilitaires.h
1/*
2 * Prototypes of various utilities for Lorene
3 *
4 */
5
6/*
7 * Copyright (c) 1999-2001 Eric Gourgoulhon
8 *
9 * This file is part of LORENE.
10 *
11 * LORENE is free software; you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation; either version 2 of the License, or
14 * (at your option) any later version.
15 *
16 * LORENE is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
20 *
21 * You should have received a copy of the GNU General Public License
22 * along with LORENE; if not, write to the Free Software
23 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
24 *
25 */
26
27
28#ifndef __UTILITAIRES_H_
29#define __UTILITAIRES_H_
30
31
32/*
33 * $Id: utilitaires.h,v 1.19 2022/04/15 13:39:24 j_novak Exp $
34 * $Log: utilitaires.h,v $
35 * Revision 1.19 2022/04/15 13:39:24 j_novak
36 * New class Eos_compose_fit to generate fitted EoSs from CompOSE tables.
37 *
38 * Revision 1.18 2022/03/22 13:36:00 j_novak
39 * Added declaration of compute_derivative to utilitaires.h
40 *
41 * Revision 1.17 2018/12/05 15:03:20 j_novak
42 * New Mg3d constructor from a formatted file.
43 *
44 * Revision 1.16 2015/01/09 15:28:52 j_novak
45 * New integration function for general non-equally-spaced grids.
46 *
47 * Revision 1.15 2014/10/13 08:52:37 j_novak
48 * Lorene classes and functions now belong to the namespace Lorene.
49 *
50 * Revision 1.14 2014/10/06 15:09:40 j_novak
51 * Modified #include directives to use c++ syntax.
52 *
53 * Revision 1.13 2014/07/04 12:09:06 j_novak
54 * New argument in zerosec(): a boolean (false by default) for aborting if the number of iteration is greater than the max.
55 *
56 * Revision 1.12 2014/04/25 10:43:50 j_novak
57 * The member 'name' is of type string now. Correction of a few const-related issues.
58 *
59 * Revision 1.11 2008/08/19 06:41:59 j_novak
60 * Minor modifications to avoid warnings with gcc 4.3. Most of them concern
61 * cast-type operations, and constant strings that must be defined as const char*
62 *
63 * Revision 1.10 2004/09/01 09:47:55 r_prix
64 * fixed/improved string-reading with read_variable(): allocates returned string
65 *
66 * Revision 1.9 2004/03/22 13:12:44 j_novak
67 * Modification of comments to use doxygen instead of doc++
68 *
69 * Revision 1.8 2003/12/17 23:12:30 r_prix
70 * replaced use of C++ <string> by standard ANSI char* to be backwards compatible
71 * with broken compilers like MIPSpro Compiler 7.2 on SGI Origin200. ;-)
72 *
73 * Revision 1.7 2003/12/05 15:05:53 r_prix
74 * added read_variable() for (C++-type) strings.
75 *
76 * Revision 1.6 2003/12/04 12:33:21 r_prix
77 * added prototypes and documentation for variable-reading functions
78 * (read_variable, load_file, load_file_buffered)
79 *
80 * Revision 1.5 2002/05/02 15:16:22 j_novak
81 * Added functions for more general bi-fluid EOS
82 *
83 * Revision 1.4 2002/04/16 08:06:44 j_novak
84 * Addition of zerosec_borne
85 *
86 * Revision 1.3 2002/04/11 09:19:46 j_novak
87 * Back to old version of zerosec
88 *
89 * Revision 1.2 2001/12/04 21:24:33 e_gourgoulhon
90 *
91 * New functions fwrite_be and fread_be for writing/reading in a
92 * binary file according to the big endian convention.
93 *
94 * Revision 1.1.1.1 2001/11/20 15:19:27 e_gourgoulhon
95 * LORENE
96 *
97 * Revision 1.6 2001/09/14 14:23:53 eric
98 * Ajout de la fonction zero_list.
99 *
100 * Revision 1.5 2001/05/29 16:11:21 eric
101 * Modif commentaires (mise en conformite Doc++ 3.4.7).
102 *
103 * Revision 1.4 1999/12/24 12:59:54 eric
104 * Ajout de la routine zero_premier.
105 *
106 * Revision 1.3 1999/12/15 15:39:42 eric
107 * *** empty log message ***
108 *
109 * Revision 1.2 1999/12/15 15:17:03 eric
110 * *** empty log message ***
111 *
112 * Revision 1.1 1999/12/15 09:41:47 eric
113 * Initial revision
114 *
115 *
116 * $Header: /cvsroot/Lorene/C++/Include/utilitaires.h,v 1.19 2022/04/15 13:39:24 j_novak Exp $
117 *
118 */
119
120#include <cstring>
121#include "headcpp.h"
122
123namespace Lorene {
124class Param ;
125class Tbl ;
126
132
133
142void arrete(int a = 0) ;
143
162bool zero_premier(double (*f)(double, const Param&), const Param& par,
163 double a, double b, int n, double& a0, double& b0) ;
164
165
166
190double zerosec( double (*f)(double, const Param&), const Param& par,
191 double a, double b, double precis, int nitermax,
192 int& niter, bool abort=true) ;
193
216double zerosec_b( double (*f)(double, const Param&),const Param& par,
217 double a, double b, double precis, int nitermax,
218 int& niter) ;
219
244void zero_list( double (*f)(double, const Param&), const Param& par,
245 double xmin, double xmax, int nsub,
246 Tbl*& az, Tbl*& bz ) ;
247
261 Tbl integ1D(const Tbl& xx, const Tbl& ff) ;
262
274 void compute_derivative(const Tbl& xx, const Tbl& ff, Tbl& dfdx) ;
275
277 Tbl poly_regression(const Tbl&, const Tbl&, int) ;
278
279
280
298int fwrite_be(const int* aa, int size, int nb, FILE* fich) ;
299
317int fwrite_be(const double* aa, int size, int nb, FILE* fich) ;
318
336int fread_be(int* aa, int size, int nb, FILE* fich) ;
337
355int fread_be(double* aa, int size, int nb, FILE* fich) ;
356
357
364char *load_file(char *fname);
365
374char *load_file_buffered(char *fname);
375
394int read_variable(const char *fname, const char *var_name, char *fmt, void *varp);
395
397int read_variable(const char *fname, const char *var_name, int &var);
399int read_variable(const char *fname, const char *var_name, bool &var);
401int read_variable(const char *fname, const char *var_name, double &var);
403int read_variable (const char *fname, const char *var_name, char **str);
404
406void *MyMalloc (long bytes);
407
409int FS_filelength (FILE *f);
410
412void c_est_pas_fait(const char * ) ;
413
416 bool search_file(ifstream& infile, const string& pattern) ;
417
419
420}
421#endif
Parameter storage.
Definition param.h:125
Basic array class.
Definition tbl.h:161
char * load_file_buffered(char *fname)
Returns pointer to data from a file using a buffer.
void zero_list(double(*f)(double, const Param &), const Param &par, double xmin, double xmax, int nsub, Tbl *&az, Tbl *&bz)
Locates approximatively all the zeros of a function in a given interval.
Definition zero_list.C:60
char * load_file(char *fname)
Read file into memory and returns pointer to data.
Tbl poly_regression(const Tbl &, const Tbl &, int)
Polynomial regression, giving Chebyshev coefficients.
Tbl integ1D(const Tbl &xx, const Tbl &ff)
Integrates a function defined on an unequally-spaced grid, approximating it by piecewise parabolae.
int FS_filelength(FILE *f)
A portable routine to determine the length of a file.
void compute_derivative(const Tbl &xx, const Tbl &ff, Tbl &dfdx)
Derives a function defined on an unequally-spaced grid, approximating it by piecewise parabolae.
Definition misc.C:64
void c_est_pas_fait(const char *)
Helpful function to say something is not implemented yet.
void arrete(int a=0)
Setting a stop point in a code.
Definition arrete.C:64
int fread_be(int *aa, int size, int nb, FILE *fich)
Reads integer(s) from a binary file according to the big endian convention.
Definition fread_be.C:72
bool zero_premier(double(*f)(double, const Param &), const Param &par, double a, double b, int n, double &a0, double &b0)
Locates the sub-interval containing the first zero of a function in a given interval.
void * MyMalloc(long bytes)
'Improved' malloc that sets memory to 0 and also auto-terminates on error.
double zerosec_b(double(*f)(double, const Param &), const Param &par, double a, double b, double precis, int nitermax, int &niter)
Finding the zero a function on a bounded domain.
int read_variable(const char *fname, const char *var_name, char *fmt, void *varp)
Reads a variable from file.
bool search_file(ifstream &infile, const string &pattern)
A function that searches for a pattern in a file and places the file stream after the found pattern.
Definition misc.C:53
int fwrite_be(const int *aa, int size, int nb, FILE *fich)
Writes integer(s) into a binary file according to the big endian convention.
Definition fwrite_be.C:73
double zerosec(double(*f)(double, const Param &), const Param &par, double a, double b, double precis, int nitermax, int &niter, bool abort=true)
Finding the zero a function.
Definition zerosec.C:92
Lorene prototypes.
Definition app_hor.h:67