ObjectiveFunctionData.hpp

Go to the documentation of this file.

/**
 * @file ObjectiveFunctionData.hpp
 * @brief Interface for Python-based objective function evaluation in topology optimization
 * @details Provides abstract interface and implementation for objective function evaluation
 *          using Python with NumPy integration, enabling flexible objective function
 *          definition for adjoint-based topology optimization
 */
 
#ifndef __OBJECTIVE_FUNCTION_DATA_HPP__
#define __OBJECTIVE_FUNCTION_DATA_HPP__
 
namespace ShapeOptimization {
 
/**
 * @brief Abstract interface for Python-defined objective functions
 * 
 * This interface allows users to define custom objective functions in Python
 * that can be called from C++ during the optimization process. The objective
 * function and its gradients are evaluated at integration points using:
 * - Coordinates of integration points
 * - Displacement field values
 * - Stress and strain tensors
 * 
 * Key methods:
 * - evalInteriorObjectiveFunction: Compute f(x,u,σ,ε) 
 * - evalInteriorObjectiveGradientStress: Compute ∂f/∂σ
 * - evalInteriorObjectiveGradientStrain: Compute ∂f/∂ε
 * - numberOfModes: Return number of topology modes for optimization
 * - blockModes: Define spatial topology modes for shape optimization
 */
struct ObjectiveFunctionData {
 
  /// Evaluate objective function f(coords, u, stress, strain)
  virtual MoFEMErrorCode evalInteriorObjectiveFunction(
      MatrixDouble &coords, boost::shared_ptr<MatrixDouble> u_ptr,
      boost::shared_ptr<MatrixDouble> stress_ptr,
      boost::shared_ptr<MatrixDouble> strain_ptr,
      boost::shared_ptr<VectorDouble> o_ptr, bool symmetrize = true) = 0;
 
  /// Evaluate gradient of objective function w.r.t. stress: ∂f/∂σ
  virtual MoFEMErrorCode evalInteriorObjectiveGradientStress(
      MatrixDouble &coords, boost::shared_ptr<MatrixDouble> u_ptr,
      boost::shared_ptr<MatrixDouble> stress_ptr,
      boost::shared_ptr<MatrixDouble> strain_ptr,
      boost::shared_ptr<MatrixDouble> o_ptr, bool symmetrize = true) = 0;
 
  /// Evaluate gradient of objective function w.r.t. strain: ∂f/∂ε
  virtual MoFEMErrorCode evalInteriorObjectiveGradientStrain(
      MatrixDouble &coords, boost::shared_ptr<MatrixDouble> u_ptr,
      boost::shared_ptr<MatrixDouble> stress_ptr,
      boost::shared_ptr<MatrixDouble> strain_ptr,
      boost::shared_ptr<MatrixDouble> o_ptr, bool symmetrize = true) = 0;
 
  /// Evaluate gradient of objective function w.r.t. displacement: ∂f/∂u
  virtual MoFEMErrorCode evalInteriorObjectiveGradientU(
      MatrixDouble &coords, boost::shared_ptr<MatrixDouble> u_ptr,
      boost::shared_ptr<MatrixDouble> stress_ptr,
      boost::shared_ptr<MatrixDouble> strain_ptr,
      boost::shared_ptr<MatrixDouble> o_ptr, bool symmetrize = true) = 0;
 
  virtual MoFEMErrorCode evalBoundaryObjectiveFunction(
      MatrixDouble &coords, boost::shared_ptr<MatrixDouble> u_ptr,
      boost::shared_ptr<MatrixDouble> t_ptr,
      boost::shared_ptr<VectorDouble> o_ptr, bool symmetrize = true) = 0;
 
  /// Evaluate gradient of objective function w.r.t. traction-like vector field
  virtual MoFEMErrorCode evalBoundaryObjectiveGradientTraction(
      MatrixDouble &coords, boost::shared_ptr<MatrixDouble> u_ptr,
      boost::shared_ptr<MatrixDouble> t_ptr,
      boost::shared_ptr<MatrixDouble> o_ptr) = 0;
 
  virtual MoFEMErrorCode evalBoundaryObjectiveGradientU(
      MatrixDouble &coords, boost::shared_ptr<MatrixDouble> u_ptr,
      boost::shared_ptr<MatrixDouble> t_ptr,
      boost::shared_ptr<MatrixDouble> o_ptr) = 0;
 
  /// Return number of topology optimization modes for given block
  virtual MoFEMErrorCode numberOfModes(int block_id, int &modes) = 0;
 
  /// Define spatial modes for topology optimization
  virtual MoFEMErrorCode blockModes(int block_id, MatrixDouble &coords,
                                    std::array<double, 3> &centroid,
                                    std::array<double, 6> &bbox,
                                    MatrixDouble &o_ptr) = 0;
 
  virtual ~ObjectiveFunctionData() = default;
};
 
boost::shared_ptr<ObjectiveFunctionData>
create_python_objective_function(std::string py_file);
 
} // namespace ShapeOptimization
 
#endif // __OBJECTIVE_FUNCTION_DATA_HPP__