Nektar++
PreconditionerBlock.h
Go to the documentation of this file.
1 ///////////////////////////////////////////////////////////////////////////////
2 //
3 // File PreconditionerBlock.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: Block Preconditioner header
33 //
34 ///////////////////////////////////////////////////////////////////////////////
35 #ifndef NEKTAR_LIB_MULTIREGIONS_PRECONDITIONERBLOCK_H
36 #define NEKTAR_LIB_MULTIREGIONS_PRECONDITIONERBLOCK_H
41 #include <LocalRegions/TetExp.h>
42 #include <LocalRegions/PrismExp.h>
43 
44 namespace Nektar
45 {
46  namespace MultiRegions
47  {
49  typedef boost::shared_ptr<PreconditionerBlock>
51 
53  {
54  public:
55  /// Creates an instance of this class
57  const boost::shared_ptr<GlobalLinSys> &plinsys,
58  const boost::shared_ptr<AssemblyMap>
59  &pLocToGloMap)
60  {
62  ::AllocateSharedPtr(plinsys,pLocToGloMap);
63  p->InitObject();
64  return p;
65  }
66 
67  /// Name of class
68  static std::string className;
69 
71  const boost::shared_ptr<GlobalLinSys> &plinsys,
72  const AssemblyMapSharedPtr &pLocToGloMap);
73 
75  virtual ~PreconditionerBlock() {}
76 
77  protected:
78  const boost::weak_ptr<GlobalLinSys> m_linsys;
81  boost::shared_ptr<AssemblyMap> m_locToGloMap;
82 
83  private:
84  void BlockPreconditionerCG(void);
85  void BlockPreconditionerHDG(void);
86 
87  virtual void v_InitObject();
88  virtual void v_DoPreconditioner(
89  const Array<OneD, NekDouble>& pInput,
90  Array<OneD, NekDouble>& pOutput);
91  virtual void v_BuildPreconditioner();
92  };
93  }
94 }
95 
96 #endif
virtual void v_DoPreconditioner(const Array< OneD, NekDouble > &pInput, Array< OneD, NekDouble > &pOutput)
Apply preconditioner to pInput and store the result in pOutput.
static boost::shared_ptr< DataType > AllocateSharedPtr()
Allocate a shared pointer from the memory pool.
boost::shared_ptr< AssemblyMap > AssemblyMapSharedPtr
Definition: AssemblyMap.h:53
static std::string className
Name of class.
#define MULTI_REGIONS_EXPORT
boost::shared_ptr< Preconditioner > PreconditionerSharedPtr
void BlockPreconditionerHDG(void)
Construct a block preconditioner for the hybridized discontinuous Galerkin system.
static PreconditionerSharedPtr create(const boost::shared_ptr< GlobalLinSys > &plinsys, const boost::shared_ptr< AssemblyMap > &pLocToGloMap)
Creates an instance of this class.
boost::shared_ptr< AssemblyMap > m_locToGloMap
boost::shared_ptr< PreconditionerBlock > PreconditionerBlockSharedPtr
boost::shared_ptr< DNekBlkMat > DNekBlkMatSharedPtr
Definition: NekTypeDefs.hpp:72
void BlockPreconditionerCG(void)
Construct a block preconditioner from for the continuous Galerkin system.
const boost::weak_ptr< GlobalLinSys > m_linsys
PreconditionerBlock(const boost::shared_ptr< GlobalLinSys > &plinsys, const AssemblyMapSharedPtr &pLocToGloMap)