cl_Objective.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_OBJECTIVE_HPP
#define BELFEM_CL_OBJECTIVE_HPP
 
#include "typedefs.hpp"
#include "cl_Vector.hpp"
 
namespace belfem
{
    namespace opt
    {
//------------------------------------------------------------------------------

        class Objective
        {
            // number of design variables
            const uint mDimension;
 
//------------------------------------------------------------------------------
        public:
//------------------------------------------------------------------------------
 
            Objective( const uint aDimension ) :
                mDimension( aDimension )
            {};
 
//------------------------------------------------------------------------------
 
            virtual ~Objective() = default;
 
//------------------------------------------------------------------------------

            virtual real
            compute_objective(
                    const Vector< real > & aX,
                          Vector< real > & aGradient ) = 0;
 
//------------------------------------------------------------------------------

            inline uint
            dimension() const
            {
                return mDimension;
            }
 
//------------------------------------------------------------------------------
        };
    }
}
#endif //BELFEM_CL_OBJECTIVE_HPP