Nektar++
PreconditionerLowEnergy.h
Go to the documentation of this file.
1 ///////////////////////////////////////////////////////////////////////////////
2 //
3 // File Preconditioner.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: Preconditioner header
33 //
34 ///////////////////////////////////////////////////////////////////////////////
35 #ifndef NEKTAR_LIB_MULTIREGIONS_PRECONDITIONERLOWENERGY_H
36 #define NEKTAR_LIB_MULTIREGIONS_PRECONDITIONERLOWENERGY_H
41 #include <LocalRegions/TetExp.h>
42 #include <LocalRegions/PrismExp.h>
43 #include <LocalRegions/HexExp.h>
44 
45 
46 namespace Nektar
47 {
48  namespace MultiRegions
49  {
51  typedef boost::shared_ptr<PreconditionerLowEnergy> PreconditionerLowEnergySharedPtr;
52 
54  {
55  public:
56  /// Creates an instance of this class
58  const boost::shared_ptr<GlobalLinSys> &plinsys,
59  const boost::shared_ptr<AssemblyMap>
60  &pLocToGloMap)
61  {
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 
76 
77  protected:
78 
79  const boost::weak_ptr<GlobalLinSys> m_linsys;
80  boost::shared_ptr<AssemblyMap> m_locToGloMap;
81 
84 
89 
94 
99 
104 
108 
109  private:
110 
111  void SetUpReferenceElements(void);
112 
113  void CreateMultiplicityMap(void);
114 
116 
120  DNekMatSharedPtr Rmodprism,
121  DNekMatSharedPtr RTmodprism);
122 
126 
127  virtual void v_InitObject();
128 
129  virtual void v_DoPreconditioner(
130  const Array<OneD, NekDouble>& pInput,
131  Array<OneD, NekDouble>& pOutput);
132 
133  virtual void v_DoTransformToLowEnergy(
134  Array<OneD, NekDouble>& pInOut,
135  int offset);
136 
137  virtual void v_DoTransformToLowEnergy(
138  const Array<OneD, NekDouble>& pInput,
139  Array<OneD, NekDouble>& pOutput);
140 
141  virtual void v_DoTransformFromLowEnergy(
142  Array<OneD, NekDouble>& pInOut);
143 
145  const Array<OneD, NekDouble>& pInput,
146  Array<OneD, NekDouble>& pOutput);
147 
149  const Array<OneD, NekDouble>& pInput,
150  Array<OneD, NekDouble>& pOutput);
151 
152  virtual void v_BuildPreconditioner();
153 
154  virtual DNekScalMatSharedPtr
155  v_TransformedSchurCompl(int offset, const boost::shared_ptr<DNekScalMat > &loc_mat);
156  };
157  }
158 }
159 
160 #endif
virtual void v_DoPreconditioner(const Array< OneD, NekDouble > &pInput, Array< OneD, NekDouble > &pOutput)
PreconditionerLowEnergy(const boost::shared_ptr< GlobalLinSys > &plinsys, const AssemblyMapSharedPtr &pLocToGloMap)
virtual void v_DoMultiplybyInverseTransposedTransformationMatrix(const Array< OneD, NekDouble > &pInput, Array< OneD, NekDouble > &pOutput)
Multiply by the block tranposed inverse transformation matrix.
static boost::shared_ptr< DataType > AllocateSharedPtr()
Allocate a shared pointer from the memory pool.
boost::shared_ptr< AssemblyMap > AssemblyMapSharedPtr
Definition: AssemblyMap.h:53
#define MULTI_REGIONS_EXPORT
boost::shared_ptr< Preconditioner > PreconditionerSharedPtr
boost::shared_ptr< HexGeom > HexGeomSharedPtr
Definition: HexGeom.h:110
boost::shared_ptr< DNekMat > DNekMatSharedPtr
Definition: NekTypeDefs.hpp:70
boost::shared_ptr< TetExp > TetExpSharedPtr
Definition: TetExp.h:234
boost::shared_ptr< DNekScalMat > DNekScalMatSharedPtr
SpatialDomains::HexGeomSharedPtr CreateRefHexGeom(void)
Sets up the reference hexahedral element needed to construct a low energy basis.
virtual DNekScalMatSharedPtr v_TransformedSchurCompl(int offset, const boost::shared_ptr< DNekScalMat > &loc_mat)
Set up the transformed block matrix system.
virtual void v_BuildPreconditioner()
Construct the low energy preconditioner from .
void SetUpReferenceElements(void)
Sets up the reference elements needed by the preconditioner.
static PreconditionerSharedPtr create(const boost::shared_ptr< GlobalLinSys > &plinsys, const boost::shared_ptr< AssemblyMap > &pLocToGloMap)
Creates an instance of this class.
boost::shared_ptr< PreconditionerLowEnergy > PreconditionerLowEnergySharedPtr
boost::shared_ptr< DNekScalBlkMat > DNekScalBlkMatSharedPtr
Definition: NekTypeDefs.hpp:74
virtual void v_DoTransformToLowEnergy(Array< OneD, NekDouble > &pInOut, int offset)
Transform the solution vector vector to low energy.
boost::shared_ptr< PrismExp > PrismExpSharedPtr
Definition: PrismExp.h:226
virtual void v_DoMultiplybyInverseTransformationMatrix(const Array< OneD, NekDouble > &pInput, Array< OneD, NekDouble > &pOutput)
Multiply by the block inverse transformation matrix.
virtual void v_DoTransformFromLowEnergy(Array< OneD, NekDouble > &pInOut)
transform the solution vector from low energy back to the original basis.
SpatialDomains::TetGeomSharedPtr CreateRefTetGeom(void)
Sets up the reference tretrahedral element needed to construct a low energy basis.
boost::shared_ptr< DNekBlkMat > DNekBlkMatSharedPtr
Definition: NekTypeDefs.hpp:72
void ModifyPrismTransformationMatrix(LocalRegions::TetExpSharedPtr TetExp, LocalRegions::PrismExpSharedPtr PrismExp, DNekMatSharedPtr Rmodprism, DNekMatSharedPtr RTmodprism)
Modify the prism transformation matrix to align with the tetrahedral modes.
boost::shared_ptr< PrismGeom > PrismGeomSharedPtr
Definition: PrismGeom.h:109
boost::shared_ptr< TetGeom > TetGeomSharedPtr
Definition: TetGeom.h:106
SpatialDomains::PrismGeomSharedPtr CreateRefPrismGeom(void)
Sets up the reference prismatic element needed to construct a low energy basis.
const boost::weak_ptr< GlobalLinSys > m_linsys