MOOSE - Multiscale Object Oriented Simulation Environment
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros
Nernst.h
Go to the documentation of this file.
1 /**********************************************************************
2 ** This program is part of 'MOOSE', the
3 ** Messaging Object Oriented Simulation Environment.
4 ** Copyright (C) 2003-2007 Upinder S. Bhalla. and NCBS
5 ** It is made available under the terms of the
6 ** GNU Lesser General Public License version 2.1
7 ** See the file COPYING.LIB for the full notice.
8 **********************************************************************/
9 
10 #ifndef _Nernst_h
11 #define _Nernst_h
12 
16 class Nernst
17 {
18  public:
19  Nernst();
20 
22  // Field function definitions
24  double getE() const;
25 
26  void setTemperature( double value );
27  double getTemperature() const;
28 
29  void setValence( int value );
30  int getValence() const;
31 
32  void setCin( double value );
33  double getCin() const;
34 
35  void setCout( double value );
36  double getCout() const;
37 
38  void setScale( double value );
39  double getScale() const;
40 
42  // Dest function definitions
44 
45  void handleCin( const Eref& e, double conc );
46  void handleCout( const Eref& e, double conc );
47 
48  static const Cinfo* initCinfo();
49  private:
50  void updateE( );
51  double E_;
52  double Temperature_;
53  int valence_;
54  double Cin_;
55  double Cout_;
56  double scale_;
57  double factor_;
58  static const double R_OVER_F;
59  static const double ZERO_CELSIUS;
60 };
61 
62 // Used by solver, readcell, etc.
63 
64 #endif // _Nernst_h
double getCin() const
Definition: Nernst.cpp:168
void setTemperature(double value)
Definition: Nernst.cpp:137
uint32_t value
Definition: moosemodule.h:42
Definition: Nernst.h:16
void setCout(double value)
Definition: Nernst.cpp:173
void setScale(double value)
Definition: Nernst.cpp:182
double Cout_
Definition: Nernst.h:55
int valence_
Definition: Nernst.h:53
Nernst()
Definition: Nernst.cpp:118
double Temperature_
Definition: Nernst.h:52
double getE() const
Definition: Nernst.cpp:132
void setValence(int value)
Definition: Nernst.cpp:150
void setCin(double value)
Definition: Nernst.cpp:163
double factor_
Definition: Nernst.h:57
void handleCout(const Eref &e, double conc)
Definition: Nernst.cpp:208
double getTemperature() const
Definition: Nernst.cpp:145
double E_
Definition: Nernst.h:51
Definition: Eref.h:26
double getCout() const
Definition: Nernst.cpp:177
double Cin_
Definition: Nernst.h:54
static const Cinfo * initCinfo()
Definition: Nernst.cpp:26
static const double R_OVER_F
Definition: Nernst.h:58
double scale_
Definition: Nernst.h:56
static const double ZERO_CELSIUS
Definition: Nernst.h:59
double getScale() const
Definition: Nernst.cpp:187
int getValence() const
Definition: Nernst.cpp:158
void handleCin(const Eref &e, double conc)
Definition: Nernst.cpp:201
Definition: Cinfo.h:18
void updateE()
Definition: Nernst.cpp:196