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 2605 2014-08-15 03:36:44Z secanell $
14 //
15 // ----------------------------------------------------------------------------
16 
17 #ifndef _DEALII_APPFRAME_NEWTON_BASIC_H_
18 #define _DEALII_APPFRAME_NEWTON_BASIC_H_
19 
20 #include <solvers/newton_base.h>
21 
22 namespace FuelCell
23 {
24  namespace ApplicationCore
25  {
26 
33  class NewtonBasic : public newtonBase
34  {
35  public:
36 
38 
39 
44 
48  ~NewtonBasic();
49 
53  virtual void declare_parameters(ParameterHandler& param);
54 
58  virtual void initialize(ParameterHandler& param);
59 
61 
63 
64 
70  virtual void solve(FEVector& u,
71  const FEVectors& in_vectors);
72 
74 
76  // DATA //
78 
80 
81 
87  static const Event bad_derivative;
88 
90 
91  private:
92 
94  // DATA //
96 
98 
99 
104  double weight;
105 
107 
108  };
109 
110  }
111 }
112 
113 #endif
virtual void initialize(ParameterHandler &param)
Initialize parameters.
This class performs basic Newton iterations with a constant weight.
Definition: newton_basic.h:33
SmartPointer< ApplicationBase > app
Pointer to the application this one depends upon.
Definition: application_wrapper.h:106
static const Event bad_derivative
This event is set if the convergence becomes bad.
Definition: newton_basic.h:87
virtual void declare_parameters(ParameterHandler &param)
Declare parameters.
Base class for applications.
Definition: application_base.h:113
Base class for all classes performing Newton&#39;s iteration.
Definition: newton_base.h:156
NewtonBasic(ApplicationBase &app)
Constructor.
virtual void solve(FEVector &u, const FEVectors &in_vectors)
This function implements basic Newton iterations with a constant weight.
double weight
A constant weight is the same for all basic Newton iterations.
Definition: newton_basic.h:104
Objects of this kind are used to notify interior applications of changes provoked by an outer loop...
Definition: event.h:51
BlockVector< double > FEVector
The vector class used by applications.
Definition: application_data.h:46
The data type used in function calls of Application.
Definition: fe_vectors.h:59