Stokhos Package Browser (Single Doxygen Collection)  Version of the Day
Stokhos_SGQuadMPModelEvaluator.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_SGQUADMPMODELEVALUATOR_HPP
43 #define STOKHOS_SGQUADMPMODELEVALUATOR_HPP
44 
45 #include "EpetraExt_ModelEvaluator.h"
46 #include "EpetraExt_MultiComm.h"
47 
48 #include "Teuchos_RCP.hpp"
49 #include "Teuchos_Array.hpp"
50 
51 namespace Stokhos {
52 
64  class SGQuadMPModelEvaluator : public EpetraExt::ModelEvaluator {
65  public:
66 
67  // Constructor
72 
75 
78 
81 
84 
87 
90  get_p_names(int l) const;
91 
94 
97 
100 
102  InArgs createInArgs() const;
103 
105  OutArgs createOutArgs() const;
106 
108  void evalModel(const InArgs& inArgs, const OutArgs& outArgs) const;
109 
111 
112  protected:
113 
116 
119 
122 
125 
127  int num_p;
128 
130  int num_g;
131 
133  int num_p_mp;
134 
136  int num_g_mp;
137 
140 
143 
145  mp_vector_t x_dot_mp;
146 
148  mp_vector_t x_mp;
149 
152 
154  mp_vector_t f_mp;
155 
157  mp_operator_t W_mp;
158 
161 
164 
167 
170 
173 
174  };
175 
176 }
177 
178 #endif // STOKHOS_SGQUADMPMODELEVALUATOR_HPP
Stokhos::SGQuadMPModelEvaluator::create_W
Teuchos::RCP< Epetra_Operator > create_W() const
Create W = alpha*M + beta*J matrix.
Definition: Stokhos_SGQuadMPModelEvaluator.cpp:297
Teuchos_RCP.hpp
Stokhos::SGQuadMPModelEvaluator::get_f_map
Teuchos::RCP< const Epetra_Map > get_f_map() const
Return residual vector map.
Definition: Stokhos_SGQuadMPModelEvaluator.cpp:255
Stokhos::SGQuadMPModelEvaluator::num_p_mp
int num_p_mp
Number of multipoint parameter vectors.
Definition: Stokhos_SGQuadMPModelEvaluator.hpp:133
Stokhos::SGQuadMPModelEvaluator::get_x_map
Teuchos::RCP< const Epetra_Map > get_x_map() const
Return solution vector map.
Definition: Stokhos_SGQuadMPModelEvaluator.cpp:248
Stokhos::SGQuadMPModelEvaluator::SGQuadMPModelEvaluator
SGQuadMPModelEvaluator(const Teuchos::RCP< EpetraExt::ModelEvaluator > &me, const Teuchos::RCP< const EpetraExt::MultiComm > &mp_comm, const Teuchos::RCP< const Epetra_Map > &mp_block_map)
Definition: Stokhos_SGQuadMPModelEvaluator.cpp:57
Stokhos::SGQuadMPModelEvaluator::x_mp
mp_vector_t x_mp
Solution vector.
Definition: Stokhos_SGQuadMPModelEvaluator.hpp:148
Stokhos::SGQuadMPModelEvaluator::f_mp
mp_vector_t f_mp
Residual vector.
Definition: Stokhos_SGQuadMPModelEvaluator.hpp:154
Stokhos::SGQuadMPModelEvaluator::num_g_mp
int num_g_mp
Number of multipoint response vectors.
Definition: Stokhos_SGQuadMPModelEvaluator.hpp:136
Stokhos::SGQuadMPModelEvaluator::get_p_map
Teuchos::RCP< const Epetra_Map > get_p_map(int l) const
Return parameter vector map.
Definition: Stokhos_SGQuadMPModelEvaluator.cpp:262
Stokhos::SGQuadMPModelEvaluator::createInArgs
InArgs createInArgs() const
Create InArgs.
Definition: Stokhos_SGQuadMPModelEvaluator.cpp:304
Stokhos::SGQuadMPModelEvaluator::mp_block_map
Teuchos::RCP< const Epetra_Map > mp_block_map
Map for layout of parallel MP blocks.
Definition: Stokhos_SGQuadMPModelEvaluator.hpp:121
Stokhos::SGQuadMPModelEvaluator::mp_p_index_map
Teuchos::Array< int > mp_p_index_map
Index map between block-p and p_mp maps.
Definition: Stokhos_SGQuadMPModelEvaluator.hpp:139
Stokhos::SGQuadMPModelEvaluator::num_g
int num_g
Number of response vectors.
Definition: Stokhos_SGQuadMPModelEvaluator.hpp:130
Teuchos_Array.hpp
Stokhos::SGQuadMPModelEvaluator::dgdx_dot_mp
Teuchos::Array< MPDerivative > dgdx_dot_mp
Response derivative.
Definition: Stokhos_SGQuadMPModelEvaluator.hpp:169
Teuchos::RCP< EpetraExt::ModelEvaluator >
Stokhos::SGQuadMPModelEvaluator::dgdx_mp
Teuchos::Array< MPDerivative > dgdx_mp
Response derivative.
Definition: Stokhos_SGQuadMPModelEvaluator.hpp:166
Teuchos::Array< int >
Stokhos::SGQuadMPModelEvaluator::get_p_init
Teuchos::RCP< const Epetra_Vector > get_p_init(int l) const
Return initial parameters.
Definition: Stokhos_SGQuadMPModelEvaluator.cpp:290
Stokhos::SGQuadMPModelEvaluator::dfdp_mp
Teuchos::Array< MPDerivative > dfdp_mp
Residual derivatives.
Definition: Stokhos_SGQuadMPModelEvaluator.hpp:160
Stokhos::SGQuadMPModelEvaluator::get_p_names
Teuchos::RCP< const Teuchos::Array< std::string > > get_p_names(int l) const
Return array of parameter names.
Definition: Stokhos_SGQuadMPModelEvaluator.cpp:276
Stokhos::SGQuadMPModelEvaluator::num_p
int num_p
Number of parameter vectors.
Definition: Stokhos_SGQuadMPModelEvaluator.hpp:127
Stokhos::SGQuadMPModelEvaluator::g_mp
Teuchos::Array< mp_vector_t > g_mp
Response vectors.
Definition: Stokhos_SGQuadMPModelEvaluator.hpp:163
Stokhos
Top-level namespace for Stokhos classes and functions.
Definition: Stokhos_AbstractPreconditionerFactory.hpp:48
Stokhos::SGQuadMPModelEvaluator::p_mp
Teuchos::Array< mp_vector_t > p_mp
Parameter vectors.
Definition: Stokhos_SGQuadMPModelEvaluator.hpp:151
Stokhos::SGQuadMPModelEvaluator::mp_g_index_map
Teuchos::Array< int > mp_g_index_map
Index map between block-g and g_mp maps.
Definition: Stokhos_SGQuadMPModelEvaluator.hpp:142
Stokhos::SGQuadMPModelEvaluator::createOutArgs
OutArgs createOutArgs() const
Create OutArgs.
Definition: Stokhos_SGQuadMPModelEvaluator.cpp:329
Stokhos::SGQuadMPModelEvaluator::evalModel
void evalModel(const InArgs &inArgs, const OutArgs &outArgs) const
Evaluate model on InArgs.
Definition: Stokhos_SGQuadMPModelEvaluator.cpp:377
Stokhos::SGQuadMPModelEvaluator::dgdp_mp
Teuchos::Array< Teuchos::Array< MPDerivative > > dgdp_mp
Response sensitivities.
Definition: Stokhos_SGQuadMPModelEvaluator.hpp:172
Stokhos::SGQuadMPModelEvaluator::W_mp
mp_operator_t W_mp
W operator.
Definition: Stokhos_SGQuadMPModelEvaluator.hpp:157
Stokhos::SGQuadMPModelEvaluator::get_g_map
Teuchos::RCP< const Epetra_Map > get_g_map(int l) const
Return observation vector map.
Definition: Stokhos_SGQuadMPModelEvaluator.cpp:269
Stokhos::SGQuadMPModelEvaluator
ModelEvaluator adaptor that implements the stochastic Galerkin residual and Jacobian computations usi...
Definition: Stokhos_SGQuadMPModelEvaluator.hpp:64
Stokhos::SGQuadMPModelEvaluator::get_x_init
Teuchos::RCP< const Epetra_Vector > get_x_init() const
Return initial solution.
Definition: Stokhos_SGQuadMPModelEvaluator.cpp:283
Stokhos::SGQuadMPModelEvaluator::me
Teuchos::RCP< EpetraExt::ModelEvaluator > me
Underlying model evaluator.
Definition: Stokhos_SGQuadMPModelEvaluator.hpp:115
Stokhos::SGQuadMPModelEvaluator::mp_comm
Teuchos::RCP< const EpetraExt::MultiComm > mp_comm
Parallel MP communicator.
Definition: Stokhos_SGQuadMPModelEvaluator.hpp:118
Stokhos::SGQuadMPModelEvaluator::x_dot_mp
mp_vector_t x_dot_mp
Time derivative vector.
Definition: Stokhos_SGQuadMPModelEvaluator.hpp:145
Stokhos::SGQuadMPModelEvaluator::sg_quad
Teuchos::RCP< const Stokhos::Quadrature< int, double > > sg_quad
SG quadrature.
Definition: Stokhos_SGQuadMPModelEvaluator.hpp:124