MueLu Version of the Day
|
Class for transferring a vector of local ordinals from a finer level to a coarser one, where each aggregate has a unique one. More...
#include <MueLu_LocalOrdinalTransferFactory_decl.hpp>
Build methods. | |
bool | useAggregatesMode_ |
Use aggregates mode (as opposed to FC mode) | |
std::string | TransferVecName_ |
The name for the vector to be transfered. This allows us to have multiple factories for different variables. | |
void | Build (Level &fineLevel, Level &coarseLevel) const |
Build an object with this factory. | |
void | BuildAggregates (Level &fineLevel, Level &coarseLevel) const |
void | BuildFC (Level &fineLevel, Level &coarseLevel) const |
Constructors/Destructors. | |
LocalOrdinalTransferFactory ()=delete | |
LocalOrdinalTransferFactory (const std::string &TransferVecName, const std::string &mode) | |
Constructor. | |
virtual | ~LocalOrdinalTransferFactory () |
Destructor. | |
RCP< const ParameterList > | GetValidParameterList () const |
Return a const parameter list of valid parameters that setParameterList() will accept. | |
Input | |
void | DeclareInput (Level &finelevel, Level &coarseLevel) const |
Specifies the data that this class needs, and the factories that generate that data. | |
Additional Inherited Members | |
![]() | |
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 |
![]() | |
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 |
Class for transferring a vector of local ordinals from a finer level to a coarser one, where each aggregate has a unique one.
Parameter | type | default | master.xml | validated | requested | description |
---|---|---|---|---|---|---|
TransferVec | Factory | null | * | (*) | Factory providing vector to be transered | |
Aggregates | Factory | null | * | (*) | Factory providing aggregates | |
CoarseMap | Factory | null | * | (*) | Generating factory of the coarse map | |
write start | int | -1 | * | first level at which coordinates should be written to file | ||
write end | int | -1 | * | last level at which coordinates should be written to file |
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 LocalOrdinalTransferFactory::GetValidParameters).
The * in the requested
column states that the data is requested as input with all dependencies (see LocalOrdinalTransferFactory::DeclareInput).
The LocalOrdinalTransferFact first checks whether there is already valid coarse TransferVec information available on the coarse level. If that is the case, we can skip the coarse TransferVec generation and just reuse the available information. Otherwise we try to build coarse grid TransverVec by using the information about the aggregates, the fine level TransferVec and the coarse map information.
After LocalOrdinalTransferFactory::Build the following data is available (if requested)
Parameter | generated by | description |
---|---|---|
TransferVec | LocalOrdinalTransferFactory | coarse level transfervec |
Definition at line 101 of file MueLu_LocalOrdinalTransferFactory_decl.hpp.
|
delete |
|
inline |
Constructor.
vectorName | The name of the quantity to be restricted. |
restrictionName | The name of the restriction Matrix. |
The operator associated with projectionName
will be applied to the MultiVector associated with vectorName
.
Definition at line 120 of file MueLu_LocalOrdinalTransferFactory_decl.hpp.
|
inlinevirtual |
Destructor.
Definition at line 126 of file MueLu_LocalOrdinalTransferFactory_decl.hpp.
|
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 66 of file MueLu_LocalOrdinalTransferFactory_def.hpp.
|
virtual |
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 78 of file MueLu_LocalOrdinalTransferFactory_def.hpp.
|
virtual |
Build an object with this factory.
Implements MueLu::TwoLevelFactoryBase.
Definition at line 97 of file MueLu_LocalOrdinalTransferFactory_def.hpp.
|
private |
Definition at line 188 of file MueLu_LocalOrdinalTransferFactory_def.hpp.
|
private |
Definition at line 103 of file MueLu_LocalOrdinalTransferFactory_def.hpp.
|
private |
Use aggregates mode (as opposed to FC mode)
Definition at line 159 of file MueLu_LocalOrdinalTransferFactory_decl.hpp.
|
private |
The name for the vector to be transfered. This allows us to have multiple factories for different variables.
Definition at line 162 of file MueLu_LocalOrdinalTransferFactory_decl.hpp.