Intrepid
Intrepid_AdaptiveSparseGridInterface.hpp
Go to the documentation of this file.
1 // @HEADER
2 // ************************************************************************
3 //
4 // Intrepid Package
5 // Copyright (2007) 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 Pavel Bochev (pbboche@sandia.gov)
38 // Denis Ridzal (dridzal@sandia.gov), or
39 // Kara Peterson (kjpeter@sandia.gov)
40 //
41 // ************************************************************************
42 // @HEADER
43 
49 #ifndef INTREPID_ADAPTIVESPARSEGRIDINTERFACE_HPP
50 #define INTREPID_ADAPTIVESPARSEGRIDINTERFACE_HPP
51 
53 
54 namespace Intrepid {
55 
62 template<class Scalar, class UserVector>
64 protected:
68 
71  int maxLevel_;
72 
75  Scalar initialDiff_;
76 
80 
83  std::vector<EIntrepidBurkardt> rule1D_;
84 
87  std::vector<EIntrepidGrowth> growth1D_;
88 
89 public:
93 
103  int dimension,
104  std::vector<EIntrepidBurkardt> rule1D,
105  std::vector<EIntrepidGrowth> growth1D,
106  int maxLevel,
107  bool isNormalized);
108 
114  virtual void eval_integrand(
115  UserVector & output,
116  std::vector<Scalar> & input) = 0;
117 
123  virtual void eval_cubature(
124  UserVector & output,
125  CubatureTensorSorted<Scalar> & cubRule);
126 
131  virtual Scalar error_indicator(
132  UserVector & input) = 0;
133 
138  virtual bool max_level(
139  std::vector<int> index);
140 
144  void init(UserVector & output);
145 
149  void getRule(std::vector<EIntrepidBurkardt> & rule1D);
150 
154  void getGrowth(std::vector<EIntrepidGrowth> & growth1D);
155 
158  int getDimension();
159 
162  Scalar getInitialDiff();
163 
166  bool isNormalized();
167 };
168 
169 } // End Intrepid namespace
170 
171 // include templated definitions
173 
174 #endif
std::vector< EIntrepidGrowth > growth1D_
The user defined 1D growth rules.
void getRule(std::vector< EIntrepidBurkardt > &rule1D)
Return user defined 1D quadrature rules.
int maxLevel_
The maximum allowable level of quadrature.
Scalar getInitialDiff()
Return initial error indicator.
Scalar initialDiff_
The initial contribution to the integral.
virtual Scalar error_indicator(UserVector &input)=0
User defined error indicator function.
int getDimension()
Return dimension of integration domain.
Definition file for the Intrepid::AdaptiveSparseGridInterface class.
void init(UserVector &output)
Compute initial quantities for sparse grid adaptation.
AdaptiveSparseGridInterface(int dimension, std::vector< EIntrepidBurkardt > rule1D, std::vector< EIntrepidGrowth > growth1D, int maxLevel, bool isNormalized)
Constructor starts with index [1,...,1].
Header file for the Intrepid::CubatureTensorSorted class.
bool isNormalized()
Return whether or not cubature weights are normalized.
int dimension_
The dimension of the integration domain.
virtual bool max_level(std::vector< int > index)
User defined test for maximum level of cubature.
virtual void eval_cubature(UserVector &output, CubatureTensorSorted< Scalar > &cubRule)
Evaluate the cubature rule.
void getGrowth(std::vector< EIntrepidGrowth > &growth1D)
Return user defined 1D growth rules.
virtual void eval_integrand(UserVector &output, std::vector< Scalar > &input)=0
Evaluate the integrand function.
Utilizes 1D cubature (integration) rules contained in the library sandia_rules (John Burkardt...
bool isNormalized_
Whether or not to normalize the weights.
std::vector< EIntrepidBurkardt > rule1D_
The user defined 1D cubature rules.