MueLu  Version of the Day
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>

Constructors/Destructors.

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

Input

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

Build methods.

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

Detailed Description

template<class Scalar = double, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
class MueLu::RigidBodyModeFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >

Nullspace Factory for building rigid body modes.

Definition at line 68 of file MueLu_RigidBodyModeFactory_decl.hpp.

Constructor & Destructor Documentation

◆ RigidBodyModeFactory() [1/2]

template<class Scalar = double, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
MueLu::RigidBodyModeFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::RigidBodyModeFactory ( const int  numPDEs)
inline

Constructor.

Definition at line 77 of file MueLu_RigidBodyModeFactory_decl.hpp.

◆ RigidBodyModeFactory() [2/2]

template<class Scalar = double, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
MueLu::RigidBodyModeFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::RigidBodyModeFactory ( const std::string &  nspName = "Nullspace")
inline

Constructor.

Definition at line 82 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 60 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

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.

Definition at line 63 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

Build an object with this factory.

Definition at line 74 of file MueLu_RigidBodyModeFactory_def.hpp.

◆ setNumPDEs()

template<class Scalar = double, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
void MueLu::RigidBodyModeFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::setNumPDEs ( int  numPDEs)
inline

Definition at line 111 of file MueLu_RigidBodyModeFactory_decl.hpp.

Member Data Documentation

◆ nspName_

template<class Scalar = double, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
std::string MueLu::RigidBodyModeFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::nspName_
private

name of nullspace vector on finest level

Definition at line 118 of file MueLu_RigidBodyModeFactory_decl.hpp.

◆ numPDEs_

template<class Scalar = double, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
int MueLu::RigidBodyModeFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::numPDEs_
private

Definition at line 120 of file MueLu_RigidBodyModeFactory_decl.hpp.

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