/usr/include/lorene/C++/Include/eos_compose.h is in liblorene-dev 0.0.0~cvs20161116+dfsg-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 | /*
* Definition of Lorene classes Eos_CompOSE
* Eos_consistent
*/
/*
* Copyright (c) 2014-2015 Jerome Novak
*
* 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 __EOS_COMPOSE_H_
#define __EOS_COMPOSE_H_
/*
* $Id: eos_compose.h,v 1.1 2015/08/04 14:41:28 j_novak Exp $
* $Log: eos_compose.h,v $
* Revision 1.1 2015/08/04 14:41:28 j_novak
* Back to previous version for Eos_CompOSE. Enthalpy-consistent EoS can be accessed using Eos_consistent class (derived from Eos_CompOSE).
*
*
*
* $Header: /cvsroot/Lorene/C++/Include/eos_compose.h,v 1.1 2015/08/04 14:41:28 j_novak Exp $
*
*/
// Standard C++
#include <string>
#include "headcpp.h"
// Headers C
#include <cstdio>
// Lorene classes
namespace Lorene {
class Tbl ;
//------------------------------------//
// class Eos_CompOSE //
//------------------------------------//
/**
* Equation of state for the <a href="http://compose.obspm.fr">CompOSE</a>
* database.
*
* General tabulated EOS, reading a table passed as an argument to the
* constructor. When built with \c Eos::eos_from_file(), the file must
* be composed of the following lines:
* \verbatim 17 Type of the EOS
1 0: standard format 1: CompOSE format
Tabulated EoS
/full/path/to/the/eos/table/name_of_the_table \endverbatim
* On the second line '0' means that the table has the standard LORENE format
* for tabulated EoSs. '1' means that the files from the CompOSE database
* are used and that the 'name_of_the_table' should be without suffix:
* e.g. \c great_eos would stand for files \c great_eos.nb and
* \c great_eos.thermo (see CompOSE documentation).
*/
class Eos_CompOSE : public Eos_tabul {
// Constructors - Destructor
// -------------------------
public:
/** Constructor from CompOSE data.
*
* @param files_path Absolute name (including path), but without
* extensions of the CompOSE data, e.g.
* \c /home/foo/eos/my_eos standing for
* files \c my_eos.nb and \c my_eos.thermo
* as dowloaded from the <a href="http://compose.obspm.fr">
* CompOSE server</a>.
*/
Eos_CompOSE(const string& files_path) ;
/** Standard constructor.
*
* @param file_name Absolute name (including path) containing
* the EOS file. This file should contain a header
* with the following first lines:
* \verbatim# Comments ...
# Name of the authors / reference
# Comments ...
# Comments ...
# Comments
XXX <-- Number of lines
#
# index n_B [fm^{-3}] rho [g/cm^3] p [dyn/cm^2]
# \endverbatim
* where 'XXX' is the number of following lines of the EoS, each line containing
* an index (integer), baryon density, energy total density and pressure
* in the units given above.
*/
Eos_CompOSE(const char* file_name) ;
protected:
/** Constructor from a binary file (created by the function
* \c sauve(FILE*) ).
* This constructor is protected because any EOS construction
* from a binary file must be done via the function
* \c Eos::eos_from_file(FILE*) .
*/
Eos_CompOSE(FILE* ) ;
/** Constructor from a formatted file.
* This constructor is protected because any EOS construction
* from a formatted file must be done via the function
* \c Eos::eos_from_file(ifstream\& ) .
*/
Eos_CompOSE(ifstream&) ;
private:
/** Copy constructor (private to make \c Eos_CompOSE
* a non-copiable class)
*/
Eos_CompOSE(const Eos_CompOSE& ) ;
/// The construction functions from a file
friend Eos* Eos::eos_from_file(FILE* ) ;
friend Eos* Eos::eos_from_file(ifstream& ) ;
public:
virtual ~Eos_CompOSE() ; ///< Destructor
// Miscellaneous
// -------------
public :
/// Comparison operator (egality)
virtual bool operator==(const Eos& ) const ;
/// Comparison operator (difference)
virtual bool operator!=(const Eos& ) const ;
/** Returns a number to identify the sub-classe of \c Eos the
* object belongs to.
*/
virtual int identify() const ;
// Outputs
// -------
protected:
virtual ostream& operator>>(ostream &) const ; ///< Operator >>
};
//------------------------------------//
// class Eos_consistent //
//------------------------------------//
/**
* Equation of state for the <a href="http://compose.obspm.fr">CompOSE</a>
* database with a consistent computation of the log-enthalpy
* (derived from \c Eos_CompOSE ).
*
* General tabulated EOS, reading a table passed as an argument to the
* constructor. The log-enthalpy \f$h\f$ is computed to ensure the relation
* \f$ dp = (e+p) dh \f$, thus eventually modifying the table. When built
* with \c Eos::eos_from_file(), the file must be composed of the following
* lines: \verbatim 20 Type of the EOS
1 0: standard format 1: CompOSE format
Tabulated EoS
/full/path/to/the/eos/table/name_of_the_table \endverbatim
* On the second line '0' means that the table has the standard LORENE format
* for tabulated EoSs. '1' means that the files from the CompOSE database
* are used and that the 'name_of_the_table' should be without suffix:
* e.g. \c great_eos would stand for files \c great_eos.nb and
* \c great_eos.thermo (see CompOSE documentation).
*/
class Eos_consistent : public Eos_CompOSE {
// Constructors - Destructor
// -------------------------
public:
/** Constructor from CompOSE data.
*
* @param files_path Absolute name (including path), but without
* extensions of the CompOSE data, e.g.
* \c /home/foo/eos/my_eos standing for
* files \c my_eos.nb and \c my_eos.thermo
* as dowloaded from the <a href="http://compose.obspm.fr">
* CompOSE server</a>.
*/
Eos_consistent(const string& files_path) ;
/** Standard constructor.
*
* @param file_name Absolute name (including path) containing
* the EOS file. This file should contain a header
* with the following first lines:
* \verbatim# Comments ...
# Name of the authors / reference
# Comments ...
# Comments ...
# Comments
XXX <-- Number of lines
#
# index n_B [fm^{-3}] rho [g/cm^3] p [dyn/cm^2]
# \endverbatim
* where 'XXX' is the number of following lines of the EoS, each line containing
* an index (integer), baryon density, energy total density and pressure
* in the units given above.
*/
Eos_consistent(const char* file_name) ;
protected:
/** Constructor from a binary file (created by the function
* \c sauve(FILE*) ).
* This constructor is protected because any EOS construction
* from a binary file must be done via the function
* \c Eos::eos_from_file(FILE*) .
*/
Eos_consistent(FILE* ) ;
/** Constructor from a formatted file.
* This constructor is protected because any EOS construction
* from a formatted file must be done via the function
* \c Eos::eos_from_file(ifstream\& ) .
*/
Eos_consistent(ifstream&) ;
private:
/** Copy constructor (private to make \c Eos_consistent
* a non-copiable class)
*/
Eos_consistent(const Eos_consistent& ) ;
/// The construction functions from a file
friend Eos* Eos::eos_from_file(FILE* ) ;
friend Eos* Eos::eos_from_file(ifstream& ) ;
public:
virtual ~Eos_consistent() ; ///< Destructor
// Miscellaneous
// -------------
public :
/// Comparison operator (egality)
virtual bool operator==(const Eos& ) const ;
/// Comparison operator (difference)
virtual bool operator!=(const Eos& ) const ;
/** Returns a number to identify the sub-classe of \c Eos the
* object belongs to.
*/
virtual int identify() const ;
// Outputs
// -------
protected:
virtual ostream& operator>>(ostream &) const ; ///< Operator >>
// Computational functions
// -----------------------
public:
/** Computes the baryon density from the log-enthalpy.
*
* @param ent [input, unit: \f$c^2\f$] log-enthalpy \e H
*
* @return baryon density \e n [unit:\f$n_{\rm nuc}:=0.1\ {\rm fm}^{-3}\f$]
*
*/
virtual double nbar_ent_p(double ent, const Param* par=0x0) const ;
/** Computes the total energy density from the log-enthalpy.
*
* @param ent [input, unit: \f$c^2\f$] log-enthalpy \e H
*
* @return energy density \e e [unit: \f$\rho_{\rm nuc} c^2\f$], where
* \f$\rho_{\rm nuc} := 1.66\ 10^{17} \ {\rm kg/m}^3\f$
*/
virtual double ener_ent_p(double ent, const Param* par=0x0) const ;
/** Computes the pressure from the log-enthalpy.
*
* @param ent [input, unit: \f$c^2\f$] log-enthalpy \e H
*
* @return pressure \e p [unit: \f$\rho_{\rm nuc} c^2\f$], where
* \f$\rho_{\rm nuc} := 1.66\ 10^{17} \ {\rm kg/m}^3\f$
*/
virtual double press_ent_p(double ent, const Param* par=0x0) const ;
};
}
#endif
|