MueLu_SingleLevelFactoryBase.hpp

Go to the documentation of this file.

// @HEADER
//
// ***********************************************************************
//
//        MueLu: A package for multigrid based preconditioning
//                  Copyright 2012 Sandia Corporation
//
// Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
// the U.S. Government retains certain rights in this software.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// 1. Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
//
// 3. Neither the name of the Corporation nor the names of the
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// Questions? Contact
//                    Jonathan Hu       (jhu@sandia.gov)
//                    Andrey Prokopenko (aprokop@sandia.gov)
//                    Ray Tuminaro      (rstumin@sandia.gov)
//
// ***********************************************************************
//
// @HEADER
#ifndef MUELU_SINGLELEVELFACTORY_HPP
#define MUELU_SINGLELEVELFACTORY_HPP

#include "MueLu_ConfigDefs.hpp"

#include "MueLu_Factory.hpp"
#include "MueLu_Level_fwd.hpp"
#include "MueLu_TimeMonitor.hpp"
#include "MueLu_Utilities.hpp"

namespace MueLu {

class SingleLevelFactoryBase : public Factory {
 public:


  SingleLevelFactoryBase() {}

  virtual ~SingleLevelFactoryBase() {}




  virtual void DeclareInput(Level& currentLevel) const = 0;




  virtual void Build(Level& currentLevel) const = 0;

  virtual void CallBuild(Level& requestedLevel) const {
#ifdef HAVE_MUELU_DEBUG
    // We cannot call Build method twice for the same level, but we can call it multiple times for different levels
    int levelID = requestedLevel.GetLevelID();
    TEUCHOS_TEST_FOR_EXCEPTION((multipleCallCheck_ == ENABLED) && (multipleCallCheckGlobal_ == ENABLED) && (lastLevelID_ == levelID),
                               Exceptions::RuntimeError,
                               this->ShortClassName() << "::Build() called twice for the same level (levelID=" << levelID
                                                      << "). This is likely due to a configuration error, or calling hierarchy setup multiple times "
                                                      << "without resetting debug info through FactoryManager::ResetDebugData().");
    if (multipleCallCheck_ == FIRSTCALL)
      multipleCallCheck_ = ENABLED;

    lastLevelID_ = levelID;
#endif

    RCP<const Teuchos::Comm<int> > comm = requestedLevel.GetComm();
    if (comm.is_null()) {
      // Some factories are called before we constructed Ac, and therefore,
      // before we set the level communicator. For such factories we can get
      // the comm from the previous level, as all processes go there
      RCP<Level>& prevLevel = requestedLevel.GetPreviousLevel();
      if (!prevLevel.is_null())
        comm = prevLevel->GetComm();
    }

    int oldRank = -1;
    if (!comm.is_null())
      oldRank = SetProcRankVerbose(comm->getRank());

    // Synchronization timer
    std::string syncTimer = this->ShortClassName() + ": Build sync (level=" + toString(requestedLevel.GetLevelID()) + ")";
    if (this->timerSync_ && !comm.is_null()) {
      TimeMonitor timer(*this, syncTimer);
      comm->barrier();
    }

    Build(requestedLevel);

    if (this->timerSync_ && !comm.is_null()) {
      TimeMonitor timer(*this, syncTimer);
      comm->barrier();
    }

    if (IsPrint(Test1))
      GetOStream(Test1) << *RemoveFactoriesFromList(GetParameterList()) << std::endl;
    else
      RemoveFactoriesFromList(GetParameterList())->print(GetOStream(Test0), Teuchos::ParameterList::PrintOptions().indent(0).showFlags(true).showDefault(false));

    if (oldRank != -1)
      SetProcRankVerbose(oldRank);
  }

  virtual void CallDeclareInput(Level& requestedLevel) const {
    DeclareInput(requestedLevel);
  }

};  // class SingleLevelFactoryBase

}  // namespace MueLu

#define MUELU_SINGLELEVELFACTORY_SHORT
#endif  // ifndef MUELU_SINGLELEVELFACTORY_HPP

// TODO: code factorization between SingleLevelFactoryBase and TwoLevelFactoryBase