Nektar++
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Pages
DriverStandard.h
Go to the documentation of this file.
1 ///////////////////////////////////////////////////////////////////////////////
2 //
3 // File AdvectionTerm.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
33 //
34 ///////////////////////////////////////////////////////////////////////////////
35 
36 #ifndef NEKTAR_SOLVERUTILS_DRIVERSTANDARD_H
37 #define NEKTAR_SOLVERUTILS_DRIVERSTANDARD_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 DriverStandard: public Driver
47  {
48  public:
50 
51  /// Creates an instance of this class
54  p->InitObject();
55  return p;
56  }
57 
58  ///Name of the class
59  static std::string className;
60 
61  protected:
62  /// Constructor
64 
65  /// Destructor
67 
68  /// Second-stage initialisation
69  SOLVER_UTILS_EXPORT virtual void v_InitObject(std::ostream &out = std::cout);
70 
71  /// Virtual function for solve implementation.
72  SOLVER_UTILS_EXPORT virtual void v_Execute(std::ostream &out = std::cout);
73 
74  static std::string driverLookupId;
75  };
76  }
77 } //end of namespace
78 
79 #endif //NEKTAR_SOLVERUTILS_DRIVERSTANDARD_H
80 
static std::string className
Name of the class.
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.
boost::shared_ptr< SessionReader > SessionReaderSharedPtr
Definition: MeshPartition.h:51
virtual SOLVER_UTILS_EXPORT void v_InitObject(std::ostream &out=std::cout)
Second-stage initialisation.
virtual SOLVER_UTILS_EXPORT void v_Execute(std::ostream &out=std::cout)
Virtual function for solve implementation.
SOLVER_UTILS_EXPORT DriverStandard(const LibUtilities::SessionReaderSharedPtr pSession)
Constructor.
virtual SOLVER_UTILS_EXPORT ~DriverStandard()
Destructor.
#define SOLVER_UTILS_EXPORT
Base class for the development of solvers.
Definition: Driver.h:65
static DriverSharedPtr create(const LibUtilities::SessionReaderSharedPtr &pSession)
Creates an instance of this class.