Thyra Version of the Day
Loading...
Searching...
No Matches
Thyra_DefaultNonlinearSolverBuilder.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_DEFAULT_NONLINEAR_SOLVER_BUILDER_HPP
43#define THYRA_DEFAULT_NONLINEAR_SOLVER_BUILDER_HPP
44
45#include "Thyra_NonlinearSolverBuilderBase.hpp"
46#include "Teuchos_AbstractFactory.hpp"
47
48
49namespace Thyra {
50
51
62 : public Thyra::NonlinearSolverBuilderBase<double>
63{
64public:
65
68
71
74
77 const RCP<const AbstractFactory<Thyra::NonlinearSolverBase<double> > >
78 &nonlinearSolverFactory,
79 const std::string &nonlinearSolverTypeName
80 );
81
85 std::string getNonlinearSolverName() const;
86
88
91
93 void setParameterList(RCP<ParameterList> const& paramList);
102
104
107
110 createNonlinearSolver(const std::string &nonlinearSolverTypeName) const;
111
113
114private:
115
116 // //////////////////////////////////////
117 // Private types
118
120 ns_fcty_t;
121
122 // //////////////////////////////////////
123 // Private data members
124
125 RCP<ParameterList> paramList_;
126 mutable RCP<const ParameterList> validParamList_;
127 Array<std::string> validNonlinearSolverNames_;
128 Array<ns_fcty_t> nonlinearSolverArray_;
129 std::string defaultNonlinearSolverName_;
130
131 // //////////////////////////////////////
132 // Private member functions
133
134 void initializeDefaults();
135
136};
137
138
139} // namespace Thyra
140
141
145template<class NonlinearSolverType, class Scalar>
146void setNonlinearSolverFactory(
147 const std::string &nonlinearSolverTypeName,
148 const Ptr<DefaultNonlinearSolverBuilder<Scalar> > &defaultNonlinearSolverBuilder
149 )
150{
152}
153
154
155#endif // THYRA_DEFAULT_NONLINEAR_SOLVER_BUILDER_HPP
Concrete subclass of Thyra::NonlinearSolverBuilderBase for creating NonlinearSolverBase objects and P...
void setNonlinearSolverFactory(const RCP< const AbstractFactory< Thyra::NonlinearSolverBase< double > > > &nonlinearSolverFactory, const std::string &nonlinearSolverTypeName)
Set a new NonlinearSolverBase factory object.
RCP< ParameterList > unsetParameterList()
RCP< const ParameterList > getParameterList() const
RCP< const ParameterList > getValidParameters() const
void setParameterList(RCP< ParameterList > const &paramList)
virtual Teuchos::RCP< NonlinearSolverBase< Scalar > > createNonlinearSolver(const std::string &nonlinearSolverTypeName) const
std::string getNonlinearSolverName() const
Get the name of the NonlinearSolver type that will be created on the next call to this->createNonline...
RCP< ParameterList > getNonconstParameterList()
Base class for all nonlinear equation solvers.
#define TEUCHOS_TEST_FOR_EXCEPT(throw_exception_test)