Nektar++
PreconditionerLinearWithDiag.cpp
Go to the documentation of this file.
1 ///////////////////////////////////////////////////////////////////////////////
2 //
3 // File: PreconditionerLinearWithDiag.cpp
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 // Permission is hereby granted, free of charge, to any person obtaining a
14 // copy of this software and associated documentation files (the "Software"),
15 // to deal in the Software without restriction, including without limitation
16 // the rights to use, copy, modify, merge, publish, distribute, sublicense,
17 // and/or sell copies of the Software, and to permit persons to whom the
18 // Software is furnished to do so, subject to the following conditions:
19 //
20 // The above copyright notice and this permission notice shall be included
21 // in all copies or substantial portions of the Software.
22 //
23 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
24 // OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
25 // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
26 // THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
27 // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
28 // FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
29 // DEALINGS IN THE SOFTWARE.
30 //
31 // Description: Preconditioner definition for Diagonal with Linear Subspace
32 //
33 ///////////////////////////////////////////////////////////////////////////////
34 
36 #include <LocalRegions/MatrixKey.h>
39 #include <cmath>
40 
41 using namespace std;
42 
43 namespace Nektar
44 {
45 namespace MultiRegions
46 {
47 /**
48  * Registers the class with the Factory.
49  */
50 
51 string PreconditionerLinearWithDiag::className =
53  "FullLinearSpaceWithDiagonal", PreconditionerLinearWithDiag::create,
54  "Full linear space and diagonal preconditioning");
55 
56 /**
57  * @class PreconditionerLinearWithDiag
58  *
59  * This class implements preconditioning for the conjugate
60  * gradient matrix solver.
61  */
62 
63 PreconditionerLinearWithDiag::PreconditionerLinearWithDiag(
64  const std::shared_ptr<GlobalLinSys> &plinsys,
65  const AssemblyMapSharedPtr &pLocToGloMap)
66  : Preconditioner(plinsys, pLocToGloMap)
67 {
68 }
69 
70 /**
71  *
72  */
74 {
76  "FullLinearSpace", m_linsys.lock(), m_locToGloMap.lock());
78  "Diagonal", m_linsys.lock(), m_locToGloMap.lock());
79 }
80 
81 /**
82  *
83  */
85 {
86  m_linSpacePrecon->BuildPreconditioner();
87  m_diagonalPrecon->BuildPreconditioner();
88 }
89 
90 /**
91  *
92  */
94  const Array<OneD, NekDouble> &pInput, Array<OneD, NekDouble> &pOutput)
95 {
96 
97  Array<OneD, NekDouble> OutputDiag(pOutput.size());
98  m_diagonalPrecon->DoPreconditioner(pInput, OutputDiag);
99 
100  // Since linear preconditioner just copies other entries
101  // this will only modify the linear space degrees of
102  // freedom
103  m_linSpacePrecon->DoPreconditionerWithNonVertOutput(pInput, pOutput,
104  OutputDiag);
105 }
106 
107 } // namespace MultiRegions
108 } // namespace Nektar
tKey RegisterCreatorFunction(tKey idKey, CreatorFunction classCreator, std::string pDesc="")
Register a class with the factory.
Definition: NekFactory.hpp:198
tBaseSharedPtr CreateInstance(tKey idKey, tParam... args)
Create an instance of the class referred to by idKey.
Definition: NekFactory.hpp:144
const std::weak_ptr< GlobalLinSys > m_linsys
std::weak_ptr< AssemblyMap > m_locToGloMap
virtual void v_DoPreconditioner(const Array< OneD, NekDouble > &pInput, Array< OneD, NekDouble > &pOutput) override
Apply a preconditioner to the conjugate gradient method.
PreconFactory & GetPreconFactory()
std::shared_ptr< AssemblyMap > AssemblyMapSharedPtr
Definition: AssemblyMap.h:51
The above copyright notice and this permission notice shall be included.
Definition: CoupledSolver.h:2