Teko Version of the Day
Loading...
Searching...
No Matches
Teko_DiagnosticPreconditionerFactory.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_DiagnosticPreconditionerFactory_hpp__
48#define __Teko_DiagnosticPreconditionerFactory_hpp__
49
50#include "Teuchos_Time.hpp"
51
52// Teko includes
53#include "Teko_PreconditionerFactory.hpp"
54
55namespace Teko {
56
73 : public virtual Teko::PreconditionerFactory {
74public:
77
84 DiagnosticPreconditionerFactory(const Teuchos::RCP<Teko::InverseFactory> & invFactory,const std::string & label,
85 const Teuchos::RCP<std::ostream> & os=Teuchos::null,bool printResidual=false);
86
89
103 virtual LinearOp buildPreconditionerOperator(LinearOp & lo,PreconditionerState & state) const;
104
106
107
118 virtual void initializeFromParameterList(const Teuchos::ParameterList & settings);
119
132 virtual Teuchos::RCP<Teuchos::ParameterList> getRequestedParameters() const;
133
145 virtual bool updateRequestedParameters(const Teuchos::ParameterList & pl);
146
148
149 int numInitialBuilds() const { return buildTimer_->numCalls(); }
150 double totalInitialBuildTime() const { return buildTimer_->totalElapsedTime(); }
151
152 int numRebuilds() const { return rebuildTimer_->numCalls(); }
153 double totalRebuildTime() const { return rebuildTimer_->totalElapsedTime(); }
154
155private:
156 void initTimers(const std::string & label);
157
158 Teuchos::RCP<std::ostream> outputStream_;
159 Teuchos::RCP<Teko::InverseFactory> invFactory_;
160 std::string diagString_;
161 bool printResidual_;
162
163 mutable Teuchos::RCP<Teuchos::Time> buildTimer_; // only first pass construction time (no rebuild)
164 mutable Teuchos::RCP<Teuchos::Time> rebuildTimer_; // rebuild-construction timer (no build)
165};
166
167} // end namespace Teko
168
169#endif
A class which builds a diagnostic operator to wrap the application of the inverse operator....
virtual ~DiagnosticPreconditionerFactory()
default destructor: prints out diagnostic string
virtual bool updateRequestedParameters(const Teuchos::ParameterList &pl)
Update this object with the fields from a parameter list.
virtual void initializeFromParameterList(const Teuchos::ParameterList &settings)
This function builds the internals of the preconditioner factory from a parameter list.
DiagnosticPreconditionerFactory()
Default constructor, for use with the AutoClone class.
virtual Teuchos::RCP< Teuchos::ParameterList > getRequestedParameters() const
Request the additional parameters this preconditioner factory needs.
virtual LinearOp buildPreconditionerOperator(LinearOp &lo, PreconditionerState &state) const
Function that is called to build the preconditioner for the linear operator that is passed in.
Abstract class which block preconditioner factories in Teko should be based on.
An implementation of a state object preconditioners.