Nektar++
VDmathArray.hpp
Go to the documentation of this file.
1 ///////////////////////////////////////////////////////////////////////////////
2 //
3 // File VmathArray.hpp
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 // Permission is hereby granted, free of charge, to any person obtaining a
14 // copy of this software and associated documentation files (the "Software"),
15 // to deal in the Software without restriction, including without limitation
16 // the rights to use, copy, modify, merge, publish, distribute, sublicense,
17 // and/or sell copies of the Software, and to permit persons to whom the
18 // Software is furnished to do so, subject to the following conditions:
19 //
20 // The above copyright notice and this permission notice shall be included
21 // in all copies or substantial portions of the Software.
22 //
23 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
24 // OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
25 // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
26 // THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
27 // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
28 // FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
29 // DEALINGS IN THE SOFTWARE.
30 //
31 // Description: Wrappers around Vmath routines using Array<OneD,T> as arugments
32 //
33 ///////////////////////////////////////////////////////////////////////////////
34 
35 #ifndef NEKTAR_LIB_LIBUTILITIES_BASSICUTILS_VECTORDISTMATHARRAY_HPP
36 #define NEKTAR_LIB_LIBUTILITIES_BASSICUTILS_VECTORDISTMATHARRAY_HPP
37 
41 
42 
43 namespace VDmath
44 {
45  using namespace Nektar;
46 
47  /// \brief
48  template<class T> T Ddot2(LibUtilities::CommSharedPtr& pComm, int n,
49  const Array<OneD, const T> &w,
50  const Array<OneD, const T> &x,
51  const Array<OneD, const int> &y)
52  {
53  ASSERTL1(n <= w.size()+w.GetOffset(),"Array out of bounds");
54  ASSERTL1(n <= x.size()+x.GetOffset(),"Array out of bounds");
55  ASSERTL1(n <= y.size()+y.GetOffset(),"Array out of bounds");
56 
57  return Ddot2(pComm, n,&w[0],&x[0],&y[0]);
58  }
59 
60  /// \brief
61  template<class T> T Ddot2(LibUtilities::CommSharedPtr& pComm, int n,
62  const Array<OneD, const T> &w, const int incw,
63  const Array<OneD, const T> &x, const int incx,
64  const Array<OneD, const int> &y, const int incy)
65  {
66  ASSERTL1(n*incw <= w.size()+w.GetOffset(),"Array out of bounds");
67  ASSERTL1(n*incx <= x.size()+x.GetOffset(),"Array out of bounds");
68  ASSERTL1(n*incy <= y.size()+y.GetOffset(),"Array out of bounds");
69 
70  return Ddot2(pComm, n,&w[0],incw,&x[0],incx,&y[0],incy);
71  }
72 
73 }
74 
75 #endif /* VDMATHARRAY_HPP_ */
#define ASSERTL1(condition, msg)
Assert Level 1 – Debugging which is used whether in FULLDEBUG or DEBUG compilation mode....
Definition: ErrorUtil.hpp:250
std::shared_ptr< Comm > CommSharedPtr
Pointer to a Communicator object.
Definition: Comm.h:54
The above copyright notice and this permission notice shall be included.
Definition: CoupledSolver.h:1
T Ddot2(Nektar::LibUtilities::CommSharedPtr &pComm, int n, const T *w, const T *x, const int *y)
vvtvp (vector times vector times vector): z = w*x*y
Definition: VDmath.hpp:44