eos_base.h
Go to the documentation of this file.
1 /*
2  -------------------------------------------------------------------
3 
4  Copyright (C) 2006-2017, Andrew W. Steiner
5 
6  This file is part of O2scl.
7 
8  O2scl is free software; you can redistribute it and/or modify
9  it under the terms of the GNU General Public License as published by
10  the Free Software Foundation; either version 3 of the License, or
11  (at your option) any later version.
12 
13  O2scl is distributed in the hope that it will be useful,
14  but WITHOUT ANY WARRANTY; without even the implied warranty of
15  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16  GNU General Public License for more details.
17 
18  You should have received a copy of the GNU General Public License
19  along with O2scl. If not, see <http://www.gnu.org/licenses/>.
20 
21  -------------------------------------------------------------------
22 */
23 /** \file eos_base.h
24  \brief File defining \ref o2scl::eos_base
25 */
26 #ifndef O2SCL_EOS_H
27 #define O2SCL_EOS_H
28 
29 #include <o2scl/part.h>
30 
31 #ifndef DOXYGEN_NO_O2NS
32 namespace o2scl {
33 #endif
34 
35  /** \brief Equation of state base class
36 
37  A base class for an equation of state
38  */
39  class eos_base {
40 
41  public:
42 
43  eos_base();
44 
45  virtual ~eos_base() {};
46 
47  /// Set class thermo object
48  virtual void set_thermo(thermo &th);
49 
50  /// Get class thermo object
51  virtual const thermo &get_thermo();
52 
53  /// The default thermo object
55 
56  /// Return string denoting type ("eos_base")
57  virtual const char *type() { return "eos_base"; }
58 
59  protected:
60 
61 #ifndef DOXYGEN_INTERNAL
62 
63  /// A pointer to the thermo object
65 
66 #endif
67 
68  };
69 
70 #ifndef DOXYGEN_NO_O2NS
71 }
72 #endif
73 
74 #endif
Equation of state base class.
Definition: eos_base.h:39
thermo * eos_thermo
A pointer to the thermo object.
Definition: eos_base.h:64
virtual const thermo & get_thermo()
Get class thermo object.
virtual const char * type()
Return string denoting type ("eos_base")
Definition: eos_base.h:57
thermo def_thermo
The default thermo object.
Definition: eos_base.h:54
virtual void set_thermo(thermo &th)
Set class thermo object.

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