ROL
ROL_Krylov.hpp
Go to the documentation of this file.
1 // @HEADER
2 // ************************************************************************
3 //
4 // Rapid Optimization Library (ROL) Package
5 // Copyright (2014) 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 lead developers:
38 // Drew Kouri (dpkouri@sandia.gov) and
39 // Denis Ridzal (dridzal@sandia.gov)
40 //
41 // ************************************************************************
42 // @HEADER
43 
44 #ifndef ROL_KRYLOV_H
45 #define ROL_KRYLOV_H
46 
51 #include "ROL_Vector.hpp"
52 #include "ROL_LinearOperator.hpp"
53 
54 namespace ROL {
55 
56 template<class Real>
57 class Krylov {
58 
59  Real absTol_; // Absolute residual tolerance
60  Real relTol_; // Relative residual tolerance
61  unsigned maxit_; // Maximum number of iterations
62 
63 public:
64  virtual ~Krylov(void) {}
65 
66  Krylov( Real absTol = 1.e-4, Real relTol = 1.e-2, unsigned maxit = 100 )
67  : absTol_(absTol), relTol_(relTol), maxit_(maxit) {}
68 
69  // Run Krylov Method
70  virtual void run( Vector<Real> &x, LinearOperator<Real> &A, const Vector<Real> &b, LinearOperator<Real> &M,
71  int &iter, int &flag ) = 0;
72 
73  void resetAbsoluteTolerance(const Real absTol) const {
74  absTol_ = absTol;
75  }
76  void resetRelativeTolerance(const Real relTol) const {
77  relTol_ = relTol;
78  }
79  void resetMaximumIteration(const unsigned maxit) {
80  maxit_ = maxit;
81  }
82  Real getAbsoluteTolerance(void) const {
83  return absTol_;
84  }
85  Real getRelativeTolerance(void) const {
86  return relTol_;
87  }
88  unsigned getMaximumIteration(void) const {
89  return maxit_;
90  }
91 };
92 
93 }
94 
95 #include "ROL_KrylovFactory.hpp"
96 
97 #endif
Defines the linear algebra or vector space interface.
Definition: ROL_Vector.hpp:74
void resetMaximumIteration(const unsigned maxit)
Definition: ROL_Krylov.hpp:79
virtual void run(Vector< Real > &x, LinearOperator< Real > &A, const Vector< Real > &b, LinearOperator< Real > &M, int &iter, int &flag)=0
Real getAbsoluteTolerance(void) const
Definition: ROL_Krylov.hpp:82
unsigned getMaximumIteration(void) const
Definition: ROL_Krylov.hpp:88
void resetRelativeTolerance(const Real relTol) const
Definition: ROL_Krylov.hpp:76
void resetAbsoluteTolerance(const Real absTol) const
Definition: ROL_Krylov.hpp:73
unsigned maxit_
Definition: ROL_Krylov.hpp:61
Provides definitions for Krylov solvers.
Definition: ROL_Krylov.hpp:57
Provides the interface to apply a linear operator.
Real getRelativeTolerance(void) const
Definition: ROL_Krylov.hpp:85
virtual ~Krylov(void)
Definition: ROL_Krylov.hpp:64
Krylov(Real absTol=1.e-4, Real relTol=1.e-2, unsigned maxit=100)
Definition: ROL_Krylov.hpp:66