Ipopt  3.12.11
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros
Public Member Functions | Protected Member Functions | List of all members
MittelmannBndryCntrlDiri3D Class Reference

Class implementating Example 1. More...

#include <MittelmannBndryCntrlDiri3D.hpp>

+ Inheritance diagram for MittelmannBndryCntrlDiri3D:

Public Member Functions

 MittelmannBndryCntrlDiri3D ()
 
virtual ~MittelmannBndryCntrlDiri3D ()
 
virtual bool InitializeProblem (Index N)
 Initialize internal parameters, where N is a parameter determining the problme size. More...
 
- Public Member Functions inherited from MittelmannBndryCntrlDiriBase3D
 MittelmannBndryCntrlDiriBase3D ()
 Constructor. More...
 
virtual ~MittelmannBndryCntrlDiriBase3D ()
 Default destructor. More...
 
virtual bool get_scaling_parameters (Number &obj_scaling, bool &use_x_scaling, Index n, Number *x_scaling, bool &use_g_scaling, Index m, Number *g_scaling)
 Method for returning scaling parameters. More...
 
virtual bool get_nlp_info (Index &n, Index &m, Index &nnz_jac_g, Index &nnz_h_lag, IndexStyleEnum &index_style)
 Method to return some info about the nlp. More...
 
virtual bool get_bounds_info (Index n, Number *x_l, Number *x_u, Index m, Number *g_l, Number *g_u)
 Method to return the bounds for my problem. More...
 
virtual bool get_starting_point (Index n, bool init_x, Number *x, bool init_z, Number *z_L, Number *z_U, Index m, bool init_lambda, Number *lambda)
 Method to return the starting point for the algorithm. More...
 
virtual bool eval_f (Index n, const Number *x, bool new_x, Number &obj_value)
 Method to return the objective value. More...
 
virtual bool eval_grad_f (Index n, const Number *x, bool new_x, Number *grad_f)
 Method to return the gradient of the objective. More...
 
virtual bool eval_g (Index n, const Number *x, bool new_x, Index m, Number *g)
 Method to return the constraint residuals. More...
 
virtual bool eval_jac_g (Index n, const Number *x, bool new_x, Index m, Index nele_jac, Index *iRow, Index *jCol, Number *values)
 Method to return: 1) The structure of the jacobian (if "values" is NULL) 2) The values of the jacobian (if "values" is not NULL) More...
 
virtual bool eval_h (Index n, const Number *x, bool new_x, Number obj_factor, Index m, const Number *lambda, bool new_lambda, Index nele_hess, Index *iRow, Index *jCol, Number *values)
 Method to return: 1) The structure of the hessian of the lagrangian (if "values" is NULL) 2) The values of the hessian of the lagrangian (if "values" is not NULL) More...
 
virtual void finalize_solution (SolverReturn status, Index n, const Number *x, const Number *z_L, const Number *z_U, Index m, const Number *g, const Number *lambda, Number obj_valu, const IpoptData *ip_data, IpoptCalculatedQuantities *ip_cq)
 This method is called after the optimization, and could write an output file with the optimal profiles. More...
 
- Public Member Functions inherited from Ipopt::TNLP
 DECLARE_STD_EXCEPTION (INVALID_TNLP)
 
 TNLP ()
 
virtual ~TNLP ()
 Default destructor. More...
 
virtual void finalize_metadata (Index n, const StringMetaDataMapType &var_string_md, const IntegerMetaDataMapType &var_integer_md, const NumericMetaDataMapType &var_numeric_md, Index m, const StringMetaDataMapType &con_string_md, const IntegerMetaDataMapType &con_integer_md, const NumericMetaDataMapType &con_numeric_md)
 This method is called just before finalize_solution. More...
 
virtual bool intermediate_callback (AlgorithmMode mode, Index iter, Number obj_value, Number inf_pr, Number inf_du, Number mu, Number d_norm, Number regularization_size, Number alpha_du, Number alpha_pr, Index ls_trials, const IpoptData *ip_data, IpoptCalculatedQuantities *ip_cq)
 Intermediate Callback method for the user. More...
 
virtual Index get_number_of_nonlinear_variables ()
 
