input_file_reader.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: © 2025 PRISMS Center at the University of Michigan
// SPDX-License-Identifier: GNU Lesser General Public Version 2.1
 
#pragma once
 
#include <deal.II/base/parameter_handler.h>
 
#include <prismspf/config.h>
 
#include <set>
#include <string>
 
PRISMS_PF_BEGIN_NAMESPACE
 
class InputFileReader
{
public:
  explicit InputFileReader(std::string input_file_name);
 
  [[nodiscard]] std::set<std::string>
  get_model_constant_names();
 
  [[nodiscard]] dealii::ParameterHandler &
  get_parameter_handler()
  {
    return parameter_handler;
  }
 
  [[nodiscard]] const std::set<std::string> &
  get_model_constant_names() const
  {
    return model_constant_names;
  }
 
  void
  declare_parameters();
 
  bool
  parse_line(std::string        line,
             const std::string &keyword,
             const std::string &entry_name,
             std::string       &out_string,
             bool               expect_equals_sign);
 
  void
  strip_spaces(std::string &line);
 
  bool
  check_keyword_match(const std::string &line, const std::string &keyword);
 
  void
  declare_mesh();
 
  void
  declare_time_discretization();
 
  void
  declare_solver_parameters();
 
  void
  declare_output_parameters();
 
  void
  declare_load_ic_parameters();
 
  void
  declare_checkpoint_parameters();
 
  void
  declare_bc_parameters();
 
  void
  declare_nucleation_parameters();
 
  void
  declare_grain_remapping_parameters();
 
  void
  declare_grain_loading_parameters();
 
  void
  declare_miscellaneous_parameters();
 
  void
  declare_model_constants();
 
  static constexpr unsigned int max_criteria = 16;
 
private:
  std::string              parameters_file_name;
  dealii::ParameterHandler parameter_handler;
  std::set<std::string>    model_constant_names;
};
 
PRISMS_PF_END_NAMESPACE