Nektar++
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Pages
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 // 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: Wrappers around Vmath routines using Array<OneD,T> as arugments
33 //
34 ///////////////////////////////////////////////////////////////////////////////
35 
36 #ifndef NEKTAR_LIB_LIBUTILITIES_BASSICUTILS_VECTORDISTMATHARRAY_HPP
37 #define NEKTAR_LIB_LIBUTILITIES_BASSICUTILS_VECTORDISTMATHARRAY_HPP
38 
42 
43 
44 namespace VDmath
45 {
46  using namespace Nektar;
47 
48  /// \brief
49  template<class T> T Ddot2(LibUtilities::CommSharedPtr& pComm, int n,
50  const Array<OneD, const T> &w,
51  const Array<OneD, const T> &x,
52  const Array<OneD, const int> &y)
53  {
54  ASSERTL1(n <= w.num_elements()+w.GetOffset(),"Array out of bounds");
55  ASSERTL1(n <= x.num_elements()+x.GetOffset(),"Array out of bounds");
56  ASSERTL1(n <= y.num_elements()+y.GetOffset(),"Array out of bounds");
57 
58  return Ddot2(pComm, n,&w[0],&x[0],&y[0]);
59  }
60 
61  /// \brief
62  template<class T> T Ddot2(LibUtilities::CommSharedPtr& pComm, int n,
63  const Array<OneD, const T> &w, const int incw,
64  const Array<OneD, const T> &x, const int incx,
65  const Array<OneD, const int> &y, const int incy)
66  {
67  ASSERTL1(n*incw <= w.num_elements()+w.GetOffset(),"Array out of bounds");
68  ASSERTL1(n*incx <= x.num_elements()+x.GetOffset(),"Array out of bounds");
69  ASSERTL1(n*incy <= y.num_elements()+y.GetOffset(),"Array out of bounds");
70 
71  return Ddot2(pComm, n,&w[0],incw,&x[0],incx,&y[0],incy);
72  }
73 
74 }
75 
76 #endif /* VDMATHARRAY_HPP_ */
boost::shared_ptr< Comm > CommSharedPtr
Pointer to a Communicator object.
Definition: Comm.h:55
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:45
#define ASSERTL1(condition, msg)
Assert Level 1 – Debugging which is used whether in FULLDEBUG or DEBUG compilation mode...
Definition: ErrorUtil.hpp:228