/usr/include/trilinos/NOX_Epetra_LinearSystem_SGGS.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 | /*
// @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 NOX_EPETRA_LINEARSYSTEMSGGS_H
#define NOX_EPETRA_LINEARSYSTEMSGGS_H
#include "Stokhos_ConfigDefs.h"
#ifdef HAVE_STOKHOS_NOX
#include "NOX_Common.H"
#include "NOX_Epetra_LinearSystem.H" // base class
#include "NOX_Utils.H" // class data element
#include "Stokhos_ParallelData.hpp"
#include "Stokhos_OrthogPolyBasis.hpp"
#include "Stokhos_EpetraSparse3Tensor.hpp"
#include "Stokhos_VectorOrthogPoly.hpp"
#include "Stokhos_VectorOrthogPolyTraitsEpetra.hpp"
#include "Stokhos_SGOperator.hpp"
#include "Stokhos_Sparse3Tensor.hpp"
#include "Epetra_Export.h"
namespace NOX {
namespace Epetra {
namespace Interface {
class Required;
class Jacobian;
class Preconditioner;
}
}
}
namespace NOX {
namespace Epetra {
/*!
* \brief Concrete implementation of NOX::Epetra::LinearSolver for
* stochastic Galerkin systems using Gauss-Seidel iterations.
*/
class LinearSystemSGGS : public virtual NOX::Epetra::LinearSystem {
public:
//! Constructor
LinearSystemSGGS(
Teuchos::ParameterList& printingParams,
Teuchos::ParameterList& linearSolverParams,
const Teuchos::RCP<NOX::Epetra::LinearSystem>& detsolve,
const Teuchos::RCP<NOX::Epetra::Interface::Required>& iReq,
const Teuchos::RCP<NOX::Epetra::Interface::Jacobian>& iJac,
const Teuchos::RCP<const Stokhos::OrthogPolyBasis<int,double> >& sg_basis,
const Teuchos::RCP<const Stokhos::ParallelData>& sg_parallel_data,
const Teuchos::RCP<Epetra_Operator>& J,
const Teuchos::RCP<const Epetra_Map>& base_map,
const Teuchos::RCP<const Epetra_Map>& sg_map,
const Teuchos::RCP<NOX::Epetra::Scaling> scalingObject =
Teuchos::null);
//! Destructor.
virtual ~LinearSystemSGGS();
/*!
* \brief Applies Jacobian to the given input vector and puts the
* answer in the result.
*/
virtual bool applyJacobian(const NOX::Epetra::Vector& input,
NOX::Epetra::Vector& result) const;
/*!
* \brief Applies Jacobian-Transpose to the given input vector and puts
* the answer in the result.
*/
virtual bool applyJacobianTranspose(const NOX::Epetra::Vector& input,
NOX::Epetra::Vector& result) const;
/*!
* \brief Applies the inverse of the Jacobian matrix to the given
* input vector and puts the answer in result.
*/
virtual bool applyJacobianInverse(Teuchos::ParameterList ¶ms,
const NOX::Epetra::Vector &input,
NOX::Epetra::Vector &result);
//! Returns false
virtual bool applyRightPreconditioning(bool useTranspose,
Teuchos::ParameterList& params,
const NOX::Epetra::Vector& input,
NOX::Epetra::Vector& result) const;
//! Returns supplied scaling object
virtual Teuchos::RCP<NOX::Epetra::Scaling> getScaling();
//! Reset supplied scaling object
virtual void resetScaling(const Teuchos::RCP<NOX::Epetra::Scaling>& s);
//! Evaluates the Jacobian based on the solution vector x.
virtual bool computeJacobian(const NOX::Epetra::Vector& x);
//! Returns false
virtual bool createPreconditioner(const NOX::Epetra::Vector& x,
Teuchos::ParameterList& p,
bool recomputeGraph) const;
//! Returns false
virtual bool destroyPreconditioner() const;
//! Returns false
virtual bool recomputePreconditioner(const NOX::Epetra::Vector& x,
Teuchos::ParameterList& linearSolverParams) const;
//! Returns PRPT_REUSE;
virtual PreconditionerReusePolicyType
getPreconditionerPolicy(bool advanceReuseCounter=true);
//! Returns false
virtual bool isPreconditionerConstructed() const;
//! Returns false
virtual bool hasPreconditioner() const;
//! Returns jacobian operator
virtual Teuchos::RCP<const Epetra_Operator>
getJacobianOperator() const;
//! Returns jacobian operator
virtual Teuchos::RCP<Epetra_Operator> getJacobianOperator();
//! Returns Teuchos::null
virtual Teuchos::RCP<const Epetra_Operator>
getGeneratedPrecOperator() const;
//! Returns Teuchos::null
virtual Teuchos::RCP<Epetra_Operator> getGeneratedPrecOperator();
//! Resets the jacobian operator
virtual void setJacobianOperatorForSolve(const Teuchos::RCP<const Epetra_Operator>& solveJacOp);
//! Does nothing
virtual void setPrecOperatorForSolve(const Teuchos::RCP<const Epetra_Operator>& solvePrecOp);
protected:
//! Pointer to deterministic solver
Teuchos::RCP<NOX::Epetra::LinearSystem> det_solver;
//! Stochastic Galerking basis
Teuchos::RCP<const Stokhos::OrthogPolyBasis<int,double> > sg_basis;
//! Stores Epetra Cijk tensor
Teuchos::RCP<const Stokhos::EpetraSparse3Tensor> epetraCijk;
//! Whether we have parallelism over stochastic blocks
bool is_stoch_parallel;
//! Stores stochastic part of row map
Teuchos::RCP<const Epetra_BlockMap> stoch_row_map;
//! Short-hand for Cijk
typedef Stokhos::Sparse3Tensor<int,double> Cijk_type;
//! Pointer to triple product
Teuchos::RCP<const Cijk_type > Cijk;
//! Reference to the user supplied Jacobian interface functions
Teuchos::RCP<NOX::Epetra::Interface::Jacobian> jacInterfacePtr;
//! Pointer to the Stokhos matrixfree epetra operator.
mutable Teuchos::RCP<Stokhos::SGOperator> sg_op;
//! Pointer to the PCE expansion of Jacobian.
mutable Teuchos::RCP<const Stokhos::EpetraOperatorOrthogPoly > sg_poly;
//! Stores base map
Teuchos::RCP<const Epetra_Map> base_map;
//! Stores SG map
Teuchos::RCP<const Epetra_Map> sg_map;
//! Scaling object supplied by the user
Teuchos::RCP<NOX::Epetra::Scaling> scaling;
//! Printing Utilities object
NOX::Utils utils;
//! Stores block vector of right-hand-sides
mutable Teuchos::RCP<EpetraExt::BlockVector> sg_df_block;
//! Stores block residual vector to compute residual norm
mutable Teuchos::RCP<EpetraExt::BlockVector> sg_y_block;
//! Stores K_0*x for the most recently computed x
mutable Teuchos::RCP<Epetra_Vector> kx;
//! Flag indicating whether stochastic blocks are distributed
bool is_parallel;
//! Stores global column map
Teuchos::RCP<const Epetra_BlockMap> sg_col_map;
//! Stores exporter from column map to row map
Teuchos::RCP<Epetra_Export> col_exporter;
//! Stores off-processor contributions to right-hand-sides
Teuchos::RCP<EpetraExt::BlockVector> sg_df_col;
//! Stores summed off-processor contributions
Teuchos::RCP<EpetraExt::BlockVector> sg_df_tmp;
//! Only use linear terms in interation
bool only_use_linear;
//! Limit to k-index
int k_limit;
};
} // namespace Epetra
} // namespace NOX
#endif
#endif
|