libMesh::OptimizationSystem::ComputeObjective Class Referenceabstract

#include <optimization_system.h>

Public Member Functions

virtual ~ComputeObjective ()
 
virtual Number objective (const NumericVector< Number > &X, sys_type &S)=0
 

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

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

Definition at line 77 of file optimization_system.h.

References objective().

77 {}

Member Function Documentation

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 the iterate X.

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


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