Thyra Version of the Day
Loading...
Searching...
No Matches
Thyra_LinearSolverBuilderBase.hpp
1// @HEADER
2// ***********************************************************************
3//
4// Thyra: Interfaces and Support for Abstract Numerical Algorithms
5// Copyright (2004) Sandia Corporation
6//
7// Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
8// license for use of this work by or on behalf of the U.S. Government.
9//
10// Redistribution and use in source and binary forms, with or without
11// modification, are permitted provided that the following conditions are
12// met:
13//
14// 1. Redistributions of source code must retain the above copyright
15// notice, this list of conditions and the following disclaimer.
16//
17// 2. Redistributions in binary form must reproduce the above copyright
18// notice, this list of conditions and the following disclaimer in the
19// documentation and/or other materials provided with the distribution.
20//
21// 3. Neither the name of the Corporation nor the names of the
22// contributors may be used to endorse or promote products derived from
23// this software without specific prior written permission.
24//
25// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
26// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
29// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
30// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
31// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
32// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
33// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
34// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
35// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36//
37// Questions? Contact Roscoe A. Bartlett (bartlettra@ornl.gov)
38//
39// ***********************************************************************
40// @HEADER
41
42#ifndef THYRA_LINEAR_SOLVER_BUILDING_BASE
43#define THYRA_LINEAR_SOLVER_BUILDING_BASE
44
45#include "Teuchos_ParameterListAcceptor.hpp"
46#include "Thyra_LinearOpWithSolveFactoryBase.hpp"
47
48
49namespace Thyra {
50
51
59template<class Scalar>
61{
62public:
63
78 const std::string &linearSolveStrategyName ) const = 0;
79
94 const std::string &preconditioningStrategyName ) const = 0;
95
96 /* \brief Create a new LinearOpWithSolveFactory object given a typical
97 * forward linear operator and a typical solve criteria.
98 *
99 * \param typicalFwdOp
100 * [in] A typical forward linear operator that represents the types of
101 * operator that will be used to solve linear system.
102 * \param typicalSolveCriteria
103 * [in] A typical solve criteria that will be used to solve for linear
104 * systems.
105 * \param typicalSolveUse
106 * [in] Determines how the solver will be used.
107 * \param solveStrategy
108 * [out] The LOWSF object that was determined to be the best suited for solving
109 * the typical system given above.
110 * \param initialLOWS
111 * [out] The LOWS object that was created that is consistent with the returned
112 * solve strategy. If <tt>initialLOWS->get()==NULL</tt> on return then there is no
113 * such object returned.
114 * \param setupTime
115 * [out] The amount of time it took to setup the solver <tt>*initalLOWS</tt> before
116 * a solve was performed.
117 * \param solveTime
118 * [out] The amount of time it took to solve a typical linear system for the
119 * returned <tt>*initalLOWS</tt> object.
120 *
121 * ToDo: Finish documentation!
122 */
123 /*
124 virtual void createSmartSolveStrategy(
125 const Teuchos::RCP<LinearOpBase<Scalar> &typicalFwdOp
126 ,const SolveCritiera<Scalar> &typicalSolveCriteria
127 ,const ESupportSolveUse &typicalSolveUse
128 ,Teuchos::RCP<LinearOpWithSolveFactoryBase<Scalar> > *solveStrategy
129 ,Teuchos::RCP<Teuchos::ParameterList> *solveStrategyParameters
130 ,Teuchos::RCP<LinearOpWithSolveBase<Scalar> > *initialLOWS
131 ,double *setupTime
132 ,double *solveTime
133 ) const = 0;
134 */
135
136private:
137
138 // Not defined and not to be called
140 operator=(const LinearSolverBuilderBase<Scalar>&);
141
142};
143
144
149template<class Scalar>
152 const LinearSolverBuilderBase<Scalar> &linearSolverBuilder,
153 const std::string &linearSolveStrategyName = ""
154 )
155{
156 return linearSolverBuilder.createLinearSolveStrategy(
157 linearSolveStrategyName );
158}
159
160
165template<class Scalar>
168 const LinearSolverBuilderBase<Scalar> &linearSolverBuilder,
169 const std::string &preconditioningStrategyName = ""
170 )
171{
172 return linearSolverBuilder.createPreconditioningStrategy(
173 preconditioningStrategyName );
174}
175
176
177} // namespace Thyra
178
179#endif // THYRA_LINEAR_SOLVER_BUILDING_BASE
Abstract interface for an object that can create LinearOpWithSolveFactoryBase objects on demand.
virtual Teuchos::RCP< LinearOpWithSolveFactoryBase< Scalar > > createLinearSolveStrategy(const std::string &linearSolveStrategyName) const =0
Create a new LinearOpWithSolveFactoryBase object purely specified by the parameter list.
Teuchos::RCP< LinearOpWithSolveFactoryBase< Scalar > > createLinearSolveStrategy(const LinearSolverBuilderBase< Scalar > &linearSolverBuilder, const std::string &linearSolveStrategyName="")
virtual Teuchos::RCP< PreconditionerFactoryBase< Scalar > > createPreconditioningStrategy(const std::string &preconditioningStrategyName) const =0
Create a new PreconditionerFactoryBase object purely specified by the parameter list.
Teuchos::RCP< PreconditionerFactoryBase< Scalar > > createPreconditioningStrategy(const LinearSolverBuilderBase< Scalar > &linearSolverBuilder, const std::string &preconditioningStrategyName="")