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 // Belos: Block Linear Solvers Package
4 //
5 // Copyright 2004-2016 NTESS and the Belos contributors.
6 // SPDX-License-Identifier: BSD-3-Clause
7 // *****************************************************************************
8 // @HEADER
9 
10 #ifndef BELOS_CG_STOCHASTIC_ITERATION_HPP
11 #define BELOS_CG_STOCHASTIC_ITERATION_HPP
12 
17 #include "BelosConfigDefs.hpp"
18 #include "BelosTypes.hpp"
19 #include "BelosIteration.hpp"
20 #include "BelosCGIteration.hpp"
21 
22 namespace Belos {
23 
25 
26 
31  template <class ScalarType, class MV>
33 
36 
39 
42 
45 
48 
49  StochasticCGIterationState() : R(Teuchos::null), Z(Teuchos::null),
50  P(Teuchos::null), AP(Teuchos::null), Y(Teuchos::null)
51  {}
52  };
53 
54 template<class ScalarType, class MV, class OP>
55 class StochasticCGIteration : virtual public Iteration<ScalarType,MV,OP> {
56 
57  public:
58 
60 
61 
75  virtual void initializeCG(StochasticCGIterationState<ScalarType,MV>& newstate) = 0;
76 
85 
86 };
87 
88 } // end Belos namespace
89 
90 #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 Mon Jul 15 2024 09:24:24 for Belos by doxygen 1.8.5