Teko Version of the Day
Loading...
Searching...
No Matches
Teko_TimingsSIMPLEPreconditionerFactory.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_TimingsSIMPLEPreconditionerFactory_hpp__
48#define __Teko_TimingsSIMPLEPreconditionerFactory_hpp__
49
50#include "Teko_BlockPreconditionerFactory.hpp"
51#include "Teko_InverseFactory.hpp"
53
54#include "Teuchos_Time.hpp"
55
56namespace Teko {
57namespace NS {
58
59// Declaration of the preconditioner factory
77public:
78 // Constructor
79 TimingsSIMPLEPreconditionerFactory(const Teuchos::RCP<InverseFactory> & inverse,
80 double alpha);
81
82 // Constructor
83 TimingsSIMPLEPreconditionerFactory(const Teuchos::RCP<InverseFactory> & invVelFactory,
84 const Teuchos::RCP<InverseFactory> & invPrsFactory,
85 double alpha);
86
89
92
93 // Function inherited from BlockPreconditionerFactory
94 LinearOp buildPreconditionerOperator(BlockedLinearOp & blo,
95 BlockPreconditionerState & state) const;
96
98 virtual void setMassMatrix(Teko::LinearOp & mass)
99 { massMatrix_ = mass; }
100
102 virtual Teuchos::RCP<Teuchos::ParameterList> getRequestedParameters() const;
103
105 virtual bool updateRequestedParameters(const Teuchos::ParameterList & pl);
106
108 virtual void initializeFromParameterList(const Teuchos::ParameterList & pl);
109
110protected:
112
113 // class members
114 Teuchos::RCP<InverseFactory> customHFactory_;
115 Teuchos::RCP<InverseFactory> invVelFactory_;
116 Teuchos::RCP<InverseFactory> invPrsFactory_;
117 double alpha_;
118 DiagonalType fInverseType_;
119 // enum FInverseType {Diagonal,Lumped,AbsRowSum,Custom} fInverseType_;
120
121 bool useMass_;
122 Teko::LinearOp massMatrix_;
123
124 // Info for the block-diagonal approximation to H if used.
125 mutable Teuchos::ParameterList BlkDiagList_;
126
127 mutable Teuchos::Time constrTotal_;
128 mutable Teuchos::Time subTotal_;
129 mutable int constrCount_;
130
131 mutable Teuchos::RCP<DiagnosticLinearOp> timed_HBt_;
132 mutable Teuchos::RCP<DiagnosticLinearOp> timed_B_;
133 mutable Teuchos::RCP<DiagnosticLinearOp> timed_invF_;
134 mutable Teuchos::RCP<DiagnosticLinearOp> timed_invS_;
135 mutable Teuchos::RCP<DiagnosticLinearOp> timed_iU_t_iL_;
136};
137
138} // end namespace NS
139} // end namespace Teko
140
141#endif
DiagonalType
Type describing the type of diagonal to construct.
Abstract class which block preconditioner factories in Teko should be based on.
virtual LinearOp buildPreconditionerOperator(BlockedLinearOp &blo, BlockPreconditionerState &state) const =0
Function that is called to build the preconditioner for the linear operator that is passed in.
An implementation of a state object for block preconditioners.
virtual bool updateRequestedParameters(const Teuchos::ParameterList &pl)
For assisting in construction of the preconditioner.
virtual void initializeFromParameterList(const Teuchos::ParameterList &pl)
Initialize from a parameter list.
LinearOp buildPreconditionerOperator(BlockedLinearOp &blo, BlockPreconditionerState &state) const
Function that is called to build the preconditioner for the linear operator that is passed in.
virtual void setMassMatrix(Teko::LinearOp &mass)
Set the mass matrix for this factory.
virtual ~TimingsSIMPLEPreconditionerFactory()
Destructor that outputs construction timings.
virtual Teuchos::RCP< Teuchos::ParameterList > getRequestedParameters() const
For assisting in construction of the preconditioner.