Amesos2 - Direct Sparse Solver Interfaces Version of the Day
Amesos2_Control.hpp
Go to the documentation of this file.
00001 // @HEADER
00002 //
00003 // ***********************************************************************
00004 //
00005 //           Amesos2: Templated Direct Sparse Solver Package 
00006 //                  Copyright 2011 Sandia Corporation
00007 //
00008 // Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
00009 // the U.S. Government retains certain rights in this software.
00010 //
00011 // Redistribution and use in source and binary forms, with or without
00012 // modification, are permitted provided that the following conditions are
00013 // met:
00014 //
00015 // 1. Redistributions of source code must retain the above copyright
00016 // notice, this list of conditions and the following disclaimer.
00017 //
00018 // 2. Redistributions in binary form must reproduce the above copyright
00019 // notice, this list of conditions and the following disclaimer in the
00020 // documentation and/or other materials provided with the distribution.
00021 //
00022 // 3. Neither the name of the Corporation nor the names of the
00023 // contributors may be used to endorse or promote products derived from
00024 // this software without specific prior written permission.
00025 //
00026 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
00027 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00028 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
00029 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
00030 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
00031 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
00032 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00033 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00034 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00035 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00036 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00037 //
00038 // Questions? Contact Michael A. Heroux (maherou@sandia.gov)
00039 //
00040 // ***********************************************************************
00041 //
00042 // @HEADER
00043 
00051 #ifndef AMESOS2_CONTROL_HPP
00052 #define AMESOS2_CONTROL_HPP
00053 
00054 #include <Teuchos_ParameterList.hpp>
00055 #include <Teuchos_RCP.hpp>
00056 
00057 namespace Amesos2 {
00058 
00059 
00060 struct Control {
00062   Control()
00063     : verbose_(0)
00064     , debug_(0)
00065     , useTranspose_(false)
00066     , addToDiag_("0.0")
00067     , addZeroToDiag_(false)
00068     , matrixProperty_(0)
00069     , rcond_threshold_(1e-12)
00070     , refactorize_(false)
00071     , scaleMethod_(0)
00072     , reindex_(false)
00073     { }
00074 
00076   ~Control() { };
00077 
00078   void setControlParameters(
00079     const Teuchos::RCP<Teuchos::ParameterList> & parameterList );
00080 
00086   int verbose_;
00087 
00089   int debug_;
00090 
00091 
00093   bool useTranspose_;
00094 
00095 
00102   std::string addToDiag_;
00103 
00104 
00110   bool addZeroToDiag_;
00111 
00112 
00122   int matrixProperty_;
00123 
00124 
00127   double rcond_threshold_; // if we refactorize, the factorization
00128   // may suffer in numeric quality.  We
00129   // compute rcond = min (abs (diag (U))) /
00130   // max (abs(diag (U))).  If this ratio is
00131   // <= rcond_threshold_, then the
00132   // "refactorization" is scrapped, and we
00133   // factor with full partial pivoting
00134   // instead.
00135 
00136 
00137   bool refactorize_; // if true, and if the Symbolic and Numeric
00138   // objects have already been created, then
00139   // attempt to "refactorize" (factor the matrix
00140   // with no changes to the pivot order since the
00141   // last call the klu_btf_factor).
00142 
00143 
00144   int scaleMethod_; // Most methods (klu, UMFPACK, Mumps, ...) can
00145   // scale the input matrix prior to
00146   // factorization.  This can improve pivoting,
00147   // reduces fill-in, and leads to a better
00148   // quality factorization.  The options are:
00149   // 0: no scaling
00150   // 1: use the default method for the specific
00151   // package
00152   // 2: use the method's 1st alternative (if it
00153   // has one)
00154   // 3: use the method's 2nd alternative, and so
00155   // on.
00156   //
00157   // Amesos2_Klu is, at present, the only code
00158   // which implements this
00159 
00160 
00168   bool reindex_;
00169 
00170 };                              // end class Control
00171 
00172 
00173 } // end namespace Amesos2
00174 
00175 #endif  // AMESOS2_CONTROL_HPP