Nektar++
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 
46 /// Base class for the development of solvers.
47 class DriverArnoldi: public Driver
48 {
49 public:
51 
52  SOLVER_UTILS_EXPORT void ArnoldiSummary(std::ostream &out);
53 
54 protected:
55  int m_kdim; /// Dimension of Krylov subspace
56  int m_nvec; /// Number of vectors to test
57  int m_nits; /// Maxmum number of iterations
58  NekDouble m_evtol; /// Tolerance of iteratiosn
59  NekDouble m_period;/// Period of time stepping algorithm
60  bool m_timeSteppingAlgorithm; /// underlying operator is time stepping
61 
62  int m_infosteps; /// interval to dump information if required.
63 
64  int m_nfields;
67  int m_negatedOp; /// Operator in solve call is negated
68 
71 
72 
73  /// Constructor
75 
76  /// Destructor
77  virtual ~DriverArnoldi();
78 
79  /// Copy Arnoldi storage to fields.
81 
82  /// Copy fields to Arnoldi storage.
84 
85  /// Copy the forward field to the adjoint system in transient growth
86  /// calculations
87  void CopyFwdToAdj();
88 
89  /// Write coefficients to file
90  void WriteFld(std::string file,
91  std::vector<Array<OneD, NekDouble> > coeffs);
92 
93  void WriteFld(std::string file, Array<OneD, NekDouble> coeffs);
94 
95  void WriteEvs(ostream &evlout, const int k,
96  const NekDouble real, const NekDouble imag,
98  bool DumpInverse = true);
99 
100  virtual void v_InitObject(ostream &out = cout);
101 
103  {
104  return m_real_evl;
105  }
106 
108  {
109  return m_imag_evl;
110  }
111 
112 };
113 
114 }
115 } //end of namespace
116 
117 #endif //NEKTAR_SOLVERUTILS_DRIVERARNOLDI_H
Array< OneD, NekDouble > m_imag_evl
Definition: DriverArnoldi.h:70
DriverArnoldi(const LibUtilities::SessionReaderSharedPtr pSession)
Constructor.
void CopyFwdToAdj()
Copy the forward field to the adjoint system in transient growth calculations.
NekDouble m_evtol
Maxmum number of iterations.
Definition: DriverArnoldi.h:58
void CopyArnoldiArrayToField(Array< OneD, NekDouble > &array)
Copy Arnoldi storage to fields.
General purpose memory allocation routines with the ability to allocate from thread specific memory p...
SOLVER_UTILS_EXPORT void ArnoldiSummary(std::ostream &out)
void CopyFieldToArnoldiArray(Array< OneD, NekDouble > &array)
Copy fields to Arnoldi storage.
boost::shared_ptr< SessionReader > SessionReaderSharedPtr
Definition: MeshPartition.h:50
void WriteFld(std::string file, std::vector< Array< OneD, NekDouble > > coeffs)
Write coefficients to file.
virtual ~DriverArnoldi()
Destructor.
virtual Array< OneD, NekDouble > v_GetRealEvl(void)
int m_nvec
Dimension of Krylov subspace.
Definition: DriverArnoldi.h:56
Array< OneD, NekDouble > m_real_evl
Operator in solve call is negated.
Definition: DriverArnoldi.h:69
double NekDouble
static const NekDouble kNekUnsetDouble
int m_nfields
interval to dump information if required.
Definition: DriverArnoldi.h:64
bool m_timeSteppingAlgorithm
Period of time stepping algorithm.
Definition: DriverArnoldi.h:60
void WriteEvs(ostream &evlout, const int k, const NekDouble real, const NekDouble imag, NekDouble resid=NekConstants::kNekUnsetDouble, bool DumpInverse=true)
#define SOLVER_UTILS_EXPORT
NekDouble m_period
Tolerance of iteratiosn.
Definition: DriverArnoldi.h:59
int m_infosteps
underlying operator is time stepping
Definition: DriverArnoldi.h:62
Base class for the development of solvers.
Definition: DriverArnoldi.h:47
Base class for the development of solvers.
Definition: Driver.h:65
virtual Array< OneD, NekDouble > v_GetImagEvl(void)
virtual void v_InitObject(ostream &out=cout)
int m_nits
Number of vectors to test.
Definition: DriverArnoldi.h:57