simple_stratimikos_example.cpp

Go to the documentation of this file.
00001 // @HEADER
00002 // ***********************************************************************
00003 // 
00004 //         Stratimikos: Thyra-based strategies for linear solvers
00005 //                Copyright (2006) 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 // This library is free software; you can redistribute it and/or modify
00011 // it under the terms of the GNU Lesser General Public License as
00012 // published by the Free Software Foundation; either version 2.1 of the
00013 // License, or (at your option) any later version.
00014 //  
00015 // This library is distributed in the hope that it will be useful, but
00016 // WITHOUT ANY WARRANTY; without even the implied warranty of
00017 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00018 // Lesser General Public License for more details.
00019 //  
00020 // You should have received a copy of the GNU Lesser General Public
00021 // License along with this library; if not, write to the Free Software
00022 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
00023 // USA
00024 // Questions? Contact Roscoe A. Bartlett (rabartl@sandia.gov) 
00025 // 
00026 // ***********************************************************************
00027 // @HEADER
00028 
00029 #include "Stratimikos_DefaultLinearSolverBuilder.hpp"
00030 #include "Thyra_LinearOpWithSolveFactoryHelpers.hpp"
00031 #include "Thyra_LinearOpWithSolveHelpers.hpp"
00032 #include "Thyra_VectorBase.hpp"
00033 #include "Thyra_EpetraThyraWrappers.hpp"
00034 #include "Thyra_EpetraLinearOp.hpp"
00035 #include "EpetraExt_readEpetraLinearSystem.h"
00036 #include "Teuchos_GlobalMPISession.hpp"
00037 #include "Teuchos_VerboseObject.hpp"
00038 #include "Teuchos_XMLParameterListHelpers.hpp"
00039 #include "Teuchos_CommandLineProcessor.hpp"
00040 #include "Teuchos_StandardCatchMacros.hpp"
00041 #ifdef HAVE_MPI
00042 #  include "Epetra_MpiComm.h"
00043 #else
00044 #  include "Epetra_SerialComm.h"
00045 #endif
00046 
00047 namespace {
00048 
00049 // Helper function to compute a single norm for a vector
00050 double epetraNorm2( const Epetra_Vector &v )
00051 {
00052   double norm[1] = { -1.0 };
00053   v.Norm2(&norm[0]);
00054   return norm[0];
00055 }
00056 
00057 } // namespace
00058 
00059 int main(int argc, char* argv[])
00060 {
00061 
00062   using Teuchos::rcp;
00063   using Teuchos::RCP;
00064   using Teuchos::CommandLineProcessor;
00065   typedef Teuchos::ParameterList::PrintOptions PLPrintOptions;
00066 
00067   bool success = true;
00068   bool verbose = true;
00069 
00070   Teuchos::GlobalMPISession mpiSession(&argc, &argv);
00071 
00072   Teuchos::RCP<Teuchos::FancyOStream>
00073     out = Teuchos::VerboseObjectBase::getDefaultOStream();
00074 
00075   try {
00076 
00077     
00078     //
00079     // A) Program setup code
00080     //
00081 
00082     //
00083     // Read options from command-line
00084     //
00085     
00086     std::string     matrixFile             = "";
00087     std::string     extraParamsFile        = "";
00088     double          tol                    = 1e-5;
00089     bool            onlyPrintOptions       = false;
00090     bool            printXmlFormat         = false;
00091     bool            showDoc                = true;
00092 
00093     Stratimikos::DefaultLinearSolverBuilder linearSolverBuilder;
00094 
00095     CommandLineProcessor  clp(false); // Don't throw exceptions
00096 
00097     // Set up command-line options for the linear solver that will be used!
00098     linearSolverBuilder.setupCLP(&clp);
00099 
00100     clp.setOption( "matrix-file", &matrixFile
00101                    ,"Defines the matrix and perhaps the RHS and LHS for a linear system to be solved." );
00102     clp.setOption( "tol", &tol, "Tolerance to check against the scaled residual norm." );
00103     clp.setOption( "extra-params-file", &extraParamsFile, "File containing extra parameters in XML format.");
00104     clp.setOption( "only-print-options", "continue-after-printing-options", &onlyPrintOptions
00105                    ,"Only print options and stop or continue on" );
00106     clp.setOption( "print-xml-format", "print-readable-format", &printXmlFormat
00107                    ,"Print the valid options in XML format or in readable format." );
00108     clp.setOption( "show-doc", "hide-doc", &showDoc
00109                    ,"Print the valid options with or without documentation." );
00110     
00111     clp.setDocString(
00112       "Simple example for the use of the Stratimikos facade Stratimikos::DefaultLinearSolverBuilder.\n"
00113       "\n"
00114       "To print out just the valid options use --matrix-file=\"\" --only-print-options with --print-xml-format"
00115       " or --print-readable-format.\n"
00116       "\n"
00117       "To solve a linear system from a system read from a file use --matrix-file=\"SomeFile.mtx\""
00118       " with options read from an XML file using --linear-solver-params-file=\"SomeFile.xml\"\n"
00119       );
00120 
00121     CommandLineProcessor::EParseCommandLineReturn parse_return = clp.parse(argc,argv);
00122     if( parse_return != CommandLineProcessor::PARSE_SUCCESSFUL ) return parse_return;
00123 
00124     //
00125     // Print out the valid options and stop if asked
00126     //
00127 
00128     if(onlyPrintOptions) {
00129       if(printXmlFormat)
00130         Teuchos::writeParameterListToXmlOStream(
00131           *linearSolverBuilder.getValidParameters()
00132           ,*out
00133           );
00134       else
00135         linearSolverBuilder.getValidParameters()->print(
00136           *out,PLPrintOptions().indent(2).showTypes(true).showDoc(showDoc)
00137           );
00138       return 0;
00139     }
00140 
00141     
00142     //
00143     // B) Epetra-specific code that sets up the linear system to be solved
00144     //
00145     // While the below code reads in the Epetra objects from a file, you can
00146     // setup the Epetra objects any way you would like.  Note that this next
00147     // set of code as nothing to do with Thyra at all, and it should not.
00148     //
00149 
00150     *out << "\nReading linear system in Epetra format from the file \'"<<matrixFile<<"\' ...\n";
00151     
00152 #ifdef HAVE_MPI
00153     Epetra_MpiComm comm(MPI_COMM_WORLD);
00154 #else
00155     Epetra_SerialComm comm;
00156 #endif
00157     RCP<Epetra_CrsMatrix> epetra_A;
00158     RCP<Epetra_Vector> epetra_x, epetra_b;
00159     EpetraExt::readEpetraLinearSystem( matrixFile, comm, &epetra_A, NULL, &epetra_x, &epetra_b );
00160 
00161     if(!epetra_b.get()) {
00162       *out << "\nThe RHS b was not read in so generate a new random vector ...\n";
00163       epetra_b = rcp(new Epetra_Vector(epetra_A->OperatorRangeMap()));
00164       epetra_b->Random();
00165     }
00166 
00167     if(!epetra_x.get()) {
00168       *out << "\nThe LHS x was not read in so generate a new zero vector ...\n";
00169       epetra_x = rcp(new Epetra_Vector(epetra_A->OperatorDomainMap()));
00170       epetra_x->PutScalar(0.0); // Initial guess is critical!
00171     }
00172 
00173     *out << "\nPrinting statistics of the Epetra linear system ...\n";
00174 
00175     *out
00176       << "\n  Epetra_CrsMatrix epetra_A of dimension "
00177       << epetra_A->OperatorRangeMap().NumGlobalElements()
00178       << " x " << epetra_A->OperatorDomainMap().NumGlobalElements()
00179       << "\n  ||epetraA||inf = " << epetra_A->NormInf()
00180       << "\n  ||epetra_b||2 = " << epetraNorm2(*epetra_b)
00181       << "\n  ||epetra_x||2 = " << epetraNorm2(*epetra_x)
00182       << "\n";
00183 
00184 
00185     //
00186     // C) The "Glue" code that takes Epetra objects and wraps them as Thyra
00187     // objects
00188     //
00189     // This next set of code wraps the Epetra objects that define the linear
00190     // system to be solved as Thyra objects so that they can be passed to the
00191     // linear solver.
00192     //
00193 
00194     RCP<const Thyra::LinearOpBase<double> >
00195       A = Thyra::epetraLinearOp( epetra_A );
00196     RCP<Thyra::VectorBase<double> >
00197       x = Thyra::create_Vector( epetra_x, A->domain() );
00198     RCP<const Thyra::VectorBase<double> >
00199       b = Thyra::create_Vector( epetra_b, A->range() );
00200 
00201     // Note that above Thyra is only interacted with in the most trival of
00202     // ways.  For most users, Thyra will only be seen as a thin wrapper that
00203     // they need know little about in order to wrap their objects in order to
00204     // pass them to Thyra-enabled solvers.
00205 
00206       
00207     //
00208     // D) Thyra-specific code for solving the linear system
00209     //
00210     // Note that this code has no mention of any concrete implementation and
00211     // therefore can be used in any use case.
00212     //
00213 
00214     // Reading in the solver parameters from the parameters file and/or from
00215     // the command line.  This was setup by the command-line options
00216     // set by the setupCLP(...) function above.
00217     linearSolverBuilder.readParameters(out.get());
00218 
00219     // Augment parameters if appropriate
00220     if(extraParamsFile.length())
00221       Teuchos::updateParametersFromXmlFile( "./"+extraParamsFile, &*linearSolverBuilder.getNonconstParameterList() );
00222 
00223     // Create a linear solver factory given information read from the
00224     // parameter list.
00225     RCP<Thyra::LinearOpWithSolveFactoryBase<double> > lowsFactory =
00226       linearSolverBuilder.createLinearSolveStrategy("");
00227 
00228     // Setup output stream and the verbosity level
00229     lowsFactory->setOStream(out);
00230     lowsFactory->setVerbLevel(Teuchos::VERB_LOW);
00231 
00232     // Create a linear solver based on the forward operator A
00233     RCP<Thyra::LinearOpWithSolveBase<double> > lows = 
00234       Thyra::linearOpWithSolve(*lowsFactory, A);
00235 
00236     // Solve the linear system (note: the initial guess in 'x' is critical)
00237     Thyra::SolveStatus<double> status =
00238       Thyra::solve<double>(*lows, Thyra::NOTRANS, *b, x.ptr());
00239     *out << "\nSolve status:\n" << status;
00240 
00241     // Write the linear solver parameters after they were read
00242     linearSolverBuilder.writeParamsFile(*lowsFactory);
00243 
00244 
00245     //
00246     // E) Post process the solution and check the error
00247     //
00248     // Note that the below code is based only on the Epetra objects themselves
00249     // and does not in any way depend or interact with any Thyra-based
00250     // objects.  The point is that most users of Thyra can largely gloss over
00251     // the fact that Thyra is really being used for anything.
00252     //
00253 
00254     // Wipe out the Thyra wrapper for x to guarantee that the solution will be
00255     // written back to epetra_x!  At the time of this writting this is not
00256     // really needed but the behavior may change at some point so this is a
00257     // good idea.
00258     x = Teuchos::null;
00259 
00260     *out
00261       << "\nSolution ||epetra_x||2 = " << epetraNorm2(*epetra_x) << "\n";
00262 
00263     *out << "\nTesting the solution error ||b-A*x||/||b|| computed through the Epetra objects ...\n";
00264 
00265     // r = b - A*x
00266     Epetra_Vector epetra_r(*epetra_b);
00267     {
00268       Epetra_Vector epetra_A_x(epetra_A->OperatorRangeMap());
00269       epetra_A->Apply(*epetra_x,epetra_A_x);
00270       epetra_r.Update(-1.0,epetra_A_x,1.0);
00271     }
00272       
00273     const double
00274       nrm_r = epetraNorm2(epetra_r),
00275       nrm_b = epetraNorm2(*epetra_b),
00276       rel_err = ( nrm_r / nrm_b );
00277     const bool
00278       passed = (rel_err <= tol);
00279 
00280     *out
00281       << "||b-A*x||/||b|| = " << nrm_r << "/" << nrm_b << " = " << rel_err
00282       << " < tol = " << tol << " ? " << ( passed ? "passed" : "failed" ) << "\n";
00283 
00284     if(!passed) success = false;
00285     
00286   }
00287   TEUCHOS_STANDARD_CATCH_STATEMENTS(verbose,std::cerr,success)
00288   
00289   if (verbose) {
00290     if(success)  *out << "\nCongratulations! All of the tests checked out!\n";
00291     else         *out << "\nOh no! At least one of the tests failed!\n";
00292   }
00293 
00294   return ( success ? 0 : 1 );
00295 
00296 }
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends
Generated on Wed Apr 13 10:19:51 2011 for Stratimikos Package Browser (Single Doxygen Collection) by  doxygen 1.6.3