Nektar++
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
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 // 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 definition for Diagonal with Linear Subspace
33 //
34 ///////////////////////////////////////////////////////////////////////////////
35 
39 #include <LocalRegions/MatrixKey.h>
40 #include <math.h>
41 
42 namespace Nektar
43 {
44  namespace MultiRegions
45  {
46  /**
47  * Registers the class with the Factory.
48  */
49 
52  "FullLinearSpaceWithDiagonal",
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 
64  const boost::shared_ptr<GlobalLinSys> &plinsys,
65  const AssemblyMapSharedPtr &pLocToGloMap)
66  : Preconditioner(plinsys, pLocToGloMap)
67  {
68  }
69 
70  /**
71  *
72  */
74  {
77  }
78 
79  /**
80  *
81  */
83  {
84  m_linSpacePrecon->BuildPreconditioner();
85  m_diagonalPrecon->BuildPreconditioner();
86  }
87 
88 
89  /**
90  *
91  */
93  const Array<OneD, NekDouble>& pInput,
94  Array<OneD, NekDouble>& pOutput)
95  {
96 
97  Array<OneD, NekDouble> OutputDiag(pOutput.num_elements());
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,OutputDiag);
104  }
105 
106  }
107 }
108 
109 
110 
111 
112 
113 
boost::shared_ptr< AssemblyMap > m_locToGloMap
tBaseSharedPtr CreateInstance(tKey idKey BOOST_PP_COMMA_IF(MAX_PARAM) BOOST_PP_ENUM_BINARY_PARAMS(MAX_PARAM, tParam, x))
Create an instance of the class referred to by idKey.
Definition: NekFactory.hpp:162
boost::shared_ptr< AssemblyMap > AssemblyMapSharedPtr
Definition: AssemblyMap.h:53
PreconFactory & GetPreconFactory()
PreconditionerLinearWithDiag(const boost::shared_ptr< GlobalLinSys > &plinsys, const AssemblyMapSharedPtr &pLocToGloMap)
const boost::weak_ptr< GlobalLinSys > m_linsys
static PreconditionerSharedPtr create(const boost::shared_ptr< GlobalLinSys > &plinsys, const boost::shared_ptr< AssemblyMap > &pLocToGloMap)
Creates an instance of this class.
virtual void v_DoPreconditioner(const Array< OneD, NekDouble > &pInput, Array< OneD, NekDouble > &pOutput)
Apply a preconditioner to the conjugate gradient method.
tKey RegisterCreatorFunction(tKey idKey, CreatorFunction classCreator, tDescription pDesc="")
Register a class with the factory.
Definition: NekFactory.hpp:215