Stokhos Package Browser (Single Doxygen Collection)  Version of the Day
Stokhos_MPModelEvaluator.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_MPMODELEVALUATOR_HPP
43 #define STOKHOS_MPMODELEVALUATOR_HPP
44 
45 #include "EpetraExt_ModelEvaluator.h"
46 #include "EpetraExt_MultiComm.h"
47 #include "EpetraExt_BlockVector.h"
48 
49 #include "Teuchos_RCP.hpp"
50 #include "Teuchos_Array.hpp"
51 #include "Teuchos_ParameterList.hpp"
52 #include "Stokhos_ParallelData.hpp"
53 
59 
60 namespace Stokhos {
61 
63 
66  class MPModelEvaluator : public EpetraExt::ModelEvaluator {
67  public:
68 
69  // Constructor
71  const Teuchos::RCP<EpetraExt::ModelEvaluator>& me,
72  const Teuchos::RCP<const EpetraExt::MultiComm>& mp_comm,
73  const Teuchos::RCP<const Epetra_Map>& mp_block_map,
74  const Teuchos::RCP<Teuchos::ParameterList>& params);
75 
78 
80  Teuchos::RCP<const Epetra_Map> get_x_map() const;
81 
83  Teuchos::RCP<const Epetra_Map> get_f_map() const;
84 
86  Teuchos::RCP<const Epetra_Map> get_p_map(int l) const;
87 
89  Teuchos::RCP<const Epetra_Map> get_g_map(int l) const;
90 
92  Teuchos::RCP<const Teuchos::Array<std::string> >
93  get_p_names(int l) const;
94 
96  Teuchos::RCP<const Epetra_Vector> get_x_init() const;
97  Teuchos::RCP<const Epetra_Vector> get_x_dot_init() const;
98 
100  Teuchos::RCP<const Epetra_Vector> get_p_init(int l) const;
101 
103  Teuchos::RCP<Epetra_Operator> create_W() const;
104 
106  Teuchos::RCP<EpetraExt::ModelEvaluator::Preconditioner> create_WPrec() const;
107 
109  Teuchos::RCP<Epetra_Operator> create_DgDx_dot_op(int j) const;
110 
112  Teuchos::RCP<Epetra_Operator> create_DgDx_op(int j) const;
113 
115  Teuchos::RCP<Epetra_Operator> create_DgDp_op(int j, int i) const;
116 
118  Teuchos::RCP<Epetra_Operator> create_DfDp_op(int i) const;
119 
121  InArgs createInArgs() const;
122 
124  OutArgs createOutArgs() const;
125 
127  void evalModel(const InArgs& inArgs, const OutArgs& outArgs) const;
128 
130 
132  void set_x_mp_init(const Stokhos::ProductEpetraVector& x_mp_in);
133  void set_x_dot_mp_init(const Stokhos::ProductEpetraVector& x_dot_mp_in);
134 
136  Teuchos::RCP<const Stokhos::ProductEpetraVector> get_x_mp_init() const;
137  Teuchos::RCP<const Stokhos::ProductEpetraVector> get_x_dot_mp_init() const;
138 
140  void set_p_mp_init(int i, const Stokhos::ProductEpetraVector& p_mp_in);
141 
143  Teuchos::RCP<const Stokhos::ProductEpetraVector> get_p_mp_init(int l) const;
144 
146 
149  Teuchos::Array<int> get_p_mp_map_indices() const;
150 
152 
155  Teuchos::Array<int> get_g_mp_map_indices() const;
156 
158  Teuchos::Array< Teuchos::RCP<const Epetra_Map> > get_g_mp_base_maps() const;
159 
161  Teuchos::RCP<Stokhos::ProductEpetraVector>
162  create_x_mp(Epetra_DataAccess CV = Copy,
163  const Epetra_Vector* v = NULL) const;
164 
166  Teuchos::RCP<Stokhos::ProductEpetraMultiVector>
167  create_x_mv_mp(int num_vecs,
168  Epetra_DataAccess CV = Copy,
169  const Epetra_MultiVector* v = NULL) const;
170 
172  Teuchos::RCP<Stokhos::ProductEpetraVector>
173  create_p_mp(int l, Epetra_DataAccess CV = Copy,
174  const Epetra_Vector* v = NULL) const;
175 
177  Teuchos::RCP<Stokhos::ProductEpetraMultiVector>
178  create_p_mv_mp(int l, int num_vecs, Epetra_DataAccess CV = Copy,
179  const Epetra_MultiVector* v = NULL) const;
180 
182  Teuchos::RCP<Stokhos::ProductEpetraVector>
183  create_f_mp(Epetra_DataAccess CV = Copy,
184  const Epetra_Vector* v = NULL) const;
185 
187  Teuchos::RCP<Stokhos::ProductEpetraMultiVector>
188  create_f_mv_mp(int num_vecs, Epetra_DataAccess CV = Copy,
189  const Epetra_MultiVector* v = NULL) const;
190 
192  Teuchos::RCP<Stokhos::ProductEpetraVector>
193  create_g_mp(int l, Epetra_DataAccess CV = Copy,
194  const Epetra_Vector* v = NULL) const;
195 
197  Teuchos::RCP<Stokhos::ProductEpetraMultiVector>
198  create_g_mv_mp(int l, int num_vecs, Epetra_DataAccess CV = Copy,
199  const Epetra_MultiVector* v = NULL) const;
200 
201  protected:
202 
204  Teuchos::RCP<EpetraExt::ModelEvaluator> me;
205 
207  unsigned int num_mp_blocks;
208 
210  Teuchos::RCP<const EpetraExt::MultiComm> mp_comm;
211 
213  Teuchos::RCP<const Epetra_Map> mp_block_map;
214 
216  Teuchos::RCP<Teuchos::ParameterList> params;
217 
220 
222  Teuchos::RCP<const Epetra_Map> x_map;
223 
225  Teuchos::RCP<const Epetra_Map> f_map;
226 
228  Teuchos::RCP<const Epetra_Map> mp_x_map;
229 
231  Teuchos::RCP<const Epetra_Map> mp_f_map;
232 
234  int num_p;
235 
237  int num_p_mp;
238 
240  Teuchos::Array<int> mp_p_index_map;
241 
243  Teuchos::Array< Teuchos::RCP<const Epetra_Map> > mp_p_map;
244 
246  Teuchos::Array< Teuchos::RCP< Teuchos::Array<std::string> > > mp_p_names;
247 
249  int num_g;
250 
252  int num_g_mp;
253 
255  Teuchos::Array<int> mp_g_index_map;
256 
258  Teuchos::Array< Teuchos::RCP<const Epetra_Map> > mp_g_map;
259 
261  mutable Teuchos::RCP< Stokhos::ProductEpetraOperator> W_mp_blocks;
262 
264  Teuchos::RCP<Stokhos::ProductEpetraVector> mp_x_init;
265  Teuchos::RCP<Stokhos::ProductEpetraVector> mp_x_dot_init;
266 
268  Teuchos::Array< Teuchos::RCP<ProductEpetraVector> > mp_p_init;
269 
271  mutable Teuchos::RCP<Stokhos::BlockDiagonalOperator> my_W;
272 
274  mutable Teuchos::RCP<Epetra_Vector> my_x;
275 
276  };
277 
278 }
279 
280 #endif // FEAPP_MODELEVALUATOR_HPP
Teuchos::RCP< const Epetra_Map > get_p_map(int l) const
Return parameter vector map.
Teuchos::RCP< const Epetra_Map > mp_x_map
Block MP unknown map.
Teuchos::Array< int > get_p_mp_map_indices() const
Get indices of MP parameters.
bool supports_x
Whether we support x (and thus f and W)
void set_x_mp_init(const Stokhos::ProductEpetraVector &x_mp_in)
Set initial multi-point solution.
int num_p_mp
Number of multi-point parameter vectors.
Multi-point model evaluator.
int num_p
Number of parameter vectors of underlying model evaluator.
Teuchos::RCP< const Epetra_Map > get_x_map() const
Return solution vector map.
OutArgs createOutArgs() const
Create OutArgs.
Teuchos::Array< Teuchos::RCP< const Epetra_Map > > mp_g_map
Block MP response map.
void set_x_dot_mp_init(const Stokhos::ProductEpetraVector &x_dot_mp_in)
Teuchos::Array< int > mp_p_index_map
Index map between block-p and p_mp maps.
Teuchos::RCP< Epetra_Operator > create_DgDx_op(int j) const
Create MP operator representing dg/dx.
Teuchos::RCP< const Epetra_Map > get_g_map(int l) const
Return response map.
InArgs createInArgs() const
Create InArgs.
Teuchos::RCP< Epetra_Operator > create_DgDx_dot_op(int j) const
Create MP operator representing dg/dxdot.
Teuchos::RCP< Stokhos::ProductEpetraMultiVector > create_g_mv_mp(int l, int num_vecs, Epetra_DataAccess CV=Copy, const Epetra_MultiVector *v=NULL) const
Create multi-point multi-vector using g map.
Teuchos::Array< Teuchos::RCP< const Epetra_Map > > get_g_mp_base_maps() const
Get base maps of MP responses.
Teuchos::RCP< Stokhos::ProductEpetraVector > create_x_mp(Epetra_DataAccess CV=Copy, const Epetra_Vector *v=NULL) const
Create multi-point vector using x map and owned mp map.
A container class for products of Epetra_Vector&#39;s.
Teuchos::RCP< EpetraExt::ModelEvaluator > me
Underlying model evaluator.
Top-level namespace for Stokhos classes and functions.
Teuchos::RCP< Stokhos::ProductEpetraOperator > W_mp_blocks
W multi-point components.
Teuchos::RCP< Stokhos::ProductEpetraVector > create_f_mp(Epetra_DataAccess CV=Copy, const Epetra_Vector *v=NULL) const
Create multi-point vector using f map.
Teuchos::RCP< const Epetra_Map > get_f_map() const
Return residual vector map.
Teuchos::RCP< Stokhos::ProductEpetraVector > mp_x_dot_init
Teuchos::RCP< const Epetra_Map > f_map
Underlying residual map.
Teuchos::RCP< const Stokhos::ProductEpetraVector > get_x_dot_mp_init() const
Teuchos::RCP< const Stokhos::ProductEpetraVector > get_x_mp_init() const
Return initial SG x.
Teuchos::RCP< const Epetra_Map > mp_block_map
Map for layout of parallel MP blocks.
MPModelEvaluator(const Teuchos::RCP< EpetraExt::ModelEvaluator > &me, const Teuchos::RCP< const EpetraExt::MultiComm > &mp_comm, const Teuchos::RCP< const Epetra_Map > &mp_block_map, const Teuchos::RCP< Teuchos::ParameterList > &params)
Teuchos::Array< Teuchos::RCP< ProductEpetraVector > > mp_p_init
MP initial p.
Teuchos::RCP< Epetra_Vector > my_x
x pointer for evaluating preconditioner
Teuchos::Array< int > mp_g_index_map
Index map between block-g and g_mp maps.
Teuchos::RCP< const Epetra_Map > mp_f_map
Block MP residual map.
Teuchos::RCP< const Epetra_Map > x_map
Underlying unknown map.
Teuchos::RCP< const Epetra_Vector > get_p_init(int l) const
Return initial parameters.
Teuchos::RCP< Stokhos::ProductEpetraMultiVector > create_x_mv_mp(int num_vecs, Epetra_DataAccess CV=Copy, const Epetra_MultiVector *v=NULL) const
Create multi-point vector using x map.
int num_g
Number of response vectors of underlying model evaluator.
Teuchos::RCP< Stokhos::ProductEpetraMultiVector > create_p_mv_mp(int l, int num_vecs, Epetra_DataAccess CV=Copy, const Epetra_MultiVector *v=NULL) const
Create multi-point vector using p map.
int num_g_mp
Number of multi-point response vectors.
Teuchos::RCP< Epetra_Operator > create_W() const
Create W = alpha*M + beta*J matrix.
Teuchos::Array< int > get_g_mp_map_indices() const
Get indices of MP responses.
Teuchos::RCP< const Epetra_Vector > get_x_init() const
Return initial solution.
Teuchos::RCP< Teuchos::ParameterList > params
Algorithmic parameters.
Teuchos::RCP< const Teuchos::Array< std::string > > get_p_names(int l) const
Return array of parameter names.
Teuchos::RCP< Stokhos::ProductEpetraVector > create_g_mp(int l, Epetra_DataAccess CV=Copy, const Epetra_Vector *v=NULL) const
Create multi-point vector using g map.
Teuchos::RCP< Stokhos::ProductEpetraMultiVector > create_f_mv_mp(int num_vecs, Epetra_DataAccess CV=Copy, const Epetra_MultiVector *v=NULL) const
Create multi-point multi-vector using f map.
Teuchos::RCP< const EpetraExt::MultiComm > mp_comm
Parallel MP communicator.
Teuchos::RCP< Stokhos::ProductEpetraVector > create_p_mp(int l, Epetra_DataAccess CV=Copy, const Epetra_Vector *v=NULL) const
Create multi-point vector using p map.
Teuchos::Array< Teuchos::RCP< const Epetra_Map > > mp_p_map
Block MP parameter map.
unsigned int num_mp_blocks
Number of blocks.
void set_p_mp_init(int i, const Stokhos::ProductEpetraVector &p_mp_in)
Set initial multi-point parameter.
Teuchos::RCP< Stokhos::BlockDiagonalOperator > my_W
W pointer for evaluating preconditioner.
Teuchos::RCP< Epetra_Operator > create_DfDp_op(int i) const
Create MP operator representing df/dp.
void evalModel(const InArgs &inArgs, const OutArgs &outArgs) const
Evaluate model on InArgs.
Teuchos::RCP< Stokhos::ProductEpetraVector > mp_x_init
MP initial x.
Teuchos::RCP< Epetra_Operator > create_DgDp_op(int j, int i) const
Create MP operator representing dg/dp.
Teuchos::RCP< const Stokhos::ProductEpetraVector > get_p_mp_init(int l) const
Return initial SG parameters.
Teuchos::RCP< const Epetra_Vector > get_x_dot_init() const
Teuchos::RCP< EpetraExt::ModelEvaluator::Preconditioner > create_WPrec() const
Create preconditioner operator.
Teuchos::Array< Teuchos::RCP< Teuchos::Array< std::string > > > mp_p_names
MP coefficient parameter names.