MueLu  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
MueLu::BlockedPFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node > Class Template Reference

Factory for building blocked, segregated prolongation operators. More...

#include <MueLu_BlockedPFactory_decl.hpp>

Inheritance diagram for MueLu::BlockedPFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >:
MueLu::PFactory MueLu::TwoLevelFactoryBase MueLu::Factory MueLu::FactoryBase MueLu::FactoryAcceptor MueLu::ParameterListAcceptorImpl MueLu::BaseClass MueLu::ParameterListAcceptor MueLu::VerboseObject MueLu::Describable Teuchos::VerboseObject< VerboseObject > Teuchos::Describable Teuchos::VerboseObjectBase Teuchos::LabeledObject

Private Member Functions

bool areGidsUnique (const std::vector< GO > &X) const
 

Private Attributes

std::vector< Teuchos::RCP
< const FactoryManagerBase > > 
FactManager_
 Input factories. More...
 
std::string diagonalView_
 Factory parameters. More...
 

Constructors/Destructors.

 BlockedPFactory ()
 Constructor. User can supply a factory for generating the tentative prolongator. More...
 
virtual ~BlockedPFactory ()
 Destructor. More...
 
RCP< const ParameterListGetValidParameterList () const
 Return a const parameter list of valid parameters that setParameterList() will accept. More...
 

Set methods.

void SetDiagonalView (std::string const &diagView)
 Change view of diagonal. More...
 
void AddFactoryManager (RCP< const FactoryManagerBase > FactManager)
 Add a factory manager. More...
 

Get methods.

std::string GetDiagonalView ()
 Returns current view of diagonal. 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...
 

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::FancyOStreamGetOStream (MsgType type, int thisProcRankOnly=0) const
 Get an output stream for outputting the input message type. More...
 
Teuchos::FancyOStreamGetBlackHole () 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 VerboseObjectsetVerbLevel (const EVerbosityLevel verbLevel) const
 
