Amesos2 - Direct Sparse Solver Interfaces Version of the Day
Amesos2_Details_registerLinearSolverFactory.hpp
Go to the documentation of this file.
1// @HEADER
2//
3// ***********************************************************************
4//
5// Amesos2: Templated Direct Sparse Solver Package
6// Copyright 2011 Sandia Corporation
7//
8// Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
9// the U.S. Government retains certain rights in this software.
10//
11// Redistribution and use in source and binary forms, with or without
12// modification, are permitted provided that the following conditions are
13// met:
14//
15// 1. Redistributions of source code must retain the above copyright
16// notice, this list of conditions and the following disclaimer.
17//
18// 2. Redistributions in binary form must reproduce the above copyright
19// notice, this list of conditions and the following disclaimer in the
20// documentation and/or other materials provided with the distribution.
21//
22// 3. Neither the name of the Corporation nor the names of the
23// contributors may be used to endorse or promote products derived from
24// this software without specific prior written permission.
25//
26// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
27// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
28// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
29// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
30// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
31// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
32// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
33// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
34// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
35// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
36// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
37//
38// Questions? Contact Michael A. Heroux (maherou@sandia.gov)
39//
40// ***********************************************************************
41//
42// @HEADER
43
47
48#ifndef AMESOS2_DETAILS_REGISTERLINEARSOLVERFACTORY_HPP
49#define AMESOS2_DETAILS_REGISTERLINEARSOLVERFACTORY_HPP
50
51#include "Amesos2_config.h"
52
53namespace Amesos2 {
54namespace Details {
55
82void registerLinearSolverFactory ();
83
84} // namespace Details
85} // namespace Amesos2
86
87namespace { // (anonymous)
88
89// \class RegisterLinearSolverFactory
90// \brief Register Amesos2's solver factory/ies with the central registry.
91//
92// \warning NOT FOR USERS. ONLY FOR USE IN THIS FILE.
93//
94// Invoke this class' constructor to register Amesos2's solver
95// factory/ies with the central registry, for all template parameter
96// combinations that Amesos2 enabled. You need not keep the instance
97// of the class around; the constructor has a side effect if it
98// returns. (This is the C++ way of doing
99// <tt>__attribute__((constructor))</tt>, without actually requiring
100// the syntax extension.)
101class RegisterLinearSolverFactory {
102public:
103 RegisterLinearSolverFactory () {
104 Amesos2::Details::registerLinearSolverFactory ();
105 }
106};
107
108// Creating an instance of RegisterLinearSolverFactory invokes its
109// constructor, which has the side effect of calling
110// Amesos2::Details::registerLinearSolverFactory().
111RegisterLinearSolverFactory registerIt;
112
113} // namespace (anonymous)
114
115#endif // AMESOS2_DETAILS_REGISTERLINEARSOLVERFACTORY_HPP