47#include "Teko_Config.h"
48#include "Teko_PreconditionerFactory.hpp"
50#include "Teko_InverseLibrary.hpp"
51#include "Teko_Preconditioner.hpp"
54#include "Teko_JacobiPreconditionerFactory.hpp"
55#include "Teko_GaussSeidelPreconditionerFactory.hpp"
56#include "Teko_AddPreconditionerFactory.hpp"
57#include "Teko_MultPreconditionerFactory.hpp"
58#include "Teko_LU2x2PreconditionerFactory.hpp"
59#include "Teko_IterativePreconditionerFactory.hpp"
60#include "Teko_DiagnosticPreconditionerFactory.hpp"
61#include "Teko_DiagonallyScaledPreconditionerFactory.hpp"
62#ifdef TEKO_HAVE_EPETRA
63#include "Teko_DiagonalPreconditionerFactory.hpp"
65#include "Teko_ProbingPreconditionerFactory.hpp"
66#include "Teko_IdentityPreconditionerFactory.hpp"
67#include "NS/Teko_LSCPreconditionerFactory.hpp"
68#include "NS/Teko_SIMPLEPreconditionerFactory.hpp"
69#include "NS/Teko_TimingsSIMPLEPreconditionerFactory.hpp"
71#ifdef Teko_ENABLE_ML_SMOOTHERS
72#include "Teko_SmootherPreconditionerFactory.hpp"
73#include "Teko_MLPreconditionerFactory.hpp"
77#include "Thyra_DefaultPreconditioner.hpp"
88 RCP<const Thyra::LinearOpBase<double> > A = fwdOpSrc.getOp();
89 return A!=Teuchos::null;
98 bp->getStateObject()->setInitialized(
false);
105 PreconditionerBase<double> * prec,
106 const ESupportSolveUse )
const
109 LinearOp A = Teuchos::rcp_const_cast<Thyra::LinearOpBase<double> >(ASrc->getOp());
112 TEUCHOS_ASSERT(blkPrec!=0);
115 RCP<PreconditionerState> state = blkPrec->getStateObject();
116 state->setInitialized(
false);
122 setOpRequestHandler(*
this,M);
125 DefaultPreconditioner<double> & dPrec = Teuchos::dyn_cast<DefaultPreconditioner<double> >(*prec);
126 dPrec.initializeUnspecified(Teuchos::rcp_const_cast<LinearOpBase<double> >(M));
131 const RCP<
const Thyra::MultiVectorBase<double> > & solnVec,
132 PreconditionerBase<double> * prec,
133 const ESupportSolveUse supportSolveUse)
const
135 Preconditioner * blkPrec =
dynamic_cast<Preconditioner *
>(prec);
136 blkPrec->setSourceVector(Teuchos::rcp_const_cast<Thyra::MultiVectorBase<double> >(solnVec));
143 RCP<
const LinearOpSourceBase<double> > * ,
144 ESupportSolveUse * )
const
149 TEUCHOS_TEST_FOR_EXCEPT_MSG(
true,
"\"PreconditionerFactory::uninitializePrec not implemented\"");
170 RCP<Teuchos::ParameterList> _paramList =
paramList_;
178 inverseLibrary_ = il;
185 if(inverseLibrary_==Teuchos::null)
186 return InverseLibrary::buildFromStratimikos();
188 return inverseLibrary_;
198 ModifiableLinearOp mlo = Teuchos::rcp_const_cast<Thyra::LinearOpBase<double> >(op);
201 RCP<RequestHandlerContainer> reqHandCont = Teuchos::rcp_dynamic_cast<RequestHandlerContainer>(mlo);
202 if(reqHandCont!=Teuchos::null) {
212CloneFactory<PreconditionerFactory> PreconditionerFactory::precFactoryBuilder_;
228RCP<PreconditionerFactory>
230 const Teuchos::ParameterList & settings,
231 const RCP<const InverseLibrary> & invLib)
233 Teko_DEBUG_SCOPE(
"PreconditionerFactory::buildPreconditionerFactory",10);
236 if(precFactoryBuilder_.cloneCount()==0) initializePrecFactoryBuilder();
239 RCP<PreconditionerFactory> precFact = precFactoryBuilder_.build(name);
241 Teko_DEBUG_MSG_BEGIN(5);
242 DEBUG_STREAM <<
"Looked up \"" << name <<
"\"" << std::endl;
243 DEBUG_STREAM <<
"Built " << precFact << std::endl;
244 Teko_DEBUG_MSG_END();
246 if(precFact==Teuchos::null)
247 return Teuchos::null;
250 if(invLib!=Teuchos::null) {
251 precFact->setInverseLibrary(invLib);
252 precFact->setRequestHandler(invLib->getRequestHandler());
257 precFact->initializeFromParameterList(settings);
278 if(precFactoryBuilder_.cloneCount()==0) initializePrecFactoryBuilder();
281 precFactoryBuilder_.addClone(name,clone);
285void PreconditionerFactory::initializePrecFactoryBuilder()
287 RCP<Cloneable> clone;
291 precFactoryBuilder_.addClone(
"Block LU2x2",clone);
294 precFactoryBuilder_.addClone(
"Block Jacobi",clone);
297 precFactoryBuilder_.addClone(
"Block Gauss-Seidel",clone);
300 precFactoryBuilder_.addClone(
"Block Add",clone);
303 precFactoryBuilder_.addClone(
"Block Multiply",clone);
306 precFactoryBuilder_.addClone(
"NS LSC",clone);
309 precFactoryBuilder_.addClone(
"NS SIMPLE",clone);
312 precFactoryBuilder_.addClone(
"NS SIMPLE-Timed",clone);
315 precFactoryBuilder_.addClone(
"Iterative Preconditioner",clone);
317#ifdef TEKO_HAVE_EPETRA
319 precFactoryBuilder_.addClone(
"Explicit Diagonal Preconditioner",clone);
323 precFactoryBuilder_.addClone(
"Diagnostic Inverse",clone);
326 precFactoryBuilder_.addClone(
"Diagonal Scaling",clone);
329 precFactoryBuilder_.addClone(
"Identity",clone);
331#ifdef Teko_ENABLE_Isorropia
333 precFactoryBuilder_.addClone(
"Probing Preconditioner",clone);
336#ifdef Teko_ENABLE_ML_SMOOTHERS
338 precFactoryBuilder_.addClone(
"Blocked ML Preconditioner",clone);
345 if(precFactoryBuilder_.cloneCount()==0) initializePrecFactoryBuilder();
346 precFactoryBuilder_.getCloneNames(names);
void initializePrec(const Teuchos::RCP< const Thyra::LinearOpSourceBase< double > > &fwdOpSrc, const Teuchos::RCP< const Thyra::MultiVectorBase< double > > &solnVec, Thyra::PreconditionerBase< double > *precOp, const Thyra::ESupportSolveUse supportSolveUse) const
initialize a newly created preconditioner object
Teuchos::RCP< Teuchos::ParameterList > getNonconstParameterList()
Get the parameter list that was set using setParameterList().
void setInverseLibrary(const Teuchos::RCP< const InverseLibrary > &il)
Set the inverse library used by this preconditioner factory.
static Teuchos::RCP< PreconditionerFactory > buildPreconditionerFactory(const std::string &name, const Teuchos::ParameterList &settings, const Teuchos::RCP< const InverseLibrary > &invLib=Teuchos::null)
Builder function for creating preconditioner factories (yes this is a factory factory).
Teuchos::RCP< Thyra::PreconditionerBase< double > > createPrec() const
create an instance of the preconditioner
void setParameterList(const Teuchos::RCP< Teuchos::ParameterList > ¶mList)
Set parameters from a parameter list and return with default values.
Teuchos::RCP< Teuchos::ParameterList > paramList_
for ParameterListAcceptor
static void addPreconditionerFactory(const std::string &name, const Teuchos::RCP< Cloneable > &clone)
Add a preconditioner factory to the builder. This is done using the clone pattern.
virtual LinearOp buildPreconditionerOperator(LinearOp &lo, PreconditionerState &state) const =0
Function that is called to build the preconditioner for the linear operator that is passed in.
void uninitializePrec(Thyra::PreconditionerBase< double > *prec, Teuchos::RCP< const Thyra::LinearOpSourceBase< double > > *fwdOpSrc, Thyra::ESupportSolveUse *supportSolveUse) const
wipe clean a already initialized preconditioner object
bool isCompatible(const Thyra::LinearOpSourceBase< double > &fwdOpSrc) const
is this operator compatiable with the preconditioner factory?
static void getPreconditionerFactoryNames(std::vector< std::string > &names)
Get the names of the block preconditioner factories.
virtual Teuchos::RCP< PreconditionerState > buildPreconditionerState() const
Function that permits the construction of an arbitrary PreconditionerState object.
Teuchos::RCP< const InverseLibrary > getInverseLibrary() const
Get the inverse library used by this preconditioner factory.
Teuchos::RCP< Teuchos::ParameterList > unsetParameterList()
Unset the parameter list that was set using setParameterList().
An extension of the Thyra::DefaultPreconditioner class with some specializations useful for use withi...
virtual Teuchos::RCP< RequestHandler > getRequestHandler() const =0
Get the request handler with pointers to the appropriate callbacks.