Nektar++
PreconditionerLinear.h
Go to the documentation of this file.
1 ///////////////////////////////////////////////////////////////////////////////
2 //
3 // File Preconditioner.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: Preconditioner header
33 //
34 ///////////////////////////////////////////////////////////////////////////////
35 #ifndef NEKTAR_LIB_MULTIREGIONS_PRECONDITIONERLINEAR_H
36 #define NEKTAR_LIB_MULTIREGIONS_PRECONDITIONERLINEAR_H
41 #include <LocalRegions/TetExp.h>
42 #include <LocalRegions/PrismExp.h>
43 
44 
45 namespace Nektar
46 {
47  namespace MultiRegions
48  {
50  {
53  };
54 
56  typedef boost::shared_ptr<PreconditionerLinear> PreconditionerLinearSharedPtr;
57 
59  {
60  public:
61  /// Creates an instance of this class
63  const boost::shared_ptr<GlobalLinSys> &plinsys,
64  const boost::shared_ptr<AssemblyMap>
65  &pLocToGloMap)
66  {
68  p->InitObject();
69  return p;
70  }
71 
72  /// Name of class
73  static std::string className1;
74 
76  const boost::shared_ptr<GlobalLinSys> &plinsys,
77  const AssemblyMapSharedPtr &pLocToGloMap);
78 
80  virtual ~PreconditionerLinear() {}
81 
82  protected:
84  boost::shared_ptr<AssemblyMap> m_vertLocToGloMap;
85 
86  private:
87  static std::string solveType;
88  static std::string solveTypeIds[];
89 
90  virtual void v_InitObject();
91 
92 
94  const Array<OneD, NekDouble>& pInput,
95  Array<OneD, NekDouble>& pOutput,
96  const Array<OneD, NekDouble>& pNonVertOutput,
97  Array<OneD, NekDouble>& pVertForce);
98 
99  virtual void v_DoPreconditioner(
100  const Array<OneD, NekDouble>& pInput,
101  Array<OneD, NekDouble>& pOutput);
102 
103  virtual void v_BuildPreconditioner();
104 
105  };
106  }
107 }
108 
109 #endif
virtual void v_DoPreconditioner(const Array< OneD, NekDouble > &pInput, Array< OneD, NekDouble > &pOutput)
Apply a preconditioner to the conjugate gradient method.
static boost::shared_ptr< DataType > AllocateSharedPtr()
Allocate a shared pointer from the memory pool.
boost::shared_ptr< AssemblyMap > AssemblyMapSharedPtr
Definition: AssemblyMap.h:53
virtual void v_DoPreconditionerWithNonVertOutput(const Array< OneD, NekDouble > &pInput, Array< OneD, NekDouble > &pOutput, const Array< OneD, NekDouble > &pNonVertOutput, Array< OneD, NekDouble > &pVertForce)
Apply a preconditioner to the conjugate gradient method with an output for non-vertex degrees of free...
static std::string className1
Name of class.
boost::shared_ptr< PreconditionerLinear > PreconditionerLinearSharedPtr
#define MULTI_REGIONS_EXPORT
boost::shared_ptr< Preconditioner > PreconditionerSharedPtr
boost::shared_ptr< AssemblyMap > m_vertLocToGloMap
PreconditionerLinear(const boost::shared_ptr< GlobalLinSys > &plinsys, const AssemblyMapSharedPtr &pLocToGloMap)
static PreconditionerSharedPtr create(const boost::shared_ptr< GlobalLinSys > &plinsys, const boost::shared_ptr< AssemblyMap > &pLocToGloMap)
Creates an instance of this class.
boost::shared_ptr< GlobalLinSys > GlobalLinSysSharedPtr
Pointer to a GlobalLinSys object.
Definition: GlobalLinSys.h:51