Tpetra Matrix/Vector Services Version of the Day
Tpetra_Power_Method_From_File.cpp
00001 /*
00002 // @HEADER
00003 // ***********************************************************************
00004 // 
00005 //          Tpetra: Templated Linear Algebra Services Package
00006 //                 Copyright (2008) 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 // @HEADER
00042 */
00043 
00044 #include <Teuchos_GlobalMPISession.hpp>
00045 #include <Teuchos_oblackholestream.hpp>
00046 #include <Teuchos_CommandLineProcessor.hpp>
00047 #include <Teuchos_Array.hpp>
00048 
00049 // I/O for Harwell-Boeing files
00050 #include <Tpetra_MatrixIO.hpp>
00051 
00052 #include "Tpetra_Power_Method.hpp"
00053 
00054 #include "Tpetra_DefaultPlatform.hpp"
00055 #include "Tpetra_Version.hpp"
00056 #include "Tpetra_Map.hpp"
00057 #include "Tpetra_MultiVector.hpp"
00058 #include "Tpetra_Vector.hpp"
00059 #include "Tpetra_CrsMatrix.hpp"
00060 
00061 int main(int argc, char *argv[]) {
00062   Teuchos::oblackholestream blackhole;
00063   Teuchos::GlobalMPISession mpiSession(&argc,&argv,&blackhole);
00064 
00065   //
00066   // Specify types used in this example
00067   // 
00068   typedef double                                                  Scalar;
00069   typedef Teuchos::ScalarTraits<Scalar>::magnitudeType            Magnitude;
00070   typedef int                                                     Ordinal;
00071   typedef Tpetra::DefaultPlatform::DefaultPlatformType            Platform;
00072   typedef Tpetra::DefaultPlatform::DefaultPlatformType::NodeType  Node;
00073   typedef Tpetra::CrsMatrix<Scalar,Ordinal,Ordinal,Node>          CrsMatrix;
00074   using Teuchos::RCP;
00075   using Teuchos::tuple;
00076 
00077   // 
00078   // Get the default communicator and node
00079   //
00080   Platform &platform = Tpetra::DefaultPlatform::getDefaultPlatform();
00081   RCP<const Teuchos::Comm<int> > comm = platform.getComm();
00082   RCP<Node>                      node = platform.getNode();
00083   const int myRank = comm->getRank();
00084 
00085   //
00086   // Get example parameters from command-line processor
00087   //  
00088   bool printMatrix = false;
00089   bool verbose = (myRank==0);
00090   int niters = 100;
00091   Magnitude tolerance = 1.0e-2;
00092   std::string filename("bcsstk14.hb");
00093   Teuchos::CommandLineProcessor cmdp(false,true);
00094   cmdp.setOption("verbose","quiet",&verbose,"Print messages and results.");
00095   cmdp.setOption("filename",&filename,"Filename for Harwell-Boeing test matrix.");
00096   cmdp.setOption("tolerance",&tolerance,"Relative residual tolerance used for solver.");
00097   cmdp.setOption("iterations",&niters,"Maximum number of iterations.");
00098   cmdp.setOption("printMatrix","noPrintMatrix",&printMatrix,"Print the full matrix after reading it.");
00099   if (cmdp.parse(argc,argv) != Teuchos::CommandLineProcessor::PARSE_SUCCESSFUL) {
00100     return -1;
00101   }
00102 
00103   // 
00104   // Say hello, print some communicator info
00105   //
00106   if (verbose) {
00107     std::cout << "\n" << Tpetra::version() << std::endl << std::endl;
00108   }
00109   std::cout << "Comm info: " << *comm;
00110 
00111   //
00112   // Read Tpetra::CrsMatrix from file
00113   //
00114   RCP<CrsMatrix> A;
00115   Tpetra::Utils::readHBMatrix(filename,comm,node,A);
00116   if (printMatrix) {
00117     RCP<Teuchos::FancyOStream> fos = Teuchos::fancyOStream(Teuchos::rcpFromRef(std::cout));
00118     A->describe(*fos, Teuchos::VERB_EXTREME);
00119   }
00120   else if (verbose) {
00121     std::cout << std::endl << A->description() << std::endl << std::endl;
00122   }
00123 
00124   //
00125   // Iterate
00126   //
00127   TpetraExamples::powerMethod<Scalar,Ordinal>(A, niters, tolerance, verbose);
00128 
00129   if (verbose) {
00130     std::cout << "\nEnd Result: TEST PASSED" << std::endl;
00131   }
00132   return 0;
00133 }
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines