// @HEADER // ***************************************************************************** // MueLu: A package for multigrid based preconditioning // // Copyright 2012 NTESS and the MueLu contributors. // SPDX-License-Identifier: BSD-3-Clause // ***************************************************************************** // @HEADER #ifndef MUELU_COMBINEPFACTORY_DECL_HPP #define MUELU_COMBINEPFACTORY_DECL_HPP #include #include #include #include "MueLu_ConfigDefs.hpp" #include "MueLu_PFactory.hpp" #include "MueLu_CombinePFactory_fwd.hpp" #include "MueLu_Level_fwd.hpp" namespace MueLuTests { // Forward declaration of friend tester class used to UnitTest CombinePFactory template class CombinePFactoryTester; } // namespace MueLuTests namespace MueLu { /*! @class CombinePFactory @ingroup MueLuTransferClasses @brief Prolongator factory that replicates 'Psubblock' matrix to create new prolongator suitable for PDE systems Takes a set of previously generated prolongators each for a subsystem multiphysics PDE and effectively makes a block diagonal prolongator by combining the "combo: npdes" times so that it can be used with a PDE system. A normal use case would be to run an existing MueLu multigrid algorithm on a set of scalar PDEs to generate a hierarchy. Then use something like MueLu::HierarchyUtils::CopyBetweenHierarchies(*scalarHierarchy0,*systemHierarchy, "P", "Psubblock0", "RCP"); . . . . . . MueLu::HierarchyUtils::CopyBetweenHierarchies(*scalarHierarchy7,*systemHierarchy, "P", "Psubblock6", "RCP"); to copy them to a new hierarchy. This new hierarchy would then have in its parameter list to then invoke ComboPFactory. Currently, this is used in src/Operators/MueLu_Multiphysics_def.hpp with an example in test/multiphysics. The end result is a block diagonal matrix corresponding to [Psubblock0 ] [ Psubblock1 ] [ Psubblock2 ] P = [ Psubblock3 ] [ Psubblock4 ] [ Psubblock5 ] [ Psubblock6] ## Input/output of CombinePFactory ## ### User parameters of SemiCoarsenPFactory ### | Parameter | type | default | master.xml | validated | requested | description | | ------------|---------|-----------|:----------:|:---------:|:---------:|----------------------------------------------------------------------------------| |combo: npdes | int | 1 | * | * | | Specifies the number of Psubblock# matrices to expect | | Psubblock0 | Matrix | | | | | Matrix defining P(0,0) block | | Psubblock1 | Matrix | | | | | Matrix defining P(1,1) block | | . | . | | | | | . | | . | . | | | | | . | | . | . | | | | | . | | Psubblockk | Matrix | | | | | Matrix defining P(k,k) block | The * in the @c master.xml column denotes that the parameter is defined in the @c master.xml file.
The * in the @c validated column means that the parameter is declared in the list of valid input parameters (see CombineCoarsenPFactory::GetValidParameters).
The * in the @c requested column states that the data is requested as input with all dependencies (see CombineCoarsenPFactory::DeclareInput). ### Variables provided by CombinePFactory ### After CombinePFactory::Build the following data is available (if requested) | Parameter | generated by | description |-------------------|--------------------------|------------------------------------------------------------------------------------------------------------------| | P | CombinePFactory | Prolongator | */ template class CombinePFactory : public PFactory { #undef MUELU_COMBINEPFACTORY_SHORT #include "MueLu_UseShortNames.hpp" public: friend class MueLuTests::CombinePFactoryTester; //! @name Constructors/Destructors. //@{ //! Constructor CombinePFactory() {} //! Destructor. virtual ~CombinePFactory() {} //@} RCP GetValidParameterList() const; //! Input //@{ void DeclareInput(Level& fineLevel, Level& coarseLevel) const; //@} //! @name Build methods. //@{ void Build(Level& fineLevel, Level& coarseLevel) const; void BuildP(Level& fineLevel, Level& coarseLevel) const; //@} private: int numPDEs_; }; // class CombinePFactory } // namespace MueLu #define MUELU_COMBINEPFACTORY_SHORT #endif // MUELU_COMBINEPFACTORY_DECL_HPP