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

Factory to transfer a map from a fine to a coarse level. More...

#include <MueLu_MapTransferFactory_decl.hpp>

Inheritance diagram for MueLu::MapTransferFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >:
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

int GetLimitOfProlongatorColumns (const ParameterList &pL) const
 Get the max number of entries per row of P to be considered for map transfer. More...
 

Private Attributes

RCP< const FactoryBasemapFact_
 Generating factory of input variable. More...
 
RCP< const ParameterListGetValidParameterList () const override
 Input. More...
 
void DeclareInput (Level &fineLevel, Level &coarseLevel) const override
 Input. More...
 

Build methods.

void Build (Level &fineLevel, Level &coarseLevel) const override
 Build an object with this factory. 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::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
 

Detailed Description

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

Factory to transfer a map from a fine to a coarse level.

Factory that transfers a map (given by a variable name and a generating factory) for building a coarse version of the map. The coarse map is stored on the coarse level using the same variable name and generating factory than the original fine level map.

The transfer is based on the prolongator maps. The prolongator/nullspace can also contain rotational modes, that might not be of interest for the map of interest. Use the option "nullspace vectors: limit to" to exclude such modes.

Input/output

User parameters

Parameter type default master.xml validated requested description
map: name string "" * * Name of the map
map: factory string "null" * * Name of the generating factory
P Factory null * * Generating factory of prolongator
nullspace vectors: limit to string "all" * * Use only these nullspace vectors/columns of P to transfer the map (e.g. to drop rotations)

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 GetValidParameters() ).
The * in the requested column states that the data is requested as input with all dependencies (see DeclareInput() ).

Variables provided by this factory

After Build() , the following data is available (if requested):

Parameter generated by description
map: name MapTransferFactory Coarse version of the input map

Definition at line 94 of file MueLu_MapTransferFactory_decl.hpp.

Member Function Documentation

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
RCP< const ParameterList > MueLu::MapTransferFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::GetValidParameterList ( ) const
overridevirtual

Input.

Implements MueLu::ParameterListAcceptor.

Definition at line 63 of file MueLu_MapTransferFactory_def.hpp.

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

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 76 of file MueLu_MapTransferFactory_def.hpp.

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

Build an object with this factory.

Implements MueLu::TwoLevelFactoryBase.

Definition at line 104 of file MueLu_MapTransferFactory_def.hpp.

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
int MueLu::MapTransferFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::GetLimitOfProlongatorColumns ( const ParameterList pL) const
private

Get the max number of entries per row of P to be considered for map transfer.

To exclude some nullspace vectors (e.g. rotations in 2D or 3D elasticity), when doing the map transfer, this routine translates the user wish to a maximal number of entries per row of P to be considered during the map transfer.

Warning
Rows of P are looped from left to right, so we rely on the usual ordering of the nullspace vectors (translations in x/y/z, then rotations around x,y,z).
Parameters
[in]pLParameter list with user-given configuration
Returns
Number of entries per row of the prolongator to be used for the map transfer

Definition at line 172 of file MueLu_MapTransferFactory_def.hpp.

Member Data Documentation

template<class Scalar = DefaultScalar, class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
RCP<const FactoryBase> MueLu::MapTransferFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::mapFact_
mutableprivate

Generating factory of input variable.

Definition at line 131 of file MueLu_MapTransferFactory_decl.hpp.


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