MueLu Version of the Day
|
Prolongator factory that replicates 'Psubblock' matrix to create new prolongator suitable for PDE systems. More...
#include <MueLu_ReplicatePFactory_decl.hpp>
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 | |
![]() | |
PFactory () | |
Constructor. | |
virtual | ~PFactory () |
Destructor. | |
void | setRestrictionMode (bool bRestrictionMode=false) |
bool | isRestrictionModeSet () |
returns restrictionMode flag | |
![]() | |
TwoLevelFactoryBase () | |
Constructor. | |
virtual | ~TwoLevelFactoryBase () |
Destructor. | |
virtual void | CallDeclareInput (Level &requestedLevel) const |
virtual void | CallBuild (Level &requestedLevel) const |
![]() | |
Factory () | |
Constructor. | |
virtual | ~Factory () |
Destructor. | |
virtual void | SetFactory (const std::string &varName, const RCP< const FactoryBase > &factory) |
Configuration. | |
const RCP< const FactoryBase > | GetFactory (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 |
![]() | |
FactoryBase () | |
Constructor. | |
virtual | ~FactoryBase () |
Destructor. | |
int | GetID () const |
return unique factory id | |
![]() | |
virtual | ~BaseClass () |
Destructor. | |
![]() | |
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 |
![]() | |
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. | |
![]() | |
virtual | ~FactoryAcceptor () |
![]() | |
ParameterListAcceptorImpl () | |
virtual | ~ParameterListAcceptorImpl ()=default |
virtual void | SetParameterList (const Teuchos::ParameterList ¶mList) |
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 |
![]() | |
ParameterListAcceptor () | |
virtual | ~ParameterListAcceptor ()=default |
![]() | |
static void | EnableTimerSync () |
static void | DisableTimerSync () |
static void | EnableMultipleCheckGlobally () |
static void | DisableMultipleCheckGlobally () |
![]() | |
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 () |
![]() | |
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 > | |
T | Get (Level &level, const std::string &varName) const |
template<class T > | |
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 |
![]() | |
bool | restrictionMode_ |
![]() | |
static bool | timerSync_ = false |
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.
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).
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.
|
inline |
Constructor.
Definition at line 124 of file MueLu_ReplicatePFactory_decl.hpp.
|
inlinevirtual |
Destructor.
Definition at line 127 of file MueLu_ReplicatePFactory_decl.hpp.
|
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.
|
virtual |
Input.
Implements MueLu::TwoLevelFactoryBase.
Definition at line 84 of file MueLu_ReplicatePFactory_def.hpp.
|
virtual |
Build an object with this factory.
Implements MueLu::TwoLevelFactoryBase.
Definition at line 90 of file MueLu_ReplicatePFactory_def.hpp.
|
virtual |
Abstract Build method.
Implements MueLu::PFactory.
Definition at line 96 of file MueLu_ReplicatePFactory_def.hpp.
|
friend |
Definition at line 1 of file MueLu_ReplicatePFactory_decl.hpp.
|
private |
Definition at line 149 of file MueLu_ReplicatePFactory_decl.hpp.