EpetraExt Package Browser (Single Doxygen Collection) Development
EpetraExt_Scale_LinearProblem.h
Go to the documentation of this file.
00001 //@HEADER
00002 // ***********************************************************************
00003 //
00004 //     EpetraExt: Epetra Extended - Linear Algebra Services Package
00005 //                 Copyright (2011) Sandia Corporation
00006 //
00007 // Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
00008 // the U.S. Government retains certain rights in this software.
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 #ifndef EpetraExt_LINEARPROBLEM_SCALE_H
00043 #define EpetraExt_LINEARPROBLEM_SCALE_H
00044 
00045 #include <vector>
00046 
00047 #include <EpetraExt_Transform.h>
00048 
00049 class Epetra_LinearProblem;
00050 class Epetra_Vector;
00051 
00052 namespace EpetraExt {
00053 
00055 
00057 class LinearProblem_Scale : public InPlaceTransform<Epetra_LinearProblem>
00058 {
00059  public:
00060 
00061   enum ScaleType{ Sum, Max, Diag, None };
00062 
00064 
00066   ~LinearProblem_Scale();
00067 
00069 
00071   LinearProblem_Scale( ScaleType left = Sum,
00072                        ScaleType right = Sum,
00073                        double exp_fac = 1.0,
00074                        int iterations = 1 )
00075   : lScale_(left),
00076     rScale_(right),
00077     expFac_(exp_fac),
00078     iters_(iterations),
00079     scaled_(false)
00080   {}
00081 
00083 
00085   bool fwd();
00086 
00088 
00090   bool rvs();
00091 
00092  private:
00093 
00094   const ScaleType lScale_;
00095   const ScaleType rScale_;
00096 
00097   const double expFac_;
00098 
00099   const int iters_;
00100 
00101   bool scaled_;
00102 
00103   std::vector<Epetra_Vector*> lScaleVecs_;
00104   std::vector<Epetra_Vector*> rScaleVecs_;
00105 };
00106 
00107 } //namespace EpetraExt
00108 
00109 #endif //EpetraExt_LINEARPROBLEM_SCALE_H
00110 
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines