MueLu::SteepestDescentSolver< Scalar, LocalOrdinal, GlobalOrdinal, Node > Class Template Reference

Implements steepest descent algorithm for energy-minimization. More...

#include <MueLu_SteepestDescentSolver_decl.hpp>

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

Private Attributes
size_t	nIts_
	Number of performed iterations. More...
SC	stepLength_
	Modifier of the step length. More...

Constructors / destructors
	SteepestDescentSolver (size_t Its, SC StepLength=Teuchos::ScalarTraits< Scalar >::one())

Iterate methods.
void	Iterate (const Matrix &A, const Constraint &C, const Matrix &P0, RCP< Matrix > &P) const
	Iterate. More...

Additional Inherited Members
Public Member Functions inherited from MueLu::SolverBase< Scalar, LocalOrdinal, GlobalOrdinal, Node >
	SolverBase ()
virtual	~SolverBase ()
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
virtual std::string	description () const
	Return a simple one-line description of this object. More...
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)
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::SteepestDescentSolver< Scalar, LocalOrdinal, GlobalOrdinal, Node >

Implements steepest descent algorithm for energy-minimization.

Definition at line 33 of file MueLu_SteepestDescentSolver_decl.hpp.

Constructor & Destructor Documentation

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

MueLu::SteepestDescentSolver< Scalar, LocalOrdinal, GlobalOrdinal, Node >::SteepestDescentSolver	(	size_t	Its,
		SC	StepLength = Teuchos::ScalarTraits<Scalar>::one()
	)

Constructor

Parameters

Its	– Number of performed iterations
StepLength	– The modifier of the step length

Definition at line 28 of file MueLu_SteepestDescentSolver_def.hpp.

Member Function Documentation

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

void MueLu::SteepestDescentSolver< Scalar, LocalOrdinal, GlobalOrdinal, Node >::Iterate ( const Matrix &  A, const Constraint &  C, const Matrix &  P0, RCP< Matrix > &  P  ) const

virtual

Iterate.

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

Definition at line 33 of file MueLu_SteepestDescentSolver_def.hpp.

Member Data Documentation

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

size_t MueLu::SteepestDescentSolver< Scalar, LocalOrdinal, GlobalOrdinal, Node >::nIts_

private

Number of performed iterations.

Definition at line 58 of file MueLu_SteepestDescentSolver_decl.hpp.

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

SC MueLu::SteepestDescentSolver< Scalar, LocalOrdinal, GlobalOrdinal, Node >::stepLength_

private

Modifier of the step length.

Definition at line 59 of file MueLu_SteepestDescentSolver_decl.hpp.

---

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

• MueLu_SteepestDescentSolver_decl.hpp
• MueLu_SteepestDescentSolver_def.hpp