Nullspace Factory for coupled acoustic-elastic problems. More...

#include <MueLu_CoupledRBMFactory_decl.hpp>

Inheritance diagram for MueLu::CoupledRBMFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >:

Build methods.
std::string	nspName_
	name of nullspace vector on finest level
int	numPDEs_
int	lastAcousticDOF_
void	Build (Level &currentLevel) const
	Build an object with this factory.
void	BuildRBM (RCP< Matrix > &A, RCP< MultiVector > &Coords, RCP< MultiVector > &nullspace) const
void	setNumPDEs (int numPDEs)
void	setLastAcousticDOF (int lastDOF)

Constructors/Destructors.
	CoupledRBMFactory (const int numPDEs)
	Constructor.
	CoupledRBMFactory (const std::string &nspName="Nullspace")
	Constructor.
virtual	~CoupledRBMFactory ()
	Destructor.

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

Additional Inherited Members
	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
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
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
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 Public Member Functions inherited from MueLu::Factory
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 ()
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::CoupledRBMFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >

Nullspace Factory for coupled acoustic-elastic problems.

Combines standard nullspace with rigid body modes. Assumes that acoustic pressure DOFs are padded with 2 extra DOFs (so that there are 3 DOFs at each mesh grid point)

Definition at line 38 of file MueLu_CoupledRBMFactory_decl.hpp.

Constructor & Destructor Documentation

◆ CoupledRBMFactory() [1/2]

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

MueLu::CoupledRBMFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::CoupledRBMFactory ( const int numPDEs )

inline

Constructor.

Definition at line 46 of file MueLu_CoupledRBMFactory_decl.hpp.

◆ CoupledRBMFactory() [2/2]

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

MueLu::CoupledRBMFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::CoupledRBMFactory ( const std::string & nspName = "Nullspace" )

inline

Constructor.

Definition at line 50 of file MueLu_CoupledRBMFactory_decl.hpp.

◆ ~CoupledRBMFactory()

template<class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>

MueLu::CoupledRBMFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::~CoupledRBMFactory ( )

virtual

Destructor.

Definition at line 24 of file MueLu_CoupledRBMFactory_def.hpp.

Member Function Documentation

◆ DeclareInput()

template<class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>

void MueLu::CoupledRBMFactory< 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_CoupledRBMFactory_def.hpp.

◆ Build()

template<class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>

void MueLu::CoupledRBMFactory< 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_CoupledRBMFactory_def.hpp.

◆ BuildRBM()

template<class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>

void MueLu::CoupledRBMFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::BuildRBM	(	RCP< Matrix > &	A,
		RCP< MultiVector > &	Coords,
		RCP< MultiVector > &	nullspace ) const

Definition at line 112 of file MueLu_CoupledRBMFactory_def.hpp.

◆ setNumPDEs()

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

void MueLu::CoupledRBMFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::setNumPDEs ( int numPDEs )

inline

Definition at line 80 of file MueLu_CoupledRBMFactory_decl.hpp.

◆ setLastAcousticDOF()

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

void MueLu::CoupledRBMFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::setLastAcousticDOF ( int lastDOF )

inline

Definition at line 84 of file MueLu_CoupledRBMFactory_decl.hpp.

Member Data Documentation

◆ nspName_

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

std::string MueLu::CoupledRBMFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::nspName_

private

name of nullspace vector on finest level

Definition at line 90 of file MueLu_CoupledRBMFactory_decl.hpp.

◆ numPDEs_

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

int MueLu::CoupledRBMFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::numPDEs_

private

Definition at line 92 of file MueLu_CoupledRBMFactory_decl.hpp.

◆ lastAcousticDOF_

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

int MueLu::CoupledRBMFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::lastAcousticDOF_

private

Definition at line 94 of file MueLu_CoupledRBMFactory_decl.hpp.

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

Build methods.

Constructors/Destructors.

Input

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CoupledRBMFactory() [1/2]

◆ CoupledRBMFactory() [2/2]

◆ ~CoupledRBMFactory()

Member Function Documentation

◆ DeclareInput()

◆ Build()

◆ BuildRBM()

◆ setNumPDEs()

◆ setLastAcousticDOF()

Member Data Documentation

◆ nspName_

◆ numPDEs_

◆ lastAcousticDOF_