Ifpack2 Templated Preconditioning Package: Ifpack2_Factory

00001 /*@HEADER
00002 // ***********************************************************************
00003 //
00004 //       Ifpack2: Tempated Object-Oriented Algebraic Preconditioner Package
00005 //                 Copyright (2009) Sandia Corporation
00006 //
00007 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
00008 // license for use of this work by or on behalf of the U.S. Government.
00009 //
00010 // Redistribution and use in source and binary forms, with or without
00011 // modification, are permitted provided that the following conditions are
00012 // met:
00013 //
00014 // 1. Redistributions of source code must retain the above copyright
00015 // notice, this list of conditions and the following disclaimer.
00016 //
00017 // 2. Redistributions in binary form must reproduce the above copyright
00018 // notice, this list of conditions and the following disclaimer in the
00019 // documentation and/or other materials provided with the distribution.
00020 //
00021 // 3. Neither the name of the Corporation nor the names of the
00022 // contributors may be used to endorse or promote products derived from
00023 // this software without specific prior written permission.
00024 //
00025 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
00026 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00027 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
00028 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
00029 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
00030 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
00031 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00032 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00033 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00034 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00035 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00036 //
00037 // Questions? Contact Michael A. Heroux (maherou@sandia.gov)
00038 //
00039 // ***********************************************************************
00040 //@HEADER
00041 */
00042 
00043 #ifndef IFPACK2_FACTORY_DECL_HPP
00044 #define IFPACK2_FACTORY_DECL_HPP
00045 
00046 #include "Ifpack2_ConfigDefs.hpp"
00047 #include "Ifpack2_Preconditioner.hpp"
00048 
00049 namespace Ifpack2 {
00050 
00052 bool supportsUnsymmetric (const std::string& prec_type);
00053 
00110 class Factory {
00111 public:
00122   template<class MatrixType>
00123   static
00124   Teuchos::RCP<Preconditioner<typename MatrixType::scalar_type,
00125                               typename MatrixType::local_ordinal_type,
00126                               typename MatrixType::global_ordinal_type,
00127                               typename MatrixType::node_type> >
00128   create (const std::string& precType,
00129           const Teuchos::RCP<const MatrixType>& matrix);
00130 
00146   template<class MatrixType>
00147   static
00148   Teuchos::RCP<Preconditioner<typename MatrixType::scalar_type,
00149                               typename MatrixType::local_ordinal_type,
00150                               typename MatrixType::global_ordinal_type,
00151                               typename MatrixType::node_type> >
00152   create (const std::string& precType,
00153           const Teuchos::RCP<const MatrixType>& matrix,
00154           const int overlap);
00155 
00157   template<class InputMatrixType, class OutputMatrixType>
00158   static
00159   Teuchos::RCP<Preconditioner<typename OutputMatrixType::scalar_type,
00160                               typename OutputMatrixType::local_ordinal_type,
00161                               typename OutputMatrixType::global_ordinal_type,
00162                               typename OutputMatrixType::node_type> >
00163   clone (const Teuchos::RCP<Preconditioner<typename InputMatrixType::scalar_type,
00164                                            typename InputMatrixType::local_ordinal_type,
00165                                            typename InputMatrixType::global_ordinal_type,
00166                                            typename InputMatrixType::node_type> >& prec,
00167          const Teuchos::RCP<const OutputMatrixType>& matrix,
00168          const Teuchos::ParameterList& params = Teuchos::ParameterList ());
00169 };
00170 
00171 } // namespace Ifpack2
00172 
00173 #endif // IFPACK2_FACTORY_DECL_HPP