/usr/include/trilinos/Stokhos_SGModelEvaluator_Interlaced.hpp is in libtrilinos-stokhos-dev 12.10.1-3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 | // @HEADER
// ***********************************************************************
//
// Stokhos Package
// Copyright (2009) Sandia Corporation
//
// Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
// license for use of this work by or on behalf of the U.S. Government.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// 1. Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
//
// 3. Neither the name of the Corporation nor the names of the
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// Questions? Contact Eric T. Phipps (etphipp@sandia.gov).
//
// ***********************************************************************
// @HEADER
#ifndef STOKHOS_SGMODELEVALUATOR_INTERLACED_HPP
#define STOKHOS_SGMODELEVALUATOR_INTERLACED_HPP
#include <vector>
#include "EpetraExt_ModelEvaluator.h"
#include "EpetraExt_MultiComm.h"
#include "EpetraExt_BlockVector.h"
#include "Teuchos_RCP.hpp"
#include "Teuchos_Array.hpp"
#include "Teuchos_ParameterList.hpp"
#include "Stokhos_ParallelData.hpp"
#include "Stokhos_OrthogPolyBasis.hpp"
#include "Stokhos_OrthogPolyExpansion.hpp"
#include "Stokhos_VectorOrthogPoly.hpp"
#include "Stokhos_VectorOrthogPolyTraitsEpetra.hpp"
#include "Stokhos_EpetraVectorOrthogPoly.hpp"
#include "Stokhos_EpetraMultiVectorOrthogPoly.hpp"
#include "Stokhos_SGOperator.hpp"
#include "Stokhos_EpetraSparse3Tensor.hpp"
namespace Stokhos {
//! Nonlinear, stochastic Galerkin ModelEvaluator that constructs a interlaced Jacobian
/*!
* SGModelEvaluator_Interlaced is an implementation of EpetraExt::ModelEvaluator that
* generates a nonlinear problem from a stochastic Galerkin
* expansion, the Jacobian and solution vectors are interlaced. It wraps a supplied
* ModelEvaluator that supports the SG
* versions of p, x, and possibly x_dot InArgs, and f and W OutArgs, and
* translates those into a new nonlinear problem. It does so by
* concatenating all of the SG components of p, x, x_dot, and f into extended
* block vectors that form the parameters, solution vector, time derivative
* vector and residual for the new nonlinear problem. Only
* forming a fully-assembled SG matrix
* is possible. The W operator of the underlying model evaluator must be
* an Epetra_CrsMatrix.
*/
class SGModelEvaluator_Interlaced : public EpetraExt::ModelEvaluator {
public:
// Constructor
SGModelEvaluator_Interlaced(
const Teuchos::RCP<EpetraExt::ModelEvaluator>& me,
const Teuchos::RCP<const Stokhos::OrthogPolyBasis<int,double> >& sg_basis,
const Teuchos::RCP<const Stokhos::Quadrature<int,double> >& sg_quad,
const Teuchos::RCP<Stokhos::OrthogPolyExpansion<int,double> >& sg_exp,
const Teuchos::RCP<const Stokhos::ParallelData>& sg_parallel_data,
const Teuchos::RCP<Teuchos::ParameterList>& params,
bool scaleOP = true);
/** \name Overridden from EpetraExt::ModelEvaluator . */
//@{
// inputs
//////////////////////////
//! Return solution vector map
Teuchos::RCP<const Epetra_Map> get_x_map() const;
//! Return parameter vector map
Teuchos::RCP<const Epetra_Map> get_p_map(int l) const;
//! Return array of parameter names
Teuchos::RCP<const Teuchos::Array<std::string> >
get_p_names(int l) const;
//! Return initial solution
Teuchos::RCP<const Epetra_Vector> get_x_init() const;
//! Return initial parameters
Teuchos::RCP<const Epetra_Vector> get_p_init(int l) const;
// outputs
//////////////////////////
//! Return residual vector map
Teuchos::RCP<const Epetra_Map> get_f_map() const;
//! Return response map
Teuchos::RCP<const Epetra_Map> get_g_map(int l) const;
//! Create W = alpha*M + beta*J matrix
Teuchos::RCP<Epetra_Operator> create_W() const;
// ????
//////////////////////////
//! Create InArgs
InArgs createInArgs() const;
//! Create OutArgs
OutArgs createOutArgs() const;
//! Evaluate model on InArgs
void evalModel(const InArgs& inArgs, const OutArgs& outArgs) const;
//@}
//! Set initial solution polynomial
void set_x_sg_init(const Stokhos::EpetraVectorOrthogPoly& x_sg_in);
//! Return initial SG x
Teuchos::RCP<const Stokhos::EpetraVectorOrthogPoly> get_x_sg_init() const;
//! Set initial parameter polynomial
void set_p_sg_init(int i, const Stokhos::EpetraVectorOrthogPoly& p_sg_in);
//! Return initial SG parameters
Teuchos::RCP<const Stokhos::EpetraVectorOrthogPoly> get_p_sg_init(int l) const;
//! Get indices of SG parameters
/*!
* These indices determine which parameter vectors support SG
*/
Teuchos::Array<int> get_p_sg_map_indices() const;
//! Get indices of SG responses
/*!
* These indices determine which response vectors support SG
*/
Teuchos::Array<int> get_g_sg_map_indices() const;
//! Get base maps of SG responses
Teuchos::Array< Teuchos::RCP<const Epetra_Map> > get_g_sg_base_maps() const;
//! Return overlap stochastic map
Teuchos::RCP<const Epetra_BlockMap> get_overlap_stochastic_map() const;
//! Return x sg overlap map
Teuchos::RCP<const Epetra_BlockMap> get_x_sg_overlap_map() const;
//! Return x sg importer
Teuchos::RCP<const Epetra_Import> get_x_sg_importer() const;
//! Create vector orthog poly using x map and owned sg map
Teuchos::RCP<Stokhos::EpetraVectorOrthogPoly>
create_x_sg(Epetra_DataAccess CV = Copy,
const Epetra_Vector* v = NULL) const;
//! Create vector orthog poly using x map and overlap sg map
Teuchos::RCP<Stokhos::EpetraVectorOrthogPoly>
create_x_sg_overlap(Epetra_DataAccess CV = Copy,
const Epetra_Vector* v = NULL) const;
//! Create vector orthog poly using x map and owned sg map
Teuchos::RCP<Stokhos::EpetraMultiVectorOrthogPoly>
create_x_mv_sg(int num_vecs,
Epetra_DataAccess CV = Copy,
const Epetra_MultiVector* v = NULL) const;
//! Create vector orthog poly using x map and overlap sg map
Teuchos::RCP<Stokhos::EpetraMultiVectorOrthogPoly>
create_x_mv_sg_overlap(int num_vecs,
Epetra_DataAccess CV = Copy,
const Epetra_MultiVector* v = NULL) const;
//! Create vector orthog poly using p map
Teuchos::RCP<Stokhos::EpetraVectorOrthogPoly>
create_p_sg(int l, Epetra_DataAccess CV = Copy,
const Epetra_Vector* v = NULL) const;
//! Create vector orthog poly using f map and owned sg map
Teuchos::RCP<Stokhos::EpetraVectorOrthogPoly>
create_f_sg(Epetra_DataAccess CV = Copy,
const Epetra_Vector* v = NULL) const;
//! Create vector orthog poly using f map and overlap sg map
Teuchos::RCP<Stokhos::EpetraVectorOrthogPoly>
create_f_sg_overlap(Epetra_DataAccess CV = Copy,
const Epetra_Vector* v = NULL) const;
//! Create multi-vector orthog poly using f map and owned sg map
Teuchos::RCP<Stokhos::EpetraMultiVectorOrthogPoly>
create_f_mv_sg(int num_vecs, Epetra_DataAccess CV = Copy,
const Epetra_MultiVector* v = NULL) const;
//! Create multi-vector orthog poly using f map and overlap sg map
Teuchos::RCP<Stokhos::EpetraMultiVectorOrthogPoly>
create_f_mv_sg_overlap(int num_vecs, Epetra_DataAccess CV = Copy,
const Epetra_MultiVector* v = NULL) const;
//! Create vector orthog poly using g map
Teuchos::RCP<Stokhos::EpetraVectorOrthogPoly>
create_g_sg(int l, Epetra_DataAccess CV = Copy,
const Epetra_Vector* v = NULL) const;
//! Create multi-vector orthog poly using g map
Teuchos::RCP<Stokhos::EpetraMultiVectorOrthogPoly>
create_g_mv_sg(int l, int num_vecs, Epetra_DataAccess CV = Copy,
const Epetra_MultiVector* v = NULL) const;
/** Build an interlaced map containing stochastic degrees of freedom for each
* element of the detministic map. This is not an adaptive map!
*/
static Teuchos::RCP<Epetra_Map>
buildInterlaceMap(const Epetra_BlockMap & determ_map,const Epetra_BlockMap & stocha_map);
/** Copy from a SG EpetraPolyOrthogVector object to an interlaced vector
*/
static void copyToInterlacedVector(const Stokhos::EpetraVectorOrthogPoly & x_sg,
Epetra_Vector & x);
/** Copy from a SG EpetraPolyOrthogVector object to an interlaced vector
*/
static void copyToPolyOrthogVector(const Epetra_Vector & x,
Stokhos::EpetraVectorOrthogPoly & x_sg);
protected:
//! Underlying model evaluator
Teuchos::RCP<EpetraExt::ModelEvaluator> me;
//! Stochastic Galerkin basis
Teuchos::RCP<const Stokhos::OrthogPolyBasis<int, double> > sg_basis;
//! Stochastic Galerkin quadrature
Teuchos::RCP<const Stokhos::Quadrature<int,double> > sg_quad;
//! Stochastic Galerkin expansion
Teuchos::RCP<Stokhos::OrthogPolyExpansion<int,double> > sg_exp;
//! Algorithmic parameters
Teuchos::RCP<Teuchos::ParameterList> params;
//! Number of stochastic blocks
unsigned int num_sg_blocks;
//! Number of W stochastic blocks (may be smaller than num_sg_blocks)
unsigned int num_W_blocks;
//! Number of p stochastic blocks (may be smaller than num_sg_blocks)
unsigned int num_p_blocks;
//! Whether we support x (and thus f and W)
bool supports_x;
//! Underlying unknown map
Teuchos::RCP<const Epetra_Map> x_map;
//! Underlying residual map
Teuchos::RCP<const Epetra_Map> f_map;
//! Parallel SG data
Teuchos::RCP<const Stokhos::ParallelData> sg_parallel_data;
//! Parallel SG communicator
Teuchos::RCP<const EpetraExt::MultiComm> sg_comm;
//! Epetra Cijk
Teuchos::RCP<const Stokhos::EpetraSparse3Tensor> epetraCijk;
//! Serial Epetra Cijk for dgdx*
Teuchos::RCP<const Stokhos::EpetraSparse3Tensor> serialCijk;
//! Map for stochastic blocks
Teuchos::RCP<const Epetra_BlockMap> stoch_row_map;
//! Overlapped map for stochastic blocks (local map)
Teuchos::RCP<const Epetra_BlockMap> overlapped_stoch_row_map;
//! Overlapped map for p stochastic blocks (local map)
Teuchos::RCP<const Epetra_BlockMap> overlapped_stoch_p_map;
//! Block SG unknown map
Teuchos::RCP<const Epetra_Map> interlace_x_map;
//! Block SG overlapped unknown map
Teuchos::RCP<const Epetra_Map> interlace_overlapped_x_map;
//! Block SG residual map
Teuchos::RCP<const Epetra_Map> interlace_f_map;
//! Block SG overlapped residual map
Teuchos::RCP<const Epetra_Map> interlace_overlapped_f_map;
//! Importer from SG to SG-overlapped maps
Teuchos::RCP<Epetra_Import> interlace_overlapped_x_importer;
//! Exporter from SG-overlapped to SG maps
Teuchos::RCP<Epetra_Export> interlace_overlapped_f_exporter;
//! Number of parameter vectors of underlying model evaluator
int num_p;
//! Number of stochastic parameter vectors
int num_p_sg;
//! Index map between block-p and p_sg maps
Teuchos::Array<int> sg_p_index_map;
//! Block SG parameter map
Teuchos::Array< Teuchos::RCP<const Epetra_Map> > sg_p_map;
//! SG coefficient parameter names
Teuchos::Array< Teuchos::RCP< Teuchos::Array<std::string> > > sg_p_names;
//! Number of response vectors of underlying model evaluator
int num_g;
//! Number of stochastic response vectors
int num_g_sg;
//! Index map between block-g and g_sg maps
Teuchos::Array<int> sg_g_index_map;
//! Block SG response map
Teuchos::Array< Teuchos::RCP<const Epetra_Map> > sg_g_map;
//! x_dot stochastic Galerkin components
Teuchos::RCP< Stokhos::EpetraVectorOrthogPoly > x_dot_sg_blocks;
//! x stochastic Galerkin components
Teuchos::RCP< Stokhos::EpetraVectorOrthogPoly > x_sg_blocks;
//! f stochastic Galerkin components
mutable Teuchos::RCP< Stokhos::EpetraVectorOrthogPoly > f_sg_blocks;
//! W stochastic Galerkin components
mutable Teuchos::RCP< Stokhos::EpetraOperatorOrthogPoly > W_sg_blocks;
mutable Teuchos::Array< Teuchos::RCP< Stokhos::EpetraMultiVectorOrthogPoly > > dfdp_sg_blocks;
//! dg/dxdot stochastic Galerkin components
mutable Teuchos::Array< Teuchos::RCP< Stokhos::EpetraMultiVectorOrthogPoly > > dgdx_dot_sg_blocks;
//! dg/dx stochastic Galerkin components
mutable Teuchos::Array< Teuchos::RCP< Stokhos::EpetraMultiVectorOrthogPoly > > dgdx_sg_blocks;
//! SG initial x
Teuchos::RCP<Stokhos::EpetraVectorOrthogPoly> sg_x_init;
//! SG initial p
Teuchos::Array< Teuchos::RCP<Stokhos::EpetraVectorOrthogPoly> > sg_p_init;
//! Whether to always evaluate W with f
bool eval_W_with_f;
//! W pointer for evaluating W with f
mutable Teuchos::RCP<Stokhos::SGOperator> my_W;
//! x pointer for evaluating preconditioner
mutable Teuchos::RCP<Epetra_Vector> my_x;
bool scaleOP;
};
}
#endif
|