MinimizeNLOPT.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: 2021 Philipp Basler, Margarete Mühlleitner and Jonas
// Müller
//
// SPDX-License-Identifier: GPL-3.0-or-later
 
#ifndef MINIMIZENLOPT_H
#define MINIMIZENLOPT_H
 
#include <memory>
#include <nlopt.hpp>
#include <vector>
 
namespace BSMPT
{
class Class_Potential_Origin;
namespace Minimizer
{
struct PointerContainerMinPlane;
namespace LibNLOPT
{
 
struct ShareInformationNLOPT
{
  const Class_Potential_Origin &model;
  double Temp;
  ShareInformationNLOPT(const Class_Potential_Origin &modelIn,
                        const double &TempIn)
      : model{modelIn}
      , Temp{TempIn}
  {
  }
};
 
struct NLOPTReturnType
{
  std::vector<double> Minimum;
  double PotVal;
  nlopt::result NLOPTResult;
  bool Success;
  NLOPTReturnType()
      : NLOPTReturnType(std::vector<double>(), 0, nlopt::result(), false)
  {
  }
  NLOPTReturnType(const std::vector<double> &MinimumIn,
                  const double &PotValIn,
                  const nlopt::result &NLOPTResultIn,
                  bool SuccessIn)
      : Minimum{MinimumIn}
      , PotVal{PotValIn}
      , NLOPTResult{NLOPTResultIn}
      , Success{SuccessIn}
  {
  }
};
 
double
NLOPTVEff(const std::vector<double> &x, std::vector<double> &grad, void *data);
 
NLOPTReturnType MinimizeUsingNLOPT(const Class_Potential_Origin &model,
                                   const double &Temp);
 
NLOPTReturnType
MinimizePlaneUsingNLOPT(const struct PointerContainerMinPlane &params);
double NLOPTVEffPlane(const std::vector<double> &x,
                      std::vector<double> &grad,
                      void *data);
 
NLOPTReturnType
FindLocalMinimum(const std::shared_ptr<Class_Potential_Origin> &model,
                 const std::vector<double> &Start,
                 const double &Temp);
 
} // namespace LibNLOPT
} // namespace Minimizer
} // namespace BSMPT
 
#endif // MINIMIZENLOPT_H