MueLu  Version of the Day
MueLu::PreDropFunctionConstVal< Scalar, LocalOrdinal, GlobalOrdinal, Node > Class Template Reference

#include <MueLu_PreDropFunctionConstVal_decl.hpp>

Inheritance diagram for MueLu::PreDropFunctionConstVal< Scalar, LocalOrdinal, GlobalOrdinal, Node >:
MueLu::PreDropFunctionBaseClass< Scalar, LocalOrdinal, GlobalOrdinal, Node > MueLu::BaseClass MueLu::VerboseObject MueLu::Describable

Public Member Functions

 PreDropFunctionConstVal (const Scalar threshold=0.0)
 Constructor. More...
 
virtual ~PreDropFunctionConstVal ()
 Destructor. More...
 
bool Drop (size_t lrow, GlobalOrdinal grow, size_t k, LocalOrdinal lcid, GlobalOrdinal gcid, const Teuchos::ArrayView< const LocalOrdinal > &indices, const Teuchos::ArrayView< const Scalar > &vals)
 
Scalar GetThreshold () const
 Return threshold value. More...
 
- Public Member Functions inherited from MueLu::PreDropFunctionBaseClass< Scalar, LocalOrdinal, GlobalOrdinal, Node >
virtual ~PreDropFunctionBaseClass ()
 Destructor. 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 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
 
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...
 

Private Attributes

Scalar threshold_
 Print the object with some verbosity level to an FancyOStream object. More...
 

Overridden from Teuchos::Describable

std::string description () const
 Return a simple one-line description of this object. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from MueLu::VerboseObject
static void SetDefaultOStream (const Teuchos::RCP< Teuchos::FancyOStream > &defaultOStream)
 
static Teuchos::RCP< Teuchos::FancyOStream > GetDefaultOStream ()
 
static void SetDefaultVerbLevel (const VerbLevel defaultVerbLevel)
 Set the default (global) verbosity level. More...
 
static VerbLevel GetDefaultVerbLevel ()
 Get the default (global) verbosity level. More...
 

Detailed Description

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

Example implementation for dropping values smaller then a constant threshold

Definition at line 62 of file MueLu_PreDropFunctionConstVal_decl.hpp.

Constructor & Destructor Documentation

◆ PreDropFunctionConstVal()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
MueLu::PreDropFunctionConstVal< Scalar, LocalOrdinal, GlobalOrdinal, Node >::PreDropFunctionConstVal ( const Scalar  threshold = 0.0)
explicit

Constructor.

Definition at line 58 of file MueLu_PreDropFunctionConstVal_def.hpp.

◆ ~PreDropFunctionConstVal()

template<class Scalar = double, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
virtual MueLu::PreDropFunctionConstVal< Scalar, LocalOrdinal, GlobalOrdinal, Node >::~PreDropFunctionConstVal ( )
inlinevirtual

Destructor.

Definition at line 73 of file MueLu_PreDropFunctionConstVal_decl.hpp.

Member Function Documentation

◆ Drop()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
bool MueLu::PreDropFunctionConstVal< Scalar, LocalOrdinal, GlobalOrdinal, Node >::Drop ( size_t  lrow,
GlobalOrdinal  grow,
size_t  k,
LocalOrdinal  lcid,
GlobalOrdinal  gcid,
const Teuchos::ArrayView< const LocalOrdinal > &  indices,
const Teuchos::ArrayView< const Scalar > &  vals 
)
virtual

Drop

Parameters
lrow(size_t): local row index (=lrowid)
grow(GlobalOrdinal: global row id
k(size_t): local column iterator
lcid(LocalOrdinal): local column id (=indices[k])
gcid(GlobalOrdinal): global column id
indices(ArrrayView): array of local column ids in current row (lrow)
vals(ArrayView): array of corresponding values in current row (lrow)
Returns
bool: false, if value in (lrow, lcid) shall be kept, true if it should be dropped

Implements MueLu::PreDropFunctionBaseClass< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 62 of file MueLu_PreDropFunctionConstVal_def.hpp.

◆ GetThreshold()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
Scalar MueLu::PreDropFunctionConstVal< Scalar, LocalOrdinal, GlobalOrdinal, Node >::GetThreshold ( ) const

Return threshold value.

Definition at line 70 of file MueLu_PreDropFunctionConstVal_def.hpp.

◆ description()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
std::string MueLu::PreDropFunctionConstVal< Scalar, LocalOrdinal, GlobalOrdinal, Node >::description ( ) const
virtual

Return a simple one-line description of this object.

Reimplemented from MueLu::Describable.

Definition at line 76 of file MueLu_PreDropFunctionConstVal_def.hpp.

Member Data Documentation

◆ threshold_

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

Print the object with some verbosity level to an FancyOStream object.

Definition at line 104 of file MueLu_PreDropFunctionConstVal_decl.hpp.


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