Belos  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
BelosStatusTestOutputFactory.hpp
Go to the documentation of this file.
1 //@HEADER
2 // ************************************************************************
3 //
4 // Belos: Block Linear Solvers Package
5 // Copyright 2004 Sandia Corporation
6 //
7 // Under the 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 
43 #ifndef BELOS_STATUS_TEST_OUTPUT_FACTORY_HPP
44 #define BELOS_STATUS_TEST_OUTPUT_FACTORY_HPP
45 
51 #include "BelosConfigDefs.hpp"
52 #include "BelosTypes.hpp"
56 
57 
58 namespace Belos {
59 
69 template <class ScalarType, class MV, class OP>
71 
72  public:
74 
75 
84  StatusTestOutputFactory( int outputStyle, Teuchos::RCP<std::map<std::string,Teuchos::RCP<StatusTest<ScalarType,MV,OP> > > > taggedTests = Teuchos::null )
85  : outputStyle_(outputStyle),
86  taggedTests_(taggedTests)
87  {}
88 
92 
93 
95 
96 
113  int mod,
114  int printStates)
115  {
117 
118  switch( outputStyle_ ) {
119 
120  case General:
121  if (mod > 0) {
122  outputTest = Teuchos::rcp( new StatusTestGeneralOutput<ScalarType,MV,OP>( printer, test, mod, printStates ) );
123  }
124  else {
125  outputTest = Teuchos::rcp( new StatusTestGeneralOutput<ScalarType,MV,OP>( printer, test, 1 ) );
126  }
127  break;
128  case Brief:
129  if (mod > 0) {
130  outputTest = Teuchos::rcp( new StatusTestResNormOutput<ScalarType,MV,OP>( printer, test, mod, printStates ) );
131  }
132  else {
133  outputTest = Teuchos::rcp( new StatusTestResNormOutput<ScalarType,MV,OP>( printer, test, 1 ) );
134  }
135  break;
136  case User:
137  if (mod > 0) {
138  outputTest = Teuchos::rcp( new StatusTestUserOutput<ScalarType,MV,OP>( printer, test, taggedTests_, mod, printStates ) );
139  }
140  else {
141  outputTest = Teuchos::rcp( new StatusTestUserOutput<ScalarType,MV,OP>( printer, test, taggedTests_, 1 ) );
142  }
143  break;
144  }
145 
146  return outputTest;
147  }
148 
150 
151  private:
152 
153  // Which type of StatusTestOutput class
154  int outputStyle_;
155 
157 
158  // Hide the default constructor and copy constructor
159  StatusTestOutputFactory( void ) {}
160  StatusTestOutputFactory( const StatusTestOutputFactory<ScalarType,MV,OP>& ) {}
161 
162 };
163 
164 } // end of Belos namespace
165 
166 #endif /* BELOS_STATUS_TEST_OUTPUT_FACTORY_HPP */
Special StatusTest for printing status tests in simple format for residuals.
Collection of types and exceptions used within the Belos solvers.
Belos&#39;s basic output manager for sending information of select verbosity levels to the appropriate ou...
A special StatusTest for printing other status tests in a simple format.
A factory class for generating StatusTestOutput objects.
A pure virtual class for defining the status tests for the Belos iterative solvers.
TEUCHOS_DEPRECATED RCP< T > rcp(T *p, Dealloc_T dealloc, bool owns_mem)
StatusTestOutputFactory(int outputStyle, Teuchos::RCP< std::map< std::string, Teuchos::RCP< StatusTest< ScalarType, MV, OP > > > > taggedTests=Teuchos::null)
Constructor.
A special StatusTest for printing other status tests in a simple format.
Teuchos::RCP< StatusTestOutput< ScalarType, MV, OP > > create(const Teuchos::RCP< OutputManager< ScalarType > > &printer, Teuchos::RCP< StatusTest< ScalarType, MV, OP > > test, int mod, int printStates)
Create the StatusTestOutput object specified by the outputStyle.
A special StatusTest for printing other status tests.
Special StatusTest for printing status tests in simple format for residuals.
Special StatusTest for printing any kind of status test.
Belos header file which uses auto-configuration information to include necessary C++ headers...

Generated on Fri Aug 14 2020 10:48:34 for Belos by doxygen 1.8.5