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

Factory for building a thresholded operator. More...

#include <MueLu_ThresholdAFilterFactory_decl.hpp>

Inheritance diagram for MueLu::ThresholdAFilterFactory< 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 varName_
 name of input and output variable
 
const Scalar threshold_
 threshold parameter
 
const bool keepDiagonal_
 
const GlobalOrdinal expectedNNZperRow_
 
void Build (Level &currentLevel) const
 Build an object with this factory.
 

Constructors/Destructors.

 ThresholdAFilterFactory (const std::string &ename, const Scalar threshold, const bool keepDiagonal=true, const GlobalOrdinal expectedNNZperRow=-1)
 Constructor.
 
void DeclareInput (Level &currentLevel) const
 Input.
 

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 FactoryBaseGetFactory (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
 
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 >
Get (Level &level, const std::string &varName) const
 
template<class 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 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::ThresholdAFilterFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >

Factory for building a thresholded operator.

Definition at line 72 of file MueLu_ThresholdAFilterFactory_decl.hpp.

Constructor & Destructor Documentation

◆ ThresholdAFilterFactory()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
MueLu::ThresholdAFilterFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::ThresholdAFilterFactory ( const std::string & ename,
const Scalar threshold,
const bool keepDiagonal = true,
const GlobalOrdinal expectedNNZperRow = -1 )

Constructor.

Definition at line 60 of file MueLu_ThresholdAFilterFactory_def.hpp.

Member Function Documentation

◆ DeclareInput()

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

Input.

Implements MueLu::SingleLevelFactoryBase.

Definition at line 65 of file MueLu_ThresholdAFilterFactory_def.hpp.

◆ Build()

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

Build an object with this factory.

Implements MueLu::SingleLevelFactoryBase.

Definition at line 70 of file MueLu_ThresholdAFilterFactory_def.hpp.

Member Data Documentation

◆ varName_

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

name of input and output variable

Definition at line 99 of file MueLu_ThresholdAFilterFactory_decl.hpp.

◆ threshold_

template<class Scalar = DefaultScalar, class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
const Scalar MueLu::ThresholdAFilterFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::threshold_
private

threshold parameter

Definition at line 100 of file MueLu_ThresholdAFilterFactory_decl.hpp.

◆ keepDiagonal_

template<class Scalar = DefaultScalar, class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
const bool MueLu::ThresholdAFilterFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::keepDiagonal_
private

Definition at line 101 of file MueLu_ThresholdAFilterFactory_decl.hpp.

◆ expectedNNZperRow_

template<class Scalar = DefaultScalar, class LocalOrdinal = DefaultLocalOrdinal, class GlobalOrdinal = DefaultGlobalOrdinal, class Node = DefaultNode>
const GlobalOrdinal MueLu::ThresholdAFilterFactory< Scalar, LocalOrdinal, GlobalOrdinal, Node >::expectedNNZperRow_
private

Definition at line 102 of file MueLu_ThresholdAFilterFactory_decl.hpp.


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