MueLu_Details_registerLinearSolverFactory.hpp

Go to the documentation of this file.

// @HEADER
// *****************************************************************************
//        MueLu: A package for multigrid based preconditioning
//
// Copyright 2012 NTESS and the MueLu contributors.
// SPDX-License-Identifier: BSD-3-Clause
// *****************************************************************************
// @HEADER


#ifndef MUELU_DETAILS_REGISTERLINEARSOLVERFACTORY_HPP
#define MUELU_DETAILS_REGISTERLINEARSOLVERFACTORY_HPP

#include "MueLu_config.hpp"

namespace MueLu {
namespace Details {

void registerLinearSolverFactory();

}  // namespace Details
}  // namespace MueLu

namespace {  // (anonymous)

// \class RegisterLinearSolverFactory
// \brief Register MueLu's solver factory/ies with the central registry.
//
// \warning NOT FOR USERS.  ONLY FOR USE IN THIS FILE.
//
// Invoke this class' constructor to register MueLu's solver
// factory/ies with the central registry, for all template paramete
// combinations that MueLu 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() {
    MueLu::Details::registerLinearSolverFactory();
  }
};

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

}  // namespace

#endif  // MUELU_DETAILS_REGISTERLINEARSOLVERFACTORY_HPP