Stokhos Package Browser (Single Doxygen Collection)  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Stokhos_OrthogPolyExpansion.hpp
Go to the documentation of this file.
1 // @HEADER
2 // *****************************************************************************
3 // Stokhos Package
4 //
5 // Copyright 2009 NTESS and the Stokhos contributors.
6 // SPDX-License-Identifier: BSD-3-Clause
7 // *****************************************************************************
8 // @HEADER
9 
10 #ifndef STOKHOS_ORTHOGPOLYEXPANSION_HPP
11 #define STOKHOS_ORTHOGPOLYEXPANSION_HPP
12 
13 #include <cmath>
14 #include <algorithm> // for std::min and std::max
15 
16 #include "Stokhos_OrthogPolyApprox.hpp"
17 #include "Stokhos_OrthogPolyBasis.hpp"
18 
19 namespace Stokhos {
20 
22  template <typename ordinal_type, typename value_type,
23  typename node_type = Stokhos::StandardStorage<ordinal_type,
24  value_type> >
25  class OrthogPolyExpansion {
26  public:
27 
29  typedef Sparse3Tensor<ordinal_type, value_type> tp_type;
30 
32  OrthogPolyExpansion() {}
33 
35  virtual ~OrthogPolyExpansion() {}
36 
38  virtual ordinal_type size() const = 0;
39 
41  virtual Teuchos::RCP<const OrthogPolyBasis<ordinal_type, value_type> >
42  getBasis() const = 0;
43 
45  virtual Teuchos::RCP<const Sparse3Tensor<ordinal_type, value_type> >
46  getTripleProduct() const = 0;
47 
48  // Operations
49  virtual void unaryMinus(
50  OrthogPolyApprox<ordinal_type, value_type, node_type>& c,
51  const OrthogPolyApprox<ordinal_type, value_type, node_type>& a) = 0;
52 
53  virtual void plusEqual(
54  OrthogPolyApprox<ordinal_type, value_type, node_type>& c,
55  const value_type& x) = 0;
56  virtual void minusEqual(
57  OrthogPolyApprox<ordinal_type, value_type, node_type>& c,
58  const value_type& x) = 0;
59  virtual void timesEqual(
60  OrthogPolyApprox<ordinal_type, value_type, node_type>& c,
61  const value_type& x) = 0;
62  virtual void divideEqual(
63  OrthogPolyApprox<ordinal_type, value_type, node_type>& c,
64  const value_type& x) = 0;
65 
66  virtual void plusEqual(
67  OrthogPolyApprox<ordinal_type, value_type, node_type>& c,
68  const OrthogPolyApprox<ordinal_type, value_type, node_type>& x) = 0;
69  virtual void minusEqual(
70  OrthogPolyApprox<ordinal_type, value_type, node_type>& c,
71  const OrthogPolyApprox<ordinal_type, value_type, node_type>& x) = 0;
72  virtual void timesEqual(
73  OrthogPolyApprox<ordinal_type, value_type, node_type>& c,
74  const OrthogPolyApprox<ordinal_type, value_type, node_type>& x) = 0;
75  virtual void divideEqual(
76  OrthogPolyApprox<ordinal_type, value_type, node_type>& c,
77  const OrthogPolyApprox<ordinal_type, value_type, node_type>& x) = 0;
78 
79  virtual void plus(
80  OrthogPolyApprox<ordinal_type, value_type, node_type>& c,
81  const OrthogPolyApprox<ordinal_type, value_type, node_type>& a,
82  const OrthogPolyApprox<ordinal_type, value_type, node_type>& b) = 0;
83  virtual void plus(
84  OrthogPolyApprox<ordinal_type, value_type, node_type>& c,
85  const value_type& a,
86  const OrthogPolyApprox<ordinal_type, value_type, node_type>& b) = 0;
87  virtual void plus(
88  OrthogPolyApprox<ordinal_type, value_type, node_type>& c,
89  const OrthogPolyApprox<ordinal_type, value_type, node_type>& a,
90  const value_type& b) = 0;
91  virtual void minus(
92  OrthogPolyApprox<ordinal_type, value_type, node_type>& c,
93  const OrthogPolyApprox<ordinal_type, value_type, node_type>& a,
94  const OrthogPolyApprox<ordinal_type, value_type, node_type>& b) = 0;
95  virtual void minus(
96  OrthogPolyApprox<ordinal_type, value_type, node_type>& c,
97  const value_type& a,
98  const OrthogPolyApprox<ordinal_type, value_type, node_type>& b) = 0;
99  virtual void minus(
100  OrthogPolyApprox<ordinal_type, value_type, node_type>& c,
101  const OrthogPolyApprox<ordinal_type, value_type, node_type>& a,
102  const value_type& b) = 0;
103  virtual void times(
104  OrthogPolyApprox<ordinal_type, value_type, node_type>& c,
105  const OrthogPolyApprox<ordinal_type, value_type, node_type>& a,
106  const OrthogPolyApprox<ordinal_type, value_type, node_type>& b) = 0;
107  virtual void times(
108  OrthogPolyApprox<ordinal_type, value_type, node_type>& c,
109  const value_type& a,
110  const OrthogPolyApprox<ordinal_type, value_type, node_type>& b) = 0;
111  virtual void times(
112  OrthogPolyApprox<ordinal_type, value_type, node_type>& c,
113  const OrthogPolyApprox<ordinal_type, value_type, node_type>& a,
114  const value_type& b) = 0;
115  virtual void divide(
116  OrthogPolyApprox<ordinal_type, value_type, node_type>& c,
117  const OrthogPolyApprox<ordinal_type, value_type, node_type>& a,
118  const OrthogPolyApprox<ordinal_type, value_type, node_type>& b) = 0;
119  virtual void divide(
120  OrthogPolyApprox<ordinal_type, value_type, node_type>& c,
121  const value_type& a,
122  const OrthogPolyApprox<ordinal_type, value_type, node_type>& b) = 0;
123  virtual void divide(
124  OrthogPolyApprox<ordinal_type, value_type, node_type>& c,
125  const OrthogPolyApprox<ordinal_type, value_type, node_type>& a,
126  const value_type& b) = 0;
127 
128  virtual void exp(
129  OrthogPolyApprox<ordinal_type, value_type, node_type>& c,
130  const OrthogPolyApprox<ordinal_type, value_type, node_type>& a) = 0;
131  virtual void log(
132  OrthogPolyApprox<ordinal_type, value_type, node_type>& c,
133  const OrthogPolyApprox<ordinal_type, value_type, node_type>& a) = 0;
134  virtual void log10(
135  OrthogPolyApprox<ordinal_type, value_type, node_type>& c,
136  const OrthogPolyApprox<ordinal_type, value_type, node_type>& a) = 0;
137  virtual void sqrt(
138  OrthogPolyApprox<ordinal_type, value_type, node_type>& c,
139  const OrthogPolyApprox<ordinal_type, value_type, node_type>& a) = 0;
140  virtual void cbrt(
141  OrthogPolyApprox<ordinal_type, value_type, node_type>& c,
142  const OrthogPolyApprox<ordinal_type, value_type, node_type>& a) = 0;
143  virtual void pow(
144  OrthogPolyApprox<ordinal_type, value_type, node_type>& c,
145  const OrthogPolyApprox<ordinal_type, value_type, node_type>& a,
146  const OrthogPolyApprox<ordinal_type, value_type, node_type>& b) = 0;
147  virtual void pow(
148  OrthogPolyApprox<ordinal_type, value_type, node_type>& c,
149  const value_type& a,
150  const OrthogPolyApprox<ordinal_type, value_type, node_type>& b) = 0;
151  virtual void pow(
152  OrthogPolyApprox<ordinal_type, value_type, node_type>& c,
153  const OrthogPolyApprox<ordinal_type, value_type, node_type>& a,
154  const value_type& b) = 0;
155  virtual void cos(
156  OrthogPolyApprox<ordinal_type, value_type, node_type>& c,
157  const OrthogPolyApprox<ordinal_type, value_type, node_type>& a) = 0;
158  virtual void sin(
159  OrthogPolyApprox<ordinal_type, value_type, node_type>& c,
160  const OrthogPolyApprox<ordinal_type, value_type, node_type>& a) = 0;
161  virtual void tan(
162  OrthogPolyApprox<ordinal_type, value_type, node_type>& c,
163  const OrthogPolyApprox<ordinal_type, value_type, node_type>& a) = 0;
164  virtual void cosh(
165  OrthogPolyApprox<ordinal_type, value_type, node_type>& c,
166  const OrthogPolyApprox<ordinal_type, value_type, node_type>& a) = 0;
167  virtual void sinh(
168  OrthogPolyApprox<ordinal_type, value_type, node_type>& c,
169  const OrthogPolyApprox<ordinal_type, value_type, node_type>& a) = 0;
170  virtual void tanh(
171  OrthogPolyApprox<ordinal_type, value_type, node_type>& c,
172  const OrthogPolyApprox<ordinal_type, value_type, node_type>& a) = 0;
173  virtual void acos(
174  OrthogPolyApprox<ordinal_type, value_type, node_type>& c,
175  const OrthogPolyApprox<ordinal_type, value_type, node_type>& a) = 0;
176  virtual void asin(
177  OrthogPolyApprox<ordinal_type, value_type, node_type>& c,
178  const OrthogPolyApprox<ordinal_type, value_type, node_type>& a) = 0;
179  virtual void atan(
180  OrthogPolyApprox<ordinal_type, value_type, node_type>& c,
181  const OrthogPolyApprox<ordinal_type, value_type, node_type>& a) = 0;
182 // virtual void atan2(OrthogPolyApprox<ordinal_type, value_type, node_type>& c,
183 // const OrthogPolyApprox<ordinal_type, value_type, node_type>& a,
184 // const OrthogPolyApprox<ordinal_type, value_type, node_type>& b) = 0;
185 // virtual void atan2(OrthogPolyApprox<ordinal_type, value_type, node_type>& c,
186 // const T& a,
187 // const OrthogPolyApprox<ordinal_type, value_type, node_type>& b) = 0;
188 // virtual void atan2(OrthogPolyApprox<ordinal_type, value_type, node_type>& c,
189 // const OrthogPolyApprox<ordinal_type, value_type, node_type>& a,
190 // const T& b) = 0;
191  virtual void acosh(
192  OrthogPolyApprox<ordinal_type, value_type, node_type>& c,
193  const OrthogPolyApprox<ordinal_type, value_type, node_type>& a) = 0;
194  virtual void asinh(
195  OrthogPolyApprox<ordinal_type, value_type, node_type>& c,
196  const OrthogPolyApprox<ordinal_type, value_type, node_type>& a) = 0;
197  virtual void atanh(
198  OrthogPolyApprox<ordinal_type, value_type, node_type>& c,
199  const OrthogPolyApprox<ordinal_type, value_type, node_type>& a) = 0;
200  virtual void abs(
201  OrthogPolyApprox<ordinal_type, value_type, node_type>& c,
202  const OrthogPolyApprox<ordinal_type, value_type, node_type>& a) = 0;
203  virtual void fabs(
204  OrthogPolyApprox<ordinal_type, value_type, node_type>& c,
205  const OrthogPolyApprox<ordinal_type, value_type, node_type>& a) = 0;
206  virtual void max(
207  OrthogPolyApprox<ordinal_type, value_type, node_type>& c,
208  const OrthogPolyApprox<ordinal_type, value_type, node_type>& a,
209  const OrthogPolyApprox<ordinal_type, value_type, node_type>& b) = 0;
210  virtual void max(
211  OrthogPolyApprox<ordinal_type, value_type, node_type>& c,
212  const value_type& a,
213  const OrthogPolyApprox<ordinal_type, value_type, node_type>& b) = 0;
214  virtual void max(
215  OrthogPolyApprox<ordinal_type, value_type, node_type>& c,
216  const OrthogPolyApprox<ordinal_type, value_type, node_type>& a,
217  const value_type& b) = 0;
218  virtual void min(
219  OrthogPolyApprox<ordinal_type, value_type, node_type>& c,
220  const OrthogPolyApprox<ordinal_type, value_type, node_type>& a,
221  const OrthogPolyApprox<ordinal_type, value_type, node_type>& b) = 0;
222  virtual void min(
223  OrthogPolyApprox<ordinal_type, value_type, node_type>& c,
224  const value_type& a,
225  const OrthogPolyApprox<ordinal_type, value_type, node_type>& b) = 0;
226  virtual void min(
227  OrthogPolyApprox<ordinal_type, value_type, node_type>& c,
228  const OrthogPolyApprox<ordinal_type, value_type, node_type>& a,
229  const value_type& b) = 0;
230 
231  private:
232 
233  // Prohibit copying
234  OrthogPolyExpansion(const OrthogPolyExpansion&);
235 
236  // Prohibit Assignment
237  OrthogPolyExpansion& operator=(const OrthogPolyExpansion& b);
238 
239  }; // class OrthogPolyExpansion
240 
241 } // namespace Stokhos
242 
243 #endif // STOKHOS_ORTHOGPOLYEXPANSION_HPP
Stokhos::OrthogPolyExpansion::fabs
virtual void fabs(OrthogPolyApprox< ordinal_type, value_type, node_type > &c, const OrthogPolyApprox< ordinal_type, value_type, node_type > &a)=0
Stokhos::OrthogPolyExpansion::acos
virtual void acos(OrthogPolyApprox< ordinal_type, value_type, node_type > &c, const OrthogPolyApprox< ordinal_type, value_type, node_type > &a)=0
Stokhos::OrthogPolyExpansion::tanh
virtual void tanh(OrthogPolyApprox< ordinal_type, value_type, node_type > &c, const OrthogPolyApprox< ordinal_type, value_type, node_type > &a)=0
Stokhos::OrthogPolyExpansion::plus
virtual void plus(OrthogPolyApprox< ordinal_type, value_type, node_type > &c, const OrthogPolyApprox< ordinal_type, value_type, node_type > &a, const OrthogPolyApprox< ordinal_type, value_type, node_type > &b)=0
Stokhos::Sparse3Tensor
Data structure storing a sparse 3-tensor C(i,j,k) in a a compressed format.
Definition: Stokhos_Sparse3Tensor.hpp:24
Stokhos::OrthogPolyExpansion::sinh
virtual void sinh(OrthogPolyApprox< ordinal_type, value_type, node_type > &c, const OrthogPolyApprox< ordinal_type, value_type, node_type > &a)=0
Stokhos::OrthogPolyExpansion::cbrt
virtual void cbrt(OrthogPolyApprox< ordinal_type, value_type, node_type > &c, const OrthogPolyApprox< ordinal_type, value_type, node_type > &a)=0
Stokhos::OrthogPolyExpansion::asinh
virtual void asinh(OrthogPolyApprox< ordinal_type, value_type, node_type > &c, const OrthogPolyApprox< ordinal_type, value_type, node_type > &a)=0
Stokhos::OrthogPolyExpansion::cosh
virtual void cosh(OrthogPolyApprox< ordinal_type, value_type, node_type > &c, const OrthogPolyApprox< ordinal_type, value_type, node_type > &a)=0
Stokhos::OrthogPolyExpansion::size
virtual ordinal_type size() const =0
Get expansion size.
Stokhos::OrthogPolyExpansion::divide
virtual void divide(OrthogPolyApprox< ordinal_type, value_type, node_type > &c, const OrthogPolyApprox< ordinal_type, value_type, node_type > &a, const OrthogPolyApprox< ordinal_type, value_type, node_type > &b)=0
Stokhos::OrthogPolyExpansion::timesEqual
virtual void timesEqual(OrthogPolyApprox< ordinal_type, value_type, node_type > &c, const value_type &x)=0
Stokhos::OrthogPolyExpansion::tp_type
Sparse3Tensor< ordinal_type, value_type > tp_type
Typename of TripleProduct tensor.
Definition: Stokhos_OrthogPolyExpansion.hpp:29
Stokhos::OrthogPolyExpansion::plusEqual
virtual void plusEqual(OrthogPolyApprox< ordinal_type, value_type, node_type > &c, const value_type &x)=0
node_type
Kokkos::Serial node_type
Definition: Stokhos_SacadoTraitsUnitTest.cpp:29
Stokhos::OrthogPolyExpansion
Abstract base class for orthogonal polynomial-based expansions.
Definition: Stokhos_OrthogPolyExpansion.hpp:25
Stokhos::OrthogPolyExpansion::operator=
OrthogPolyExpansion & operator=(const OrthogPolyExpansion &b)
Stokhos::OrthogPolyExpansion::tan
virtual void tan(OrthogPolyApprox< ordinal_type, value_type, node_type > &c, const OrthogPolyApprox< ordinal_type, value_type, node_type > &a)=0
Stokhos::OrthogPolyExpansion::pow
virtual void pow(OrthogPolyApprox< ordinal_type, value_type, node_type > &c, const OrthogPolyApprox< ordinal_type, value_type, node_type > &a, const OrthogPolyApprox< ordinal_type, value_type, node_type > &b)=0
Stokhos::OrthogPolyExpansion::cos
virtual void cos(OrthogPolyApprox< ordinal_type, value_type, node_type > &c, const OrthogPolyApprox< ordinal_type, value_type, node_type > &a)=0
Stokhos::OrthogPolyExpansion::minus
virtual void minus(OrthogPolyApprox< ordinal_type, value_type, node_type > &c, const OrthogPolyApprox< ordinal_type, value_type, node_type > &a, const OrthogPolyApprox< ordinal_type, value_type, node_type > &b)=0
Stokhos_OrthogPolyApprox.hpp
Stokhos::OrthogPolyExpansion::max
virtual void max(OrthogPolyApprox< ordinal_type, value_type, node_type > &c, const OrthogPolyApprox< ordinal_type, value_type, node_type > &a, const OrthogPolyApprox< ordinal_type, value_type, node_type > &b)=0
Stokhos::OrthogPolyExpansion::sin
virtual void sin(OrthogPolyApprox< ordinal_type, value_type, node_type > &c, const OrthogPolyApprox< ordinal_type, value_type, node_type > &a)=0
Stokhos::OrthogPolyExpansion::log10
virtual void log10(OrthogPolyApprox< ordinal_type, value_type, node_type > &c, const OrthogPolyApprox< ordinal_type, value_type, node_type > &a)=0
Stokhos_OrthogPolyBasis.hpp
Stokhos::OrthogPolyApprox
Class to store coefficients of a projection onto an orthogonal polynomial basis.
Definition: Stokhos_OrthogPolyApprox.hpp:29
Stokhos::OrthogPolyExpansion::log
virtual void log(OrthogPolyApprox< ordinal_type, value_type, node_type > &c, const OrthogPolyApprox< ordinal_type, value_type, node_type > &a)=0
Stokhos::OrthogPolyExpansion::asin
virtual void asin(OrthogPolyApprox< ordinal_type, value_type, node_type > &c, const OrthogPolyApprox< ordinal_type, value_type, node_type > &a)=0
Stokhos::OrthogPolyExpansion::minusEqual
virtual void minusEqual(OrthogPolyApprox< ordinal_type, value_type, node_type > &c, const value_type &x)=0
Stokhos::OrthogPolyExpansion::min
virtual void min(OrthogPolyApprox< ordinal_type, value_type, node_type > &c, const OrthogPolyApprox< ordinal_type, value_type, node_type > &a, const OrthogPolyApprox< ordinal_type, value_type, node_type > &b)=0
Stokhos::OrthogPolyExpansion::sqrt
virtual void sqrt(OrthogPolyApprox< ordinal_type, value_type, node_type > &c, const OrthogPolyApprox< ordinal_type, value_type, node_type > &a)=0
Stokhos::OrthogPolyExpansion::abs
virtual void abs(OrthogPolyApprox< ordinal_type, value_type, node_type > &c, const OrthogPolyApprox< ordinal_type, value_type, node_type > &a)=0
Stokhos::OrthogPolyExpansion::divideEqual
virtual void divideEqual(OrthogPolyApprox< ordinal_type, value_type, node_type > &c, const value_type &x)=0
Stokhos::OrthogPolyExpansion::acosh
virtual void acosh(OrthogPolyApprox< ordinal_type, value_type, node_type > &c, const OrthogPolyApprox< ordinal_type, value_type, node_type > &a)=0
Stokhos::OrthogPolyExpansion::getBasis
virtual Teuchos::RCP< const OrthogPolyBasis< ordinal_type, value_type > > getBasis() const =0
Get basis.
Stokhos::OrthogPolyExpansion::atan
virtual void atan(OrthogPolyApprox< ordinal_type, value_type, node_type > &c, const OrthogPolyApprox< ordinal_type, value_type, node_type > &a)=0
Stokhos::OrthogPolyExpansion::unaryMinus
virtual void unaryMinus(OrthogPolyApprox< ordinal_type, value_type, node_type > &c, const OrthogPolyApprox< ordinal_type, value_type, node_type > &a)=0
Stokhos::OrthogPolyExpansion::times
virtual void times(OrthogPolyApprox< ordinal_type, value_type, node_type > &c, const OrthogPolyApprox< ordinal_type, value_type, node_type > &a, const OrthogPolyApprox< ordinal_type, value_type, node_type > &b)=0
Stokhos::OrthogPolyExpansion::exp
virtual void exp(OrthogPolyApprox< ordinal_type, value_type, node_type > &c, const OrthogPolyApprox< ordinal_type, value_type, node_type > &a)=0
Stokhos::OrthogPolyExpansion::getTripleProduct
virtual Teuchos::RCP< const Sparse3Tensor< ordinal_type, value_type > > getTripleProduct() const =0
Get triple product.
Stokhos::OrthogPolyExpansion::atanh
virtual void atanh(OrthogPolyApprox< ordinal_type, value_type, node_type > &c, const OrthogPolyApprox< ordinal_type, value_type, node_type > &a)=0
Generated on Fri Nov 22 2024 09:18:13 for Stokhos Package Browser (Single Doxygen Collection) by   doxygen 1.8.5