EpetraExt Package Browser (Single Doxygen Collection)  Development
EpetraExt_MultiPointModelEvaluator.h
Go to the documentation of this file.
1 /*
2 //@HEADER
3 // ***********************************************************************
4 //
5 // EpetraExt: Epetra Extended - Linear Algebra Services Package
6 // Copyright (2011) Sandia Corporation
7 //
8 // Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
9 // the U.S. Government retains certain rights in this software.
10 //
11 // Redistribution and use in source and binary forms, with or without
12 // modification, are permitted provided that the following conditions are
13 // met:
14 //
15 // 1. Redistributions of source code must retain the above copyright
16 // notice, this list of conditions and the following disclaimer.
17 //
18 // 2. Redistributions in binary form must reproduce the above copyright
19 // notice, this list of conditions and the following disclaimer in the
20 // documentation and/or other materials provided with the distribution.
21 //
22 // 3. Neither the name of the Corporation nor the names of the
23 // contributors may be used to endorse or promote products derived from
24 // this software without specific prior written permission.
25 //
26 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
27 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
28 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
29 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
30 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
31 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
32 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
33 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
34 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
35 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
36 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
37 //
38 // Questions? Contact Michael A. Heroux (maherou@sandia.gov)
39 //
40 // ***********************************************************************
41 //@HEADER
42 */
43 
44 #ifndef EPETRAEXT_MULTIPOINTMODELEVALUATOR_H
45 #define EPETRAEXT_MULTIPOINTMODELEVALUATOR_H
46 
47 #include "Epetra_ConfigDefs.h"
50 #include "EpetraExt_BlockVector.h"
52 #ifdef HAVE_MPI
53 #include "EpetraExt_MultiMpiComm.h"
54 #else
56 #endif
57 
67 namespace EpetraExt {
69  : public ModelEvaluator
70  {
71  public:
72 
75 
79  const Teuchos::RCP<EpetraExt::MultiComm> &globalComm_,
80  const std::vector<Epetra_Vector*> initGuessVec,
81  Teuchos::RCP<std::vector< Teuchos::RCP<Epetra_Vector> > > qvec,
82  Teuchos::RCP<std::vector< Teuchos::RCP<Epetra_Vector> > > matching_vec = Teuchos::null
83  );
84 
86 
88 
89 
92 
108  InArgs createInArgs() const;
110  OutArgs createOutArgs() const;
112  void evalModel( const InArgs& inArgs, const OutArgs& outArgs ) const;
113 
115 
116  private:
117 
119 
122 
125 
128 
131 
134 
137 
140 
144 
151 
154 
157 
160 
163 
166 
169 
172 
175 
178 
181 
188 #ifndef EPETRA_NO_32BIT_GLOBAL_INDICES
189  std::vector< std::vector<int> >* rowStencil_int;
190 #endif
191 #ifndef EPETRA_NO_64BIT_GLOBAL_INDICES
192  std::vector< std::vector<long long> >* rowStencil_LL;
193 #endif
194 
196 #ifndef EPETRA_NO_32BIT_GLOBAL_INDICES
197  std::vector<int>* rowIndex_int;
198 #endif
199 #ifndef EPETRA_NO_64BIT_GLOBAL_INDICES
200  std::vector<long long>* rowIndex_LL;
201 #endif
202  bool longlong;
203 
207  int num_g0;
208  int num_p0;
209 
213 
214  };
215 }
216 #endif
EpetraExt::ModelEvaluator
Base interface for evaluating a stateless "model".
Definition: EpetraExt_ModelEvaluator.h:85
EpetraExt::MultiPointModelEvaluator::num_g0
int num_g0
Definition: EpetraExt_MultiPointModelEvaluator.h:207
EpetraExt::MultiPointModelEvaluator::block_f
EpetraExt::BlockVector * block_f
Pointer to global multipoint residual vector – local storage.
Definition: EpetraExt_MultiPointModelEvaluator.h:159
EpetraExt::MultiPointModelEvaluator::timeDomain
int timeDomain
Time domain on current processor.
Definition: EpetraExt_MultiPointModelEvaluator.h:180
EpetraExt_BlockVector.h
EpetraExt::MultiPointModelEvaluator::get_x_map
Teuchos::RCP< const Epetra_Map > get_x_map() const
Definition: EpetraExt_MultiPointModelEvaluator.cpp:235
EpetraExt::MultiPointModelEvaluator::split_W
Teuchos::RCP< Epetra_RowMatrix > split_W
Pointer to split (spatial) Jacobian matrix.
Definition: EpetraExt_MultiPointModelEvaluator.h:127
EpetraExt::MultiPointModelEvaluator::createOutArgs
OutArgs createOutArgs() const
Definition: EpetraExt_MultiPointModelEvaluator.cpp:280
EpetraExt::MultiPointModelEvaluator::split_x
Teuchos::RCP< Epetra_Vector > split_x
Split (spatial) input vector – local storage.
Definition: EpetraExt_MultiPointModelEvaluator.h:130
EpetraExt_MultiMpiComm.h
EpetraExt::MultiPointModelEvaluator::num_p0
int num_p0
Definition: EpetraExt_MultiPointModelEvaluator.h:208
EpetraExt::MultiPointModelEvaluator::longlong
bool longlong
Definition: EpetraExt_MultiPointModelEvaluator.h:202
EpetraExt::MultiPointModelEvaluator::matching_vec
Teuchos::RCP< std::vector< Teuchos::RCP< Epetra_Vector > > > matching_vec
Array of vectors that have data for g-matching optimization problem.
Definition: EpetraExt_MultiPointModelEvaluator.h:211
EpetraExt::BlockVector
Definition: EpetraExt_BlockVector.h:60
EpetraExt::MultiPointModelEvaluator::matchingProblem
bool matchingProblem
Definition: EpetraExt_MultiPointModelEvaluator.h:212
EpetraExt::MultiPointModelEvaluator::rowIndex_int
std::vector< int > * rowIndex_int
Set of indices into global XYZT Jacobian matrix.
Definition: EpetraExt_MultiPointModelEvaluator.h:197
EpetraExt::MultiPointModelEvaluator::block_DfDp
EpetraExt::BlockMultiVector * block_DfDp
Pointer to global multipoint DfDp multi vector – local storage.
Definition: EpetraExt_MultiPointModelEvaluator.h:162
EpetraExt::MultiPointModelEvaluator::underlyingNg
int underlyingNg
Number of g vectors supported by underlyingME, often used as a bool.
Definition: EpetraExt_MultiPointModelEvaluator.h:171
EpetraExt::MultiPointModelEvaluator::get_x_init
Teuchos::RCP< const Epetra_Vector > get_x_init() const
Definition: EpetraExt_MultiPointModelEvaluator.cpp:255
EpetraExt::MultiPointModelEvaluator::create_W
Teuchos::RCP< Epetra_Operator > create_W() const
Definition: EpetraExt_MultiPointModelEvaluator.cpp:265
EpetraExt::MultiPointModelEvaluator::numTimeDomains
int numTimeDomains
Total number of time step domains.
Definition: EpetraExt_MultiPointModelEvaluator.h:177
EpetraExt::MultiPointModelEvaluator::get_f_map
Teuchos::RCP< const Epetra_Map > get_f_map() const
Definition: EpetraExt_MultiPointModelEvaluator.cpp:240
EpetraExt_MultiSerialComm.h
EpetraExt::MultiPointModelEvaluator::derivMV_DfDp
EpetraExt::ModelEvaluator::DerivativeMultiVector * derivMV_DfDp
Definition: EpetraExt_MultiPointModelEvaluator.h:145
EpetraExt::MultiPointModelEvaluator::split_DgDx
Teuchos::RCP< Epetra_MultiVector > split_DgDx
Split sensitivity vector – local storage.
Definition: EpetraExt_MultiPointModelEvaluator.h:142
Teuchos::RCP< EpetraExt::ModelEvaluator >
EpetraExt::MultiPointModelEvaluator::block_DgDx
EpetraExt::BlockMultiVector * block_DgDx
Pointer to global multipoint DfDp multi vector – local storage.
Definition: EpetraExt_MultiPointModelEvaluator.h:165
EpetraExt::MultiPointModelEvaluator::get_p_map
Teuchos::RCP< const Epetra_Map > get_p_map(int l) const
\breif .
Definition: EpetraExt_MultiPointModelEvaluator.cpp:245
EpetraExt::MultiPointModelEvaluator::derivMV_DgDp
EpetraExt::ModelEvaluator::DerivativeMultiVector * derivMV_DgDp
Definition: EpetraExt_MultiPointModelEvaluator.h:149
EpetraExt::MultiPointModelEvaluator
Definition: EpetraExt_MultiPointModelEvaluator.h:68
EpetraExt::MultiPointModelEvaluator::globalComm
Teuchos::RCP< EpetraExt::MultiComm > globalComm
Pointer to the global (full XYZT) communicator.
Definition: EpetraExt_MultiPointModelEvaluator.h:121
EpetraExt_BlockCrsMatrix.h
EpetraExt::MultiPointModelEvaluator::orientation_DgDp
EDerivativeMultiVectorOrientation orientation_DgDp
Some local data.
Definition: EpetraExt_MultiPointModelEvaluator.h:205
EpetraExt::MultiPointModelEvaluator::~MultiPointModelEvaluator
~MultiPointModelEvaluator()
Definition: EpetraExt_MultiPointModelEvaluator.cpp:210
EpetraExt::MultiPointModelEvaluator::evalModel
void evalModel(const InArgs &inArgs, const OutArgs &outArgs) const
Definition: EpetraExt_MultiPointModelEvaluator.cpp:325
EpetraExt_ModelEvaluator.h
EpetraExt::MultiPointModelEvaluator::timeStepsOnTimeDomain
int timeStepsOnTimeDomain
Number of time steps computed on each time domain.
Definition: EpetraExt_MultiPointModelEvaluator.h:174
EpetraExt::MultiPointModelEvaluator::deriv_DgDx
EpetraExt::ModelEvaluator::Derivative * deriv_DgDx
Definition: EpetraExt_MultiPointModelEvaluator.h:148
EpetraExt::MultiPointModelEvaluator::get_g_map
Teuchos::RCP< const Epetra_Map > get_g_map(int j) const
\breif .
Definition: EpetraExt_MultiPointModelEvaluator.cpp:250
EpetraExt::MultiPointModelEvaluator::split_g
Teuchos::RCP< Epetra_Vector > split_g
Split vector of response functions – local storage.
Definition: EpetraExt_MultiPointModelEvaluator.h:136
EpetraExt::MultiPointModelEvaluator::q_vec
Teuchos::RCP< std::vector< Teuchos::RCP< Epetra_Vector > > > q_vec
Array of parameter vectors that define the multi-point problem.
Definition: EpetraExt_MultiPointModelEvaluator.h:124
EpetraExt::MultiPointModelEvaluator::solution_init
Teuchos::RCP< EpetraExt::BlockVector > solution_init
Pointer to initial multipoint solution vector.
Definition: EpetraExt_MultiPointModelEvaluator.h:168
EpetraExt::ModelEvaluator::Derivative
Simple aggregate class that stores a derivative object as a general linear operator or as a multi-vec...
Definition: EpetraExt_ModelEvaluator.h:467
EpetraExt::MultiPointModelEvaluator::deriv_DfDp
EpetraExt::ModelEvaluator::Derivative * deriv_DfDp
Definition: EpetraExt_MultiPointModelEvaluator.h:146
EpetraExt::MultiPointModelEvaluator::rowStencil_int
std::vector< std::vector< int > > * rowStencil_int
Stencil for each row of global XYZT Jacobian matrix.
Definition: EpetraExt_MultiPointModelEvaluator.h:189
EpetraExt::ModelEvaluator::EDerivativeMultiVectorOrientation
EDerivativeMultiVectorOrientation
Definition: EpetraExt_ModelEvaluator.h:326
EpetraExt_BlockMultiVector.h
EpetraExt::MultiPointModelEvaluator::split_DgDp
Teuchos::RCP< Epetra_MultiVector > split_DgDp
Definition: EpetraExt_MultiPointModelEvaluator.h:143
Epetra_ConfigDefs.h
EpetraExt::MultiPointModelEvaluator::split_f
Teuchos::RCP< Epetra_Vector > split_f
Split (spatial) residual vector – local storage.
Definition: EpetraExt_MultiPointModelEvaluator.h:133
EpetraExt::MultiPointModelEvaluator::createInArgs
InArgs createInArgs() const
Definition: EpetraExt_MultiPointModelEvaluator.cpp:270
EpetraExt::MultiPointModelEvaluator::derivMV_DgDx
EpetraExt::ModelEvaluator::DerivativeMultiVector * derivMV_DgDx
Definition: EpetraExt_MultiPointModelEvaluator.h:147
EpetraExt::ModelEvaluator::InArgs
Definition: EpetraExt_ModelEvaluator.h:135
EpetraExt::MultiPointModelEvaluator::num_dg0dp0
int num_dg0dp0
Definition: EpetraExt_MultiPointModelEvaluator.h:206
EpetraExt::MultiPointModelEvaluator::block_W
Teuchos::RCP< EpetraExt::BlockCrsMatrix > block_W
Pointer to global XYZT Jacobian matrix.
Definition: EpetraExt_MultiPointModelEvaluator.h:153
EpetraExt::ModelEvaluator::OutArgs
Definition: EpetraExt_ModelEvaluator.h:760
EpetraExt::ModelEvaluator::DerivativeMultiVector
Simple aggregate class for a derivative object represented as a column-wise multi-vector or its trans...
Definition: EpetraExt_ModelEvaluator.h:436
EpetraExt::BlockMultiVector
Definition: EpetraExt_BlockMultiVector.h:59
EpetraExt::MultiPointModelEvaluator::deriv_DgDp
EpetraExt::ModelEvaluator::Derivative * deriv_DgDp
Definition: EpetraExt_MultiPointModelEvaluator.h:150
EpetraExt::MultiPointModelEvaluator::MultiPointModelEvaluator
MultiPointModelEvaluator(Teuchos::RCP< EpetraExt::ModelEvaluator > underlyingME_, const Teuchos::RCP< EpetraExt::MultiComm > &globalComm_, const std::vector< Epetra_Vector * > initGuessVec, Teuchos::RCP< std::vector< Teuchos::RCP< Epetra_Vector > > > qvec, Teuchos::RCP< std::vector< Teuchos::RCP< Epetra_Vector > > > matching_vec=Teuchos::null)
Definition: EpetraExt_MultiPointModelEvaluator.cpp:48
EpetraExt::MultiPointModelEvaluator::block_x
EpetraExt::BlockVector * block_x
Pointer to global multipoint solution vector – local storage.
Definition: EpetraExt_MultiPointModelEvaluator.h:156
EpetraExt::MultiPointModelEvaluator::underlyingME
Teuchos::RCP< EpetraExt::ModelEvaluator > underlyingME
Definition: EpetraExt_MultiPointModelEvaluator.h:118
EpetraExt
EpetraExt::BlockCrsMatrix: A class for constructing a distributed block matrix.
Definition: EpetraExt_BlockCrsMatrix.cpp:46
EpetraExt::MultiPointModelEvaluator::get_p_init
Teuchos::RCP< const Epetra_Vector > get_p_init(int l) const
Definition: EpetraExt_MultiPointModelEvaluator.cpp:260
EpetraExt::MultiPointModelEvaluator::rowIndex_LL
std::vector< long long > * rowIndex_LL
Definition: EpetraExt_MultiPointModelEvaluator.h:200
EpetraExt::MultiPointModelEvaluator::rowStencil_LL
std::vector< std::vector< long long > > * rowStencil_LL
Definition: EpetraExt_MultiPointModelEvaluator.h:192
EpetraExt::MultiPointModelEvaluator::split_DfDp
Teuchos::RCP< Epetra_MultiVector > split_DfDp
Split sensitivity vector – local storage.
Definition: EpetraExt_MultiPointModelEvaluator.h:139