Nektar++
GlobalLinSysIterativeFull.h
Go to the documentation of this file.
1 ///////////////////////////////////////////////////////////////////////////////
2 //
3 // File GlobalLinSysIterativeFull.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: GlobalLinSysIterativeFull header
33 //
34 ///////////////////////////////////////////////////////////////////////////////
35 #ifndef NEKTAR_LIB_MULTIREGIONS_GLOBALLINSYSIterativeCG_H
36 #define NEKTAR_LIB_MULTIREGIONS_GLOBALLINSYSIterativeCG_H
37 
39 
40 namespace Nektar
41 {
42  namespace MultiRegions
43  {
44  // Forward declarations
45  class ExpList;
46 
47  /// A global linear system.
49  {
50  public:
51  /// Creates an instance of this class
53  const GlobalLinSysKey &pLinSysKey,
54  const boost::weak_ptr<ExpList> &pExpList,
55  const boost::shared_ptr<AssemblyMap>
56  &pLocToGloMap)
57  {
59  ::AllocateSharedPtr(pLinSysKey, pExpList, pLocToGloMap);
60  }
61 
62  /// Name of class
63  static std::string className;
64 
65  /// Constructor for full direct matrix solve.
67  const GlobalLinSysKey &pLinSysKey,
68  const boost::weak_ptr<ExpList> &pExpList,
69  const boost::shared_ptr<AssemblyMap>
70  &pLocToGloMap);
71 
73 
74  private:
75  // Local to global map.
76  boost::shared_ptr<AssemblyMap> m_locToGloMap;
77 
78  /// Solve the linear system for given input and output vectors
79  /// using a specified local to global map.
80  virtual void v_Solve(
83  const AssemblyMapSharedPtr &locToGloMap,
84  const Array<OneD, const NekDouble> &dirForcing
86 
87  virtual void v_DoMatrixMultiply(
88  const Array<OneD, NekDouble>& pInput,
89  Array<OneD, NekDouble>& pOutput);
90 
91  virtual void v_UniqueMap();
92 
93  };
94  }
95 }
96 
97 #endif
static Array< OneD, NekDouble > NullNekDouble1DArray
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
Describe a linear system.
boost::shared_ptr< GlobalLinSys > GlobalLinSysSharedPtr
Pointer to a GlobalLinSys object.
Definition: GlobalLinSys.h:51
GlobalLinSysIterativeFull(const GlobalLinSysKey &pLinSysKey, const boost::weak_ptr< ExpList > &pExpList, const boost::shared_ptr< AssemblyMap > &pLocToGloMap)
Constructor for full direct matrix solve.
static GlobalLinSysSharedPtr create(const GlobalLinSysKey &pLinSysKey, const boost::weak_ptr< ExpList > &pExpList, const boost::shared_ptr< AssemblyMap > &pLocToGloMap)
Creates an instance of this class.
virtual void v_Solve(const Array< OneD, const NekDouble > &in, Array< OneD, NekDouble > &out, const AssemblyMapSharedPtr &locToGloMap, const Array< OneD, const NekDouble > &dirForcing=NullNekDouble1DArray)
Solve the linear system for given input and output vectors using a specified local to global map...
virtual void v_DoMatrixMultiply(const Array< OneD, NekDouble > &pInput, Array< OneD, NekDouble > &pOutput)