/* ***********************************************************************
//
//   Copyright (C) 2025 -- The 4D-STAR Collaboration
//   File Author: Emily Boudreaux
//   Last Modified: March 19, 2025
//
//   4DSSE is free software; you can use it and/or modify
//   it under the terms and restrictions the GNU General Library Public
//   License version 3 (GPLv3) as published by the Free Software Foundation.
//
//   4DSSE is distributed in the hope that it will be useful,
//   but WITHOUT ANY WARRANTY; without even the implied warranty of
//   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
//   See the GNU Library General Public License for more details.
//
//   You should have received a copy of the GNU Library General Public License
//   along with this software; if not, write to the Free Software
//   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
//
// *********************************************************************** */
#ifndef POLYMFEMUTILS_H
#define POLYMFEMUTILS_H

#include "mfem.hpp"
#include <string>
#include "config.h"
#include "probe.h"


/**
 * @file polyMFEMUtils.h
 * @brief A collection of utilities for working with MFEM and solving the lane-emden equation.
 */


/**
 * @namespace polyMFEMUtils
 * @brief A namespace for utilities for working with MFEM and solving the lane-emden equation.
 */
namespace polyMFEMUtils {
  /**
   * @brief A class for nonlinear power integrator.
   */
  class NonlinearPowerIntegrator: public mfem::NonlinearFormIntegrator {
  private: 
    Config& m_config = Config::getInstance();
    Probe::LogManager& m_logManager = Probe::LogManager::getInstance();
    quill::Logger* m_logger = m_logManager.getLogger("log");
    mfem::Coefficient &m_coeff;
    double m_polytropicIndex;
  public:
    /**
     * @brief Constructor for NonlinearPowerIntegrator.
     * 
     * @param coeff The function coefficient.
     * @param n The polytropic index.
     */
    NonlinearPowerIntegrator(mfem::Coefficient &coeff, double n);

    /**
     * @brief Assembles the element vector.
     * 
     * @param el The finite element.
     * @param Trans The element transformation.
     * @param elfun The element function.
     * @param elvect The element vector to be assembled.
     */
     virtual void AssembleElementVector(const mfem::FiniteElement &el, mfem::ElementTransformation &Trans, const mfem::Vector &elfun, mfem::Vector &elvect) override;
    /**
     * @brief Assembles the element gradient.
     * 
     * @param el The finite element.
     * @param Trans The element transformation.
     * @param elfun The element function.
     * @param elmat The element matrix to be assembled.
     */
     virtual void AssembleElementGrad (const mfem::FiniteElement &el, mfem::ElementTransformation &Trans, const mfem::Vector &elfun, mfem::DenseMatrix &elmat) override;
  };
} // namespace polyMFEMUtils

#endif // POLYMFEMUTILS_H