Loading [MathJax]/extensions/tex2jax.js
ug4
•All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Public Member Functions | List of all members
ug::MinimalResiduumDamping< X, Y > Class Template Reference

damping computed based on the minimal residuum More...

#include <damping.h>

+ Inheritance diagram for ug::MinimalResiduumDamping< 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
 
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 damping factor
 
- Public Member Functions inherited from ug::IDamping< X, Y >
virtual ~IDamping ()
 virtual destructor
 

Detailed Description

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

damping computed based on the minimal residuum

Member Function Documentation

◆ config_string()

template<typename X , typename Y = X>
virtual std::string ug::MinimalResiduumDamping< 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 >.

◆ constant_damping()

template<typename X , typename Y = X>
virtual bool ug::MinimalResiduumDamping< 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::MinimalResiduumDamping< X, Y >::damping ( ) const
inlinevirtual

returns the constant damping factor

Implements ug::IDamping< X, Y >.

References UG_THROW.

◆ damping() [2/2]

template<typename X , typename Y = X>
virtual number ug::MinimalResiduumDamping< X, Y >::damping ( const Y &  c,
const X &  d,
ConstSmartPtr< ILinearOperator< Y, X > >  spLinOp 
) const
inlinevirtual

returns the damping factor

Implements ug::IDamping< X, Y >.

References SmartPtr< T, FreePolicy >::cast_const(), UG_CATCH_THROW, and ug::VecProd().

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