Nektar++
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties 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 using namespace std;
43 
44 namespace Nektar
45 {
46  namespace MultiRegions
47  {
48  /**
49  * Registers the class with the Factory.
50  */
51 
52  string PreconditionerLinearWithDiag::className
54  "FullLinearSpaceWithDiagonal",
55  PreconditionerLinearWithDiag::create,
56  "Full linear space and diagonal preconditioning");
57 
58  /**
59  * @class PreconditionerLinearWithDiag
60  *
61  * This class implements preconditioning for the conjugate
62  * gradient matrix solver.
63  */
64 
65  PreconditionerLinearWithDiag::PreconditionerLinearWithDiag(
66  const boost::shared_ptr<GlobalLinSys> &plinsys,
67  const AssemblyMapSharedPtr &pLocToGloMap)
68  : Preconditioner(plinsys, pLocToGloMap)
69  {
70  }
71 
72  /**
73  *
74  */
76  {
79  }
80 
81  /**
82  *
83  */
85  {
86  m_linSpacePrecon->BuildPreconditioner();
87  m_diagonalPrecon->BuildPreconditioner();
88  }
89 
90 
91  /**
92  *
93  */
95  const Array<OneD, NekDouble>& pInput,
96  Array<OneD, NekDouble>& pOutput)
97  {
98 
99  Array<OneD, NekDouble> OutputDiag(pOutput.num_elements());
100  m_diagonalPrecon->DoPreconditioner(pInput, OutputDiag);
101 
102  // Since linear preconditioner just copies other entries
103  // this will only modify the linear space degrees of
104  // freedom
105  m_linSpacePrecon->DoPreconditionerWithNonVertOutput(pInput, pOutput,OutputDiag);
106  }
107 
108  }
109 }
110 
111 
112 
113 
114 
115 
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()
STL namespace.
const boost::weak_ptr< GlobalLinSys > m_linsys
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