field_modifier.hpp

Go to the documentation of this file.

// SPDX-FileCopyrightText: 2025 VTT Technical Research Centre of Finland Ltd
// SPDX-License-Identifier: AGPL-3.0-or-later
 
#ifndef PFC_FIELD_MODIFIER_HPP
#define PFC_FIELD_MODIFIER_HPP
 
#include "constants.hpp"
#include "model.hpp"
 
namespace pfc {
 
class FieldModifier {
 
private:
  std::string m_field_name = "default";
  std::string m_default_name = "default";
 
public:
  // Future enhancement: Support modifying multiple fields in one modifier
  // virtual void apply(Model &model, const std::string &field_name, double time) =
  // 0;
 
  void set_field_name(const std::string &field_name) {
    if (field_name.empty()) {
      throw std::invalid_argument("Field name cannot be empty");
    }
    m_field_name = field_name;
  }
 
  const std::string &get_field_name() const { return m_field_name; }
 
  virtual const std::string &get_modifier_name() const { return m_default_name; }
 
  virtual void apply(Model &model, double time) = 0;
 
  virtual ~FieldModifier() = default;
};
 
} // namespace pfc
 
#endif // PFC_FIELD_MODIFIER_HPP