Amesos2_Details_registerLinearSolverFactory.hpp

Go to the documentation of this file.

// @HEADER
// *****************************************************************************
//           Amesos2: Templated Direct Sparse Solver Package
//
// Copyright 2011 NTESS and the Amesos2 contributors.
// SPDX-License-Identifier: BSD-3-Clause
// *****************************************************************************
// @HEADER


#ifndef AMESOS2_DETAILS_REGISTERLINEARSOLVERFACTORY_HPP
#define AMESOS2_DETAILS_REGISTERLINEARSOLVERFACTORY_HPP

#include "Amesos2_config.h"

namespace Amesos2 {
namespace Details {

void registerLinearSolverFactory ();

} // namespace Details
} // namespace Amesos2

namespace { // (anonymous)

// \class RegisterLinearSolverFactory
// \brief Register Amesos2's solver factory/ies with the central registry.
//
// \warning NOT FOR USERS.  ONLY FOR USE IN THIS FILE.
//
// Invoke this class' constructor to register Amesos2's solver
// factory/ies with the central registry, for all template parameter
// combinations that Amesos2 enabled.  You need not keep the instance
// of the class around; the constructor has a side effect if it
// returns.  (This is the C++ way of doing
// <tt>__attribute__((constructor))</tt>, without actually requiring
// the syntax extension.)
class RegisterLinearSolverFactory {
public:
  RegisterLinearSolverFactory () {
    Amesos2::Details::registerLinearSolverFactory ();
  }
};

// Creating an instance of RegisterLinearSolverFactory invokes its
// constructor, which has the side effect of calling
// Amesos2::Details::registerLinearSolverFactory().
RegisterLinearSolverFactory registerIt;

} // namespace (anonymous)

#endif // AMESOS2_DETAILS_REGISTERLINEARSOLVERFACTORY_HPP