cl_Optimizer.hpp

Go to the documentation of this file.

/*
 * BELFEM -- The Berkeley Lab Finite Element Framework
 * Copyright (c) 2026, The Regents of the University of California,
 * through Lawrence Berkeley National Laboratory (subject to receipt of any required
 * approvals from the U.S. Dept. of Energy).  All rights reserved.
 *
 * Developers: Christian Messe, Gregory Giard
 *
 * See the top-level LICENSE file for the complete license and disclaimer.
 */
 
#ifndef BELFEM_CL_OPTIMIZER_HPP
#define BELFEM_CL_OPTIMIZER_HPP
 
#include "typedefs.hpp"
#include "cl_Vector.hpp"
#include "cl_Objective.hpp"
#include "en_Opt_Algorithm.hpp"
#include "en_Opt_Status.hpp"
 
namespace belfem
{
    namespace opt
    {
//------------------------------------------------------------------------------

        class Optimizer
        {
            // objective to be minimized or maximized
            Objective & mObjective;
 
            // algorithm used for this optimizer
            Algorithm mAlgorithm;
 
            // lower / upper bounds on the design variables. Set together via
            // set_bounds(); both left empty means an unbounded problem.
            Vector< real > mLowerBounds;
            Vector< real > mUpperBounds;
 
            // relative tolerance on the objective value
            real mFtolRel = 1.0e-8;
 
            // relative tolerance on the design vector
            real mXtolRel = 1.0e-8;
 
            // maximum number of objective evaluations
            uint mMaxEval = 1000;
 
            // if true, the objective is maximized instead of minimized
            bool mMaximize = false;
 
            // detailed diagnostic from the solver library for the most recent
            // optimize() call; empty when no detail was reported
            string mErrmsg;
 
//------------------------------------------------------------------------------
        public:
//------------------------------------------------------------------------------
 
            Optimizer( Objective & aObjective, const Algorithm aAlgorithm );
 
//------------------------------------------------------------------------------
 
            ~Optimizer() = default;
 
//------------------------------------------------------------------------------

            void
            set_bounds(
                    const Vector< real > & aLowerBounds,
                    const Vector< real > & aUpperBounds );
 
//------------------------------------------------------------------------------

            Status
            optimize( Vector< real > & aX, real & aValue );
 
//------------------------------------------------------------------------------

            inline const string &
            errmsg() const;
 
//------------------------------------------------------------------------------

            inline real &
            ftol_rel();
 
//------------------------------------------------------------------------------

            inline real &
            xtol_rel();
 
//------------------------------------------------------------------------------

            inline uint &
            max_eval();
 
//------------------------------------------------------------------------------

            inline bool &
            maximize();
 
//------------------------------------------------------------------------------

            inline const Algorithm &
            algorithm() const;
 
//------------------------------------------------------------------------------
        };
 
//------------------------------------------------------------------------------
 
        inline real &
        Optimizer::ftol_rel()
        {
            return mFtolRel;
        }
 
//------------------------------------------------------------------------------
 
        inline real &
        Optimizer::xtol_rel()
        {
            return mXtolRel;
        }
 
//------------------------------------------------------------------------------
 
        inline uint &
        Optimizer::max_eval()
        {
            return mMaxEval;
        }
 
//------------------------------------------------------------------------------
 
        inline bool &
        Optimizer::maximize()
        {
            return mMaximize;
        }
 
//------------------------------------------------------------------------------
 
        inline const Algorithm &
        Optimizer::algorithm() const
        {
            return mAlgorithm;
        }
 
//------------------------------------------------------------------------------
 
        inline const string &
        Optimizer::errmsg() const
        {
            return mErrmsg;
        }
 
//------------------------------------------------------------------------------
    }
}
#endif //BELFEM_CL_OPTIMIZER_HPP