ug::ILineSearch< TVector > Class Template Referenceabstract
#include <line_search.h>
Inheritance diagram for ug::ILineSearch< TVector >:
Public Types | |
| typedef TVector | vector_type |
Public Member Functions | |
| virtual std::string | config_string () const =0 |
| returns information about configuration parameters More... | |
| virtual bool | search (SmartPtr< IOperator< vector_type > > spOp, vector_type &u, vector_type &p, vector_type &d, number defect)=0 |
| virtual void | set_offset (std::string offset)=0 |
| set string to be printed before each output of line search More... | |
| virtual | ~ILineSearch () |
| virtual destructor More... | |
Detailed Description
template<typename TVector>
class ug::ILineSearch< TVector >
LineSearch
This is the base class for a line search object. An instance is passed to a newton solver to control the line search.
Member Typedef Documentation
◆ vector_type
template<typename TVector >
| typedef TVector ug::ILineSearch< TVector >::vector_type |
Constructor & Destructor Documentation
◆ ~ILineSearch()
template<typename TVector >
|
inlinevirtual |
virtual destructor
Member Function Documentation
◆ config_string()
template<typename TVector >
|
pure virtual |
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
Implemented in ug::StandardLineSearch< TVector >.
◆ search()
template<typename TVector >
|
pure virtual |
Performs a line search to a given direction.
- Parameters
-
[in] Op Non-linear operator [in] u current solution [in] p search direction [in,out] d defect [in] defect norm of current defect
- Returns
- true if line search successful false if line search failed
Implemented in ug::StandardLineSearch< TVector >.
◆ set_offset()
template<typename TVector >
|
pure virtual |
set string to be printed before each output of line search
Implemented in ug::StandardLineSearch< TVector >.
The documentation for this class was generated from the following file:
- ugbase/lib_disc/operator/non_linear_operator/line_search.h
