Nektar++
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
DriverArnoldi.h
Go to the documentation of this file.
1 ///////////////////////////////////////////////////////////////////////////////
2 //
3 // File DriverArnoldi.h
4 //
5 // For more information, please see: http://www.nektar.info
6 //
7 // The MIT License
8 //
9 // Copyright (c) 2006 Division of Applied Mathematics, Brown University (USA),
10 // Department of Aeronautics, Imperial College London (UK), and Scientific
11 // Computing and Imaging Institute, University of Utah (USA).
12 //
13 // License for the specific language governing rights and limitations under
14 // Permission is hereby granted, free of charge, to any person obtaining a
15 // copy of this software and associated documentation files (the "Software"),
16 // to deal in the Software without restriction, including without limitation
17 // the rights to use, copy, modify, merge, publish, distribute, sublicense,
18 // and/or sell copies of the Software, and to permit persons to whom the
19 // Software is furnished to do so, subject to the following conditions:
20 //
21 // The above copyright notice and this permission notice shall be included
22 // in all copies or substantial portions of the Software.
23 //
24 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
25 // OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
26 // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
27 // THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
28 // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
29 // FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
30 // DEALINGS IN THE SOFTWARE.
31 //
32 // Description: Base Driver class for the stability solver
33 //
34 ///////////////////////////////////////////////////////////////////////////////
35 
36 #ifndef NEKTAR_SOLVERUTILS_DRIVERARNOLDI_H
37 #define NEKTAR_SOLVERUTILS_DRIVERARNOLDI_H
38 
39 #include <SolverUtils/Driver.h>
40 
41 namespace Nektar
42 {
43  namespace SolverUtils
44  {
45  /// Base class for the development of solvers.
46  class DriverArnoldi: public Driver
47  {
48  public:
50 
51  SOLVER_UTILS_EXPORT void ArnoldiSummary(std::ostream &out);
52 
53  protected:
54  int m_kdim; /// Dimension of Krylov subspace
55  int m_nvec; /// Number of vectors to test
56  int m_nits; /// Maxmum number of iterations
57  NekDouble m_evtol;/// Tolerance of iteratiosn
58  NekDouble m_period;/// Period of time stepping algorithm
59  bool m_timeSteppingAlgorithm; /// underlying operator is time stepping
60 
61  int m_infosteps; /// interval to dump information if required.
62 
63  int m_nfields;
66 
67  Array<OneD, NekDouble> m_real_evl;
68  Array<OneD, NekDouble> m_imag_evl;
69 
70 
71  /// Constructor
73 
74  /// Destructor
75  virtual ~DriverArnoldi();
76 
77  /// Copy Arnoldi storage to fields.
78  void CopyArnoldiArrayToField(Array<OneD, NekDouble> &array);
79 
80  /// Copy fields to Arnoldi storage.
81  void CopyFieldToArnoldiArray(Array<OneD, NekDouble> &array);
82 
83  ///Copy the forward field to the adjoint system in transient growth calculations
84  void CopyFwdToAdj();
85 
86  // write coefficients to file.
87  void WriteFld(std::string file, std::vector<Array<OneD, NekDouble> > coeffs);
88 
89  void WriteFld(std::string file, Array<OneD, NekDouble> coeffs);
90 
91  void WriteEvs(ostream &evlout, const int k,
92  const NekDouble real, const NekDouble imag,
94 
95  virtual void v_InitObject(ostream &out = cout);
96 
97  virtual Array<OneD, NekDouble> v_GetRealEvl(void)
98  {
99  return m_real_evl;
100  }
101 
102  virtual Array<OneD, NekDouble> v_GetImagEvl(void)
103  {
104  return m_imag_evl;
105  }
106 
107  };
108  }
109 } //end of namespace
110 
111 #endif //NEKTAR_SOLVERUTILS_DRIVERARNOLDI_H
112