Nektar++
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Pages
PreconditionerLinearWithLowEnergy.cpp
Go to the documentation of this file.
1 ///////////////////////////////////////////////////////////////////////////////
2 //
3 // File Preconditioner.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
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 PreconditionerLinearWithLowEnergy::className
54  "FullLinearSpaceWithLowEnergyBlock",
55  PreconditionerLinearWithLowEnergy::create,
56  "Full Linear space and low energy block preconditioning");
57 
58  /**
59  * @class PreconditionerLinearWithLowEnergy
60  *
61  * This class implements preconditioning for the conjugate
62  * gradient matrix solver.
63  */
64 
65  PreconditionerLinearWithLowEnergy::PreconditionerLinearWithLowEnergy(
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  Array<OneD, NekDouble>& pInOut,
86  int offset)
87  {
88  m_lowEnergyPrecon->DoTransformToLowEnergy(pInOut,offset);
89  }
90 
91  /**
92  *
93  */
95  Array<OneD, NekDouble>& pInput)
96  {
97  m_lowEnergyPrecon->DoTransformFromLowEnergy(pInput);
98  }
99 
100 
102  v_TransformedSchurCompl(int offset, const boost::shared_ptr<DNekScalMat > &loc_mat)
103  {
104  DNekScalMatSharedPtr returnval;
105  returnval=m_lowEnergyPrecon->TransformedSchurCompl(offset,loc_mat);
106  return returnval;
107  }
108 
109  /**
110  *
111  */
113  {
114  m_linSpacePrecon->BuildPreconditioner();
115  m_lowEnergyPrecon->BuildPreconditioner();
116  }
117 
118 
119  /**
120  *
121  */
123  const Array<OneD, NekDouble>& pInput,
124  Array<OneD, NekDouble>& pOutput)
125  {
126  int nGlobal = pInput.num_elements();
127 
128  Array<OneD, NekDouble> OutputLowEnergy(nGlobal, 0.0);
129  Array<OneD, NekDouble> tmp(nGlobal, 0.0);
130  Array<OneD, NekDouble> OutputLinear(nGlobal, 0.0);
131  Array<OneD, NekDouble> InputLinear(nGlobal, 0.0);
132 
133  //Apply Low Energy preconditioner
134  m_lowEnergyPrecon->DoPreconditioner(pInput, OutputLowEnergy);
135 
136  //Transform input from low energy to original basis
137  m_lowEnergyPrecon->DoMultiplybyInverseTransformationMatrix(pInput, InputLinear);
138 
139  //Apply linear space preconditioner
140  m_linSpacePrecon->DoPreconditionerWithNonVertOutput(InputLinear, OutputLinear, tmp);
141 
142  m_lowEnergyPrecon->DoMultiplybyInverseTransposedTransformationMatrix(OutputLinear,pOutput);
143 
144  Vmath::Vadd(nGlobal,pOutput,1,OutputLowEnergy,1,pOutput,1);
145  }
146 
147  }
148 }
149 
150 
151 
152 
153 
154 
boost::shared_ptr< AssemblyMap > m_locToGloMap
virtual void v_DoTransformToLowEnergy(Array< OneD, NekDouble > &pInOut, int offset)
Transform from original basis to low energy basis.
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.
boost::shared_ptr< DNekScalMat > DNekScalMatSharedPtr
const boost::weak_ptr< GlobalLinSys > m_linsys
virtual void v_DoTransformFromLowEnergy(Array< OneD, NekDouble > &pInput)
Transform from low energy basis to orignal basis.
virtual DNekScalMatSharedPtr v_TransformedSchurCompl(int offset, const boost::shared_ptr< DNekScalMat > &loc_mat)
Get block elemental transposed transformation matrix .
virtual void v_DoPreconditioner(const Array< OneD, NekDouble > &pInput, Array< OneD, NekDouble > &pOutput)
Apply a preconditioner to the conjugate gradient method.
void Vadd(int n, const T *x, const int incx, const T *y, const int incy, T *z, const int incz)
Add vector z = x+y.
Definition: Vmath.cpp:299
tKey RegisterCreatorFunction(tKey idKey, CreatorFunction classCreator, tDescription pDesc="")
Register a class with the factory.
Definition: NekFactory.hpp:215