////////////////////////////////////////////////////////////////////////////////
//
//  File: OptimiseObj.h
//
//  For more information, please see: http://www.nektar.info/
//
//  The MIT License
//
//  Copyright (c) 2006 Division of Applied Mathematics, Brown University (USA),
//  Department of Aeronautics, Imperial College London (UK), and Scientific
//  Computing and Imaging Institute, University of Utah (USA).
//
//  Permission is hereby granted, free of charge, to any person obtaining a
//  copy of this software and associated documentation files (the "Software"),
//  to deal in the Software without restriction, including without limitation
//  the rights to use, copy, modify, merge, publish, distribute, sublicense,
//  and/or sell copies of the Software, and to permit persons to whom the
//  Software is furnished to do so, subject to the following conditions:
//
//  The above copyright notice and this permission notice shall be included
//  in all copies or substantial portions of the Software.
//
//  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
//  OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
//  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
//  THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
//  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
//  FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
//  DEALINGS IN THE SOFTWARE.
//
//  Description:
//
////////////////////////////////////////////////////////////////////////////////

#ifndef NEKTAR_MESHUTILS_OPTIMISATION_OPTIMISEOBJ_H
#define NEKTAR_MESHUTILS_OPTIMISATION_OPTIMISEOBJ_H

#include <LibUtilities/LinearAlgebra/NekTypeDefs.hpp>

namespace Nektar::NekMesh
{

class OptiObj
{
public:
    OptiObj()
    {
    }

    virtual ~OptiObj()
    {
    }

    virtual NekDouble F([[maybe_unused]] Array<OneD, NekDouble> xitst)
    {
        NEKERROR(ErrorUtil::efatal,
                 "F() should be implemented in inheriting class");
        return 0.0;
    }

    virtual DNekMat dF([[maybe_unused]] Array<OneD, NekDouble> xitst)
    {
        NEKERROR(ErrorUtil::efatal,
                 "dF() should be implemented in inheriting class");
        return DNekMat(1, 1, 0.0);
    }

    virtual Array<OneD, NekDouble> Getxi()
    {
        NEKERROR(ErrorUtil::efatal,
                 "Getxi() should be implemented in inheriting class");
        return Array<OneD, NekDouble>();
    }

    virtual Array<OneD, NekDouble> Getli()
    {
        NEKERROR(ErrorUtil::efatal,
                 "Getli() should be implemented in inheriting class");
        return Array<OneD, NekDouble>();
    }

    virtual Array<OneD, NekDouble> Getui()
    {
        NEKERROR(ErrorUtil::efatal,
                 "Getui() should be implemented in inheriting class");
        return Array<OneD, NekDouble>();
    }

    virtual void Update([[maybe_unused]] Array<OneD, NekDouble> xinew)
    {
        NEKERROR(ErrorUtil::efatal,
                 "Update() should be implemented in inheriting class");
    }
};
typedef std::shared_ptr<OptiObj> OptiObjSharedPtr;

} // namespace Nektar::NekMesh
#endif
