libMesh::OptimizationSystem::ComputeGradient Class Reference

Abstract base class to be used to calculate the gradient of an objective function. More...

#include <optimization_system.h>

Inheritance diagram for libMesh::OptimizationSystem::ComputeGradient:

Public Member Functions
virtual	~ComputeGradient ()=default
virtual void	gradient (const NumericVector< Number > &X, NumericVector< Number > &grad_f, sys_type &S)=0
	This function will be called to compute the gradient of the objective function, and must be implemented by the user in a derived class. More...

Detailed Description

Abstract base class to be used to calculate the gradient of an objective function.

Definition at line 100 of file optimization_system.h.

Constructor & Destructor Documentation

~ComputeGradient()

virtual libMesh::OptimizationSystem::ComputeGradient::~ComputeGradient ( )

virtualdefault

Member Function Documentation

gradient()

virtual void libMesh::OptimizationSystem::ComputeGradient::gradient ( const NumericVector< Number > &  X, NumericVector< Number > &  grad_f, sys_type &  S  )

pure virtual

This function will be called to compute the gradient of the objective function, and must be implemented by the user in a derived class.

Set grad_f to be the gradient at the iterate X.

Referenced by libMesh::__libmesh_nlopt_objective(), and libMesh::__libmesh_tao_gradient().

---

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

• include/systems/optimization_system.h