EpetraExt Package Browser (Single Doxygen Collection)  Development
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
EpetraExt_Scale_LinearProblem.h
Go to the documentation of this file.
1 //@HEADER
2 // ***********************************************************************
3 //
4 // EpetraExt: Epetra Extended - Linear Algebra Services Package
5 // Copyright (2011) Sandia Corporation
6 //
7 // Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
8 // the U.S. Government retains certain rights in this software.
9 //
10 // Redistribution and use in source and binary forms, with or without
11 // modification, are permitted provided that the following conditions are
12 // met:
13 //
14 // 1. Redistributions of source code must retain the above copyright
15 // notice, this list of conditions and the following disclaimer.
16 //
17 // 2. Redistributions in binary form must reproduce the above copyright
18 // notice, this list of conditions and the following disclaimer in the
19 // documentation and/or other materials provided with the distribution.
20 //
21 // 3. Neither the name of the Corporation nor the names of the
22 // contributors may be used to endorse or promote products derived from
23 // this software without specific prior written permission.
24 //
25 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
26 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
29 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
30 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
31 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
32 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
33 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
34 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
35 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36 //
37 // Questions? Contact Michael A. Heroux (maherou@sandia.gov)
38 //
39 // ***********************************************************************
40 //@HEADER
41 
42 #ifndef EpetraExt_LINEARPROBLEM_SCALE_H
43 #define EpetraExt_LINEARPROBLEM_SCALE_H
44 
45 #include <vector>
46 
47 #include <EpetraExt_Transform.h>
48 
50 class Epetra_Vector;
51 
52 namespace EpetraExt {
53 
55 
57 class LinearProblem_Scale : public InPlaceTransform<Epetra_LinearProblem>
58 {
59  public:
60 
61  enum ScaleType{ Sum, Max, Diag, None };
62 
64 
67 
69 
72  ScaleType right = Sum,
73  double exp_fac = 1.0,
74  int iterations = 1 )
75  : lScale_(left),
76  rScale_(right),
77  expFac_(exp_fac),
78  iters_(iterations),
79  scaled_(false)
80  {}
81 
83 
85  bool fwd();
86 
88 
90  bool rvs();
91 
92  private:
93 
96 
97  const double expFac_;
98 
99  const int iters_;
100 
101  bool scaled_;
102 
103  std::vector<Epetra_Vector*> lScaleVecs_;
104  std::vector<Epetra_Vector*> rScaleVecs_;
105 };
106 
107 } //namespace EpetraExt
108 
109 #endif //EpetraExt_LINEARPROBLEM_SCALE_H
110 
LinearProblem_Scale(ScaleType left=Sum, ScaleType right=Sum, double exp_fac=1.0, int iterations=1)
Constructor.
std::vector< Epetra_Vector * > lScaleVecs_
Given an input Epetra_LinearProblem, recursive, left and right scaling are performed.
std::vector< Epetra_Vector * > rScaleVecs_