Teko Version of the Day
Loading...
Searching...
No Matches
Teko_InverseLibrary.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_InverseLibrary_hpp__
48#define __Teko_InverseLibrary_hpp__
49
50#include "Teko_InverseFactory.hpp"
51
52// Teuchos includes
53#include "Teuchos_ParameterList.hpp"
54
55// Stratimikos includes
56#include "Stratimikos_DefaultLinearSolverBuilder.hpp"
57
58// Teko includes
59#include "Teko_RequestHandler.hpp"
60#include "Teko_RequestHandlerContainer.hpp"
61
62namespace Teko {
63
64void addToStratimikosBuilder(const Teuchos::RCP<Stratimikos::DefaultLinearSolverBuilder> & builder);
65
66class InverseLibrary : public RequestHandlerContainer {
67public:
68 InverseLibrary();
69
70 InverseLibrary(const Teuchos::RCP<Stratimikos::DefaultLinearSolverBuilder> & strat);
71
73 void addInverse(const std::string & label,const Teuchos::ParameterList & pl);
74
76 void addStratSolver(const std::string & label,const std::string & type,const Teuchos::ParameterList & pl);
77
79 void addStratPrecond(const std::string & label,const std::string & type,const Teuchos::ParameterList & pl);
80
82 void addBlockPrecond(const std::string & label,const std::string & type,const Teuchos::ParameterList & pl);
83
91 Teuchos::RCP<const Teuchos::ParameterList> getParameterList(const std::string & label) const;
92
94 Teuchos::RCP<InverseFactory> getInverseFactory(const std::string & label) const;
95
97 void PrintAvailableInverses(std::ostream & os) const;
98
100 void setRequestHandler(const Teuchos::RCP<RequestHandler> & rh)
101 { callbackHandler_ = rh; }
102
104 Teuchos::RCP<RequestHandler> getRequestHandler() const
105 { return callbackHandler_; }
106
107protected:
108
109 // stratimikos type Inverse objects: mapping the label to a parameter list
110 std::map<std::string,Teuchos::RCP<const Teuchos::ParameterList> > stratSolver_;
111 std::map<std::string,Teuchos::RCP<const Teuchos::ParameterList> > stratPrecond_;
112 std::map<std::string,Teuchos::RCP<const Teuchos::ParameterList> > blockPrecond_;
113
114 // vectors showing which string types are in Stratimikos
115 std::vector<std::string> stratValidSolver_;
116 std::vector<std::string> stratValidPrecond_;
117 std::vector<std::string> blockValidPrecond_;
118
120 Teuchos::RCP<RequestHandler> callbackHandler_;
121
123 Teuchos::RCP<Stratimikos::DefaultLinearSolverBuilder> defaultBuilder_;
124
125public:
126
137 static Teuchos::RCP<InverseLibrary> buildFromParameterList(const Teuchos::ParameterList & pl,bool useStratDefaults=true);
138
149 static Teuchos::RCP<InverseLibrary> buildFromParameterList(const Teuchos::ParameterList & pl,
150 const Teuchos::RCP<Stratimikos::DefaultLinearSolverBuilder> & strat);
151
160 static Teuchos::RCP<InverseLibrary> buildFromStratimikos();
161
171 static Teuchos::RCP<InverseLibrary> buildFromStratimikos(
172 const Stratimikos::DefaultLinearSolverBuilder & strat);
173
183 static Teuchos::RCP<InverseLibrary> buildFromStratimikos(
184 const Teuchos::RCP<Stratimikos::DefaultLinearSolverBuilder> & strat);
185};
186
187} // end namespace Teko
188
189#endif