MueLu Version of the Day
Loading...
Searching...
No Matches
MueLu::RAPShiftFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node > Class Template Reference

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>

Inheritance diagram for MueLu::RAPShiftFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >:
MueLu::TwoLevelFactoryBase MueLu::Factory MueLu::FactoryBase MueLu::FactoryAcceptor MueLu::ParameterListAcceptorImpl MueLu::BaseClass MueLu::ParameterListAcceptor MueLu::VerboseObject MueLu::Describable

Handling of user-defined transfer factories

bool implicitTranspose_
 If true, the action of the restriction operator action is implicitly defined by the transpose of the prolongator.
 
std::vector< RCP< const FactoryBase > > transferFacts_
 list of user-defined transfer Factories
 
std::vector< Scalarshifts_
 
void SetImplicitTranspose (bool const &implicit)
 Indicate that the restriction operator action should be implicitly defined by the transpose of the prolongator.
 
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.
 
size_t NumTransferFactories () const
 Returns number of transfer factories.
 

Constructors/Destructors.

 RAPShiftFactory ()
 
virtual ~RAPShiftFactory ()
 

Input

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.
 

Build methods.

void Build (Level &fineLevel, Level &coarseLevel) const
 Build an object with this factory.
 

Additional Inherited Members

- Public Member Functions inherited from MueLu::TwoLevelFactoryBase
 TwoLevelFactoryBase ()
 Constructor.
 
virtual ~TwoLevelFactoryBase ()
 Destructor.
 
virtual void CallDeclareInput (Level &requestedLevel) const
 
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 FactoryBaseGetFactory (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
 
- Public Member Functions inherited from MueLu::FactoryBase
 FactoryBase ()
 Constructor.
 
virtual ~FactoryBase ()
 Destructor.
 
int GetID () const
 return unique factory id
 
- Public Member Functions inherited from MueLu::BaseClass
virtual ~BaseClass ()
 Destructor.
 
- Public Member Functions inherited from MueLu::VerboseObject
 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 &paramList)
 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
 
- 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 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 >
Get (Level &level, const std::string &varName) const
 
template<class 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
 
- Static Protected Attributes inherited from MueLu::Factory
static bool timerSync_ = false
 

Detailed Description

template<class Scalar = DefaultScalar, class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
class MueLu::RAPShiftFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >

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 78 of file MueLu_RAPShiftFactory_decl.hpp.

Constructor & Destructor Documentation

◆ RAPShiftFactory()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
MueLu::RAPShiftFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::RAPShiftFactory ( )

Definition at line 68 of file MueLu_RAPShiftFactory_def.hpp.

◆ ~RAPShiftFactory()

template<class Scalar = DefaultScalar, class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
virtual MueLu::RAPShiftFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::~RAPShiftFactory ( )
inlinevirtual

Definition at line 88 of file MueLu_RAPShiftFactory_decl.hpp.

Member Function Documentation

◆ GetValidParameterList()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
RCP< const ParameterList > MueLu::RAPShiftFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::GetValidParameterList ( ) const
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 74 of file MueLu_RAPShiftFactory_def.hpp.

◆ DeclareInput()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
void MueLu::RAPShiftFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::DeclareInput ( Level & fineLevel,
Level & coarseLevel ) const
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 112 of file MueLu_RAPShiftFactory_def.hpp.

◆ Build()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
void MueLu::RAPShiftFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::Build ( Level & fineLevel,
Level & coarseLevel ) const
virtual

Build an object with this factory.

Implements MueLu::TwoLevelFactoryBase.

Definition at line 168 of file MueLu_RAPShiftFactory_def.hpp.

◆ SetImplicitTranspose()

template<class Scalar = DefaultScalar, class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
void MueLu::RAPShiftFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::SetImplicitTranspose ( bool const & implicit)
inline

Indicate that the restriction operator action should be implicitly defined by the transpose of the prolongator.

Definition at line 110 of file MueLu_RAPShiftFactory_decl.hpp.

◆ SetShifts()

template<class Scalar = DefaultScalar, class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
void MueLu::RAPShiftFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::SetShifts ( std::vector< Scalar > & shifts)
inline

Definition at line 114 of file MueLu_RAPShiftFactory_decl.hpp.

◆ AddTransferFactory()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
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 391 of file MueLu_RAPShiftFactory_def.hpp.

◆ NumTransferFactories()

template<class Scalar = DefaultScalar, class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
size_t MueLu::RAPShiftFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::NumTransferFactories ( ) const
inline

Returns number of transfer factories.

Definition at line 132 of file MueLu_RAPShiftFactory_decl.hpp.

Member Data Documentation

◆ implicitTranspose_

template<class Scalar = DefaultScalar, class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
bool MueLu::RAPShiftFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::implicitTranspose_
private

If true, the action of the restriction operator action is implicitly defined by the transpose of the prolongator.

Definition at line 139 of file MueLu_RAPShiftFactory_decl.hpp.

◆ transferFacts_

template<class Scalar = DefaultScalar, class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
std::vector<RCP<const FactoryBase> > MueLu::RAPShiftFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::transferFacts_
private

list of user-defined transfer Factories

Definition at line 143 of file MueLu_RAPShiftFactory_decl.hpp.

◆ shifts_

template<class Scalar = DefaultScalar, class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
std::vector<Scalar> MueLu::RAPShiftFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::shifts_
private

Definition at line 146 of file MueLu_RAPShiftFactory_decl.hpp.


The documentation for this class was generated from the following files: