Thyra_Amesos2LinearOpWithSolveFactory_decl.hpp

Go to the documentation of this file.

/*
// @HEADER
// ***********************************************************************
// 
//         Stratimikos: Thyra-based strategies for linear solvers
//                Copyright (2006) 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.
// 
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// 1. Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
//
// 3. Neither the name of the Corporation nor the names of the
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// Questions? Contact Roscoe A. Bartlett (rabartl@sandia.gov) 
// 
// ***********************************************************************
// @HEADER
*/

#ifndef THYRA_AMESOS2_LINEAR_OP_WITH_SOLVE_FACTORY_DECL_HPP
#define THYRA_AMESOS2_LINEAR_OP_WITH_SOLVE_FACTORY_DECL_HPP

#include "Thyra_LinearOpWithSolveFactoryBase.hpp"
#include "Thyra_TpetraThyraWrappers.hpp"
#include "Thyra_Amesos2Types.hpp"
#include "Amesos2.hpp"
#include "Amesos2_Version.hpp"
#include "Teuchos_StandardMemberCompositionMacros.hpp"
#include "Teuchos_StandardCompositionMacros.hpp"
#include "Trilinos_Details_LinearSolver.hpp"
#include "Trilinos_Details_LinearSolverFactory.hpp"
#include "Thyra_Amesos2LinearOpWithSolve_decl.hpp"

namespace Thyra {

template<typename Scalar>
class Amesos2LinearOpWithSolveFactory : public LinearOpWithSolveFactoryBase<Scalar> {
public:
  using ConverterT = typename Amesos2LinearOpWithSolve<Scalar>::ConverterT;
  using MAT = typename Amesos2LinearOpWithSolve<Scalar>::MAT;
  using MV = typename Amesos2LinearOpWithSolve<Scalar>::MV;
  using Solver = typename Amesos2LinearOpWithSolve<Scalar>::Solver;


  static const std::string SolverType_name;
  static const std::string RefactorizationPolicy_name;
  static const std::string ThrowOnPreconditionerInput_name;
  static const std::string Amesos2_Settings_name;



  ~Amesos2LinearOpWithSolveFactory();

  Amesos2LinearOpWithSolveFactory(
    const Amesos2::ESolverType solverType
#ifdef HAVE_AMESOS2_KLU2
    = Amesos2::KLU2,
#else
    = Amesos2::LAPACK,
#endif
    const Amesos2::ERefactorizationPolicy refactorizationPolicy
      = Amesos2::REPIVOT_ON_REFACTORIZATION,
    const bool throwOnPrecInput = true
    );
    


  bool isCompatible( const LinearOpSourceBase<Scalar> &fwdOpSrc ) const;

  Teuchos::RCP<LinearOpWithSolveBase<Scalar> > createOp() const;

  void initializeOp(
    const Teuchos::RCP<const LinearOpSourceBase<Scalar> > &fwdOpSrc,
    LinearOpWithSolveBase<Scalar> *Op,
    const ESupportSolveUse supportSolveUse
    ) const;

  bool supportsPreconditionerInputType(const EPreconditionerInputType precOpType) const;

  void initializePreconditionedOp(
    const Teuchos::RCP<const LinearOpSourceBase<Scalar> > &fwdOpSrc,
    const Teuchos::RCP<const PreconditionerBase<Scalar> > &prec,
    LinearOpWithSolveBase<Scalar> *Op,
    const ESupportSolveUse supportSolveUse
    ) const;

  void initializePreconditionedOp(
    const Teuchos::RCP<const LinearOpSourceBase<Scalar> > &fwdOpSrc,
    const Teuchos::RCP<const LinearOpSourceBase<Scalar> > &approxFwdOpSrc,
    LinearOpWithSolveBase<Scalar> *Op,
    const ESupportSolveUse supportSolveUse
    ) const;

  void uninitializeOp(
    LinearOpWithSolveBase<Scalar> *Op,
    Teuchos::RCP<const LinearOpSourceBase<Scalar> > *fwdOpSrc,
    Teuchos::RCP<const PreconditionerBase<Scalar> > *prec,
    Teuchos::RCP<const LinearOpSourceBase<Scalar> > *approxFwdOpSrc,
    ESupportSolveUse *supportSolveUse
    ) const;



  void setParameterList(Teuchos::RCP<Teuchos::ParameterList> const& paramList);
  Teuchos::RCP<Teuchos::ParameterList> getNonconstParameterList();
  Teuchos::RCP<Teuchos::ParameterList> unsetParameterList();
  Teuchos::RCP<const Teuchos::ParameterList> getParameterList() const;
  Teuchos::RCP<const Teuchos::ParameterList> getValidParameters() const;



  std::string description() const;


private:

  // /////////////////////////
  // Private data members

  Amesos2::ESolverType solverType_;
  Amesos2::ERefactorizationPolicy refactorizationPolicy_;
  bool throwOnPrecInput_;
  Teuchos::RCP<Teuchos::ParameterList> paramList_;

  // /////////////////////////
  // Private member functions

  static Teuchos::RCP<const Teuchos::ParameterList>
  generateAndGetValidParameters();

};

} // namespace Thyra

#endif // THYRA_AMESOS2_LINEAR_OP_WITH_SOLVE_FACTORY_HPP