MueLu
Version of the Day
|
Class for transferring coordinates from a finer level to a coarser one for BlockedCrsMatrices. This basically combines the Coordinates generated by each separate block. More...
#include <MueLu_BlockedCoordinatesTransferFactory_decl.hpp>
Private Attributes | |
std::vector< RCP< const FactoryBase > > | subFactories_ |
list of user-defined sub Factories More... | |
Constructors/Destructors. | |
BlockedCoordinatesTransferFactory () | |
Constructor. More... | |
virtual | ~BlockedCoordinatesTransferFactory () |
Destructor. More... | |
RCP< const ParameterList > | GetValidParameterList () const |
Return a const parameter list of valid parameters that setParameterList() will accept. More... | |
Input | |
void | DeclareInput (Level &finelevel, Level &coarseLevel) const |
Specifies the data that this class needs, and the factories that generate that data. More... | |
Build methods. | |
void | Build (Level &fineLevel, Level &coarseLevel) const |
Build an object with this factory. More... | |
void | AddFactory (const RCP< const FactoryBase > &factory) |
Add (sub) coords factory in the end of list of factories in BlockedCoordinatesTransferFactory. More... | |
size_t | NumFactories () const |
Returns number of sub factories. 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::FancyOStream & | GetOStream (MsgType type, int thisProcRankOnly=0) const |
Get an output stream for outputting the input message type. More... | |
Teuchos::FancyOStream & | GetBlackHole () 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 VerboseObject & | setVerbLevel (const EVerbosityLevel verbLevel) const |
virtual const VerboseObject & | setOverridingVerbLevel (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 VerboseObjectBase & | setOStream (const RCP< FancyOStream > &oStream) const |
virtual const VerboseObjectBase & | setOverridingOStream (const RCP< FancyOStream > &oStream) const |
virtual VerboseObjectBase & | setLinePrefix (const std::string &linePrefix) |
virtual RCP< FancyOStream > | getOStream () const |
virtual RCP< FancyOStream > | getOverridingOStream () 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 ¶mList) |
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 ParameterEntry & | GetParameter (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 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< FancyOStream > | getDefaultOStream () |
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 |
Class for transferring coordinates from a finer level to a coarser one for BlockedCrsMatrices. This basically combines the Coordinates generated by each separate block.
Parameter | type | default | master.xml | validated | requested | description |
---|---|---|---|---|---|---|
BlockedCoordinates | Factory | null | * | (*) | Factory providing coordinates | |
Aggregates | Factory | null | * | (*) | Factory providing aggregates | |
CoarseMap | Factory | null | * | (*) | Generating factory of the coarse map |
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 BlockedCoordinatesTransferFactory::GetValidParameters).
The * in the requested
column states that the data is requested as input with all dependencies (see BlockedCoordinatesTransferFactory::DeclareInput).
The BlockedCoordinatesTransferFact first checks whether there is already valid coarse coordinates information available on the coarse level. If that is the case, we can skip the coordinate transfer and just reuse the available information. Otherwise we try to build coarse grid coordinates by using the information from the sub-factories.
After BlockedCoordinatesTransferFactory::Build the following data is available (if requested)
Parameter | generated by | description |
---|---|---|
Coordinates | BlockedCoordinatesTransferFactory | coarse level coordinates (unified) |
Definition at line 93 of file MueLu_BlockedCoordinatesTransferFactory_decl.hpp.
|
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 109 of file MueLu_BlockedCoordinatesTransferFactory_decl.hpp.
|
inlinevirtual |
Destructor.
Definition at line 112 of file MueLu_BlockedCoordinatesTransferFactory_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.
Implements MueLu::ParameterListAcceptor.
Definition at line 64 of file MueLu_BlockedCoordinatesTransferFactory_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 73 of file MueLu_BlockedCoordinatesTransferFactory_def.hpp.
|
virtual |
Build an object with this factory.
Implements MueLu::TwoLevelFactoryBase.
Definition at line 89 of file MueLu_BlockedCoordinatesTransferFactory_def.hpp.
void MueLu::BlockedCoordinatesTransferFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::AddFactory | ( | const RCP< const FactoryBase > & | factory | ) |
Add (sub) coords factory in the end of list of factories in BlockedCoordinatesTransferFactory.
Definition at line 128 of file MueLu_BlockedCoordinatesTransferFactory_def.hpp.
|
inline |
Returns number of sub factories.
Definition at line 146 of file MueLu_BlockedCoordinatesTransferFactory_decl.hpp.
|
private |
list of user-defined sub Factories
Definition at line 151 of file MueLu_BlockedCoordinatesTransferFactory_decl.hpp.