Abstract class to define by user specified optimization function. More...
Public Member Functions | |
| MyOpt () | |
| Default Constructor. | |
| MyOpt (Mesh &mesh) | |
| Constructor using mesh instance. More... | |
| virtual | ~MyOpt () |
| Destructor. | |
| virtual real_t | Objective (Vect< real_t > &x)=0 |
| Virtual member function to define objective. More... | |
| virtual void | Gradient (Vect< real_t > &x, Vect< real_t > &g) |
| Virtual member function to define gradient vector of objective. More... | |
| void | setEquation (Equa< real_t > *eq) |
| Define equation instance. More... | |
| Equa< real_t > * | getEquation () const |
| Get pointer to equation instance. More... | |
Detailed Description
Abstract class to define by user specified optimization function.
The user has to implement a class that inherits from the present one where the virtual functions are implemented.
- Author
- Rachid Touzani
- Copyright
- GNU Lesser Public License
Constructor & Destructor Documentation
Member Function Documentation
Virtual member function to define objective.
- Parameters
-
[in] x Vector of optimization variables
- Returns
- Value of objective
Virtual member function to define gradient vector of objective.
- Parameters
-
[in] x Vector of optimization variables [out] g Gradient vector
Define equation instance.
- Parameters
-
[in] eq Pointer to equation instance
- Remarks
- This member function is to be invoked in the user class defining the optimization problem