Thyra_NonlinearSolverBuilderBase.hpp

Go to the documentation of this file.

// @HEADER
// ***********************************************************************
// 
//    Thyra: Interfaces and Support for Abstract Numerical Algorithms
//                 Copyright (2004) Sandia Corporation
// 
// Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
// license for use of this work by or on behalf of the U.S. Government.
// 
// This library is free software; you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as
// published by the Free Software Foundation; either version 2.1 of the
// License, or (at your option) any later version.
//  
// This library is distributed in the hope that it will be useful, but
// WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
//  
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
// USA
// Questions? Contact Michael A. Heroux (maherou@sandia.gov) 
// 
// ***********************************************************************
// @HEADER

#ifndef THYRA_NONLINEAR_SOLVER_BUILDER_BASE
#define THYRA_NONLINEAR_SOLVER_BUILDER_BASE

#include "Thyra_NonlinearSolverBase.hpp"
#include "Teuchos_ParameterListAcceptor.hpp"


namespace Thyra {


template<class Scalar>
class NonlinearSolverBuilderBase : virtual public Teuchos::ParameterListAcceptor
{
public:
  
  virtual Teuchos::RCP<NonlinearSolverBase<Scalar> >
  createNonlinearSolver(const std::string &nonlinearSolverTypeName) const = 0;

private:
  
  // Not defined and not to be called
  NonlinearSolverBuilderBase<Scalar>&
  operator=(const NonlinearSolverBuilderBase<Scalar>&);

};


template<class Scalar>
Teuchos::RCP<NonlinearSolverBase<Scalar> >
createNonlinearSolver(
  const NonlinearSolverBuilderBase<Scalar> &nonlinearSolverBuilder,
  const std::string &nonlinearSolverTypeName = ""
  )
{
  return nonlinearSolverBuilder.createNonlinearSolver(nonlinearSolverTypeName);
}


} // namespace Thyra


#endif // THYRA_NONLINEAR_SOLVER_BUILDER_BASE