OpenFCST: The open-source Fuel Cell Simulation Toolbox
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
newton_basic.h
Go to the documentation of this file.
1 // ----------------------------------------------------------------------------
2 //
3 // FCST: Fuel Cell Simulation Toolbox
4 //
5 // Copyright (C) 2006-2013 by Energy Systems Design Laboratory, University of Alberta
6 //
7 // This software is distributed under the MIT License
8 // For more information, see the README file in /doc/LICENSE
9 //
10 // - Class: newton_basic.h
11 // - Description: This class performs basic Newton iterations with a constant weight
12 // - Developers: Valentin N. Zingan, University of Alberta
13 // - Id: $Id: newton_basic.h 1354 2013-08-17 00:01:22Z secanell $
14 //
15 // ----------------------------------------------------------------------------
16 
17 #ifndef _DEALII_APPFRAME_NEWTON_BASIC_H_
18 #define _DEALII_APPFRAME_NEWTON_BASIC_H_
19 
20 #include <newton_base.h>
21 
22 namespace AppFrame
23 {
24 
31 class NewtonBasic : public newtonBase
32 {
33 public:
34 
36 
37 
42 
46  ~NewtonBasic();
47 
51  virtual void declare_parameters(ParameterHandler& param);
52 
56  virtual void initialize(ParameterHandler& param);
57 
59 
61 
62 
68  virtual void solve(FEVector& u,
69  const FEVectors& in_vectors);
70 
72 
74  // DATA //
76 
78 
79 
85  static const Event bad_derivative;
86 
88 
89 private:
90 
92  // DATA //
94 
96 
97 
102  double weight;
103 
108  unsigned int step;
109 
111 
112 };
113 
114 } // AppFrame
115 
116 #endif