Stokhos Package Browser (Single Doxygen Collection) Version of the Day
Loading...
Searching...
No Matches
Stokhos_GrowthRules.hpp
Go to the documentation of this file.
1// @HEADER
2// ***********************************************************************
3//
4// Stokhos Package
5// Copyright (2009) Sandia Corporation
6//
7// Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
8// license for use of this work by or on behalf of the U.S. Government.
9//
10// Redistribution and use in source and binary forms, with or without
11// modification, are permitted provided that the following conditions are
12// met:
13//
14// 1. Redistributions of source code must retain the above copyright
15// notice, this list of conditions and the following disclaimer.
16//
17// 2. Redistributions in binary form must reproduce the above copyright
18// notice, this list of conditions and the following disclaimer in the
19// documentation and/or other materials provided with the distribution.
20//
21// 3. Neither the name of the Corporation nor the names of the
22// contributors may be used to endorse or promote products derived from
23// this software without specific prior written permission.
24//
25// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
26// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
29// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
30// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
31// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
32// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
33// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
34// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
35// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36//
37// Questions? Contact Eric T. Phipps (etphipp@sandia.gov).
38//
39// ***********************************************************************
40// @HEADER
41
42#ifndef STOKHOS_GROWTH_RULES
43#define STOKHOS_GROWTH_RULES
44
45namespace Stokhos {
46
48 template <typename value_type>
49 class GrowthRule {
50 public:
51
54
56 virtual ~GrowthRule() {}
57
59 virtual value_type operator() (const value_type& x) const = 0;
60 };
61
63 template <typename value_type>
64 class IdentityGrowthRule : public GrowthRule<value_type> {
65 public:
68
71
73 virtual value_type operator() (const value_type& x) const { return x; }
74 };
75
77 template <typename value_type>
78 class LinearGrowthRule : public GrowthRule<value_type> {
79 public:
81 LinearGrowthRule(const value_type& a_ = value_type(1),
82 const value_type& b_ = value_type(0)) :
83 a(a_), b(b_) {}
84
86 virtual ~LinearGrowthRule() {}
87
89 virtual value_type operator() (const value_type& x) const { return a*x+b; }
90
91 protected:
92
94 value_type a;
95
97 value_type b;
98 };
99
101
107 template <typename value_type>
108 class EvenGrowthRule : public GrowthRule<value_type> {
109 public:
112
114 virtual ~EvenGrowthRule() {}
115
117 virtual value_type operator() (const value_type& x) const {
118 if (x % value_type(2) == value_type(1)) return x+value_type(1);
119 return x;
120 }
121
122 };
123
125 template <typename value_type>
127 public:
130
133
135 virtual value_type operator() (const value_type& x) const {
136 if (x == value_type(0)) return value_type(0);
137 return std::pow(value_type(2),x-value_type(1));
138 }
139
140 };
141
143 template <typename value_type>
145 public:
148
151
153 virtual value_type operator() (const value_type& x) const {
154 // Gauss-Patterson rules have precision 3*2*l-1, which is odd.
155 // Since discrete orthogonality requires integrating polynomials of
156 // order 2*p, setting p = 3*2*{l-1}-1 will yield the largest p such that
157 // 2*p <= 3*2^l-1
158 if (x == value_type(0)) return value_type(0);
159 return 3*std::pow(value_type(2),x-value_type(1))-value_type(1);
160 }
161
162 };
163
164}
165
166#endif
An exponential growth rule for Clenshaw-Curtis.
virtual value_type operator()(const value_type &x) const
Evaluate growth rule.
A growth rule that always makes the supplied order even.
virtual value_type operator()(const value_type &x) const
Evaluate growth rule.
virtual ~EvenGrowthRule()
Destructor.
An exponential growth rule for Gauss-Patterson.
virtual value_type operator()(const value_type &x) const
Evaluate growth rule.
Interface for abstract growth rules.
virtual ~GrowthRule()
Destructor.
virtual value_type operator()(const value_type &x) const =0
Evaluate growth rule.
A growth rule that is the identity.
virtual value_type operator()(const value_type &x) const
Evaluate growth rule.
virtual ~IdentityGrowthRule()
Destructor.
virtual ~LinearGrowthRule()
Destructor.
virtual value_type operator()(const value_type &x) const
Evaluate growth rule.
LinearGrowthRule(const value_type &a_=value_type(1), const value_type &b_=value_type(0))
Constructor.
Top-level namespace for Stokhos classes and functions.