|
MueLu
Version of the Day
|
|
MueLu
Version of the Day
|
Prolongator factory which allows switching between two different prolongator strategies. More...
#include <MueLu_TogglePFactory_decl.hpp>
Private Attributes | |
| std::vector< RCP< const FactoryBase > > | prolongatorFacts_ |
| list of user-defined prolongation operator factories More... | |
| std::vector< RCP< const FactoryBase > > | ptentFacts_ |
| list of user-defined tentative prolongation operator factories More... | |
| std::vector< RCP< const FactoryBase > > | nspFacts_ |
| list of user-defined nullspace factories (i.e. the prolongator factories which also generate the coarse level nullspace) More... | |
| bool | hasDeclaredInput_ |
Constructors/Destructors. | |
| TogglePFactory () | |
| Constructor. More... | |
| virtual | ~TogglePFactory () |
| Destructor. More... | |
| RCP< const ParameterList > | GetValidParameterList () const |
| Return a const parameter list of valid parameters that setParameterList() will accept. More... | |
| void | DeclareInput (Level &fineLevel, Level &coarseLevel) const |
| Input. More... | |
Build methods. | |
| void | Build (Level &fineLevel, Level &coarseLevel) const |
| Build method. More... | |
| void | BuildP (Level &, Level &) const |
| Abstract Build method. More... | |
| void | AddProlongatorFactory (const RCP< const FactoryBase > &factory) |
| Add a prolongator factory in the end of list of prolongator factories. More... | |
| size_t | NumProlongatorFactories () const |
| Returns number of prolongator factories. More... | |
| void | AddPtentFactory (const RCP< const FactoryBase > &factory) |
| Add a tentative prolongator factory in the end of list of prolongator factories. More... | |
| size_t | NumPtentFactories () const |
| Returns number of tentative prolongator factories. More... | |
| void | AddCoarseNullspaceFactory (const RCP< const FactoryBase > &factory) |
| Add a coarse nullspace factory in the end of list of coarse nullspace factories. More... | |
| size_t | NumCoarseNullspaceFactories () const |
| Returns number of coarse null space factories. More... | |
| RCP< const FactoryBase > | getProlongatorFactory (size_t t) const |
Additional Inherited Members | |
 Public Member Functions inherited from MueLu::PFactory | |
