refinement_criterion.h

// SPDX-FileCopyrightText: © 2025 PRISMS Center at the University of Michigan
// SPDX-License-Identifier: GNU Lesser General Public Version 2.1
 
#ifndef refinement_criterion_h
#define refinement_criterion_h
 
#include <prismspf/config.h>
 
#include <cfloat>
#include <cstdint>
#include <string>
 
PRISMS_PF_BEGIN_NAMESPACE
 
namespace GridRefinement
{
  enum RefinementFlags : std::uint8_t
  {
    nothing = 0,
 
    value = 0x0001,
 
    gradient = 0x0002,
  };
 
  // Function that enables bitwise OR between flags
  inline RefinementFlags
  operator|(const RefinementFlags flag_1, const RefinementFlags flag_2)
  {
    return static_cast<RefinementFlags>(static_cast<unsigned int>(flag_1) |
                                        static_cast<unsigned int>(flag_2));
  }
 
  // Function that enables bitwise compound OR between flags
  inline RefinementFlags &
  operator|=(RefinementFlags &flag_1, const RefinementFlags flag_2)
  {
    flag_1 = flag_1 | flag_2;
    return flag_1;
  }
 
  // Function that enables bitwise AND between flags
  inline RefinementFlags
  operator&(const RefinementFlags flag_1, const RefinementFlags flag_2)
  {
    return static_cast<RefinementFlags>(static_cast<unsigned int>(flag_1) &
                                        static_cast<unsigned int>(flag_2));
  }
 
  // Function that enables bitwise compound AND between flags
  inline RefinementFlags &
  operator&=(RefinementFlags &flag_1, const RefinementFlags flag_2)
  {
    flag_1 = flag_1 & flag_2;
    return flag_1;
  }
 
  class RefinementCriterion
  {
  public:
    std::string     variable_name;
    unsigned int    variable_index       = 0;
    RefinementFlags criterion_type       = RefinementFlags::nothing;
    double          value_lower_bound    = DBL_MAX;
    double          value_upper_bound    = DBL_MAX;
    double          gradient_lower_bound = DBL_MAX;
 
    [[nodiscard]] std::string
    criterion_to_string() const
    {
      if (criterion_type == RefinementFlags::nothing)
        {
          return "None";
        }
      if (((criterion_type & RefinementFlags::value) != 0U) &&
          ((criterion_type & RefinementFlags::gradient) != 0U))
        {
          return "Value and gradient";
        }
      if ((criterion_type & RefinementFlags::value) != 0U)
        {
          return "Value";
        }
      if ((criterion_type & RefinementFlags::gradient) != 0U)
        {
          return "Gradient";
        }
 
      return "Unknown criterion";
    }
    criterion_to_string() const {…}
  };
  class RefinementCriterion {…};
} // namespace GridRefinement
 
PRISMS_PF_END_NAMESPACE
 
#endif