Stokhos Package Browser (Single Doxygen Collection)  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Stokhos_OrthogPolyExpansionBase.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_ORTHOGPOLYEXPANSIONBASE_HPP
11 #define STOKHOS_ORTHOGPOLYEXPANSIONBASE_HPP
12 
13 #include "Stokhos_OrthogPolyExpansion.hpp"
14 #include "Stokhos_DivisionExpansionStrategy.hpp"
15 
16 #include "Teuchos_RCP.hpp"
17 #include "Teuchos_ParameterList.hpp"
18 
19 namespace Stokhos {
20 
22 
26  template <typename ordinal_type, typename value_type, typename node_type>
27  class OrthogPolyExpansionBase :
28  public OrthogPolyExpansion<ordinal_type, value_type, node_type> {
29  public:
30 
32  OrthogPolyExpansionBase(
33  const Teuchos::RCP<const OrthogPolyBasis<ordinal_type, value_type> >& basis,
34  const Teuchos::RCP<const Stokhos::Sparse3Tensor<ordinal_type, value_type> >& Cijk,
35  const Teuchos::RCP<Teuchos::ParameterList>& params = Teuchos::null);
36 
38  virtual ~OrthogPolyExpansionBase() {}
39 
41  ordinal_type size() const { return sz; }
42 
44  Teuchos::RCP< const OrthogPolyBasis<ordinal_type, value_type> >
45  getBasis() const {return basis; }
46 
48  virtual Teuchos::RCP<const Sparse3Tensor<ordinal_type, value_type> >
49  getTripleProduct() const { return Cijk; }
50 
51  // Operations
52  void unaryMinus(
53  OrthogPolyApprox<ordinal_type, value_type, node_type>& c,
54  const OrthogPolyApprox<ordinal_type, value_type, node_type>& a);
55 
56  void plusEqual(
57  OrthogPolyApprox<ordinal_type, value_type, node_type>& c,
58  const value_type& x);
59  void minusEqual(
60  OrthogPolyApprox<ordinal_type, value_type, node_type>& c,
61  const value_type& x);
62  void timesEqual(
63  OrthogPolyApprox<ordinal_type, value_type, node_type>& c,
64  const value_type& x);
65  void divideEqual(
66  OrthogPolyApprox<ordinal_type, value_type, node_type>& c,
67  const value_type& x);
68 
69  void plusEqual(
70  OrthogPolyApprox<ordinal_type, value_type, node_type>& c,
71  const OrthogPolyApprox<ordinal_type, value_type, node_type>& x);
72  void minusEqual(
73  OrthogPolyApprox<ordinal_type, value_type, node_type>& c,
74  const OrthogPolyApprox<ordinal_type, value_type, node_type>& x);
75  void timesEqual(
76  OrthogPolyApprox<ordinal_type, value_type, node_type>& c,
77  const OrthogPolyApprox<ordinal_type, value_type, node_type>& x);
78  void divideEqual(
79  OrthogPolyApprox<ordinal_type, value_type, node_type>& c,
80  const OrthogPolyApprox<ordinal_type, value_type, node_type>& x);
81 
82  void plus(OrthogPolyApprox<ordinal_type, value_type, node_type>& c,
83  const OrthogPolyApprox<ordinal_type, value_type, node_type>& a,
84  const OrthogPolyApprox<ordinal_type, value_type, node_type>& b);
85  void plus(OrthogPolyApprox<ordinal_type, value_type, node_type>& c,
86  const value_type& a,
87  const OrthogPolyApprox<ordinal_type, value_type, node_type>& b);
88  void plus(OrthogPolyApprox<ordinal_type, value_type, node_type>& c,
89  const OrthogPolyApprox<ordinal_type, value_type, node_type>& a,
90  const value_type& b);
91  void minus(OrthogPolyApprox<ordinal_type, value_type, node_type>& c,
92  const OrthogPolyApprox<ordinal_type, value_type, node_type>& a,
93  const OrthogPolyApprox<ordinal_type, value_type, node_type>& b);
94  void minus(OrthogPolyApprox<ordinal_type, value_type, node_type>& c,
95  const value_type& a,
96  const OrthogPolyApprox<ordinal_type, value_type, node_type>& b);
97  void minus(OrthogPolyApprox<ordinal_type, value_type, node_type>& c,
98  const OrthogPolyApprox<ordinal_type, value_type, node_type>& a,
99  const value_type& b);
100  void times(OrthogPolyApprox<ordinal_type, value_type, node_type>& c,
101  const OrthogPolyApprox<ordinal_type, value_type, node_type>& a,
102  const OrthogPolyApprox<ordinal_type, value_type, node_type>& b);
103  void times(OrthogPolyApprox<ordinal_type, value_type, node_type>& c,
104  const value_type& a,
105  const OrthogPolyApprox<ordinal_type, value_type, node_type>& b);
106  void times(OrthogPolyApprox<ordinal_type, value_type, node_type>& c,
107  const OrthogPolyApprox<ordinal_type, value_type, node_type>& a,
108  const value_type& b);
109  void divide(OrthogPolyApprox<ordinal_type, value_type, node_type>& c,
110  const OrthogPolyApprox<ordinal_type, value_type, node_type>& a,
111  const OrthogPolyApprox<ordinal_type, value_type, node_type>& b);
112  void divide(OrthogPolyApprox<ordinal_type, value_type, node_type>& c,
113  const value_type& a,
114  const OrthogPolyApprox<ordinal_type, value_type, node_type>& b);
115  void divide(OrthogPolyApprox<ordinal_type, value_type, node_type>& c,
116  const OrthogPolyApprox<ordinal_type, value_type, node_type>& a,
117  const value_type& b);
118 
119 
120  void abs(OrthogPolyApprox<ordinal_type, value_type, node_type>& c,
121  const OrthogPolyApprox<ordinal_type, value_type, node_type>& a);
122  void fabs(OrthogPolyApprox<ordinal_type, value_type, node_type>& c,
123  const OrthogPolyApprox<ordinal_type, value_type, node_type>& a);
124  void max(OrthogPolyApprox<ordinal_type, value_type, node_type>& c,
125  const OrthogPolyApprox<ordinal_type, value_type, node_type>& a,
126  const OrthogPolyApprox<ordinal_type, value_type, node_type>& b);
127  void max(OrthogPolyApprox<ordinal_type, value_type, node_type>& c,
128  const value_type& a,
129  const OrthogPolyApprox<ordinal_type, value_type, node_type>& b);
130  void max(OrthogPolyApprox<ordinal_type, value_type, node_type>& c,
131  const OrthogPolyApprox<ordinal_type, value_type, node_type>& a,
132  const value_type& b);
133  void min(OrthogPolyApprox<ordinal_type, value_type, node_type>& c,
134  const OrthogPolyApprox<ordinal_type, value_type, node_type>& a,
135  const OrthogPolyApprox<ordinal_type, value_type, node_type>& b);
136  void min(OrthogPolyApprox<ordinal_type, value_type, node_type>& c,
137  const value_type& a,
138  const OrthogPolyApprox<ordinal_type, value_type, node_type>& b);
139  void min(OrthogPolyApprox<ordinal_type, value_type, node_type>& c,
140  const OrthogPolyApprox<ordinal_type, value_type, node_type>& a,
141  const value_type& b);
142 
143  private:
144 
145  // Prohibit copying
146  OrthogPolyExpansionBase(const OrthogPolyExpansionBase&);
147 
148  // Prohibit Assignment
149  OrthogPolyExpansionBase& operator=(const OrthogPolyExpansionBase& b);
150 
151  protected:
152 
154  Teuchos::RCP<const OrthogPolyBasis<ordinal_type, value_type> > basis;
155 
157  typedef Stokhos::Sparse3Tensor<ordinal_type, value_type> Cijk_type;
158 
160  Teuchos::RCP<const Stokhos::Sparse3Tensor<ordinal_type, value_type> > Cijk;
161 
163  Teuchos::RCP<Teuchos::ParameterList> params;
164 
166  Teuchos::RCP<Stokhos::DivisionExpansionStrategy<ordinal_type,value_type,node_type> > division_strategy;
167 
169  ordinal_type sz;
170 
171  }; // class OrthogPolyExpansionBase
172 
173 } // namespace Stokhos
174 
175 #include "Stokhos_OrthogPolyExpansionBaseImp.hpp"
176 
177 #endif // STOKHOS_ORTHOGPOLYEXPANSIONBASE_HPP
Stokhos::OrthogPolyExpansionBase::divideEqual
void divideEqual(OrthogPolyApprox< ordinal_type, value_type, node_type > &c, const value_type &x)
Definition: Stokhos_OrthogPolyExpansionBaseImp.hpp:144
Stokhos::OrthogPolyExpansionBase::basis
Teuchos::RCP< const OrthogPolyBasis< ordinal_type, value_type > > basis
Basis.
Definition: Stokhos_OrthogPolyExpansionBase.hpp:154
Stokhos_OrthogPolyExpansion.hpp
Stokhos::OrthogPolyExpansionBase::params
Teuchos::RCP< Teuchos::ParameterList > params
Parameter list.
Definition: Stokhos_OrthogPolyExpansionBase.hpp:163
Stokhos_OrthogPolyExpansionBaseImp.hpp
Stokhos::OrthogPolyExpansionBase::minusEqual
void minusEqual(OrthogPolyApprox< ordinal_type, value_type, node_type > &c, const value_type &x)
Definition: Stokhos_OrthogPolyExpansionBaseImp.hpp:120
Stokhos::OrthogPolyExpansionBase::operator=
OrthogPolyExpansionBase & operator=(const OrthogPolyExpansionBase &b)
Stokhos::Sparse3Tensor
Data structure storing a sparse 3-tensor C(i,j,k) in a a compressed format.
Definition: Stokhos_Sparse3Tensor.hpp:24
Stokhos::OrthogPolyExpansionBase::getBasis
Teuchos::RCP< const OrthogPolyBasis< ordinal_type, value_type > > getBasis() const
Get basis.
Definition: Stokhos_OrthogPolyExpansionBase.hpp:45
Stokhos::OrthogPolyExpansionBase::divide
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)
Definition: Stokhos_OrthogPolyExpansionBaseImp.hpp:567
Stokhos::OrthogPolyExpansionBase::size
ordinal_type size() const
Get expansion size.
Definition: Stokhos_OrthogPolyExpansionBase.hpp:41
Stokhos::OrthogPolyExpansionBase::division_strategy
Teuchos::RCP< Stokhos::DivisionExpansionStrategy< ordinal_type, value_type, node_type > > division_strategy
Division expansion strategy.
Definition: Stokhos_OrthogPolyExpansionBase.hpp:166
Stokhos::OrthogPolyExpansionBase
Base class for consolidating common expansion implementations.
Definition: Stokhos_OrthogPolyExpansionBase.hpp:27
Stokhos::OrthogPolyExpansionBase::timesEqual
void timesEqual(OrthogPolyApprox< ordinal_type, value_type, node_type > &c, const value_type &x)
Definition: Stokhos_OrthogPolyExpansionBaseImp.hpp:129
Stokhos::OrthogPolyExpansionBase::max
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)
Definition: Stokhos_OrthogPolyExpansionBaseImp.hpp:635
Stokhos::OrthogPolyExpansionBase::plusEqual
void plusEqual(OrthogPolyApprox< ordinal_type, value_type, node_type > &c, const value_type &x)
Definition: Stokhos_OrthogPolyExpansionBaseImp.hpp:111
Stokhos::OrthogPolyExpansionBase::getTripleProduct
virtual Teuchos::RCP< const Sparse3Tensor< ordinal_type, value_type > > getTripleProduct() const
Get triple product.
Definition: Stokhos_OrthogPolyExpansionBase.hpp:49
Stokhos::OrthogPolyExpansion
Abstract base class for orthogonal polynomial-based expansions.
Definition: Stokhos_OrthogPolyExpansion.hpp:25
Stokhos_DivisionExpansionStrategy.hpp
Stokhos::OrthogPolyBasis
Abstract base class for multivariate orthogonal polynomials.
Definition: Stokhos_OrthogPolyBasis.hpp:40
Teuchos_ParameterList.hpp
Stokhos::OrthogPolyExpansionBase::min
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)
Definition: Stokhos_OrthogPolyExpansionBaseImp.hpp:687
Stokhos::OrthogPolyExpansionBase::plus
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)
Definition: Stokhos_OrthogPolyExpansionBaseImp.hpp:292
Stokhos::OrthogPolyExpansionBase::minus
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)
Definition: Stokhos_OrthogPolyExpansionBaseImp.hpp:370
Stokhos::OrthogPolyExpansionBase::times
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)
Definition: Stokhos_OrthogPolyExpansionBaseImp.hpp:448
Stokhos::OrthogPolyApprox
Class to store coefficients of a projection onto an orthogonal polynomial basis.
Definition: Stokhos_OrthogPolyApprox.hpp:29
Stokhos::OrthogPolyExpansionBase::abs
void abs(OrthogPolyApprox< ordinal_type, value_type, node_type > &c, const OrthogPolyApprox< ordinal_type, value_type, node_type > &a)
Definition: Stokhos_OrthogPolyExpansionBaseImp.hpp:622
Stokhos::OrthogPolyExpansionBase::Cijk
Teuchos::RCP< const Stokhos::Sparse3Tensor< ordinal_type, value_type > > Cijk
Triple-product tensor.
Definition: Stokhos_OrthogPolyExpansionBase.hpp:160
Stokhos::OrthogPolyExpansionBase::Cijk_type
Stokhos::Sparse3Tensor< ordinal_type, value_type > Cijk_type
Short-hand for Cijk.
Definition: Stokhos_OrthogPolyExpansionBase.hpp:157
Stokhos::OrthogPolyExpansionBase::unaryMinus
void unaryMinus(OrthogPolyApprox< ordinal_type, value_type, node_type > &c, const OrthogPolyApprox< ordinal_type, value_type, node_type > &a)
Definition: Stokhos_OrthogPolyExpansionBaseImp.hpp:89
Teuchos_RCP.hpp
Stokhos::OrthogPolyExpansionBase::fabs
void fabs(OrthogPolyApprox< ordinal_type, value_type, node_type > &c, const OrthogPolyApprox< ordinal_type, value_type, node_type > &a)
Definition: Stokhos_OrthogPolyExpansionBaseImp.hpp:609
Stokhos::OrthogPolyExpansionBase::OrthogPolyExpansionBase
OrthogPolyExpansionBase(const Teuchos::RCP< const OrthogPolyBasis< ordinal_type, value_type > > &basis, const Teuchos::RCP< const Stokhos::Sparse3Tensor< ordinal_type, value_type > > &Cijk, const Teuchos::RCP< Teuchos::ParameterList > &params=Teuchos::null)
Constructor.
Definition: Stokhos_OrthogPolyExpansionBaseImp.hpp:21
Generated by   doxygen 1.8.5