Teko Version of the Day
Loading...
Searching...
No Matches
Teko_JacobiPreconditionerFactory.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_JacobiPreconditionerFactory_hpp__
11#define __Teko_JacobiPreconditionerFactory_hpp__
12
13#include "Teuchos_RCP.hpp"
14
15#include "Teko_BlockPreconditionerFactory.hpp"
16#include "Teko_BlockInvDiagonalStrategy.hpp"
17
18namespace Teko {
19
36 public:
38
39
43 JacobiPreconditionerFactory(const LinearOp& invD0, const LinearOp& invD1);
44
49 JacobiPreconditionerFactory(const RCP<const BlockInvDiagonalStrategy>& strategy);
50
54
56
63 LinearOp buildPreconditionerOperator(BlockedLinearOp& blo, BlockPreconditionerState& state) const;
64
66 Teuchos::RCP<const BlockInvDiagonalStrategy> getInvDiagStrategy() const {
67 return invOpsStrategy_;
68 }
69
70 protected:
72
74 Teuchos::RCP<const BlockInvDiagonalStrategy> invOpsStrategy_;
75
77 virtual void initializeFromParameterList(const Teuchos::ParameterList& pl);
78};
79
80} // end namespace Teko
81
82#endif
Abstract class which block preconditioner factories in Teko should be based on.
virtual LinearOp buildPreconditionerOperator(BlockedLinearOp &blo, BlockPreconditionerState &state) const =0
Function that is called to build the preconditioner for the linear operator that is passed in.
An implementation of a state object for block preconditioners.
virtual void initializeFromParameterList(const Teuchos::ParameterList &pl)
Initialize from a parameter list.
LinearOp buildPreconditionerOperator(BlockedLinearOp &blo, BlockPreconditionerState &state) const
Create the Jacobi preconditioner operator.
Teuchos::RCP< const BlockInvDiagonalStrategy > getInvDiagStrategy() const
Get inv diagonal strategy.
JacobiPreconditionerFactory(const LinearOp &invD0, const LinearOp &invD1)
Teuchos::RCP< const BlockInvDiagonalStrategy > invOpsStrategy_
some members