Teko  Version of the Day
 All Classes Files Functions Variables Pages
Teko_LU2x2DiagonalStrategy.hpp
1 /*
2 // @HEADER
3 //
4 // ***********************************************************************
5 //
6 // Teko: A package for block and physics based preconditioning
7 // Copyright 2010 Sandia Corporation
8 //
9 // Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
10 // the U.S. Government retains certain rights in this software.
11 //
12 // Redistribution and use in source and binary forms, with or without
13 // modification, are permitted provided that the following conditions are
14 // met:
15 //
16 // 1. Redistributions of source code must retain the above copyright
17 // notice, this list of conditions and the following disclaimer.
18 //
19 // 2. Redistributions in binary form must reproduce the above copyright
20 // notice, this list of conditions and the following disclaimer in the
21 // documentation and/or other materials provided with the distribution.
22 //
23 // 3. Neither the name of the Corporation nor the names of the
24 // contributors may be used to endorse or promote products derived from
25 // this software without specific prior written permission.
26 //
27 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
28 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
29 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
30 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
31 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
32 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
33 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
34 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
35 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
36 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
37 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
38 //
39 // Questions? Contact Eric C. Cyr (eccyr@sandia.gov)
40 //
41 // ***********************************************************************
42 //
43 // @HEADER
44 
45 */
46 
47 #ifndef __Teko_LU2x2DiagonalStrategy_hpp__
48 #define __Teko_LU2x2DiagonalStrategy_hpp__
49 
50 #include "Teko_LU2x2Strategy.hpp"
51 
52 // Teuchos includes
53 #include "Teuchos_Time.hpp"
54 
55 namespace Teko {
56 
67 public:
70 
72  LU2x2DiagonalStrategy(const Teuchos::RCP<InverseFactory> & invFA,
73  const Teuchos::RCP<InverseFactory> & invS);
74 
77 
79  virtual const Teko::LinearOp
80  getHatInvA00(const Teko::BlockedLinearOp & A,BlockPreconditionerState & state) const;
81 
83  virtual const Teko::LinearOp
84  getTildeInvA00(const Teko::BlockedLinearOp & A,BlockPreconditionerState & state) const;
85 
87  virtual const Teko::LinearOp
88  getInvS(const Teko::BlockedLinearOp & A,BlockPreconditionerState & state) const;
89 
101  virtual void initializeFromParameterList(const Teuchos::ParameterList & settings,
102  const InverseLibrary & invLib);
103 
104 protected:
107  static void buildTimers();
108 
115  void initializeState(const Teko::BlockedLinearOp & A,BlockPreconditionerState & state) const;
116 
117  // how to invert the matrices
118  Teuchos::RCP<InverseFactory> invFactoryA00_; // for \tilde{A_00}\f$
119  Teuchos::RCP<InverseFactory> invFactoryS_;
120 
121  DiagonalType a00InverseType_;
122 
123  static Teuchos::RCP<Teuchos::Time> initTimer_;
124  static Teuchos::RCP<Teuchos::Time> invSTimer_;
125  static Teuchos::RCP<Teuchos::Time> invA00Timer_;
126  static Teuchos::RCP<Teuchos::Time> opsTimer_;
127 };
128 
129 } // end namespace Teko
130 
131 #endif
virtual const Teko::LinearOp getTildeInvA00(const Teko::BlockedLinearOp &A, BlockPreconditionerState &state) const
Strategy for computing and in the LU2x2PreconditionerFactory. Uses the diagonal of to build ...
An implementation of a state object for block preconditioners.
Abstract strategy for computing inv(F) and inv(S) in the LU2x2PreconditionerFactory.
void initializeState(const Teko::BlockedLinearOp &A, BlockPreconditionerState &state) const
virtual const Teko::LinearOp getHatInvA00(const Teko::BlockedLinearOp &A, BlockPreconditionerState &state) const
virtual ~LU2x2DiagonalStrategy()
Destructor (does nothing)
virtual const Teko::LinearOp getInvS(const Teko::BlockedLinearOp &A, BlockPreconditionerState &state) const
virtual void initializeFromParameterList(const Teuchos::ParameterList &settings, const InverseLibrary &invLib)
This function builds the internals of the state from a parameter list.