variable_attribute_loader.h

// SPDX-FileCopyrightText: © 2025 PRISMS Center at the University of Michigan
// SPDX-License-Identifier: GNU Lesser General Public Version 2.1
 
#ifndef variable_attribute_loader_h
#define variable_attribute_loader_h
 
#include <prismspf/config.h>
#include <prismspf/core/type_enums.h>
#include <prismspf/core/variable_attributes.h>
 
#include <map>
#include <string>
 
PRISMS_PF_BEGIN_NAMESPACE
 
class variableAttributeLoader
{
public:
  variableAttributeLoader() = default;
 
  virtual ~variableAttributeLoader() = default;
 
  void
  init_variable_attributes();
 
  [[nodiscard]] std::map<unsigned int, variableAttributes>
  get_var_attributes() const;
 
protected:
  virtual void
  loadVariableAttributes();
 
  void
  set_variable_name(const unsigned int &index, const std::string &name);
 
  void
  set_variable_type(const unsigned int &index, const fieldType &field_type);
 
  void
  set_variable_equation_type(const unsigned int &index, const PDEType &pde_type);
 
  void
  set_is_postprocessed_field(const unsigned int &index, const bool &is_postprocess);
 
  void
  set_dependencies_value_term_RHS(const unsigned int &index,
                                  const std::string  &dependencies);
 
  void
  set_dependencies_gradient_term_RHS(const unsigned int &index,
                                     const std::string  &dependencies);
 
  void
  set_dependencies_value_term_LHS(const unsigned int &index,
                                  const std::string  &dependencies);
 
  void
  set_dependencies_gradient_term_LHS(const unsigned int &index,
                                     const std::string  &dependencies);
 
  template <typename Iterable>
  void
  insert_dependencies_value_term_RHS(const unsigned int &index,
                                     const Iterable     &dependencies);
 
  template <typename Iterable>
  void
  insert_dependencies_gradient_term_RHS(const unsigned int &index,
                                        const Iterable     &dependencies);
 
  template <typename Iterable>
  void
  insert_dependencies_value_term_LHS(const unsigned int &index,
                                     const Iterable     &dependencies);
 
  template <typename Iterable>
  void
  insert_dependencies_gradient_term_LHS(const unsigned int &index,
                                        const Iterable     &dependencies);
 
private:
  std::map<unsigned int, variableAttributes> var_attributes;
 
  void
  validate_attributes();
 
  void
  validate_variable_name(const std::string           &name,
                         const std::set<std::string> &forbidden_names,
                         const std::string           &context,
                         unsigned int                 index);
 
  void
  populate_dependencies(
    const std::set<std::pair<std::string, std::string>> &reg_delimiters,
    const std::set<std::pair<std::string, std::string>> &dep_type_delimiters,
    const std::string                                   &variable_name,
    unsigned int                                         index,
    std::set<std::string>                               &reg_possible_deps,
    std::map<unsigned int, std::set<std::string>>       &change_possible_deps);
 
  void
  validate_dependencies(
    const std::set<std::string>                         &dependencies,
    const std::string                                   &context,
    unsigned int                                         index,
    const std::string                                   &variable_name,
    const std::set<std::string>                         &reg_possible_deps,
    const std::map<unsigned int, std::set<std::string>> &change_possible_deps);
 
  void
  validate_old_solution_dependencies();
 
  static std::string
  strip_whitespace(const std::string &text);
  // The above function should be moved to a 'utilities' module
};
class variableAttributeLoader {…};
 
// Template derived class for variableAttributeLoader for applications.
// `loadVariableAttributes()` and `loadPostProcessorVariableAttributes()` are should be
// filled out in all the applications.
class customAttributeLoader : public variableAttributeLoader
{
public:
  ~customAttributeLoader() override = default;
 
  void
  loadVariableAttributes() override;
};
class customAttributeLoader : public variableAttributeLoader {…};
 
PRISMS_PF_END_NAMESPACE
 
#endif