inputFileReader Class Reference

Parameters file reader. Declares parameter names in a dealii parameter_handler and parses the file for the values. Variable assignment occurs in userInputParameters. More...

#include <inputFileReader.h>

Public Member Functions
	inputFileReader (const std::string &input_file_name, const AttributesList &_var_attributes, const AttributesList &_pp_attributes)
	Constructor.
std::vector< std::string >	get_subsection_entry_list (const std::string &subsec_name, const std::string &entry_name, const std::string &default_entry)
	Method to get a list of entry values from multiple subsections in an input file.
std::set< std::string >	get_model_constant_names ()
	Get the trailing part of the entry name after a specified string (used to extract the model constant names).
void	declare_parameters ()
	Method to declare the parameters to be read from an input file.
void	declare_mesh ()
	Declare parameters for the mesh.
void	declare_time_discretization ()
	Declare parameters for timestepping.
void	declare_solver_parameters ()
	Declare parameters for linear and nonlinear solvers.
void	declare_output_parameters ()
	Declare parameters for outputs.
void	declare_load_IC_parameters ()
	Declare parameters for loading ICs from files.
void	declare_checkpoint_parameters ()
	Declare parameters for checkpoints.
void	declare_BC_parameters ()
	Declare parameters for boundary conditions.
void	declare_pinning_parameters ()
	Declare parameters for pinned points.
void	declare_nucleation_parameters ()
	Declare parameters for nucleation.
void	declare_grain_remapping_parameters ()
	Declare parameters for grain remapping.
void	declare_grain_loading_parameters ()
	Declare parameters for grain structure loading.
void	declare_model_constants ()
	Declare parameters for user-defined model constants.

Static Public Member Functions
static bool	parse_line (std::string line, const std::string &keyword, const std::string &entry_name, std::string &out_string, bool expect_equals_sign)
	Method to check if a line has the desired contents and if so, extract it.
static void	strip_spaces (std::string &line)
	Strip spaces from the front and back of a string.
static bool	check_keyword_match (std::string &line, const std::string &keyword)
	Check whether a string starts with a keyword.

Public Attributes
const std::string	parameters_file_name
const AttributesList &	var_attributes
const AttributesList &	pp_attributes
dealii::ParameterHandler	parameter_handler
std::set< std::string >	model_constant_names
unsigned int	number_of_dimensions

Detailed Description

Parameters file reader. Declares parameter names in a dealii parameter_handler and parses the file for the values. Variable assignment occurs in userInputParameters.

---

The documentation for this class was generated from the following files:

• /home/runner/work/phaseField/phaseField/include/core/inputFileReader.h
• /home/runner/work/phaseField/phaseField/src/core/inputFileReader.cc