virtual bool get_list_of_nonlinear_variables (Index num_nonlin_vars, Index *pos_nonlin_vars)
 
virtual bool get_var_con_metadata (Index n, StringMetaDataMapType &var_string_md, IntegerMetaDataMapType &var_integer_md, NumericMetaDataMapType &var_numeric_md, Index m, StringMetaDataMapType &con_string_md, IntegerMetaDataMapType &con_integer_md, NumericMetaDataMapType &con_numeric_md)
 overload this method to return any meta data for the variables and the constraints More...
 
virtual bool get_variables_linearity (Index n, LinearityType *var_types)
 overload this method to return the variables linearity (TNLP::LINEAR or TNLP::NON_LINEAR). More...
 
virtual bool get_constraints_linearity (Index m, LinearityType *const_types)
 overload this method to return the constraint linearity. More...
 
virtual bool get_warm_start_iterate (IteratesVector &warm_start_iterate)
 overload this method to provide an Ipopt iterate (already in the form Ipopt requires it internally) for a warm start. More...
 
- Public Member Functions inherited from Ipopt::ReferencedObject
 ReferencedObject ()
 
virtual ~ReferencedObject ()
 
Index ReferenceCount () const
 
void AddRef (const Referencer *referencer) const
 
void ReleaseRef (const Referencer *referencer) const
 

Protected Member Functions

virtual Number y_d_cont (Number x1, Number x2, Number x3) const
 Target profile function for y. More...
 
- Protected Member Functions inherited from MittelmannBndryCntrlDiriBase3D
void SetBaseParameters (Index N, Number alpha, Number lb_y, Number ub_y, Number lb_u, Number ub_u, Number d_const, Number B, Number C)
 Method for setting the internal parameters that define the problem. More...
 

Private Member Functions

hide implicitly defined contructors copy operators
 MittelmannBndryCntrlDiri3D (const MittelmannBndryCntrlDiri3D &)
 
MittelmannBndryCntrlDiri3Doperator= (const MittelmannBndryCntrlDiri3D &)
 

Additional Inherited Members

- Public Types inherited from Ipopt::TNLP
enum  LinearityType { LINEAR, NON_LINEAR }
 Type of the constraints. More...
 
enum  IndexStyleEnum { C_STYLE =0, FORTRAN_STYLE =1 }
 overload this method to return the number of variables and constraints, and the number of non-zeros in the jacobian and the hessian. More...
 
typedef std::map< std::string,
std::vector< std::string > > 
StringMetaDataMapType
 
typedef std::map< std::string,
std::vector< Index > > 
IntegerMetaDataMapType
 
typedef std::map< std::string,
std::vector< Number > > 
NumericMetaDataMapType
 

Detailed Description

Class implementating Example 1.

Definition at line 274 of file MittelmannBndryCntrlDiri3D.hpp.

Constructor & Destructor Documentation

MittelmannBndryCntrlDiri3D::MittelmannBndryCntrlDiri3D ( )
inline

Definition at line 277 of file MittelmannBndryCntrlDiri3D.hpp.

virtual MittelmannBndryCntrlDiri3D::~MittelmannBndryCntrlDiri3D ( )
inlinevirtual

Definition at line 280 of file MittelmannBndryCntrlDiri3D.hpp.

MittelmannBndryCntrlDiri3D::MittelmannBndryCntrlDiri3D ( const MittelmannBndryCntrlDiri3D )
private

Member Function Documentation

virtual bool MittelmannBndryCntrlDiri3D::InitializeProblem ( Index  N)
inlinevirtual

Initialize internal parameters, where N is a parameter determining the problme size.

This returns false, if N has an invalid value.

Implements RegisteredTNLP.

Definition at line 283 of file MittelmannBndryCntrlDiri3D.hpp.

virtual Number MittelmannBndryCntrlDiri3D::y_d_cont ( Number  x1,
Number  x2,
Number  x3 
) const
inlineprotectedvirtual

Target profile function for y.

Implements MittelmannBndryCntrlDiriBase3D.

Definition at line 302 of file MittelmannBndryCntrlDiri3D.hpp.

MittelmannBndryCntrlDiri3D& MittelmannBndryCntrlDiri3D::operator= ( const MittelmannBndryCntrlDiri3D )
private

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