Factory that provides an interface for a concrete implementation of a prolongation operator. More...
#include <MueLu_PFactory_decl.hpp>
Protected Attributes | |
| bool | restrictionMode_ |
Constructors/Destructors. | |
| PFactory () | |
| Constructor. | |
| virtual | ~PFactory () |
| Destructor. | |
Build methods. | |
| virtual void | BuildP (Level &fineLevel, Level &coarseLevel) const =0 |
| Abstract Build method. | |
Restriction mode | |
| void | setRestrictionMode (bool bRestrictionMode=false) |
| bool | isRestrictionModeSet () |
| returns restrictionMode flag | |
Additional Inherited Members | |
| TwoLevelFactoryBase () | |
| Constructor. | |
| virtual | ~TwoLevelFactoryBase () |
| Destructor. | |
| virtual void | DeclareInput (Level &fineLevel, Level &coarseLevel) const =0 |
| Input. | |
| virtual void | CallDeclareInput (Level &requestedLevel) const |
| virtual void | Build (Level &fineLevel, Level &coarseLevel) const =0 |
| Build an object with this factory. | |
| 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 FactoryBase > | GetFactory (const std::string &varName) const |
| Default implementation of FactoryAcceptor::GetFactory(). | |
| RCP< ParameterList > | RemoveFactoriesFromList (const ParameterList &list) const |
| virtual RCP< const ParameterList > | GetValidParameterList () const |
| Return a const parameter list of valid parameters that setParameterList() will accept. | |
| 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 | |
| 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 |
| 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 ¶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 Public Member Functions inherited from MueLu::Factory | |
| 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 () |
| 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 |
| Static Protected Attributes inherited from MueLu::Factory | |
| static bool | timerSync_ = false |
Detailed Description
Factory that provides an interface for a concrete implementation of a prolongation operator.
For a concrete implementation the user has to overwrite the virtual Build method.
Definition at line 28 of file MueLu_PFactory_decl.hpp.
Constructor & Destructor Documentation
◆ PFactory()
|
inline |
Constructor.
Definition at line 37 of file MueLu_PFactory_decl.hpp.
◆ ~PFactory()
|
inlinevirtual |
Destructor.
Definition at line 41 of file MueLu_PFactory_decl.hpp.
Member Function Documentation
◆ BuildP()
Abstract Build method.
Implemented in MueLu::BlackBoxPFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::BlockedPFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::ClassicalPFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::CombinePFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::EminPFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::GeneralGeometricPFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::GeoInterpFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::GeometricInterpolationPFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::GeometricInterpolationPFactory_kokkos< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::IntrepidPCoarsenFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::MatrixFreeTentativePFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::PgPFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::ReitzingerPFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::ReplicatePFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::SaPFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::SaPFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::SemiCoarsenPFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::SemiCoarsenPFactory_kokkos< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::TentativePFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::TentativePFactory_kokkos< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::TogglePFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >, MueLu::UnsmooshFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >, and MueLu::UserPFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >.
◆ setRestrictionMode()
|
inline |
switch prolongator factory to restriction mode if set to true, the prolongation factory generates a restriciton operator instead of a prolongation operator
Definition at line 58 of file MueLu_PFactory_decl.hpp.
◆ isRestrictionModeSet()
|
inline |
returns restrictionMode flag
Definition at line 63 of file MueLu_PFactory_decl.hpp.
Member Data Documentation
◆ restrictionMode_
|
protected |
Definition at line 30 of file MueLu_PFactory_decl.hpp.
The documentation for this class was generated from the following file:
