MueLu Version of the Day
|
Factory to transfer a map from a fine to a coarse level. More...
#include <MueLu_MapTransferFactory_decl.hpp>
Public Member Functions | |
RCP< const ParameterList > | GetValidParameterList () const override |
Input. | |
void | DeclareInput (Level &fineLevel, Level &coarseLevel) const override |
Input. | |
![]() | |
TwoLevelFactoryBase () | |
Constructor. | |
virtual | ~TwoLevelFactoryBase () |
Destructor. | |
virtual void | CallDeclareInput (Level &requestedLevel) const |
virtual void | CallBuild (Level &requestedLevel) const |
![]() | |
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 |
![]() | |
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 |
![]() | |
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. | |
![]() | |
virtual | ~FactoryAcceptor () |
virtual void | SetFactory (const std::string &varName, const RCP< const FactoryBase > &factory)=0 |
Configuration. | |
virtual const RCP< const FactoryBase > | GetFactory (const std::string &varName) const =0 |
![]() | |
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 |
Build methods. | |
RCP< const FactoryBase > | mapFact_ |
Generating factory of input variable. | |
void | Build (Level &fineLevel, Level &coarseLevel) const override |
Build an object with this factory. | |
int | GetLimitOfProlongatorColumns (const ParameterList &pL) const |
Get the max number of entries per row of P to be considered for map transfer. | |
Additional Inherited Members | |
![]() | |
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 () |
![]() | |
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 |
bool | IsAvailable (Level &level, const std::string &varName) const |
![]() | |
static bool | timerSync_ = false |
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.
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()
).
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.
|
overridevirtual |
Input.
Reimplemented from MueLu::Factory.
Definition at line 63 of file MueLu_MapTransferFactory_def.hpp.
|
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.
|
overridevirtual |
Build an object with this factory.
Implements MueLu::TwoLevelFactoryBase.
Definition at line 107 of file MueLu_MapTransferFactory_def.hpp.
|
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.
[in] | pL | Parameter list with user-given configuration |
Definition at line 178 of file MueLu_MapTransferFactory_def.hpp.
|
mutableprivate |
Generating factory of input variable.
Definition at line 133 of file MueLu_MapTransferFactory_decl.hpp.