Stokhos Package Browser (Single Doxygen Collection)  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Stokhos_MPModelEvaluator.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_MPMODELEVALUATOR_HPP
11 #define STOKHOS_MPMODELEVALUATOR_HPP
12 
13 #include "EpetraExt_ModelEvaluator.h"
14 #include "EpetraExt_MultiComm.h"
15 #include "EpetraExt_BlockVector.h"
16 
17 #include "Teuchos_RCP.hpp"
18 #include "Teuchos_Array.hpp"
20 #include "Stokhos_ParallelData.hpp"
21 
27 
28 namespace Stokhos {
29 
31 
34  class MPModelEvaluator : public EpetraExt::ModelEvaluator {
35  public:
36 
37  // Constructor
43 
46 
49 
52 
55 
58 
61  get_p_names(int l) const;
62 
66 
69 
72 
75 
78 
81 
84 
87 
89  InArgs createInArgs() const;
90 
92  OutArgs createOutArgs() const;
93 
95  void evalModel(const InArgs& inArgs, const OutArgs& outArgs) const;
96 
98 
100  void set_x_mp_init(const Stokhos::ProductEpetraVector& x_mp_in);
101  void set_x_dot_mp_init(const Stokhos::ProductEpetraVector& x_dot_mp_in);
102 
106 
108  void set_p_mp_init(int i, const Stokhos::ProductEpetraVector& p_mp_in);
109 
112 
114 
118 
120 
124 
127 
131  const Epetra_Vector* v = NULL) const;
132 
135  create_x_mv_mp(int num_vecs,
136  Epetra_DataAccess CV = Copy,
137  const Epetra_MultiVector* v = NULL) const;
138 
141  create_p_mp(int l, Epetra_DataAccess CV = Copy,
142  const Epetra_Vector* v = NULL) const;
143 
146  create_p_mv_mp(int l, int num_vecs, Epetra_DataAccess CV = Copy,
147  const Epetra_MultiVector* v = NULL) const;
148 
152  const Epetra_Vector* v = NULL) const;
153 
156  create_f_mv_mp(int num_vecs, Epetra_DataAccess CV = Copy,
157  const Epetra_MultiVector* v = NULL) const;
158 
161  create_g_mp(int l, Epetra_DataAccess CV = Copy,
162  const Epetra_Vector* v = NULL) const;
163 
166  create_g_mv_mp(int l, int num_vecs, Epetra_DataAccess CV = Copy,
167  const Epetra_MultiVector* v = NULL) const;
168 
169  protected:
170 
173 
175  unsigned int num_mp_blocks;
176 
179 
182 
185 
188 
191 
194 
197 
200 
202  int num_p;
203 
205  int num_p_mp;
206 
209 
212 
215 
217  int num_g;
218 
220  int num_g_mp;
221 
224 
227 
230 
234 
237 
240 
243 
244  };
245 
246 }
247 
248 #endif // FEAPP_MODELEVALUATOR_HPP
Teuchos::RCP< const Stokhos::ProductEpetraVector > get_x_dot_mp_init() const
Teuchos::RCP< const Epetra_Map > mp_x_map
Block MP unknown map.
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.
void evalModel(const InArgs &inArgs, const OutArgs &outArgs) const
Evaluate model on InArgs.
Teuchos::RCP< const Epetra_Vector > get_x_dot_init() const
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 Epetra_Map > get_f_map() const
Return residual vector map.
Teuchos::RCP< const Epetra_Map > get_g_map(int l) const
Return response map.
Teuchos::RCP< Epetra_Operator > create_DgDp_op(int j, int i) const
Create MP operator representing dg/dp.
Teuchos::RCP< Epetra_Operator > create_W() const
Create W = alpha*M + beta*J matrix.
bool supports_x
Whether we support x (and thus f and W)
Teuchos::RCP< const Stokhos::ProductEpetraVector > get_p_mp_init(int l) const
Return initial SG parameters.
void set_x_mp_init(const Stokhos::ProductEpetraVector &x_mp_in)
Set initial multi-point solution.
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.
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_Vector > get_x_init() const
Return initial solution.
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.
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::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::Array< Teuchos::RCP< const Epetra_Map > > get_g_mp_base_maps() const
Get base maps of MP responses.
Teuchos::RCP< EpetraExt::ModelEvaluator::Preconditioner > create_WPrec() const
Create preconditioner operator.
Teuchos::RCP< const Teuchos::Array< std::string > > get_p_names(int l) const
Return array of parameter names.
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::Array< int > get_g_mp_map_indices() const
Get indices of MP responses.
A container class for products of Epetra_Vector&#39;s.
Teuchos::RCP< EpetraExt::ModelEvaluator > me
Underlying model evaluator.
Teuchos::RCP< Stokhos::ProductEpetraOperator > W_mp_blocks
W multi-point components.
Teuchos::RCP< Stokhos::ProductEpetraVector > mp_x_dot_init
Teuchos::RCP< const Epetra_Map > f_map
Underlying residual map.
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.
Teuchos::RCP< Epetra_Operator > create_DgDx_op(int j) const
Create MP operator representing dg/dx.
OutArgs createOutArgs() const
Create OutArgs.
Teuchos::RCP< Epetra_Operator > create_DgDx_dot_op(int j) const
Create MP operator representing dg/dxdot.
Teuchos::RCP< const Epetra_Map > get_p_map(int l) const
Return parameter vector map.
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 Stokhos::ProductEpetraVector > get_x_mp_init() const
Return initial SG x.
Teuchos::RCP< const Epetra_Map > x_map
Underlying unknown map.
Teuchos::Array< int > get_p_mp_map_indices() const
Get indices of MP parameters.
int num_g
Number of response vectors of underlying model evaluator.
int num_g_mp
Number of multi-point response vectors.
InArgs createInArgs() const
Create InArgs.
Teuchos::RCP< const Epetra_Map > get_x_map() const
Return solution vector map.
Teuchos::RCP< Teuchos::ParameterList > params
Algorithmic parameters.
Epetra_DataAccess
Teuchos::RCP< const EpetraExt::MultiComm > mp_comm
Parallel MP communicator.
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< const Epetra_Vector > get_p_init(int l) const
Return initial parameters.
Teuchos::RCP< Stokhos::ProductEpetraVector > mp_x_init
MP initial x.
Teuchos::RCP< Epetra_Operator > create_DfDp_op(int i) const
Create MP operator representing df/dp.
Teuchos::Array< Teuchos::RCP< Teuchos::Array< std::string > > > mp_p_names
MP coefficient parameter names.
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.