en_Opt_Status.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_EN_OPT_STATUS_HPP
#define BELFEM_EN_OPT_STATUS_HPP
 
#include "typedefs.hpp"
 
namespace belfem
{
    namespace opt
    {
        enum class Status
        {
            // --- success: the optimizer converged on a stopping criterion ---
            SUCCESS          = 0, // generic success
            STOPVAL_REACHED  = 1, // objective dropped below the stop value
            FTOL_REACHED     = 2, // relative change of objective below ftol
            XTOL_REACHED     = 3, // relative change of design vector below xtol
            MAXEVAL_REACHED  = 4, // reached the maximum number of evaluations
            MAXTIME_REACHED  = 5, // reached the maximum wall-clock time
 
            // --- failure: no usable result was produced -------------------
            FAILURE          = 6, // generic failure
            INVALID_ARGS     = 7, // bounds/tolerances inconsistent
            OUT_OF_MEMORY    = 8, // allocation failed
            ROUNDOFF_LIMITED = 9, // halted by roundoff, result may be inaccurate
            FORCED_STOP      = 10 // objective requested an early stop
        };
 
//------------------------------------------------------------------------------

        inline bool
        is_success( const Status aStatus )
        {
            return aStatus <= Status::MAXTIME_REACHED;
        }
 
//------------------------------------------------------------------------------

        inline bool
        is_usable( const Status aStatus )
        {
            return is_success( aStatus )
                || aStatus == Status::ROUNDOFF_LIMITED
                || aStatus == Status::FORCED_STOP;
        }
 
//------------------------------------------------------------------------------

        string
        error_message( const Status aStatus );
 
//------------------------------------------------------------------------------
    }
}
#endif //BELFEM_EN_OPT_STATUS_HPP