Teko
Version of the Day
Toggle main menu visibility
Loading...
Searching...
No Matches
src
Teko_IterativePreconditionerFactory.hpp
1
// @HEADER
2
// *****************************************************************************
3
// Teko: A package for block and physics based preconditioning
4
//
5
// Copyright 2010 NTESS and the Teko contributors.
6
// SPDX-License-Identifier: BSD-3-Clause
7
// *****************************************************************************
8
// @HEADER
9
10
#ifndef __Teko_IterativePreconditionerFactory_hpp__
11
#define __Teko_IterativePreconditionerFactory_hpp__
12
13
// Teko includes
14
#include "Teko_PreconditionerFactory.hpp"
15
16
namespace
Teko {
17
60
class
IterativePreconditionerFactory
:
public
virtual
Teko::PreconditionerFactory
{
61
public
:
63
IterativePreconditionerFactory
();
64
75
IterativePreconditionerFactory
(
unsigned
int
correctionNum,
76
const
Teuchos::RCP<Teko::InverseFactory>& precFactory);
77
88
IterativePreconditionerFactory
(
unsigned
int
correctionNum,
89
const
Teuchos::RCP<Teko::PreconditionerFactory>& precFactory);
90
104
virtual
LinearOp
buildPreconditionerOperator
(LinearOp& lo,
PreconditionerState
& state)
const
;
105
107
108
119
virtual
void
initializeFromParameterList
(
const
Teuchos::ParameterList& settings);
120
133
virtual
Teuchos::RCP<Teuchos::ParameterList>
getRequestedParameters
()
const
;
134
146
virtual
bool
updateRequestedParameters
(
const
Teuchos::ParameterList& pl);
147
149
150
protected
:
151
unsigned
int
correctionNum_;
152
Teuchos::RCP<Teko::InverseFactory> precFactory_;
153
};
154
155
}
// end namespace Teko
156
157
#endif
Teko::IterativePreconditionerFactory::updateRequestedParameters
virtual bool updateRequestedParameters(const Teuchos::ParameterList &pl)
Update this object with the fields from a parameter list.
Definition
Teko_IterativePreconditionerFactory.cpp:110
Teko::IterativePreconditionerFactory::buildPreconditionerOperator
virtual LinearOp buildPreconditionerOperator(LinearOp &lo, PreconditionerState &state) const
Function that is called to build the preconditioner for the linear operator that is passed in.
Definition
Teko_IterativePreconditionerFactory.cpp:41
Teko::IterativePreconditionerFactory::initializeFromParameterList
virtual void initializeFromParameterList(const Teuchos::ParameterList &settings)
This function builds the internals of the preconditioner factory from a parameter list.
Definition
Teko_IterativePreconditionerFactory.cpp:74
Teko::IterativePreconditionerFactory::getRequestedParameters
virtual Teuchos::RCP< Teuchos::ParameterList > getRequestedParameters() const
Request the additional parameters this preconditioner factory needs.
Definition
Teko_IterativePreconditionerFactory.cpp:98
Teko::IterativePreconditionerFactory::IterativePreconditionerFactory
IterativePreconditionerFactory()
Default constructor, for use with the AutoClone class.
Definition
Teko_IterativePreconditionerFactory.cpp:18
Teko::PreconditionerFactory
Abstract class which block preconditioner factories in Teko should be based on.
Definition
Teko_PreconditionerFactory.hpp:46
Teko::PreconditionerState
An implementation of a state object preconditioners.
Definition
Teko_PreconditionerState.hpp:34
Generated by
1.17.0