Digital Image Correlation Engine  Version 1.0
A modular, high-performance, image correlation tool used to compute full-field displacements and strains from digital images
Public Member Functions | Protected Attributes | List of all members
DICe::Subset_Simplex Class Reference

a class that peforms a Nelde-Mead type optimization More...

#include <DICe_Simplex.h>

Inheritance diagram for DICe::Subset_Simplex:
DICe::Simplex

Public Member Functions

 Subset_Simplex (const DICe::Objective *const obj, const Teuchos::RCP< Teuchos::ParameterList > &params=Teuchos::null)
 Default constructor. More...
 
virtual ~Subset_Simplex ()
 destructor
 
virtual scalar_t objective (Teuchos::RCP< std::vector< scalar_t > > variables)
 the objective function that the simplex method is optimizing More...
 
Status_Flag minimize (Teuchos::RCP< Local_Shape_Function > shape_function, int_t &num_iterations, const scalar_t &threshold=1.0E-10)
 
virtual Status_Flag minimize (Teuchos::RCP< std::vector< scalar_t > > variables, Teuchos::RCP< std::vector< scalar_t > > deltas, int_t &num_iterations, const scalar_t &threshold=1.0E-10)
 
- Public Member Functions inherited from DICe::Simplex
 Simplex (const Teuchos::RCP< Teuchos::ParameterList > &params=Teuchos::null)
 Default constructor. More...
 
virtual ~Simplex ()
 destructor
 
virtual Status_Flag minimize (Teuchos::RCP< std::vector< scalar_t > > variables, Teuchos::RCP< std::vector< scalar_t > > deltas, int_t &num_iterations, const scalar_t &threshold=1.0E-10)
 Returns the status of the algorithm when complete. More...
 

Protected Attributes

const DICe::Objective *const obj_
 Pointer to a DICe::Objective, used to gain access to objective methods like gamma()
 
Teuchos::RCP< Local_Shape_Functionshape_function_
 Pointer to a shape function class.
 
- Protected Attributes inherited from DICe::Simplex
int_t max_iterations_
 Maximum allowed iterations for convergence.
 
double tolerance_
 Convergence tolerance.
 
scalar_t tiny_
 Numerically small value.
 

Detailed Description

a class that peforms a Nelde-Mead type optimization

Constructor & Destructor Documentation

◆ Subset_Simplex()

DICe::Subset_Simplex::Subset_Simplex ( const DICe::Objective *const  obj,
const Teuchos::RCP< Teuchos::ParameterList > &  params = Teuchos::null 
)

Default constructor.

Parameters
objPointer to a DICe::Objective, used to gain access to the gamma() method of the objective
paramsParamters that define the varaitions on the initial guess, convergence tolerance and max number of iterations

Member Function Documentation

◆ minimize()

virtual Status_Flag DICe::Simplex::minimize

call the minimization routine

Parameters
shape_functionpointer to a shape function
num_iterationsthe number of iterations
thresholdthe convergence threshold

◆ objective()

virtual scalar_t DICe::Subset_Simplex::objective ( Teuchos::RCP< std::vector< scalar_t > >  variables)
virtual

the objective function that the simplex method is optimizing

Parameters
variablesthe current guess at which to evaluate the objective

Implements DICe::Simplex.