MueLu_FactoryManagerBase.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_FACTORYMANAGERBASE_HPP
#define MUELU_FACTORYMANAGERBASE_HPP
 
#include <string>
 
#include "MueLu_ConfigDefs.hpp"
#include "MueLu_BaseClass.hpp"
 
#include "MueLu_FactoryBase_fwd.hpp"
 
namespace MueLu {

class FactoryManagerBase : public BaseClass {
 public:
  FactoryManagerBase()
    : bIgnoreUserData_(false) {}

  virtual ~FactoryManagerBase() {}



  // Return ref because user also give ref to the Hierarchy.
  const virtual RCP<const FactoryBase> GetFactory(const std::string& varName) const = 0;

  // Return true if Factory associated with varName is registered
  virtual bool hasFactory(const std::string& varName) const = 0;
 
  // Free temporarily hold data at the end of Hierarchy::Setup()
  // This method is const because the clean concerns only mutable data.
  virtual void Clean() const {}  // TODO: should be used inside of MueLu::Hierarchy
 
#ifdef HAVE_MUELU_DEBUG
  virtual void ResetDebugData() const = 0;
#endif

  bool IgnoreUserData() const { return bIgnoreUserData_; }

  void SetIgnoreUserData(bool bIgnoreUserData = false) { bIgnoreUserData_ = bIgnoreUserData; }
 
 private:
  bool bIgnoreUserData_;
 
};  // class FactoryManagerBase
 
}  // namespace MueLu
 
#define MUELU_FACTORYMANAGERBASE_SHORT
#endif  // ifndef MUELU_FACTORYMANAGERBASE_HPP