Nektar++
NekLinSysIter.cpp
Go to the documentation of this file.
1///////////////////////////////////////////////////////////////////////////////
2//
3// File: NekLinSysIter.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: NekLinSysIter definition
33//
34///////////////////////////////////////////////////////////////////////////////
35
37
38using namespace std;
39
41{
42/**
43 * @class NekLinSysIter
44 *
45 * Solves a linear system using iterative methods.
46 */
48{
49 static NekLinSysIterFactory instance;
50 return instance;
51}
52
55 const LibUtilities::CommSharedPtr &vRowComm, const int nDimen,
56 const NekSysKey &pKey)
57 : NekSys(pSession, vRowComm, nDimen, pKey)
58{
61 m_isLocal = false;
62}
63
65{
68}
69
71{
72 int nmap = map.size();
73 if (m_map.size() != nmap)
74 {
75 m_map = Array<OneD, int>(nmap, 0);
76 }
77 Vmath::Vcopy(nmap, map, 1, m_map, 1);
78}
79
81{
83}
84
86{
87 NekDouble vExchange(0.0);
88 vExchange = Vmath::Dot2(pIn.GetDimension(), &pIn[0], &pIn[0], &m_map[0]);
89 m_rowComm->AllReduce(vExchange, LibUtilities::ReduceSum);
90 m_rhs_magnitude = (vExchange > 1.0e-6) ? vExchange : 1.0;
91}
92
94{
95 NekDouble vExchange(0.0);
96 Array<OneD, NekDouble> wk(pIn.size());
98 vExchange = Vmath::Dot(pIn.size(), wk, pIn);
99 m_rowComm->AllReduce(vExchange, LibUtilities::ReduceSum);
100 m_rhs_magnitude = (vExchange > 1e-6) ? vExchange : 1.0;
101}
102
103} // namespace Nektar::LibUtilities
Provides a generic Factory class.
Definition: NekFactory.hpp:104
NekDouble m_rhs_magnitude
Dot product of rhs to normalise stopping criterion.
void Set_Rhs_Magnitude(const NekVector< NekDouble > &pIn)
NekLinSysIter(const LibUtilities::SessionReaderSharedPtr &pSession, const LibUtilities::CommSharedPtr &vRowComm, const int nDimen, const NekSysKey &pKey)
Array< OneD, int > m_map
Global to universal unique map.
LibUtilities::CommSharedPtr m_rowComm
Communicate.
Definition: NekSys.h:293
virtual void v_InitObject()
Definition: NekSys.h:306
NekSysOperators m_operator
Operators.
Definition: NekSys.h:302
int m_SysDimen
The dimension of the system.
Definition: NekSys.h:304
int m_maxiter
Maximum iterations.
Definition: NekSys.h:289
void DoAssembleLoc(InArrayType &xn, OutArrayType &xn1, const bool &flag=false) const
Definition: NekSys.h:161
unsigned int GetDimension() const
Returns the number of dimensions for the point.
Definition: NekVector.cpp:201
std::shared_ptr< SessionReader > SessionReaderSharedPtr
NekLinSysIterFactory & GetNekLinSysIterFactory()
std::shared_ptr< Comm > CommSharedPtr
Pointer to a Communicator object.
Definition: Comm.h:55
double NekDouble
T Dot2(int n, const T *w, const T *x, const int *y)
dot product
Definition: Vmath.hpp:790
T Dot(int n, const T *w, const T *x)
dot product
Definition: Vmath.hpp:761
void Vcopy(int n, const T *x, const int incx, T *y, const int incy)
Definition: Vmath.hpp:825