Belos  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
BelosStochasticCGIteration.hpp
Go to the documentation of this file.
1 //@HEADER
2 // ************************************************************************
3 //
4 // Belos: Block Linear Solvers Package
5 // Copyright 2004 Sandia Corporation
6 //
7 // Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
8 // the U.S. Government retains certain rights in this software.
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 Michael A. Heroux (maherou@sandia.gov)
38 //
39 // ************************************************************************
40 //@HEADER
41 
42 #ifndef BELOS_CG_STOCHASTIC_ITERATION_HPP
43 #define BELOS_CG_STOCHASTIC_ITERATION_HPP
44 
49 #include "BelosConfigDefs.hpp"
50 #include "BelosTypes.hpp"
51 #include "BelosIteration.hpp"
52 #include "BelosCGIteration.hpp"
53 
54 namespace Belos {
55 
57 
58 
63  template <class ScalarType, class MV>
65 
68 
71 
74 
77 
80 
81  StochasticCGIterationState() : R(Teuchos::null), Z(Teuchos::null),
82  P(Teuchos::null), AP(Teuchos::null), Y(Teuchos::null)
83  {}
84  };
85 
86 template<class ScalarType, class MV, class OP>
87 class StochasticCGIteration : virtual public Iteration<ScalarType,MV,OP> {
88 
89  public:
90 
92 
93 
107  virtual void initializeCG(StochasticCGIterationState<ScalarType,MV>& newstate) = 0;
108 
117 
118 };
119 
120 } // end Belos namespace
121 
122 #endif /* BELOS_STOCHASTIC_CG_ITERATION_HPP */
Collection of types and exceptions used within the Belos solvers.
virtual StochasticCGIterationState< ScalarType, MV > getState() const =0
Get the current state of the linear solver.
Pure virtual base class which augments the basic interface for a conjugate gradient linear solver ite...
Pure virtual base class which describes the basic interface to the linear solver iteration.
Teuchos::RCP< const MV > Z
The current preconditioned residual.
virtual void initializeCG(StochasticCGIterationState< ScalarType, MV > &newstate)=0
Initialize the solver to an iterate, providing a complete state.
Teuchos::RCP< const MV > AP
The matrix A applied to current decent direction vector.
Teuchos::RCP< const MV > R
The current residual.
Teuchos::RCP< const MV > P
The current decent direction vector.
Belos header file which uses auto-configuration information to include necessary C++ headers...
Teuchos::RCP< const MV > Y
The current stochastic recurrence vector.
Structure to contain pointers to CGIteration state variables.

Generated on Fri Jun 5 2020 10:20:48 for Belos by doxygen 1.8.5