| PFactory () | |
| Constructor. More... | |
| virtual | ~PFactory () |
| Destructor. More... | |
| void | setRestrictionMode (bool bRestrictionMode=false) |
| bool | isRestrictionModeSet () |
| returns restrictionMode flag More... | |
| Public Member Functions inherited from MueLu::TwoLevelFactoryBase | |
| TwoLevelFactoryBase () | |
| Constructor. More... | |
| virtual | ~TwoLevelFactoryBase () |
| Destructor. More... | |
| virtual void | CallDeclareInput (Level &requestedLevel) const |
| virtual void | CallBuild (Level &requestedLevel) const |
| Public Member Functions inherited from MueLu::Factory | |
| void | EnableMultipleCallCheck () const |
| Constructor. More... | |
| void | DisableMultipleCallCheck () const |
| void | ResetDebugData () const |
| Public Member Functions inherited from MueLu::FactoryBase | |
| FactoryBase () | |
| Constructor. More... | |
| virtual | ~FactoryBase () |
| Destructor. More... | |
| int | GetID () const |
| return unique factory id More... | |
| Public Member Functions inherited from MueLu::BaseClass | |
| virtual | ~BaseClass () |
| Destructor. More... | |
| Public Member Functions inherited from MueLu::VerboseObject | |
| VerbLevel | GetVerbLevel () const |
| Get the verbosity level. More... | |
| void | SetVerbLevel (const VerbLevel verbLevel) |
| Set the verbosity level of this object. More... | |
| int | GetProcRankVerbose () const |
| Get proc rank used for printing. Do not use this information for any other purpose. More... | |
| int | SetProcRankVerbose (int procRank) const |
| Set proc rank used for printing. More... | |
| bool | IsPrint (MsgType type, int thisProcRankOnly=-1) const |
| Find out whether we need to print out information for a specific message type. More... | |
| Teuchos::FancyOStream & | GetOStream (MsgType type, int thisProcRankOnly=0) const |
| Get an output stream for outputting the input message type. More... | |
| Teuchos::FancyOStream & | GetBlackHole () const |
| VerboseObject () | |
| virtual | ~VerboseObject () |
| Destructor. More... | |
| Public Member Functions inherited from Teuchos::VerboseObject< VerboseObject > | |
| VerboseObject (const EVerbosityLevel verbLevel=VERB_DEFAULT, const RCP< FancyOStream > &oStream=Teuchos::null) | |
| virtual const VerboseObject & | setVerbLevel (const EVerbosityLevel verbLevel) const |
| virtual const VerboseObject & | setOverridingVerbLevel (const EVerbosityLevel verbLevel) const |
| virtual EVerbosityLevel | getVerbLevel () const |
| TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT RCP< const ParameterList > | getValidVerboseObjectSublist () |
| TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT void | setupVerboseObjectSublist (ParameterList *paramList) |
| TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT void | readVerboseObjectSublist (ParameterList *paramList, RCP< FancyOStream > *oStream, EVerbosityLevel *verbLevel) |
| void | readVerboseObjectSublist (ParameterList *paramList, VerboseObject< ObjectType > *verboseObject) |
| Public Member Functions inherited from Teuchos::VerboseObjectBase | |
| virtual | ~VerboseObjectBase () |
| VerboseObjectBase (const RCP< FancyOStream > &oStream=Teuchos::null) | |
| virtual const VerboseObjectBase & | setOStream (const RCP< FancyOStream > &oStream) const |
| virtual const VerboseObjectBase & | setOverridingOStream (const RCP< FancyOStream > &oStream) const |
| virtual VerboseObjectBase & | setLinePrefix (const std::string &linePrefix) |
| virtual RCP< FancyOStream > | getOStream () const |
| virtual RCP< FancyOStream > | getOverridingOStream () const |
| virtual std::string | getLinePrefix () const |
| virtual OSTab | getOSTab (const int tabs=1, const std::string &linePrefix="") const |
| Public Member Functions inherited from MueLu::Describable | |
| virtual | ~Describable () |
| Destructor. More... | |
| virtual std::string | ShortClassName () const |
| Return the class name of the object, without template parameters and without namespace. More... | |
| 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. More... | |
| 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. More... | |
| Public Member Functions inherited from Teuchos::Describable | |
| void | describe (std::ostream &out, const EVerbosityLevel verbLevel=verbLevel_default) const |
| LabeledObject () | |
| virtual | ~LabeledObject () |
| virtual void | setObjectLabel (const std::string &objectLabel) |
| virtual std::string | getObjectLabel () const |
| DescribableStreamManipulatorState | describe (const Describable &describable, const EVerbosityLevel verbLevel=Describable::verbLevel_default) |
| std::ostream & | operator<< (std::ostream &os, const DescribableStreamManipulatorState &d) |
| Public Member Functions inherited from MueLu::FactoryAcceptor | |
| virtual | ~FactoryAcceptor () |
| virtual void | SetFactory (const std::string &varName, const RCP< const FactoryBase > &factory)=0 |
| Configuration. More... | |
| virtual const RCP< const FactoryBase > | GetFactory (const std::string &varName) const =0 |
| Public Member Functions inherited from MueLu::ParameterListAcceptorImpl | |
| ParameterListAcceptorImpl () | |
| virtual | ~ParameterListAcceptorImpl ()=default |
| virtual void | SetParameterList (const Teuchos::ParameterList ¶mList) |
| Set parameters from a parameter list and return with default values. More... | |
| virtual const Teuchos::ParameterList & | GetParameterList () const |
| void | SetParameter (const std::string &name, const ParameterEntry &entry) |
| Set a parameter directly as a ParameterEntry. More... | |
| const ParameterEntry & | GetParameter (const std::string &name) const |
| Retrieves a const entry with the name name. More... | |
| 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 | EnableMultipleCheckGlobally () |
| static void | DisableMultipleCheckGlobally () |
| Static Public Member Functions inherited from MueLu::VerboseObject | |
| static void | SetMueLuOStream (const Teuchos::RCP< Teuchos::FancyOStream > &mueluOStream) |
| static void | SetMueLuOFileStream (const std::string &filename) |
| static Teuchos::RCP < Teuchos::FancyOStream > | GetMueLuOStream () |
| static void | SetDefaultVerbLevel (const VerbLevel defaultVerbLevel) |
| Set the default (global) verbosity level. More... | |
| static VerbLevel | GetDefaultVerbLevel () |
| Get the default (global) verbosity level. More... | |
| Static Public Member Functions inherited from Teuchos::VerboseObject< VerboseObject > | |
| static void | setDefaultVerbLevel (const EVerbosityLevel defaultVerbLevel) |
| static EVerbosityLevel | getDefaultVerbLevel () |
| Static Public Member Functions inherited from Teuchos::VerboseObjectBase | |
| static void | setDefaultOStream (const RCP< FancyOStream > &defaultOStream) |
| static RCP< FancyOStream > | getDefaultOStream () |
| Static Public Attributes inherited from Teuchos::Describable | |
| static const EVerbosityLevel | verbLevel_default |
| Protected Member Functions inherited from Teuchos::VerboseObject< VerboseObject > | |
| void | initializeVerboseObject (const EVerbosityLevel verbLevel=VERB_DEFAULT, const RCP< FancyOStream > &oStream=Teuchos::null) |
| Protected Member Functions inherited from Teuchos::VerboseObjectBase | |
| void | initializeVerboseObjectBase (const RCP< FancyOStream > &oStream=Teuchos::null) |
| virtual void | informUpdatedVerbosityState () const |
| Protected Attributes inherited from MueLu::PFactory | |
| bool | restrictionMode_ |
Prolongator factory which allows switching between two different prolongator strategies.
| Parameter | type | default | master.xml | validated | requested | description |
|---|---|---|---|---|---|---|
| P | Factory | null | * | * | Generating factories of prolongators. Note that the TogglePFactory needs at least two different prolongator subfactories. | |
| Ptent | Factory | null | * | * | Generating factories of base prolongators. Note that the TogglePFactory needs at least two different base prolongator subfactories. Usually, the factory for Ptent is the same as for the coarse null space. | |
| Nullspace | Factory | null | * | * | Generating factories for fine level null space information. Note, that you have to provide a null space information source factory for each prolongator factory. | |
| NumZLayers | Factory | NoFactory | * | * | Factory which provides information about z layers. Usually it is stored with MueLu::NoFactory as generating factory. The data is generated by the SemiCoarsenPFactory. | |
| semicoarsen: number of levels | int | ? | * | * | number of levels which are reserved for semi-coarsening. Note that the TogglePFactory stops the semi-coarsening process either when we have more levels than declared in this parameter or as soon as the number of remaining z-levels is 1. |
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 TogglePFactory::GetValidParameters).
The * in the requested column states that the data is requested as input with all dependencies (see TogglePFactory::DeclareInput).
After TogglePFactory::Build the following data is available (if requested)
| Parameter | generated by | description |
|---|---|---|
| P | TogglePFactory | Prolongator |
| Ptent | TogglePFactory | Base prolongator (e.g. tentative prolongator) |
| Nullspace | TogglePFactory | associated coarse null space |
Definition at line 94 of file MueLu_TogglePFactory_decl.hpp.
|
inline |
Constructor.
Definition at line 103 of file MueLu_TogglePFactory_decl.hpp.
|
inlinevirtual |
Destructor.
Definition at line 107 of file MueLu_TogglePFactory_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.
Implements MueLu::ParameterListAcceptor.
Definition at line 60 of file MueLu_TogglePFactory_def.hpp.
|
virtual |
Input.
Implements MueLu::TwoLevelFactoryBase.
Definition at line 72 of file MueLu_TogglePFactory_def.hpp.
|
virtual |
Build method.
Implements MueLu::TwoLevelFactoryBase.
Definition at line 102 of file MueLu_TogglePFactory_def.hpp.
|
inlinevirtual |
Abstract Build method.
Implements MueLu::PFactory.
Definition at line 126 of file MueLu_TogglePFactory_decl.hpp.
| void MueLu::TogglePFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::AddProlongatorFactory | ( | const RCP< const FactoryBase > & | factory | ) |
Add a prolongator factory in the end of list of prolongator factories.
Definition at line 182 of file MueLu_TogglePFactory_def.hpp.
|
inline |
Returns number of prolongator factories.
Definition at line 135 of file MueLu_TogglePFactory_decl.hpp.
| void MueLu::TogglePFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::AddPtentFactory | ( | const RCP< const FactoryBase > & | factory | ) |
Add a tentative prolongator factory in the end of list of prolongator factories.
Definition at line 192 of file MueLu_TogglePFactory_def.hpp.
|
inline |
Returns number of tentative prolongator factories.
Definition at line 141 of file MueLu_TogglePFactory_decl.hpp.
| void MueLu::TogglePFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::AddCoarseNullspaceFactory | ( | const RCP< const FactoryBase > & | factory | ) |
Add a coarse nullspace factory in the end of list of coarse nullspace factories.
Definition at line 202 of file MueLu_TogglePFactory_def.hpp.
|
inline |
Returns number of coarse null space factories.
Definition at line 147 of file MueLu_TogglePFactory_decl.hpp.
|
inline |
Definition at line 149 of file MueLu_TogglePFactory_decl.hpp.
|
mutableprivate |
list of user-defined prolongation operator factories
Definition at line 153 of file MueLu_TogglePFactory_decl.hpp.
|
mutableprivate |
list of user-defined tentative prolongation operator factories
Definition at line 156 of file MueLu_TogglePFactory_decl.hpp.
|
mutableprivate |
list of user-defined nullspace factories (i.e. the prolongator factories which also generate the coarse level nullspace)
Definition at line 159 of file MueLu_TogglePFactory_decl.hpp.
|
mutableprivate |
Definition at line 161 of file MueLu_TogglePFactory_decl.hpp.
1.8.5 
