46 #ifndef MUELU_HIERARCHY_DECL_HPP 47 #define MUELU_HIERARCHY_DECL_HPP 49 #include <Teuchos_ParameterList.hpp> 50 #include <Teuchos_Ptr.hpp> 52 #include <Xpetra_ConfigDefs.hpp> 53 #include <Xpetra_Matrix_fwd.hpp> 54 #include <Xpetra_MultiVector_fwd.hpp> 55 #include <Xpetra_MultiVectorFactory_fwd.hpp> 56 #include <Xpetra_Operator_fwd.hpp> 66 #include "MueLu_FactoryManager.hpp" 104 #undef MUELU_HIERARCHY_SHORT 107 typedef Teuchos::ScalarTraits<SC>
STS;
135 Hierarchy(
const RCP<Matrix> & A,
const std::string& label);
167 template<
class S2,
class LO2,
class GO2,
class N2>
177 void AddLevel(
const RCP<Level> & level);
183 RCP<Level> &
GetLevel(
const int levelID = 0);
239 bool Setup(
int coarseLevelID,
const RCP<const FactoryManagerBase> fineLevelManager ,
const RCP<const FactoryManagerBase> coarseLevelManager,
240 const RCP<const FactoryManagerBase> nextLevelManager = Teuchos::null);
248 void Clear(
int startLevel = 0);
274 ReturnType Iterate(
const MultiVector& B, MultiVector& X, ConvData conv = ConvData(),
275 bool InitialGuessIsZero =
false, LO startLevel = 0);
286 void Write(
const LO &start=-1,
const LO &end=-1,
const std::string &suffix=
"");
319 void describe(Teuchos::FancyOStream& out,
const Teuchos::EVerbosityLevel verbLevel = Teuchos::VERB_HIGH)
const;
426 #define MUELU_HIERARCHY_SHORT 427 #endif // MUELU_HIERARCHY_DECL_HPP
void IsPreconditioner(const bool flag)
Array< RCP< MultiVector > > coarseExport_
This class specifies the default factory that should generate some data on a Level if the data does n...
double GetSmootherComplexity() const
MueLu::DefaultLocalOrdinal LocalOrdinal
KokkosClassic::DefaultNode::DefaultNodeType DefaultNode
RCP< Level > & GetLevel(const int levelID=0)
Retrieve a certain level from hierarchy.
Hierarchy()
Default constructor.
void DeleteLevelMultiVectors()
Array< RCP< MultiVector > > coarseImport_
static bool GetDefaultFuseProlongationAndUpdate()
void AddLevel(const RCP< Level > &level)
Add a level at the end of the hierarchy.
int sizeOfAllocatedLevelMultiVectors_
Caching (Multi)Vectors used in Hierarchy::Iterate()
int WCycleStartLevel_
Level at which to start W-cycle.
void SetMaxCoarseSize(Xpetra::global_size_t maxCoarseSize)
void AddNewLevel()
Add a new level at the end of the hierarchy.
static Xpetra::global_size_t GetDefaultMaxCoarseSize()
void SetCycle(CycleType Cycle)
Supports VCYCLE and WCYCLE types.
void Clear(int startLevel=0)
Clear impermanent data from previous setup.
void DumpCurrentGraph(int level) const
void SetFuseProlongationAndUpdate(const bool &fuse)
Namespace for MueLu classes and methods.
Teuchos::ScalarTraits< SC > STS
std::string description_
cache description to avoid recreating in each call to description() - use ResetDescription() to force...
MagnitudeType rate_
Convergece rate.
static const NoFactory * get()
void ReplaceCoordinateMap(Level &level)
void AddKeepFlag(const std::string &ename, const FactoryBase *factory=NoFactory::get(), KeepType keep=MueLu::Keep)
Call Level::AddKeepFlag for each level of the Hierarchy.
void print(std::ostream &out=std::cout, const VerbLevel verbLevel=(MueLu::Parameters|MueLu::Statistics0)) const
Hierarchy::print is local hierarchy function, thus the statistics can be different from global ones...
Xpetra::UnderlyingLib lib()
Base class for factories (e.g., R, P, and A_coarse).
Print statistics that do not involve significant additional computation.
ConvData(std::pair< LO, MagnitudeType > p)
Xpetra::UnderlyingLib lib_
Epetra/Tpetra mode.
CycleType GetCycle() const
Returns multigrid cycle type (supports VCYCLE and WCYCLE)
static CycleType GetDefaultCycle()
MueLu::DefaultScalar Scalar
MueLu::DefaultGlobalOrdinal GlobalOrdinal
void Write(const LO &start=-1, const LO &end=-1, const std::string &suffix="")
Print matrices in the multigrid hierarchy to file.
Class that holds all level-specific information.
void SetCycleStartLevel(int cycleStart)
Class that provides default factories within Needs class.
void ResetDescription()
force recreation of cached description_ next time description() is called:
void RemoveKeepFlag(const std::string &ename, const FactoryBase *factory, KeepType keep=MueLu::All)
Call Level::RemoveKeepFlag for each level of the Hierarchy.
int GetGlobalNumLevels() const
void CheckLevel(Level &level, int levelID)
Helper function.
bool GetFuseProlongationAndUpdate() const
const RCP< const FactoryManagerBase > & GetLevelManager(const int levelID) const
Always keep data, even accross run. This flag is set by Level::Keep(). This flag is propagated to coa...
ConvData(MagnitudeType tol)
static bool GetDefaultImplicitTranspose()
void describe(Teuchos::FancyOStream &out, const VerbLevel verbLevel=Default) const
Print the Hierarchy with some verbosity level to a FancyOStream object.
void AllocateLevelMultiVectors(int numvecs, bool forceMapCheck=false)
bool GetImplicitTranspose() const
void SetPRrebalance(bool doPRrebalance)
void SetMatvecParams(RCP< ParameterList > matvecParams)
double GetOperatorComplexity() const
static int GetDefaultMaxLevels()
Base class for MueLu classes.
void SetImplicitTranspose(const bool &implicit)
CycleType Cycle_
V- or W-cycle.
bool fuseProlongationAndUpdate_
virtual ~Hierarchy()
Destructor.
Data struct for defining stopping criteria of multigrid iteration.
Array< RCP< MultiVector > > coarseRhs_
STS::magnitudeType MagnitudeType
void Delete(const std::string &ename, const FactoryBase *factory=NoFactory::get())
Call Level::Delete(ename, factory) for each level of the Hierarchy.
MagnitudeType GetRate() const
Array< RCP< Level > > Levels_
Container for Level objects.
bool isPreconditioner_
Hierarchy may be used in a standalone mode, or as a preconditioner.
static bool GetDefaultPRrebalance()
static int GetDefaultCycleStartLevel()
Xpetra::global_size_t GetMaxCoarseSize() const
void SetProlongatorScalingFactor(double scalingFactor)
Specify damping factor alpha such that x = x + alpha*P*c, where c is the coarse grid correction...
ReturnType Iterate(const MultiVector &B, MultiVector &X, ConvData conv=ConvData(), bool InitialGuessIsZero=false, LO startLevel=0)
Apply the multigrid preconditioner.
double scalingFactor_
Scaling factor to be applied to coarse grid correction.
Array< RCP< MultiVector > > residual_
void Keep(const std::string &ename, const FactoryBase *factory=NoFactory::get())
Call Level::Keep(ename, factory) for each level of the Hierarchy.
bool isDumpingEnabled_
Graph dumping.
void setlib(Xpetra::UnderlyingLib inlib)
std::string description() const
Return a simple one-line description of this object.
bool Setup(int coarseLevelID, const RCP< const FactoryManagerBase > fineLevelManager, const RCP< const FactoryManagerBase > coarseLevelManager, const RCP< const FactoryManagerBase > nextLevelManager=Teuchos::null)
Multi-level setup phase: build a new level of the hierarchy.
Array< RCP< MultiVector > > coarseX_
Array< RCP< MultiVector > > correction_
void EnableGraphDumping(const std::string &filename, int levelID=1)
Provides methods to build a multigrid hierarchy and apply multigrid cycles.
Array< RCP< const FactoryManagerBase > > levelManagers_
Level managers used during the Setup.
Xpetra::global_size_t maxCoarseSize_