Public Member Functions
	userInputParameters (inputFileReader &input_file_reader, dealii::ParameterHandler &parameter_handler)
	Constructor. Reads in user input parameters from file and loads them into member variables.

void	load_BC_list (const std::vector< std::string > &list_of_BCs)
	Creates a list of BCs to store in BC_list object.

void	assign_boundary_conditions (std::vector< std::string > &boundary_condition_list, varBCs< dim > &boundary_condition)
	Assign the boundary condition to the varBC<dim> object given some boundary condition string vector.

double	get_model_constant_double (const std::string &constant_name) const
	Retrieve the double from the `model_constants` that are defined from the parameters.prm parser. This is essentially just a wrapper for boost::get.

int	get_model_constant_int (const std::string &constant_name) const
	Retrieve the int from the `model_constants` that are defined from the parameters.prm parser. This is essentially just a wrapper for boost::get.

bool	get_model_constant_bool (const std::string &constant_name) const
	Retrieve the bool from the `model_constants` that are defined from the parameters.prm parser. This is essentially just a wrapper for boost::get.

dealii::Tensor< 1, dim >	get_model_constant_rank_1_tensor (const std::string &constant_name) const
	Retrieve the rank 1 tensor from the `model_constants` that are defined from the parameters.prm parser. This is essentially just a wrapper for boost::get.

dealii::Tensor< 2, dim >	get_model_constant_rank_2_tensor (const std::string &constant_name) const
	Retrieve the rank 2 tensor from the `model_constants` that are defined from the parameters.prm parser. This is essentially just a wrapper for boost::get.

dealii::Tensor< 2, 2 *dim - 1+dim/3 >	get_model_constant_elasticity_tensor (const std::string &constant_name) const
	Retrieve the elasticity tensor from the `model_constants` that are defined from the parameters.prm parser. This is essentially just a wrapper for boost::get.

void	loadVariableAttributes ()

std::vector< double >	get_nucleus_semiaxes (unsigned int var_index) const

std::vector< double >	get_nucleus_freeze_semiaxes (unsigned int var_index) const

std::vector< double >	get_nucleus_rotation (unsigned int var_index) const

double	get_no_nucleation_border_thickness (unsigned int var_index) const

double	get_nucleus_hold_time (unsigned int var_index) const

dealii::Tensor< 2, dim, double >	get_nucleus_rotation_matrix (unsigned int var_index) const

Public Attributes
std::vector< double >	domain_size

std::vector< unsigned int >	subdivisions

unsigned int	refine_factor

unsigned int	degree

bool	h_adaptivity

unsigned int	max_refinement_level

unsigned int	min_refinement_level

unsigned int	skip_remeshing_steps

std::vector< RefinementCriterion >	refinement_criteria

unsigned int	skip_print_steps

std::string	output_file_type

bool	output_vtu_per_process

std::string	output_file_name

std::vector< unsigned int >	outputTimeStepList

bool	print_timing_with_output

double	dtValue

double	finalTime

unsigned int	totalIncrements

LinearSolverParameters	linear_solver_parameters

NonlinearSolverParameters	nonlinear_solver_parameters

boost::unordered_map< unsigned int, dealii::Point< dim > >	pinned_point

const AttributesList &	var_attributes

const AttributesList &	pp_attributes

unsigned int	num_var_explicit_RHS

unsigned int	num_var_nonexplicit_RHS

std::vector< variable_info >	varInfoListExplicitRHS

std::vector< variable_info >	varInfoListNonexplicitRHS

unsigned int	num_var_LHS

std::vector< variable_info >	varInfoListLHS

std::vector< variable_info >	varChangeInfoListLHS

std::vector< bool >	load_ICs

std::vector< bool >	load_parallel_file

std::vector< std::string >	load_file_name

std::vector< std::string >	load_field_name

bool	resume_from_checkpoint

std::vector< unsigned int >	checkpointTimeStepList

unsigned int	num_integrated_fields

bool	postProcessingRequired

std::vector< unsigned int >	integrated_field_indices

std::vector< variable_info >	pp_varInfoList

std::vector< variable_info >	pp_baseVarInfoList

std::vector< varBCs< dim > >	BC_list

std::map< std::string, InputVariant< dim > >	model_constants

bool	nucleation_occurs

std::vector< unsigned int >	nucleating_variable_indices

std::vector< unsigned int >	nucleation_need_value

bool	evolution_before_nucleation

double	min_distance_between_nuclei

double	nucleation_order_parameter_cutoff

unsigned int	steps_between_nucleation_attempts

double	nucleation_start_time

double	nucleation_end_time

bool	grain_remapping_activated

std::vector< unsigned int >	variables_for_remapping

unsigned int	skip_grain_reassignment_steps

double	order_parameter_threshold

double	buffer_between_grains

bool	load_grain_structure

std::string	load_vtk_file_type

double	min_radius_for_loading_grains

std::string	grain_structure_filename

std::string	grain_structure_variable_name

unsigned int	num_grain_smoothing_cycles

Member Function Documentation

◆ get_model_constant_bool()

template<int dim>

bool userInputParameters< dim >::get_model_constant_bool ( const std::string & constant_name ) const

inline

Retrieve the bool from the model_constants that are defined from the parameters.prm parser. This is essentially just a wrapper for boost::get.

Parameters

constant_name Name of the constant to retrieve.

◆ get_model_constant_double()

template<int dim>

double userInputParameters< dim >::get_model_constant_double ( const std::string & constant_name ) const

inline

Retrieve the double from the model_constants that are defined from the parameters.prm parser. This is essentially just a wrapper for boost::get.

Parameters

constant_name Name of the constant to retrieve.

◆ get_model_constant_elasticity_tensor()

template<int dim>

dealii::Tensor< 2, 2 *dim - 1+dim/3 > userInputParameters< dim >::get_model_constant_elasticity_tensor ( const std::string & constant_name ) const

inline

Retrieve the elasticity tensor from the model_constants that are defined from the parameters.prm parser. This is essentially just a wrapper for boost::get.

Parameters

constant_name Name of the constant to retrieve.

◆ get_model_constant_int()

template<int dim>

int userInputParameters< dim >::get_model_constant_int ( const std::string & constant_name ) const

inline

Retrieve the int from the model_constants that are defined from the parameters.prm parser. This is essentially just a wrapper for boost::get.

Parameters

constant_name Name of the constant to retrieve.

◆ get_model_constant_rank_1_tensor()

template<int dim>

dealii::Tensor< 1, dim > userInputParameters< dim >::get_model_constant_rank_1_tensor ( const std::string & constant_name ) const

inline

Retrieve the rank 1 tensor from the model_constants that are defined from the parameters.prm parser. This is essentially just a wrapper for boost::get.

Parameters

constant_name Name of the constant to retrieve.

◆ get_model_constant_rank_2_tensor()

template<int dim>

dealii::Tensor< 2, dim > userInputParameters< dim >::get_model_constant_rank_2_tensor ( const std::string & constant_name ) const

inline

Retrieve the rank 2 tensor from the model_constants that are defined from the parameters.prm parser. This is essentially just a wrapper for boost::get.

Parameters

constant_name Name of the constant to retrieve.

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

/home/runner/work/phaseField/phaseField/include/core/userInputParameters.h
/home/runner/work/phaseField/phaseField/src/core/userInputParameters.cc

Public Member Functions

Public Attributes

Member Function Documentation

◆ get_model_constant_bool()

◆ get_model_constant_double()

◆ get_model_constant_elasticity_tensor()

◆ get_model_constant_int()

◆ get_model_constant_rank_1_tensor()

◆ get_model_constant_rank_2_tensor()