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 More... | |
| virtual bool | constant_damping () const |
| returns if damping is constant More... | |
| ConstantDamping (number factor) | |
| virtual number | damping () const |
| returns the constant damping factor More... | |
| virtual number | damping (const Y &c, const X &d, ConstSmartPtr< ILinearOperator< Y, X > > spLinOp) const |
| returns the constant damping factor More... | |
| Public Member Functions inherited from ug::IDamping< X, X > | |
| virtual number | damping (const X &c, const X &d, ConstSmartPtr< ILinearOperator< X, X > > spLinOp) const=0 |
| returns the damping More... | |
| virtual | ~IDamping () |
| virtual destructor More... | |
Protected Attributes | |
| number | m_factor |
| constant damping factor More... | |
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>
|
inline |
Member Function Documentation
◆ config_string()
template<typename X , typename Y = X>
|
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, X >.
References ug::ConstantDamping< X, Y >::m_factor.
◆ constant_damping()
template<typename X , typename Y = X>
|
inlinevirtual |
returns if damping is constant
Implements ug::IDamping< X, X >.
◆ damping() [1/2]
template<typename X , typename Y = X>
|
inlinevirtual |
returns the constant damping factor
Implements ug::IDamping< X, X >.
References ug::ConstantDamping< X, Y >::m_factor.
◆ damping() [2/2]
template<typename X , typename Y = X>
|
inlinevirtual |
returns the constant damping factor
References ug::ConstantDamping< X, Y >::m_factor.
Member Data Documentation
◆ m_factor
template<typename X , typename Y = X>
|
protected |
constant damping factor
Referenced by ug::ConstantDamping< X, Y >::config_string(), and ug::ConstantDamping< X, Y >::damping().
The documentation for this class was generated from the following file:
- ugbase/lib_algebra/operator/damping.h