virtual const VerboseObjectsetOverridingVerbLevel (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 VerboseObjectBasesetOStream (const RCP< FancyOStream > &oStream) const
 
virtual const VerboseObjectBasesetOverridingOStream (const RCP< FancyOStream > &oStream) const
 
virtual VerboseObjectBasesetLinePrefix (const std::string &linePrefix)
 
virtual RCP< FancyOStreamgetOStream () const
 
virtual RCP< FancyOStreamgetOverridingOStream () 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 &paramList)
 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 ParameterEntryGetParameter (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< FancyOStreamgetDefaultOStream ()
 
- 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_
 

Detailed Description

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

Factory for building blocked, segregated prolongation operators.

Factory for building blocked, segregated prolongation operators of the form \( P=\diag(P_{11},P_{22},\ldots)\), where \( P_{ii}\) are prolongation operators for the corresponding subblocks \(i\) in the blocked operator \( A \)

Parameters
RCP<FactoryBase>AFact = Teuchos::null: factory for generating blocked operator \( A\).

The blocked operator \( A \) is need for accessing the underlaying blocked maps (MapExtractors). Use the AddFactoryManager function to define block rows in the blocked operator. For each block row you have to define a special factory manager that handles the prolongation and restriction operator for the corresponding blocks. The SubBlockAFactory class provides a factory interface for accessing specific blocks in the blocked operator A

// define SubBlockAFactory objects for accessing the diagonal blocks in the blocked operator A
RCP<SubBlockAFactory> A11Fact = Teuchos::rcp(new SubBlockAFactory(MueLu::NoFactory::getRCP(), 0, 0));
RCP<SubBlockAFactory> A22Fact = Teuchos::rcp(new SubBlockAFactory(MueLu::NoFactory::getRCP(), 1, 1));
// define transfer operators for first block row
RCP<TentativePFactory> P11Fact = rcp(new TentativePFactory());
RCP<TransPFactory> R11Fact = rcp(new TransPFactory(P11Fact));
// define transfer operators for second block row
RCP<TentativePFactory> P22TentFact = rcp(new TentativePFactory());
RCP<PgPFactory> P22Fact = rcp(new PgPFactory(P22TentFact));
RCP<GenericRFactory> R22Fact = rcp(new GenericRFactory(P22Fact));
// setup facatory managers for first and second block row
RCP<FactoryManager> M11 = rcp(new FactoryManager());
M11->SetFactory("A", A11Fact);
M11->SetFactory("P", P11Fact);
M11->SetFactory("R", R11Fact);
RCP<FactoryManager> M22 = rcp(new FactoryManager());
M22->SetFactory("A", A22Fact);
M22->SetFactory("P", P22Fact);
M22->SetFactory("R", R22Fact);
// setup blocked transfer operator
// use Teuchos::null as AFactory -> standard "A" variable (in this case the blocked operator A)
RCP<BlockedPFactory> PFact = rcp(new BlockedPFactory());
PFact->SetFactory("A",Teuchos::null); // not necessary (use blocked operator A)
PFact->AddFactoryManager(M11); // add factory manager for first block row
PFact->AddFactoryManager(M22); // add factory manager for second block row
// define restriction operator
// Note: always use GenericRFactory here.
// The simple TransPFactory class cannot handle blocked operators, yet.
RCP<GenericRFactory> RFact = rcp(new GenericRFactory(PFact));
// RAP factory
RCP<RAPFactory> AcFact = rcp(new RAPFactory(PFact, RFact));

Definition at line 125 of file MueLu_BlockedPFactory_decl.hpp.

Constructor & Destructor Documentation

template<class Scalar = DefaultScalar, class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
MueLu::BlockedPFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::BlockedPFactory ( )
inline

Constructor. User can supply a factory for generating the tentative prolongator.

Definition at line 136 of file MueLu_BlockedPFactory_decl.hpp.

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

Destructor.

Definition at line 139 of file MueLu_BlockedPFactory_decl.hpp.

Member Function Documentation

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
RCP< const ParameterList > MueLu::BlockedPFactory< 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.

Implements MueLu::ParameterListAcceptor.

Definition at line 74 of file MueLu_BlockedPFactory_def.hpp.

template<class Scalar = DefaultScalar, class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
void MueLu::BlockedPFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::SetDiagonalView ( std::string const &  diagView)
inline

Change view of diagonal.

Definition at line 149 of file MueLu_BlockedPFactory_decl.hpp.

template<class Scalar = DefaultScalar, class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
void MueLu::BlockedPFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::AddFactoryManager ( RCP< const FactoryManagerBase FactManager)
inline

Add a factory manager.

Definition at line 152 of file MueLu_BlockedPFactory_decl.hpp.

template<class Scalar = DefaultScalar, class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
std::string MueLu::BlockedPFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::GetDiagonalView ( )
inline

Returns current view of diagonal.

Definition at line 160 of file MueLu_BlockedPFactory_decl.hpp.

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
void MueLu::BlockedPFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::DeclareInput ( Level fineLevel,
Level coarseLevel 
) const
virtual

Input.

Implements MueLu::TwoLevelFactoryBase.

Definition at line 84 of file MueLu_BlockedPFactory_def.hpp.

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

Build method.

Builds smoothed aggregation prolongator and returns it in coarseLevel.

Implements MueLu::TwoLevelFactoryBase.

Definition at line 110 of file MueLu_BlockedPFactory_def.hpp.

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
void MueLu::BlockedPFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::BuildP ( Level fineLevel,
Level coarseLevel 
) const
virtual

Abstract Build method.

Implements MueLu::PFactory.

Definition at line 106 of file MueLu_BlockedPFactory_def.hpp.

template<class Scalar = DefaultScalar, class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
bool MueLu::BlockedPFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::areGidsUnique ( const std::vector< GO > &  X) const
inlineprivate

Definition at line 185 of file MueLu_BlockedPFactory_decl.hpp.

Member Data Documentation

template<class Scalar = DefaultScalar, class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
std::vector<Teuchos::RCP<const FactoryManagerBase> > MueLu::BlockedPFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::FactManager_
private

Input factories.

Definition at line 191 of file MueLu_BlockedPFactory_decl.hpp.

template<class Scalar = DefaultScalar, class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
std::string MueLu::BlockedPFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::diagonalView_
private

Factory parameters.

Definition at line 195 of file MueLu_BlockedPFactory_decl.hpp.


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