MueLu Version of the Day
Loading...
Searching...
No Matches
MueLu::ReplicatePFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node > Class Template Reference

Prolongator factory that replicates 'Psubblock' matrix to create new prolongator suitable for PDE systems. More...

#include <MueLu_ReplicatePFactory_decl.hpp>

Inheritance diagram for MueLu::ReplicatePFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >:
MueLu::PFactory MueLu::TwoLevelFactoryBase MueLu::Factory MueLu::FactoryBase MueLu::FactoryAcceptor MueLu::ParameterListAcceptorImpl MueLu::BaseClass MueLu::ParameterListAcceptor MueLu::VerboseObject MueLu::Describable

Friends

class MueLuTests::ReplicatePFactoryTester< Scalar, LocalOrdinal, GlobalOrdinal, Node >
 

Build methods.

int numPDEs_
 
void Build (Level &fineLevel, Level &coarseLevel) const
 Build an object with this factory.
 
void BuildP (Level &fineLevel, Level &coarseLevel) const
 Abstract Build method.
 

Constructors/Destructors.

 ReplicatePFactory ()
 Constructor.
 
virtual ~ReplicatePFactory ()
 Destructor.
 
RCP< const ParameterList > GetValidParameterList () const
 Return a const parameter list of valid parameters that setParameterList() will accept.
 
void DeclareInput (Level &fineLevel, Level &coarseLevel) const
 Input.
 

Additional Inherited Members

- Public Member Functions inherited from MueLu::PFactory
 PFactory ()
 Constructor.
 
virtual ~PFactory ()
 Destructor.
 
void setRestrictionMode (bool bRestrictionMode=false)
 
bool isRestrictionModeSet ()
 returns restrictionMode flag
 
- Public Member Functions inherited from MueLu::TwoLevelFactoryBase
 TwoLevelFactoryBase ()
 Constructor.
 
virtual ~TwoLevelFactoryBase ()
 Destructor.
 
virtual void CallDeclareInput (Level &requestedLevel) const
 
virtual void CallBuild (Level &requestedLevel) const
 
- Public Member Functions inherited from MueLu::Factory
 Factory ()
 Constructor.
 
virtual ~Factory ()
 Destructor.
 
virtual void SetFactory (const std::string &varName, const RCP< const FactoryBase > &factory)
 Configuration.
 
const RCP< const FactoryBaseGetFactory (const std::string &varName) const
 Default implementation of FactoryAcceptor::GetFactory()
 
RCP< ParameterList > RemoveFactoriesFromList (const ParameterList &list) const
 
void EnableMultipleCallCheck () const
 
void DisableMultipleCallCheck () const
 
void ResetDebugData () const
 
- Public Member Functions inherited from MueLu::FactoryBase
 FactoryBase ()
 Constructor.
 
virtual ~FactoryBase ()
 Destructor.
 
int GetID () const
 return unique factory id
 
- Public Member Functions inherited from MueLu::BaseClass
virtual ~BaseClass ()
 Destructor.
 
- Public Member Functions inherited from MueLu::VerboseObject
 VerboseObject ()
 
virtual ~VerboseObject ()
 Destructor.
 
VerbLevel GetVerbLevel () const
 Get the verbosity level.
 
void SetVerbLevel (const VerbLevel verbLevel)
 Set the verbosity level of this object.
 
int GetProcRankVerbose () const
 Get proc rank used for printing. Do not use this information for any other purpose.
 
int SetProcRankVerbose (int procRank) const
 Set proc rank used for printing.
 
bool IsPrint (MsgType type, int thisProcRankOnly=-1) const
 Find out whether we need to print out information for a specific message type.
 
Teuchos::FancyOStream & GetOStream (MsgType type, int thisProcRankOnly=0) const
 Get an output stream for outputting the input message type.
 
Teuchos::FancyOStream & GetBlackHole () const
 
- Public Member Functions inherited from MueLu::Describable
virtual ~Describable ()
 Destructor.
 
virtual void describe (Teuchos::FancyOStream &out_arg, const VerbLevel verbLevel=Default) const
 
virtual std::string description () const
 Return a simple one-line description of this object.
 
void describe (Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel=Teuchos::Describable::verbLevel_default) const
 Print the object with some verbosity level to an FancyOStream object.
 
virtual std::string ShortClassName () const
 Return the class name of the object, without template parameters and without namespace.
 
- Public Member Functions inherited from MueLu::FactoryAcceptor
virtual ~FactoryAcceptor ()
 
- Public Member Functions inherited from MueLu::ParameterListAcceptorImpl
 ParameterListAcceptorImpl ()
 
virtual ~ParameterListAcceptorImpl ()=default
 
virtual void SetParameterList (const Teuchos::ParameterList &paramList)
 Set parameters from a parameter list and return with default values.
 
virtual const Teuchos::ParameterList & GetParameterList () const
 
void SetParameter (const std::string &name, const ParameterEntry &entry)
 Set a parameter directly as a ParameterEntry.
 
const ParameterEntry & GetParameter (const std::string &name) const
 Retrieves a const entry with the name name.
 
virtual void GetDocumentation (std::ostream &os) const
 
- Public Member Functions inherited from MueLu::ParameterListAcceptor
 ParameterListAcceptor ()
 
virtual ~ParameterListAcceptor ()=default
 
- Static Public Member Functions inherited from MueLu::Factory
static void EnableTimerSync ()
 
static void DisableTimerSync ()
 
static void EnableMultipleCheckGlobally ()
 
static void DisableMultipleCheckGlobally ()
 
- Static Public Member Functions inherited from MueLu::VerboseObject
static void SetDefaultVerbLevel (const VerbLevel defaultVerbLevel)
 Set the default (global) verbosity level.
 
static VerbLevel GetDefaultVerbLevel ()
 Get the default (global) verbosity level.
 
static void SetMueLuOStream (const Teuchos::RCP< Teuchos::FancyOStream > &mueluOStream)
 
static void SetMueLuOFileStream (const std::string &filename)
 
static Teuchos::RCP< Teuchos::FancyOStream > GetMueLuOStream ()
 
- Protected Member Functions inherited from MueLu::Factory
void Input (Level &level, const std::string &varName) const
 
void Input (Level &level, const std::string &varName, const std::string &varParamName) const
 
template<class T >
Get (Level &level, const std::string &varName) const
 
template<class T >
Get (Level &level, const std::string &varName, const std::string &varParamName) const
 
template<class T >
void Set (Level &level, const std::string &varName, const T &data) const
 
bool IsAvailable (Level &level, const std::string &varName) const
 
- Protected Attributes inherited from MueLu::PFactory
bool restrictionMode_
 
- Static Protected Attributes inherited from MueLu::Factory
static bool timerSync_ = false
 

Detailed Description

template<class Scalar = DefaultScalar, class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
class MueLu::ReplicatePFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >

Prolongator factory that replicates 'Psubblock' matrix to create new prolongator suitable for PDE systems.

Takes a previously generated prolongator for a scalar PDE and effectively makes a block diagonal prolongator by replicating it "replicate: 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 scalar PDE to generate a hierarchy. Then use something like

MueLu::HierarchyUtils<SC,LO,GO,NO>::CopyBetweenHierarchies(*scalarHierarchy,*systemHierarchy, "P", "Psubblock", "RCP<Matrix>");

to copy it to the new hierarchy. This new hierarchy would then have <Parameter name="multigrid algorithm" type="string" value="replicate"> in its parameter list to then invoke RepliatePFactory. Currently, this is used in src/Operators/MueLu_Maxwell1_def.hpp with an example in test/maxwell.

Input/output of ReplicatePFactory

User parameters of SemiCoarsenPFactory

Parameter type default master.xml validated requested description
replicate: npdes int 1 * * Specifies the number of Psubblock copies to make
Psubblock Matrix Matrix that will be replicated

The * in the master.xml column denotes that the parameter is defined in the master.xml file.
The * in the validated column means that the parameter is declared in the list of valid input parameters (see ReplicateCoarsenPFactory::GetValidParameters).
The * in the requested column states that the data is requested as input with all dependencies (see ReplicateCoarsenPFactory::DeclareInput).

Variables provided by ReplicatePFactory

After ReplicatePFactory::Build the following data is available (if requested)

Parameter generated by description
P ReplicatePFactory Prolongator

Definition at line 112 of file MueLu_ReplicatePFactory_decl.hpp.

Constructor & Destructor Documentation

◆ ReplicatePFactory()

template<class Scalar = DefaultScalar, class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
MueLu::ReplicatePFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::ReplicatePFactory ( )
inline

Constructor.

Definition at line 124 of file MueLu_ReplicatePFactory_decl.hpp.

◆ ~ReplicatePFactory()

template<class Scalar = DefaultScalar, class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
virtual MueLu::ReplicatePFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::~ReplicatePFactory ( )
inlinevirtual

Destructor.

Definition at line 127 of file MueLu_ReplicatePFactory_decl.hpp.

Member Function Documentation

◆ GetValidParameterList()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
RCP< const ParameterList > MueLu::ReplicatePFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::GetValidParameterList ( ) const
virtual

Return a const parameter list of valid parameters that setParameterList() will accept.

Also define the default values of parameters according to the input parameter list.

Reimplemented from MueLu::Factory.

Definition at line 76 of file MueLu_ReplicatePFactory_def.hpp.

◆ DeclareInput()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
void MueLu::ReplicatePFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::DeclareInput ( Level & fineLevel,
Level & coarseLevel ) const
virtual

Input.

Implements MueLu::TwoLevelFactoryBase.

Definition at line 84 of file MueLu_ReplicatePFactory_def.hpp.

◆ Build()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
void MueLu::ReplicatePFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::Build ( Level & fineLevel,
Level & coarseLevel ) const
virtual

Build an object with this factory.

Implements MueLu::TwoLevelFactoryBase.

Definition at line 90 of file MueLu_ReplicatePFactory_def.hpp.

◆ BuildP()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
void MueLu::ReplicatePFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::BuildP ( Level & fineLevel,
Level & coarseLevel ) const
virtual

Abstract Build method.

Implements MueLu::PFactory.

Definition at line 96 of file MueLu_ReplicatePFactory_def.hpp.

Friends And Related Symbol Documentation

◆ MueLuTests::ReplicatePFactoryTester< Scalar, LocalOrdinal, GlobalOrdinal, Node >

template<class Scalar = DefaultScalar, class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
friend class MueLuTests::ReplicatePFactoryTester< Scalar, LocalOrdinal, GlobalOrdinal, Node >
friend

Definition at line 1 of file MueLu_ReplicatePFactory_decl.hpp.

Member Data Documentation

◆ numPDEs_

template<class Scalar = DefaultScalar, class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
int MueLu::ReplicatePFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::numPDEs_
private

Definition at line 149 of file MueLu_ReplicatePFactory_decl.hpp.


The documentation for this class was generated from the following files: