Nektar++
DriverArpack.h
Go to the documentation of this file.
1 ///////////////////////////////////////////////////////////////////////////////
2 //
3 // File DriverArpack.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: Driver class for the stability solver using Arpack
33 //
34 ///////////////////////////////////////////////////////////////////////////////
35 
36 #ifndef NEKTAR_SOLVERUTILS_DRIVERARPACK_H
37 #define NEKTAR_SOLVERUTILS_DRIVERARPACK_H
38 
40 
42 
43 namespace Nektar
44 {
45 namespace SolverUtils
46 {
47 
48 /// Base class for the development of solvers.
50 {
51 public:
52  friend class MemoryManager<DriverArpack>;
53 
54  /// Creates an instance of this class
57  p->InitObject();
58  return p;
59  }
60 
61  ///Name of the class
62  static std::string className;
63 
64 
65 
66 protected:
67  int m_maxn;//Maximum size of the problem
68  int m_maxnev;//maximum number of eigenvalues requested
69  int m_maxncv;//Largest number of basis vector used in Implicitly Restarted Arnoldi
70 
71  /// Constructor
73 
74  /// Destructor
75  virtual ~DriverArpack();
76 
77  /// Virtual function for initialisation implementation.
78  virtual void v_InitObject(ostream &out = cout);
79 
80  /// Virtual function for solve implementation.
81  virtual void v_Execute(ostream &out = cout);
82 
83  static std::string arpackProblemTypeLookupIds[];
84  static std::string arpackProblemTypeDefault;
85  static std::string driverLookupId;
86 
87 private:
88  static std::string ArpackProblemTypeTrans[];
89 };
90 
91 }
92 } //end of namespace
93 
94 #endif //NEKTAR_SOLVERUTILS_DRIVERARPACK_H
95 
virtual ~DriverArpack()
Destructor.
boost::shared_ptr< Driver > DriverSharedPtr
A shared pointer to a Driver object.
Definition: Driver.h:52
static boost::shared_ptr< DataType > AllocateSharedPtr()
Allocate a shared pointer from the memory pool.
General purpose memory allocation routines with the ability to allocate from thread specific memory p...
Base class for the development of solvers.
Definition: DriverArpack.h:49
boost::shared_ptr< SessionReader > SessionReaderSharedPtr
Definition: MeshPartition.h:50
static std::string arpackProblemTypeLookupIds[]
Definition: DriverArpack.h:83
DriverArpack(const LibUtilities::SessionReaderSharedPtr pSession)
Constructor.
static std::string ArpackProblemTypeTrans[]
Definition: DriverArpack.h:88
static std::string driverLookupId
Definition: DriverArpack.h:85
static std::string arpackProblemTypeDefault
Definition: DriverArpack.h:84
static DriverSharedPtr create(const LibUtilities::SessionReaderSharedPtr &pSession)
Creates an instance of this class.
Definition: DriverArpack.h:55
virtual void v_Execute(ostream &out=cout)
Virtual function for solve implementation.
virtual void v_InitObject(ostream &out=cout)
Virtual function for initialisation implementation.
Base class for the development of solvers.
Definition: DriverArnoldi.h:47
static std::string className
Name of the class.
Definition: DriverArpack.h:62