ug::ConstantDamping< X, Y > Class Template Reference

constant damping factor More...

#include <damping.h>

Inheritance diagram for ug::ConstantDamping< X, Y >:

Public Member Functions
virtual std::string	config_string () const
	returns information about configuration parameters
virtual bool	constant_damping () const
	returns if damping is constant
	ConstantDamping (number factor)
virtual number	damping () const
	returns the constant damping factor
virtual number	damping (const Y &c, const X &d, ConstSmartPtr< ILinearOperator< Y, X > > spLinOp) const
	returns the constant damping factor
Public Member Functions inherited from ug::IDamping< X, Y >
virtual	~IDamping ()
	virtual destructor

Protected Attributes
number	m_factor
	constant damping factor

Detailed Description

template<typename X, typename Y = X>
class ug::ConstantDamping< X, Y >

constant damping factor

Constructor & Destructor Documentation

ConstantDamping()

template<typename X , typename Y = X>

ug::ConstantDamping< X, Y >::ConstantDamping ( number  factor )

inline

Member Function Documentation

config_string()

template<typename X , typename Y = X>

virtual std::string ug::ConstantDamping< X, Y >::config_string ( ) const

inlinevirtual

returns information about configuration parameters

this should return necessary information about parameters and possibly calling config_string of subcomponents.

Returns

std::string necessary information about configuration parameters

Implements ug::IDamping< X, Y >.

References ug::ConstantDamping< X, Y >::m_factor.

constant_damping()

template<typename X , typename Y = X>

virtual bool ug::ConstantDamping< X, Y >::constant_damping ( ) const

inlinevirtual

returns if damping is constant

Implements ug::IDamping< X, Y >.

damping() [1/2]

template<typename X , typename Y = X>

virtual number ug::ConstantDamping< X, Y >::damping ( ) const

inlinevirtual

returns the constant damping factor

Implements ug::IDamping< X, Y >.

References ug::ConstantDamping< X, Y >::m_factor.

damping() [2/2]

template<typename X , typename Y = X>

virtual number ug::ConstantDamping< X, Y >::damping ( const Y &  c, const X &  d, ConstSmartPtr< ILinearOperator< Y, X > >  spLinOp  ) const

inlinevirtual

returns the constant damping factor

Implements ug::IDamping< X, Y >.

References ug::ConstantDamping< X, Y >::m_factor.

Member Data Documentation

m_factor

template<typename X , typename Y = X>

number ug::ConstantDamping< X, Y >::m_factor

protected

constant damping factor

Referenced by ug::ConstantDamping< X, Y >::config_string(), ug::ConstantDamping< X, Y >::damping(), and ug::ConstantDamping< X, Y >::damping().

---

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

• ugbase/lib_algebra/operator/damping.h