Teko
Version of the Day
Toggle main menu visibility
Loading...
Searching...
No Matches
src
Teko_AddPreconditionerFactory.hpp
1
/*
2
// @HEADER
3
//
4
// ***********************************************************************
5
//
6
// Teko: A package for block and physics based preconditioning
7
// Copyright 2010 Sandia Corporation
8
//
9
// Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
10
// the U.S. Government retains certain rights in this software.
11
//
12
// Redistribution and use in source and binary forms, with or without
13
// modification, are permitted provided that the following conditions are
14
// met:
15
//
16
// 1. Redistributions of source code must retain the above copyright
17
// notice, this list of conditions and the following disclaimer.
18
//
19
// 2. Redistributions in binary form must reproduce the above copyright
20
// notice, this list of conditions and the following disclaimer in the
21
// documentation and/or other materials provided with the distribution.
22
//
23
// 3. Neither the name of the Corporation nor the names of the
24
// contributors may be used to endorse or promote products derived from
25
// this software without specific prior written permission.
26
//
27
// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
28
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
29
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
30
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
31
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
32
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
33
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
34
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
35
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
36
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
37
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
38
//
39
// Questions? Contact Eric C. Cyr (eccyr@sandia.gov)
40
//
41
// ***********************************************************************
42
//
43
// @HEADER
44
45
*/
46
47
#ifndef __Teko_AddPreconditionerFactory_hpp__
48
#define __Teko_AddPreconditionerFactory_hpp__
49
50
#include "Teko_BlockPreconditionerFactory.hpp"
51
#include "
Teko_Utilities.hpp
"
52
53
namespace
Teko {
54
59
class
AddPrecondState :
public
Teko::BlockPreconditionerState
{
60
public
:
61
AddPrecondState() {}
62
63
Teuchos::RCP<BlockPreconditionerState> StateOne_;
64
Teuchos::RCP<BlockPreconditionerState> StateTwo_;
65
};
66
71
class
AddPreconditionerFactory
72
:
public
Teko::BlockPreconditionerFactory
{
73
public
:
75
AddPreconditionerFactory
(
const
Teuchos::RCP<const Teko::BlockPreconditionerFactory> & FirstFactory,
76
const
Teuchos::RCP<const Teko::BlockPreconditionerFactory> & SecondFactory);
77
78
AddPreconditionerFactory
();
79
81
Teko::LinearOp
buildPreconditionerOperator
(Teko::BlockedLinearOp & blo,
82
Teko::BlockPreconditionerState
& state)
const
;
83
85
virtual
Teuchos::RCP<Teko::PreconditionerState>
buildPreconditionerState
()
const
;
86
87
protected
:
88
using
Teko::BlockPreconditionerFactory::buildPreconditionerOperator
;
89
90
// class members
91
Teuchos::RCP<const Teko::BlockPreconditionerFactory> FirstFactory_;
92
Teuchos::RCP<const Teko::BlockPreconditionerFactory> SecondFactory_;
93
95
virtual
void
initializeFromParameterList
(
const
Teuchos::ParameterList & pl);
96
};
97
98
}
// end namespace Teko
99
100
#endif
Teko_Utilities.hpp
Teko::AddPreconditionerFactory::buildPreconditionerState
virtual Teuchos::RCP< Teko::PreconditionerState > buildPreconditionerState() const
Build the AddPrecondState object.
Definition
Teko_AddPreconditionerFactory.cpp:63
Teko::AddPreconditionerFactory::AddPreconditionerFactory
AddPreconditionerFactory(const Teuchos::RCP< const Teko::BlockPreconditionerFactory > &FirstFactory, const Teuchos::RCP< const Teko::BlockPreconditionerFactory > &SecondFactory)
Constructor.
Teko::AddPreconditionerFactory::buildPreconditionerOperator
Teko::LinearOp buildPreconditionerOperator(Teko::BlockedLinearOp &blo, Teko::BlockPreconditionerState &state) const
Function inherited from Teko::BlockPreconditionerFactory.
Definition
Teko_AddPreconditionerFactory.cpp:73
Teko::AddPreconditionerFactory::initializeFromParameterList
virtual void initializeFromParameterList(const Teuchos::ParameterList &pl)
Initialize from a parameter list.
Definition
Teko_AddPreconditionerFactory.cpp:94
Teko::BlockPreconditionerFactory
Abstract class which block preconditioner factories in Teko should be based on.
Definition
Teko_BlockPreconditionerFactory.hpp:99
Teko::BlockPreconditionerFactory::buildPreconditionerOperator
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.
Teko::BlockPreconditionerState
An implementation of a state object for block preconditioners.
Definition
Teko_BlockPreconditionerFactory.hpp:80
Generated by
1.17.0