Particles and Nuclei Sub-Library: Version 0.910
hdf_nucmass_io.h
Go to the documentation of this file.
00001 /*
00002   -------------------------------------------------------------------
00003 
00004   Copyright (C) 2006-2012, Andrew W. Steiner
00005 
00006   This file is part of O2scl.
00007   
00008   O2scl is free software; you can redistribute it and/or modify
00009   it under the terms of the GNU General Public License as published by
00010   the Free Software Foundation; either version 3 of the License, or
00011   (at your option) any later version.
00012   
00013   O2scl is distributed in the hope that it will be useful,
00014   but WITHOUT ANY WARRANTY; without even the implied warranty of
00015   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00016   GNU General Public License for more details.
00017   
00018   You should have received a copy of the GNU General Public License
00019   along with O2scl. If not, see <http://www.gnu.org/licenses/>.
00020 
00021   -------------------------------------------------------------------
00022 */
00023 #ifndef O2SCL_HDF_NUCMASS_IO_H
00024 #define O2SCL_HDF_NUCMASS_IO_H
00025 
00026 /** \file hdf_nucmass_io.h
00027     \brief File for HDF input of the \o2 \ref ame_mass and 
00028     \ref mnmsk_mass data files
00029 */
00030 
00031 #include <hdf5.h>
00032 #include <hdf5_hl.h>
00033 
00034 #include <o2scl/constants.h>
00035 #include <o2scl/hdf_file.h>
00036 #include <o2scl/lib_settings.h>
00037 #include <o2scl/nuclear_mass.h>
00038 
00039 #ifndef DOXYGENP
00040 namespace o2scl_hdf {
00041 #endif
00042 
00043 #ifdef DOXYGENP
00044 
00045   // Separately document these functions since they're in the hidden
00046   // o2scl namespace
00047   
00048   /// Read data for \ref ame_mass from an HDF table
00049   int ame_load(ame_mass &ame, std::string version, string dir="");
00050 
00051   /// Read data for \ref mnmsk_mass from an HDF table
00052   int mnmsk_load(mnmsk_mass &mnmsk, string dir="");
00053   
00054   /** \brief Read data for \ref hfb_mass from an HDF table
00055       
00056       Valid values of \c model at present are 2, 8, and 14, corresponding
00057       to the HFB2 (\ref Goriely02), HFB8 (\ref Samyn04), and HFB14 
00058       (\ref Goriely07). If a number other than these three is given,
00059       the error handler is called. 
00060   */
00061   int hfb_load(hfb_mass &hfb, int model=14, string dir="");
00062 
00063   /** \brief Read data for \ref hfb_mass from an HDF table
00064       
00065       Valid values of \c model at present are 17 and 21, corresponding
00066       to the HFB17 (\ref Goriely02) and HFB21 (\ref Samyn04). If a
00067       number other than these two is given, the error handler is
00068       called.
00069   */
00070   int hfb_sp_load(hfb_sp_mass &hfb, int model=21, string dir="");
00071 
00072 #endif
00073 
00074   int ame_load(o2scl::ame_mass &ame, std::string version, 
00075                std::string dir="");
00076   
00077   int mnmsk_load(o2scl::mnmsk_mass &mnmsk, std::string dir="");
00078   
00079   int hfb_load(o2scl::hfb_mass &hfb, int model=14, std::string dir="");
00080 
00081   int hfb_sp_load(o2scl::hfb_sp_mass &hfb, int model=21, std::string dir="");
00082   
00083 #ifndef DOXYGENP
00084 }
00085 #endif
00086 
00087 #endif
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Friends

Documentation generated with Doxygen. Provided under the GNU Free Documentation License (see License Information).

Get Object-oriented Scientific Computing
Lib at SourceForge.net. Fast, secure and Free Open Source software
downloads.