Belos
Version of the Day
Toggle main menu visibility
Loading...
Searching...
No Matches
src
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
16
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>
32
struct
StochasticCGIterationState
{
33
35
Teuchos::RCP<const MV>
R
;
36
38
Teuchos::RCP<const MV>
Z
;
39
41
Teuchos::RCP<const MV>
P
;
42
44
Teuchos::RCP<const MV>
AP
;
45
47
Teuchos::RCP<const MV>
Y
;
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
83
virtual
StochasticCGIterationState<ScalarType,MV>
getState
()
const
= 0;
85
86
};
87
88
}
// end Belos namespace
89
90
#endif
/* BELOS_STOCHASTIC_CG_ITERATION_HPP */
BelosCGIteration.hpp
Pure virtual base class which augments the basic interface for a conjugate gradient linear solver ite...
BelosConfigDefs.hpp
Belos header file which uses auto-configuration information to include necessary C++ headers.
BelosIteration.hpp
Pure virtual base class which describes the basic interface to the linear solver iteration.
BelosTypes.hpp
Collection of types and exceptions used within the Belos solvers.
Belos::Iteration::Iteration
Iteration()
Default Constructor.
Definition
BelosIteration.hpp:49
Belos::StochasticCGIteration
Definition
BelosStochasticCGIteration.hpp:55
Belos::StochasticCGIteration::getState
virtual StochasticCGIterationState< ScalarType, MV > getState() const =0
Get the current state of the linear solver.
Belos::StochasticCGIteration::initializeCG
virtual void initializeCG(StochasticCGIterationState< ScalarType, MV > &newstate)=0
Initialize the solver to an iterate, providing a complete state.
Belos
Definition
Belos_Details_EBelosSolverType.cpp:13
Belos::StochasticCGIterationState
Structure to contain pointers to CGIteration state variables.
Definition
BelosStochasticCGIteration.hpp:32
Belos::StochasticCGIterationState::Y
Teuchos::RCP< const MV > Y
The current stochastic recurrence vector.
Definition
BelosStochasticCGIteration.hpp:47
Belos::StochasticCGIterationState::AP
Teuchos::RCP< const MV > AP
The matrix A applied to current decent direction vector.
Definition
BelosStochasticCGIteration.hpp:44
Belos::StochasticCGIterationState::P
Teuchos::RCP< const MV > P
The current decent direction vector.
Definition
BelosStochasticCGIteration.hpp:41
Belos::StochasticCGIterationState::Z
Teuchos::RCP< const MV > Z
The current preconditioned residual.
Definition
BelosStochasticCGIteration.hpp:38
Belos::StochasticCGIterationState::R
Teuchos::RCP< const MV > R
The current residual.
Definition
BelosStochasticCGIteration.hpp:35
Belos::StochasticCGIterationState::StochasticCGIterationState
StochasticCGIterationState()
Definition
BelosStochasticCGIteration.hpp:49
Generated for Belos by
1.17.0