Belos Package Browser (Single Doxygen Collection)  Development
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Belos_Details_registerLinearSolverFactory.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 #ifndef BELOS_DETAILS_REGISTERLINEARSOLVERFACTORY_HPP
43 #define BELOS_DETAILS_REGISTERLINEARSOLVERFACTORY_HPP
44 
47 
48 #include "BelosConfigDefs.hpp"
49 
50 namespace Belos {
51 namespace Details {
52 
90 
91 } // namespace Details
92 } // namespace Belos
93 
94 namespace { // (anonymous)
95 
96 // \class RegisterLinearSolverFactory
97 // \brief Register Belos' solver factory/ies with the central registry.
98 //
99 // \warning NOT FOR USERS. ONLY FOR USE IN THIS FILE.
100 //
101 // Invoke this class' constructor to register Belos's solver
102 // factory/ies with the central registry, for all template parameter
103 // combinations that Belos enabled. You need not keep the instance of
104 // the class around; the constructor has a side effect if it returns.
105 // (This is the C++ way of doing
106 // <tt>__attribute__((constructor))</tt>, without actually requiring
107 // the syntax extension.)
108 class RegisterLinearSolverFactory {
109 public:
110  RegisterLinearSolverFactory () {
112  }
113 };
114 
115 // Creating an instance of RegisterLinearSolverFactory invokes its
116 // constructor, which has the side effect of calling
117 // Belos::Details::registerLinearSolverFactory().
118 RegisterLinearSolverFactory registerIt;
119 
120 } // namespace (anonymous)
121 
122 #endif /* BELOS_DETAILS_REGISTERLINEARSOLVERFACTORY_HPP */
Belos header file which uses auto-configuration information to include necessary C++ headers...
void registerLinearSolverFactory()
Register Belos&#39; LinearSolverFactory with the central repository, for all enabled combinations of temp...