Anasazi  Version of the Day
AnasaziBasicOutputManager.hpp
Go to the documentation of this file.
1 // @HEADER
2 // ***********************************************************************
3 //
4 // Anasazi: Block Eigensolvers Package
5 // Copyright 2004 Sandia Corporation
6 //
7 // Under 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 ANASAZI_BASIC_OUTPUT_MANAGER_HPP
43 #define ANASAZI_BASIC_OUTPUT_MANAGER_HPP
44 
49 #include "AnasaziConfigDefs.hpp"
50 #include "AnasaziOutputManager.hpp"
51 #include "Teuchos_oblackholestream.hpp"
52 
53 #ifdef HAVE_MPI
54 #include <mpi.h>
55 #endif
56 
65 namespace Anasazi {
66 
67  template <class ScalarType>
68  class BasicOutputManager : public OutputManager<ScalarType> {
69 
70  public:
71 
73 
74 
76  BasicOutputManager(int vb = Anasazi::Errors, int rootRank = 0);
77 
80  const Teuchos::RCP<Teuchos::FancyOStream>& fos)
81  : OutputManager<ScalarType>(vb, fos)
82  {};
83 
85  virtual ~BasicOutputManager() {};
87 
88 
89  private:
90 
92 
93 
96 
99 
101  };
102 
103  template<class ScalarType>
105  : OutputManager<ScalarType>(vb)
106  {
107 #ifdef HAVE_MPI
108  // The OutputManger constructor will create fos_ that outputs to std::cout
109  // This class will query MPI to print on processor 0, if parallel.
110  int myRank = 0;
111  int numProcs = 1;
112  // Initialize MPI
113  int mpiStarted = 0;
114  MPI_Initialized(&mpiStarted);
115  if (mpiStarted)
116  {
117  MPI_Comm_rank(MPI_COMM_WORLD, &myRank);
118  MPI_Comm_size(MPI_COMM_WORLD, &numProcs);
119  }
120  this->fos_->setProcRankAndSize(myRank, numProcs);
121  this->fos_->setOutputToRootOnly(rootRank);
122 #endif
123  }
124 
125 } // end Anasazi namespace
126 
127 #endif
128 
129 // end of file AnasaziOutputManager.hpp
Anasazi::BasicOutputManager::BasicOutputManager
BasicOutputManager(int vb, const Teuchos::RCP< Teuchos::FancyOStream > &fos)
Constructor with specified verbosity and formatted output stream.
Definition: AnasaziBasicOutputManager.hpp:79
Anasazi::OutputManager
Output managers remove the need for the eigensolver to know any information about the required output...
Definition: AnasaziOutputManager.hpp:68
Anasazi::BasicOutputManager::~BasicOutputManager
virtual ~BasicOutputManager()
Destructor.
Definition: AnasaziBasicOutputManager.hpp:85
Anasazi::Errors
Definition: AnasaziTypes.hpp:163
Anasazi::BasicOutputManager
Anasazi's basic output manager for sending information of select verbosity levels to the appropriate ...
Definition: AnasaziBasicOutputManager.hpp:68
Anasazi
Namespace Anasazi contains the classes, structs, enums and utilities used by the Anasazi package.
Anasazi::BasicOutputManager::BasicOutputManager
BasicOutputManager(int vb=Anasazi::Errors, int rootRank=0)
Default constructor.
Definition: AnasaziBasicOutputManager.hpp:104
AnasaziConfigDefs.hpp
Anasazi header file which uses auto-configuration information to include necessary C++ headers.
AnasaziOutputManager.hpp
Abstract class definition for Anasazi Output Managers.