Equation of State Sub-Library: Version 0.910
eos.h
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_EOS_H
00024 #define O2SCL_EOS_H
00025 
00026 #include <o2scl/part.h>
00027 
00028 #ifndef DOXYGENP
00029 namespace o2scl {
00030 #endif
00031 
00032   /** \brief Equation of state base
00033     
00034       A base class for the computation of an equation of state
00035 
00036   */
00037   class eos {
00038   public:
00039 
00040     eos();
00041 
00042     virtual ~eos() {};
00043 
00044     /// Set class thermo object
00045     virtual int set_thermo(thermo &th);
00046 
00047     /// Get class thermo object
00048     virtual int get_thermo(thermo *&th);
00049 
00050     /// The default thermo object
00051     thermo def_thermo;
00052 
00053     /// Return string denoting type ("eos")
00054     virtual const char *type() { return "eos"; }
00055 
00056   protected:
00057 
00058 #ifndef DOXYGEN_INTERNAL
00059 
00060     /// A pointer to the thermo object
00061     thermo *eos_thermo;
00062 
00063 #endif
00064 
00065   };
00066   
00067 #ifndef DOXYGENP
00068 }
00069 #endif
00070 
00071 #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.