ug::ILevelPreconditioner< TAlgebra > Class Template Reference
A preconditioner for the multi-grid context which is aware of the grid level it operates on. More...
#include <level_preconditioner_interface.h>
Inheritance diagram for ug::ILevelPreconditioner< TAlgebra >:
Public Member Functions | |
| virtual void | grid_level_has_changed () |
| response to change in grid level More... | |
| ILevelPreconditioner () | |
| constructor More... | |
| ILevelPreconditioner (const GridLevel &gl) | |
| constructor with grid level More... | |
| ILevelPreconditioner (const ILevelPreconditioner< TAlgebra > &parent) | |
| clone constructor More... | |
| void | set_grid_level (const GridLevel &gl) |
| set the grid level More... | |
| Public Member Functions inherited from ug::IPreconditioner< TAlgebra > | |
| virtual bool | apply (vector_type &c, const vector_type &d) |
| compute new correction c = B*d More... | |
| virtual bool | apply_update_defect (vector_type &c, vector_type &d) |
| compute new correction c = B*d and update defect d:= d - L*c More... | |
| SmartPtr< MatrixOperator< matrix_type, vector_type > > | approx_operator () |
| underlying matrix based operator used for the preconditioner More... | |
| SmartPtr< MatrixOperator< matrix_type, vector_type > > | defect_operator () |
| underlying matrix based operator for calculation of defect More... | |
| virtual bool | init (SmartPtr< ILinearOperator< vector_type > > J, const vector_type &u) |
| implements the ILinearIterator-interface for matrix based preconditioner More... | |
| bool | init (SmartPtr< ILinearOperator< vector_type > > L) |
| implements the ILinearIterator-interface for matrix based preconditioner More... | |
| bool | init (SmartPtr< MatrixOperator< matrix_type, vector_type > > Op) |
| initializes the preconditioner for a matrix based operator More... | |
| IPreconditioner () | |
| default constructor More... | |
| IPreconditioner (const IPreconditioner< TAlgebra > &parent) | |
| clone constructor More... | |
| IPreconditioner (SmartPtr< IDebugWriter< algebra_type > > spDebugWriter) | |
| constructor setting debug writer More... | |
| virtual void | set_approximation (SmartPtr< MatrixOperator< matrix_type, vector_type > > approx) |
| virtual | ~IPreconditioner () |
| virtual destructor More... | |
| Public Member Functions inherited from ug::ILinearIterator< TAlgebra::vector_type > | |
| virtual SmartPtr< ILinearIterator< TAlgebra::vector_type, TAlgebra::vector_type > > | clone ()=0 |
| clone More... | |
| virtual std::string | config_string () const |
| SmartPtr< IDamping< TAlgebra::vector_type, TAlgebra::vector_type > > | damping () |
| returns the scaling More... | |
| ILinearIterator () | |
| constructor More... | |
| ILinearIterator (const ILinearIterator< TAlgebra::vector_type, TAlgebra::vector_type > &parent) | |
| copy constructor More... | |
| virtual bool | init (SmartPtr< ILinearOperator< TAlgebra::vector_type, TAlgebra::vector_type > > J, const TAlgebra::vector_type &u)=0 |
| initialize for operator J(u) and linearization point u More... | |
| virtual bool | init (SmartPtr< ILinearOperator< TAlgebra::vector_type, TAlgebra::vector_type > > L)=0 |
| initialize for linear operator L More... | |
| void | set_damp (number factor) |
| sets the damping to a constant factor More... | |
| void | set_damp (SmartPtr< IDamping< TAlgebra::vector_type, TAlgebra::vector_type > > spScaling) |
| sets a scaling for the correction More... | |
| virtual bool | supports_parallel () const=0 |
| returns if parallel solving is supported More... | |
| virtual | ~ILinearIterator () |
| virtual destructor More... | |
| Public Member Functions inherited from ug::DebugWritingObject< TAlgebra > | |
| SmartPtr< IDebugWriter< algebra_type > > | debug_writer () |
| returns the debug writer More... | |
| ConstSmartPtr< IDebugWriter< algebra_type > > | debug_writer () const |
| bool | debug_writer_valid () const |
| returns true if the debug writer is set More... | |
| DebugWritingObject () | |
| DebugWritingObject (const DebugWritingObject< algebra_type > &parent) | |
| clone constructor More... | |
| DebugWritingObject (SmartPtr< IDebugWriter< algebra_type > > spDebugWriter) | |
| virtual void | set_debug (SmartPtr< IDebugWriter< algebra_type > > spDebugWriter) |
| set debug writer More... | |
| virtual | ~DebugWritingObject () |
| virtual destructor More... | |
| Public Member Functions inherited from ug::VectorDebugWritingObject< TAlgebra::vector_type > | |
| virtual void | set_debug (SmartPtr< IVectorDebugWriter< vector_type > > spDebugWriter) |
| set debug writer More... | |
| SmartPtr< IVectorDebugWriter< vector_type > > | vector_debug_writer () |
| returns the debug writer More... | |
| ConstSmartPtr< IVectorDebugWriter< vector_type > > | vector_debug_writer () const |
| bool | vector_debug_writer_valid () const |
| returns true if the debug writer is set More... | |
| VectorDebugWritingObject () | |
| VectorDebugWritingObject (SmartPtr< IVectorDebugWriter< vector_type > > spDebugWriter) | |
| void | write_debug (const vector_type &vec, const char *filename) |
| writing debug output for a vector (if debug writer set) More... | |
| virtual | ~VectorDebugWritingObject () |
| virtual destructor More... | |
Protected Attributes | |
| GridLevel | m_gl |
| Protected Attributes inherited from ug::IPreconditioner< TAlgebra > | |
| bool | m_bInit |
| init flag indicating if init has been called More... | |
| bool | m_bOtherApproxOperator |
| SmartPtr< MatrixOperator< matrix_type, vector_type > > | m_spApproxOperator |
| underlying matrix based operator used for the preconditioner More... | |
| SmartPtr< ILinearOperator< vector_type > > | m_spDefectOperator |
| underlying matrix based operator for calculation of defect More... | |
| Protected Attributes inherited from ug::ILinearIterator< TAlgebra::vector_type > | |
| SmartPtr< IDamping< TAlgebra::vector_type, TAlgebra::vector_type > > | m_spDamping |
| the scaling More... | |
| Protected Attributes inherited from ug::DebugWritingObject< TAlgebra > | |
| SmartPtr< IDebugWriter< algebra_type > > | m_spDebugWriter |
| Debug Writer. More... | |
| Protected Attributes inherited from ug::VectorDebugWritingObject< TAlgebra::vector_type > | |
| SmartPtr< IVectorDebugWriter< vector_type > > | m_spVectorDebugWriter |
| Debug Writer. More... | |
Additional Inherited Members | |
| Public Types inherited from ug::IPreconditioner< TAlgebra > | |
| typedef TAlgebra | algebra_type |
| Algebra type. More... | |
| typedef MatrixOperator< matrix_type, vector_type > | matrix_operator_type |
| Matrix Operator type. More... | |
| typedef TAlgebra::matrix_type | matrix_type |
| Matrix type. More... | |
| typedef TAlgebra::vector_type | vector_type |
| Vector type. More... | |
| Public Types inherited from ug::ILinearIterator< TAlgebra::vector_type > | |
| typedef TAlgebra::vector_type | codomain_function_type |
| Range space. More... | |
| typedef TAlgebra::vector_type | domain_function_type |
| Domain space. More... | |
| Public Types inherited from ug::DebugWritingObject< TAlgebra > | |
| typedef TAlgebra | algebra_type |
| type of algebra More... | |
| typedef TAlgebra::matrix_type | matrix_type |
| type of matrix More... | |
| typedef TAlgebra::vector_type | vector_type |
| type of vector More... | |
| Public Types inherited from ug::VectorDebugWritingObject< TAlgebra::vector_type > | |
| typedef TAlgebra::vector_type | vector_type |
| type of vector More... | |
| Protected Member Functions inherited from ug::IPreconditioner< TAlgebra > | |
| virtual const char * | name () const =0 |
| returns the name of iterator More... | |
| virtual bool | postprocess ()=0 |
| cleans the operator More... | |
| virtual bool | preprocess (SmartPtr< MatrixOperator< matrix_type, vector_type > > pOp)=0 |
| initializes the preconditioner More... | |
| virtual bool | step (SmartPtr< MatrixOperator< matrix_type, vector_type > > pOp, vector_type &c, const vector_type &d)=0 |
| computes a new correction c = B*d More... | |
| Protected Member Functions inherited from ug::DebugWritingObject< TAlgebra > | |
| void | enter_debug_writer_section (const char *secDir) |
| enters a debugging section More... | |
| void | enter_debug_writer_section (std::string secDir) |
| enters a debugging section More... | |
| void | leave_debug_writer_section () |
| leaves a debugging section More... | |
| void | write_debug (const matrix_type &mat, const char *filename) |
| write debug output for a matrix (if debug writer set) More... | |
| void | write_debug (const matrix_type &mat, std::string name) |
| write debug output for a matrix (if debug writer set) More... | |
| Protected Member Functions inherited from ug::VectorDebugWritingObject< TAlgebra::vector_type > | |
| void | enter_vector_debug_writer_section (const char *secDir) |
| enters a debugging section More... | |
| void | enter_vector_debug_writer_section (std::string secDir) |
| enters a debugging section More... | |
| void | leave_vector_debug_writer_section () |
| leaves a debugging section More... | |
| void | print_debugger_message (const char *msg) |
| prints a debugger message (listing all the sections) More... | |
| void | print_debugger_message (std::string msg) |
| prints a debugger message (listing all the sections) More... | |
| virtual void | write_debug (const vector_type &vec, std::string name) |
| writing debug output for a vector (if debug writer set) More... | |
Detailed Description
template<typename TAlgebra>
class ug::ILevelPreconditioner< TAlgebra >
A preconditioner for the multi-grid context which is aware of the grid level it operates on.
Constructor & Destructor Documentation
◆ ILevelPreconditioner() [1/3]
template<typename TAlgebra >
|
inline |
constructor
◆ ILevelPreconditioner() [2/3]
template<typename TAlgebra >
|
inline |
constructor with grid level
◆ ILevelPreconditioner() [3/3]
template<typename TAlgebra >
|
inline |
clone constructor
Member Function Documentation
◆ grid_level_has_changed()
template<typename TAlgebra >
|
inlinevirtual |
response to change in grid level
Referenced by ug::ILevelPreconditioner< TAlgebra >::set_grid_level().
◆ set_grid_level()
template<typename TAlgebra >
|
inline |
set the grid level
References ug::ILevelPreconditioner< TAlgebra >::grid_level_has_changed(), and ug::ILevelPreconditioner< TAlgebra >::m_gl.
Referenced by ug::AssembledMultiGridCycle< TDomain, TAlgebra >::init_level_memory().
Member Data Documentation
◆ m_gl
template<typename TAlgebra >
|
protected |
Referenced by ug::ILevelPreconditioner< TAlgebra >::set_grid_level().
The documentation for this class was generated from the following file:
- ugbase/lib_disc/operator/linear_operator/level_preconditioner_interface.h
