Thyra_Amesos2Types.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_TYPES_HPP
#define THYRA_AMESOS2_TYPES_HPP

#include "Amesos2_config.h"
#include "Teuchos_StringToIntMap.hpp"

namespace Thyra {

namespace Amesos2 {

enum ESolverType {
  KLU2
#ifdef HAVE_AMESOS2_LAPACK
  ,LAPACK
#endif
#ifdef HAVE_AMESOS2_SUPERLU
  ,SUPERLU
#endif
#ifdef HAVE_AMESOS2_SUPERLUMT
  ,SUPERLUMT
#endif
#ifdef HAVE_AMESOS2_SUPERLUDIST
  ,SUPERLUDIST
#endif
#ifdef HAVE_AMESOS2_PARDISO_MKL
  ,PARDISO_MKL
#endif
#ifdef HAVE_AMESOS2_CHOLMOD
  ,CHOLMOD
#endif
#ifdef HAVE_AMESOS2_BASKER
  ,BASKER
#endif
#ifdef HAVE_AMESOS2_MUMPS
  ,MUMPS
#endif
}; 

const int numSolverTypes = 1
#ifdef HAVE_AMESOS2_LAPACK
+1
#endif
#ifdef HAVE_AMESOS2_SUPERLU
+1
#endif
#ifdef HAVE_AMESOS2_SUPERLUMT
+1
#endif
#ifdef HAVE_AMESOS2_SUPERLUDIST
+1
#endif
#ifdef HAVE_AMESOS2_PARDISO_MKL
+1
#endif
#ifdef HAVE_AMESOS2_CHOLMOD
+1
#endif
#ifdef HAVE_AMESOS2_BASKER
+1
#endif
#ifdef HAVE_AMESOS2_MUMPS
+1
#endif
; 

extern const ESolverType solverTypeValues[numSolverTypes];

extern const char* solverTypeNames[numSolverTypes];

extern const bool supportsUnsymmetric[numSolverTypes];

inline const char* toString(const ESolverType solverType)
{ return solverTypeNames[solverType]; }

extern Teuchos::StringToIntMap solverTypeNameToEnumMap;

enum ERefactorizationPolicy {
  REPIVOT_ON_REFACTORIZATION     
  ,NO_PIVOT_ON_REFACTORIZATION   
};

const int numRefactorizationPolices = 2;

extern const ERefactorizationPolicy refactorizationPolicyValues[numRefactorizationPolices];

extern const char* refactorizationPolicyNames[numRefactorizationPolices];

inline const char* toString(const ERefactorizationPolicy refactorizationPolicy)
{ return refactorizationPolicyNames[refactorizationPolicy]; }

extern Teuchos::StringToIntMap refactorizationPolicyNameToEnumMap;

}// namespace Amesos2

} // namespace Thyra

#endif // THYRA_AMESOS2_TYPES_HPP