IterationPack: General framework for building iterative algorithms  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
IterationPack_AlgorithmTracker.hpp
1 // @HEADER
2 // ***********************************************************************
3 //
4 // Moocho: Multi-functional Object-Oriented arCHitecture for Optimization
5 // Copyright (2003) Sandia Corporation
6 //
7 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
8 // license for use of this work by or on behalf of the U.S. Government.
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 Roscoe A. Bartlett (rabartl@sandia.gov)
38 //
39 // ***********************************************************************
40 // @HEADER
41 
42 #ifndef ALGORITHM_TRACK_H
43 #define ALGORITHM_TRACK_H
44 
45 #include <iosfwd>
46 
47 #include "IterationPack_Types.hpp"
48 #include "Teuchos_RCP.hpp"
49 
50 namespace IterationPack {
51 
60 public:
61 
63  virtual ~AlgorithmTracker() {}
64 
67 
70 
72 
75 
83 
85 
88 
93  virtual void initialize();
94 
99  virtual void output_iteration(const Algorithm& algo) const;
100 
105  virtual void output_final(const Algorithm& algo, EAlgoReturn algo_return) const;
106 
108 
111 
114  virtual void set_journal_out(const ostream_ptr_t& journal_out);
115 
118  const ostream_ptr_t& get_journal_out() const;
119 
123  virtual std::ostream& journal_out() const;
124 
126 
127 private:
128 
129 #ifndef DOXYGEN_COMPILE
130  ostream_ptr_t journal_out_;
131 #endif
132 
133  // not defined and not to be called
135 
136 }; // end class AlgorithmTracker
137 
138 } // end namespace IterationPack
139 
140 #endif // ALGORITHM_TRACK_H
virtual void initialize()
Reinitialize the track object right before it is used.
const ostream_ptr_t & get_journal_out() const
Get the smart pointer to the journal file.
virtual void output_final(const Algorithm &algo, EAlgoReturn algo_return) const
Output information about a just completed algorithm.
virtual void set_journal_out(const ostream_ptr_t &journal_out)
Set a smart pointer to the journal file.
virtual std::ostream & journal_out() const
Return a reference to a std::ostream to be used to output debug information and the like...
virtual void output_iteration(const Algorithm &algo) const
Output information about an iteration just completed.
Acts as the central hub for an iterative algorithm.
Used to ouput iteration results and other information.