|
MueLu
Version of the Day
|
|
MueLu
Version of the Day
|
Factory for building Smoothed Aggregation prolongators.
#include <MueLu_SaPFactory_decl.hpp>
Public Types | |
| typedef LocalOrdinal | local_ordinal_type |
| typedef GlobalOrdinal | global_ordinal_type |
| typedef Node::execution_space | execution_space |
| typedef Node | node_type |
Constructors/Destructors. | |
| SaPFactory () | |
| Constructor. User can supply a factory for generating the tentative prolongator. More... | |
| virtual | ~SaPFactory () |
| 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 &fineLevel, Level &coarseLevel) const |
| Abstract Build method. More... | |
| void | SatisfyPConstraintsNonKokkos (RCP< Matrix > A, RCP< Matrix > &P) const |
| void | optimalSatisfyPConstraintsForScalarPDEsNonKokkos (RCP< Matrix > &P) const |
| void | SatisfyPConstraints (RCP< Matrix > A, RCP< Matrix > &P) const |
| void | optimalSatisfyPConstraintsForScalarPDEs (RCP< Matrix > &P) const |
| bool | constrainRow (Scalar *orig, LocalOrdinal nEntries, Scalar leftBound, Scalar rghtBound, Scalar rsumTarget, Scalar *fixedUnsorted, Scalar *scalarData) 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 |
| void | DisableMultipleCallCheck () const |
| void | ResetDebugData () const |
| Factory () | |
| Constructor. More... | |
| virtual | ~Factory () |
| Destructor. More... | |
| virtual void | SetFactory (const std::string &varName, const RCP< const FactoryBase > &factory) |
| Configuration. More... | |
| const RCP< const FactoryBase > | GetFactory (const std::string &varName) const |
| Default implementation of FactoryAcceptor::GetFactory() More... | |
| RCP< ParameterList > | RemoveFactoriesFromList (const ParameterList &list) 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 () |
| 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 | EnableTimerSync () |
| static void | DisableTimerSync () |
| 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 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 > | |
| 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 |
| template<class T > | |
| bool | IsType (Level &level, const std::string &varName) const |
| bool | IsAvailable (Level &level, const std::string &varName) const |
| 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_ |
| Static Protected Attributes inherited from MueLu::Factory | |
| static bool | timerSync_ = false |
Factory for building Smoothed Aggregation prolongators.
| Parameter | type | default | master.xml | validated | requested | description |
|---|---|---|---|---|---|---|
| sa: damping factor | double | 1.33 | * | * | Damping factor for smoothed aggregation transfer operators | |
| sa: calculate eigenvalue estimate | bool | false | * | * | Force calculation of eigenvalue estimate during prolongator smoothing | |
| sa: eigenvalue estimate num iterations | int | 10 | * | * | Number of power iterations to estimate max eigenvalue | |
| A | Factory | null | * | * | Generating factory of the matrix A used during the prolongator smoothing process | |
| P | Factory | null | * | * | Tentative prolongator factory (should be a TentativePFactory object). Note that if "P" is not provided the FactoryManager tries the factory which is generating the variable "Ptent" as input for "P". In the standard case using the default settings this is the non-smoothed tentative prolongation operator. |
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 SaPFactory::GetValidParameters).
The * in the requested column states that the data is requested as input with all dependencies (see SaPFactory::DeclareInput).
After SaPFactory::Build the following data is available (if requested)
| Parameter | generated by | description |
|---|---|---|
| P | SaPFactory | Smoothed prolongator |
Definition at line 62 of file MueLu_SaPFactory_decl.hpp.
| typedef LocalOrdinal MueLu::SaPFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::local_ordinal_type |
Definition at line 64 of file MueLu_SaPFactory_decl.hpp.
| typedef GlobalOrdinal MueLu::SaPFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::global_ordinal_type |
Definition at line 65 of file MueLu_SaPFactory_decl.hpp.
| typedef Node::execution_space MueLu::SaPFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::execution_space |
Definition at line 66 of file MueLu_SaPFactory_decl.hpp.
| typedef Node MueLu::SaPFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::node_type |
Definition at line 67 of file MueLu_SaPFactory_decl.hpp.
|
default |
Constructor. User can supply a factory for generating the tentative prolongator.
|
virtualdefault |
Destructor.
|
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 38 of file MueLu_SaPFactory_def.hpp.
|
virtual |
Input.
Implements MueLu::TwoLevelFactoryBase.
Definition at line 68 of file MueLu_SaPFactory_def.hpp.
|
virtual |
Build method.
Builds smoothed aggregation prolongator and returns it in <tt>coarseLevel</tt>.
FIXME what does the return code mean (unclear in MueMat)?
Implements MueLu::TwoLevelFactoryBase.
Definition at line 81 of file MueLu_SaPFactory_def.hpp.
|
virtual |
Abstract Build method.
Implements MueLu::PFactory.
Definition at line 86 of file MueLu_SaPFactory_def.hpp.
| void MueLu::SaPFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::SatisfyPConstraintsNonKokkos | ( | RCP< Matrix > | A, |
| RCP< Matrix > & | P | ||
| ) | const |
Definition at line 295 of file MueLu_SaPFactory_def.hpp.
| void MueLu::SaPFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::optimalSatisfyPConstraintsForScalarPDEsNonKokkos | ( | RCP< Matrix > & | P | ) | const |
Definition at line 370 of file MueLu_SaPFactory_def.hpp.
| void MueLu::SaPFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::SatisfyPConstraints | ( | RCP< Matrix > | A, |
| RCP< Matrix > & | P | ||
| ) | const |
Definition at line 984 of file MueLu_SaPFactory_def.hpp.
| void MueLu::SaPFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::optimalSatisfyPConstraintsForScalarPDEs | ( | RCP< Matrix > & | P | ) | const |
Definition at line 996 of file MueLu_SaPFactory_def.hpp.
| bool MueLu::SaPFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::constrainRow | ( | Scalar * | orig, |
| LocalOrdinal | nEntries, | ||
| Scalar | leftBound, | ||
| Scalar | rghtBound, | ||
| Scalar | rsumTarget, | ||
| Scalar * | fixedUnsorted, | ||
| Scalar * | scalarData | ||
| ) | const |
Definition at line 404 of file MueLu_SaPFactory_def.hpp.
1.8.5 
