libMesh::OptimizationSystem::ComputeObjective Class Reference

Abstract base class to be used to calculate the objective function for optimization. More...

#include <optimization_system.h>

Inheritance diagram for libMesh::OptimizationSystem::ComputeObjective:

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

Detailed Description

Abstract base class to be used to calculate the objective function for optimization.

Definition at line 74 of file optimization_system.h.

Constructor & Destructor Documentation

~ComputeObjective()

virtual libMesh::OptimizationSystem::ComputeObjective::~ComputeObjective ( )

inlinevirtual

Definition at line 77 of file optimization_system.h.

{}

Member Function Documentation

objective()

virtual Number libMesh::OptimizationSystem::ComputeObjective::objective ( const NumericVector< Number > &  X, sys_type &  S  )

pure virtual

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

Returns

The value of the objective function at iterate X.

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

---

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

• include/systems/optimization_system.h