Amesos_Control.cpp

Go to the documentation of this file.

// @HEADER
// ***********************************************************************
//
//                Amesos: Direct Sparse Solver Package
//                 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., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301
// USA
// Questions? Contact Michael A. Heroux (maherou@sandia.gov)
//
// ***********************************************************************
// @HEADER

#include "Amesos_Control.h"
void Amesos_Control::SetControlParameters( const Teuchos::ParameterList &ParameterList) {

  // add zero to diagonal if diagonal element is not present
  // - not supported for matrices which are missing elements from the diagonal.  See bug #1928 for discussion
  if( ParameterList.isParameter("AddZeroToDiag") ) 
    AddZeroToDiag_ = ParameterList.get<bool>("AddZeroToDiag");

  // add this value to all diagonal elements which are structurally non-zero
  // no change is made to non-zero structure of the matrix.
  if( ParameterList.isParameter("AddToDiag") )
    AddToDiag_ = ParameterList.get<double>("AddToDiag");

  // Determine whether to Refactorize
  if( ParameterList.isParameter("Refactorize") )
    refactorize_ = ParameterList.get<bool>("Refactorize");


  // threshold for determining if refactorize worked OK
  // UNUSED at present - KSS June 2004
  if( ParameterList.isParameter("RcondThreshold") )
    rcond_threshold_ = ParameterList.get<double>("RcondThreshold");

  // define how many processes to use in the ScaLAPACK factor and solve
  // if (-1), a heuristic is used to determine the number of processes to use 
  if( ParameterList.isParameter("MaxProcs") )
    MaxProcesses_ = ParameterList.get<int>("MaxProcs");
  
  // Matrix property, defined internally in Amesos_Mumps as an integer,
  // whose value can be:
  // - 0 : general unsymmetric matrix;
  // - 1 : SPD;
  // - 2 : general symmetric matrix.
  if( ParameterList.isParameter("MatrixProperty") ) {
    std::string MatrixProperty;
    MatrixProperty = ParameterList.get<std::string>("MatrixProperty");
    if( MatrixProperty == "SPD" )
      MatrixProperty_ = 1;
    else if( MatrixProperty == "symmetric" ) 
      MatrixProperty_ = 2;
    else if( MatrixProperty == "general" )   
      MatrixProperty_ = 0;
    else {
      //      AMESOS_CHK_ERR( -1 ) ;
      //      if ( verbose_ ) std::cerr << "Amesos : ERROR" << std::endl 
      //       << "Amesos : MatrixProperty value not recognized ("
      //       << MatrixProperty << ")" << std::endl;
    }
  }

  // scaling method: 0: none, 1: use method's default, 2: use
  // the method's 1st alternative, 3: etc.
  if( ParameterList.isParameter("ScaleMethod") )
    ScaleMethod_ = ParameterList.get<int>("ScaleMethod");


  if( ParameterList.isParameter("Reindex") )
    Reindex_ = ParameterList.get<bool>("Reindex");

}