MueLu Version of the Day
Loading...
Searching...
No Matches
List of all members
MueLu::RigidBodyModeFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node > Class Template Reference

Nullspace Factory for building rigid body modes. More...

#include <MueLu_RigidBodyModeFactory_decl.hpp>

Inheritance diagram for MueLu::RigidBodyModeFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >:
MueLu::SingleLevelFactoryBase MueLu::Factory MueLu::FactoryBase MueLu::FactoryAcceptor MueLu::ParameterListAcceptorImpl MueLu::BaseClass MueLu::ParameterListAcceptor MueLu::VerboseObject MueLu::Describable

Build methods.

std::string nspName_
 name of nullspace vector on finest level
 
int numPDEs_
 
void Build (Level &currentLevel) const
 Build an object with this factory.
 
void setNumPDEs (int numPDEs)
 

Constructors/Destructors.

 RigidBodyModeFactory (const int numPDEs)
 Constructor.
 
 RigidBodyModeFactory (const std::string &nspName="Nullspace")
 Constructor.
 
virtual ~RigidBodyModeFactory ()
 Destructor.
 

Input

void DeclareInput (Level &currentLevel) const
 Specifies the data that this class needs, and the factories that generate that data.
 

Additional Inherited Members

- Public Member Functions inherited from MueLu::SingleLevelFactoryBase
 SingleLevelFactoryBase ()
 Constructor.
 
virtual ~SingleLevelFactoryBase ()
 Destructor.
 
virtual void CallBuild (Level &requestedLevel) const
 
virtual void CallDeclareInput (Level &requestedLevel) const
 
- Public Member Functions inherited from MueLu::Factory
 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
 
- Public Member Functions inherited from MueLu::FactoryBase
 FactoryBase ()
 Constructor.
 
virtual ~FactoryBase ()
 Destructor.
 
int GetID () const
 return unique factory id
 
- Public Member Functions inherited from MueLu::BaseClass
virtual ~BaseClass ()
 Destructor.
 
- Public Member Functions inherited from MueLu::VerboseObject
 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
 
- Public Member Functions inherited from MueLu::Describable
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.
 
- Public Member Functions inherited from MueLu::FactoryAcceptor
virtual ~FactoryAcceptor ()
 
- 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.
 
virtual const Teuchos::ParameterList & GetParameterList () const
 
virtual const Teuchos::ParameterList & GetParameterListWithoutValidation () 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
 
- Public Member Functions inherited from MueLu::ParameterListAcceptor
 ParameterListAcceptor ()
 
virtual ~ParameterListAcceptor ()=default
 
- Static Public Member Functions inherited from MueLu::Factory
static void EnableTimerSync ()
 
static void DisableTimerSync ()
 
static void EnableMultipleCheckGlobally ()
 
static void DisableMultipleCheckGlobally ()
 
- Static Public Member Functions inherited from MueLu::VerboseObject
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 ()
 
- Protected Member Functions inherited from MueLu::Factory
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
 
template<class T >
bool IsType (Level &level, const std::string &varName) const
 
bool IsAvailable (Level &level, const std::string &varName) const
 
- Static Protected Attributes inherited from MueLu::Factory
static bool timerSync_ = false
 

Detailed Description

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

Nullspace Factory for building rigid body modes.

Definition at line 35 of file MueLu_RigidBodyModeFactory_decl.hpp.

Constructor & Destructor Documentation

◆ RigidBodyModeFactory() [1/2]

template<class Scalar = DefaultScalar, class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
MueLu::RigidBodyModeFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::RigidBodyModeFactory ( const int  numPDEs)
inline

Constructor.

Definition at line 44 of file MueLu_RigidBodyModeFactory_decl.hpp.

◆ RigidBodyModeFactory() [2/2]

template<class Scalar = DefaultScalar, class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
MueLu::RigidBodyModeFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::RigidBodyModeFactory ( const std::string &  nspName = "Nullspace")
inline

Constructor.

Definition at line 48 of file MueLu_RigidBodyModeFactory_decl.hpp.

◆ ~RigidBodyModeFactory()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
MueLu::RigidBodyModeFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::~RigidBodyModeFactory ( )
virtual

Destructor.

Definition at line 24 of file MueLu_RigidBodyModeFactory_def.hpp.

Member Function Documentation

◆ DeclareInput()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
void MueLu::RigidBodyModeFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::DeclareInput ( Level &  currentLevel) const
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::SingleLevelFactoryBase.

Definition at line 27 of file MueLu_RigidBodyModeFactory_def.hpp.

◆ Build()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
void MueLu::RigidBodyModeFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::Build ( Level &  currentLevel) const
virtual

Build an object with this factory.

Implements MueLu::SingleLevelFactoryBase.

Definition at line 38 of file MueLu_RigidBodyModeFactory_def.hpp.

◆ setNumPDEs()

template<class Scalar = DefaultScalar, class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
void MueLu::RigidBodyModeFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::setNumPDEs ( int  numPDEs)
inline

Definition at line 76 of file MueLu_RigidBodyModeFactory_decl.hpp.

Member Data Documentation

◆ nspName_

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

name of nullspace vector on finest level

Definition at line 82 of file MueLu_RigidBodyModeFactory_decl.hpp.

◆ numPDEs_

template<class Scalar = DefaultScalar, class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
int MueLu::RigidBodyModeFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::numPDEs_
private

Definition at line 84 of file MueLu_RigidBodyModeFactory_decl.hpp.

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