|
MueLu
Version of the Day
|
|
MueLu
Version of the Day
|
Factory for building coarse grid matrices, when the matrix is of the form K+a*M. Useful when you want to change the shift variable ("a") at every level. Each level must store the stiffness matrix K and mass matrix M separately. More...
#include <MueLu_RAPShiftFactory_decl.hpp>
Private Attributes | |
| bool | implicitTranspose_ |
| If true, the action of the restriction operator action is implicitly defined by the transpose of the prolongator. More... | |
| std::vector< RCP< const FactoryBase > > | transferFacts_ |
| list of user-defined transfer Factories More... | |
| std::vector< Scalar > | shifts_ |
Constructors/Destructors. | |
| RAPShiftFactory () | |
| virtual | ~RAPShiftFactory () |
Input | |
| 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 an object with this factory. More... | |
Handling of user-defined transfer factories | |
| void | SetImplicitTranspose (bool const &implicit) |
| Indicate that the restriction operator action should be implicitly defined by the transpose of the prolongator. More... | |
| void | SetShifts (std::vector< Scalar > &shifts) |
| void | AddTransferFactory (const RCP< const FactoryBase > &factory) |
| Add transfer factory in the end of list of transfer factories in RepartitionAcFactory. More... | |
| size_t | NumTransferFactories () const |
| Returns number of transfer factories. More... | |
Additional Inherited Members | |
 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 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 |
Factory for building coarse grid matrices, when the matrix is of the form K+a*M. Useful when you want to change the shift variable ("a") at every level. Each level must store the stiffness matrix K and mass matrix M separately.
Definition at line 75 of file MueLu_RAPShiftFactory_decl.hpp.
| MueLu::RAPShiftFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::RAPShiftFactory | ( | ) |
Definition at line 68 of file MueLu_RAPShiftFactory_def.hpp.
|
inlinevirtual |
Definition at line 85 of file MueLu_RAPShiftFactory_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 74 of file MueLu_RAPShiftFactory_def.hpp.
|
virtual |
Input.
Specifies the data that this class needs, and the factories that generate that data.
If the Build method of this class requires some data, but the generating factory is not specified in DeclareInput, then this class will fall back to the settings in FactoryManager.
Implements MueLu::TwoLevelFactoryBase.
Definition at line 111 of file MueLu_RAPShiftFactory_def.hpp.
|
virtual |
Build an object with this factory.
Implements MueLu::TwoLevelFactoryBase.
Definition at line 167 of file MueLu_RAPShiftFactory_def.hpp.
|
inline |
Indicate that the restriction operator action should be implicitly defined by the transpose of the prolongator.
Definition at line 107 of file MueLu_RAPShiftFactory_decl.hpp.
|
inline |
Definition at line 111 of file MueLu_RAPShiftFactory_decl.hpp.
| void MueLu::RAPShiftFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::AddTransferFactory | ( | const RCP< const FactoryBase > & | factory | ) |
Add transfer factory in the end of list of transfer factories in RepartitionAcFactory.
Transfer factories are derived from TwoLevelFactoryBase and project some data from the fine level to the next coarser level.
Definition at line 385 of file MueLu_RAPShiftFactory_def.hpp.
|
inline |
Returns number of transfer factories.
Definition at line 129 of file MueLu_RAPShiftFactory_decl.hpp.
|
private |
If true, the action of the restriction operator action is implicitly defined by the transpose of the prolongator.
Definition at line 136 of file MueLu_RAPShiftFactory_decl.hpp.
|
private |
list of user-defined transfer Factories
Definition at line 140 of file MueLu_RAPShiftFactory_decl.hpp.
|
private |
Definition at line 143 of file MueLu_RAPShiftFactory_decl.hpp.
1.8.5 
