#include <MueLu_PreDropFunctionConstVal_decl.hpp>

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

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 Teuchos::VerboseObject< VerboseObject >
	VerboseObject (const EVerbosityLevel verbLevel=VERB_DEFAULT, const RCP< FancyOStream > &oStream=Teuchos::null)

virtual const VerboseObject &	setVerbLevel (const EVerbosityLevel verbLevel) const

virtual const VerboseObject &	setOverridingVerbLevel (const EVerbosityLevel verbLevel) const

virtual EVerbosityLevel	getVerbLevel () const

TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT RCP< const ParameterList >	getValidVerboseObjectSublist ()

TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT void	setupVerboseObjectSublist (ParameterList *paramList)

TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT void	readVerboseObjectSublist (ParameterList paramList, RCP< FancyOStream > oStream, EVerbosityLevel *verbLevel)

void	readVerboseObjectSublist (ParameterList paramList, VerboseObject< ObjectType > verboseObject)

Public Member Functions inherited from Teuchos::VerboseObjectBase
virtual	~VerboseObjectBase ()

	VerboseObjectBase (const RCP< FancyOStream > &oStream=Teuchos::null)

virtual const VerboseObjectBase &	setOStream (const RCP< FancyOStream > &oStream) const

virtual const VerboseObjectBase &	setOverridingOStream (const RCP< FancyOStream > &oStream) const

virtual VerboseObjectBase &	setLinePrefix (const std::string &linePrefix)

virtual RCP< FancyOStream >	getOStream () const

virtual RCP< FancyOStream >	getOverridingOStream () const

virtual std::string	getLinePrefix () const

virtual OSTab	getOSTab (const int tabs=1, const std::string &linePrefix="") const

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...

Public Member Functions inherited from Teuchos::Describable
void	describe (std::ostream &out, const EVerbosityLevel verbLevel=verbLevel_default) const

	LabeledObject ()

virtual	~LabeledObject ()

virtual void	setObjectLabel (const std::string &objectLabel)

virtual std::string	getObjectLabel () const

DescribableStreamManipulatorState	describe (const Describable &describable, const EVerbosityLevel verbLevel=Describable::verbLevel_default)

std::ostream &	operator<< (std::ostream &os, const DescribableStreamManipulatorState &d)

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	SetMueLuOStream (const Teuchos::RCP< Teuchos::FancyOStream > &mueluOStream)

static void	SetMueLuOFileStream (const std::string &filename)

static Teuchos::RCP < Teuchos::FancyOStream >	GetMueLuOStream ()

static void	SetDefaultVerbLevel (const VerbLevel defaultVerbLevel)
	Set the default (global) verbosity level. More...

static VerbLevel	GetDefaultVerbLevel ()
	Get the default (global) verbosity level. More...

Static Public Member Functions inherited from Teuchos::VerboseObject< VerboseObject >
static void	setDefaultVerbLevel (const EVerbosityLevel defaultVerbLevel)

static EVerbosityLevel	getDefaultVerbLevel ()

Static Public Member Functions inherited from Teuchos::VerboseObjectBase
static void	setDefaultOStream (const RCP< FancyOStream > &defaultOStream)

static RCP< FancyOStream >	getDefaultOStream ()

Static Public Attributes inherited from Teuchos::Describable
static const EVerbosityLevel	verbLevel_default

Protected Member Functions inherited from Teuchos::VerboseObject< VerboseObject >
void	initializeVerboseObject (const EVerbosityLevel verbLevel=VERB_DEFAULT, const RCP< FancyOStream > &oStream=Teuchos::null)

Protected Member Functions inherited from Teuchos::VerboseObjectBase
void	initializeVerboseObjectBase (const RCP< FancyOStream > &oStream=Teuchos::null)

virtual void	informUpdatedVerbosityState () const

Detailed Description

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

Example implementation for dropping values smaller then a constant threshold

Definition at line 27 of file MueLu_PreDropFunctionConstVal_decl.hpp.

Constructor & Destructor Documentation

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 21 of file MueLu_PreDropFunctionConstVal_def.hpp.

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

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

inlinevirtual

Destructor.

Definition at line 36 of file MueLu_PreDropFunctionConstVal_decl.hpp.

Member Function Documentation

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 25 of file MueLu_PreDropFunctionConstVal_def.hpp.

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

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

Return threshold value.

Definition at line 33 of file MueLu_PreDropFunctionConstVal_def.hpp.

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 38 of file MueLu_PreDropFunctionConstVal_def.hpp.

Member Data Documentation

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

Scalar MueLu::PreDropFunctionConstVal< Scalar, LocalOrdinal, GlobalOrdinal, Node >::threshold_

private

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

Definition at line 66 of file MueLu_PreDropFunctionConstVal_decl.hpp.

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

Public Member Functions

Private Attributes

Overridden from Teuchos::Describable

Additional Inherited Members

Detailed Description

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

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

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