#include <user_input_parameters.h>

Collaboration diagram for UserInputParameters< dim >:

Public Member Functions
	UserInputParameters ()=default
	Default Constructor.

	UserInputParameters (const std::string &file_name)
	Constructor. Reads in user input parameters from file and loads them into member variables.

void	validate (const std::vector< FieldAttributes > &field_attributes, const std::vector< SolveGroup > &solve_groups)
	Ensure that the parameters are compatible with a set of fields and solvers.

std::string	parameter_summary ()
	Ensure that the parameters are compatible with a set of fields and solvers.

Private Member Functions
void	assign_spatial_discretization_parameters (dealii::ParameterHandler &parameter_handler)
	Assign the provided user inputs to parameters for anything related to the spatial discretiziation.

void	assign_temporal_discretization_parameters (dealii::ParameterHandler &parameter_handler)
	Assign the provided user inputs to parameters for anything related to the temporal discretiziation.

void	assign_linear_solve_parameters (dealii::ParameterHandler &parameter_handler)
	Assign the provided user inputs to parameters for anything related to linear solves.

void	assign_nonlinear_solve_parameters (dealii::ParameterHandler &parameter_handler)
	Assign the provided user inputs to parameters for anything related to nonlinear solves.

void	assign_output_parameters (dealii::ParameterHandler &parameter_handler)
	Assign the provided user inputs to parameters for anything related to outputs.

void	assign_checkpoint_parameters (dealii::ParameterHandler &parameter_handler)
	Assign the provided user inputs to parameters for anything related to checkpoints.

void	assign_load_initial_condition_parameters (dealii::ParameterHandler &parameter_handler)
	Assign the provided user inputs to parameters for anything related to loading in initial condition.

void	assign_nucleation_parameters (dealii::ParameterHandler &parameter_handler)
	Assign the provided user inputs to parameters for anything related to nucleation.

void	assign_grain_parameters (dealii::ParameterHandler &parameter_handler)
	Assign the provided user inputs to parameters for anything related to grain remapping and grain vtk load-in.

void	assign_boundary_parameters (dealii::ParameterHandler &parameter_handler)
	Assign the provided user inputs to parameters for anything related to boundaries.

void	assign_miscellaneous_parameters (dealii::ParameterHandler &parameter_handler)
	Assign the provided user inputs to parameters for anything related to miscellaneous parameters.

void	load_model_constants (const InputFileReader &input_file_reader, dealii::ParameterHandler &parameter_handler)
	Assign the provided user constants.

Constructor & Destructor Documentation

◆ UserInputParameters() [1/2]

template<unsigned int dim>

UserInputParameters< dim >::UserInputParameters ( )

default

Default Constructor.

◆ UserInputParameters() [2/2]

template<unsigned int dim>

PRISMS_PF_BEGIN_NAMESPACE UserInputParameters< dim >::UserInputParameters ( const std::string & file_name )

explicit

Constructor. Reads in user input parameters from file and loads them into member variables.

Member Function Documentation

◆ assign_boundary_parameters()

template<unsigned int dim>

void UserInputParameters< dim >::assign_boundary_parameters ( dealii::ParameterHandler & parameter_handler )

private

Assign the provided user inputs to parameters for anything related to boundaries.

◆ assign_checkpoint_parameters()

template<unsigned int dim>

void UserInputParameters< dim >::assign_checkpoint_parameters ( dealii::ParameterHandler & parameter_handler )

private

Assign the provided user inputs to parameters for anything related to checkpoints.

◆ assign_grain_parameters()

template<unsigned int dim>

void UserInputParameters< dim >::assign_grain_parameters ( dealii::ParameterHandler & parameter_handler )

private

Assign the provided user inputs to parameters for anything related to grain remapping and grain vtk load-in.

◆ assign_linear_solve_parameters()

template<unsigned int dim>

void UserInputParameters< dim >::assign_linear_solve_parameters ( dealii::ParameterHandler & parameter_handler )

private

Assign the provided user inputs to parameters for anything related to linear solves.

◆ assign_load_initial_condition_parameters()

template<unsigned int dim>

void UserInputParameters< dim >::assign_load_initial_condition_parameters ( dealii::ParameterHandler & parameter_handler )

private

Assign the provided user inputs to parameters for anything related to loading in initial condition.

◆ assign_miscellaneous_parameters()

template<unsigned int dim>

void UserInputParameters< dim >::assign_miscellaneous_parameters ( dealii::ParameterHandler & parameter_handler )

private

Assign the provided user inputs to parameters for anything related to miscellaneous parameters.

◆ assign_nonlinear_solve_parameters()

template<unsigned int dim>

void UserInputParameters< dim >::assign_nonlinear_solve_parameters ( dealii::ParameterHandler & parameter_handler )

private

Assign the provided user inputs to parameters for anything related to nonlinear solves.

◆ assign_nucleation_parameters()

template<unsigned int dim>

void UserInputParameters< dim >::assign_nucleation_parameters ( dealii::ParameterHandler & parameter_handler )

private

Assign the provided user inputs to parameters for anything related to nucleation.

◆ assign_output_parameters()

template<unsigned int dim>

void UserInputParameters< dim >::assign_output_parameters ( dealii::ParameterHandler & parameter_handler )

private

Assign the provided user inputs to parameters for anything related to outputs.

◆ assign_spatial_discretization_parameters()

template<unsigned int dim>

void UserInputParameters< dim >::assign_spatial_discretization_parameters ( dealii::ParameterHandler & parameter_handler )

private

Assign the provided user inputs to parameters for anything related to the spatial discretiziation.

◆ assign_temporal_discretization_parameters()

template<unsigned int dim>

void UserInputParameters< dim >::assign_temporal_discretization_parameters ( dealii::ParameterHandler & parameter_handler )

private

Assign the provided user inputs to parameters for anything related to the temporal discretiziation.

◆ load_model_constants()

template<unsigned int dim>

void UserInputParameters< dim >::load_model_constants	(	const InputFileReader &	input_file_reader,
		dealii::ParameterHandler &	parameter_handler
	)

private

Assign the provided user constants.

◆ parameter_summary()

template<unsigned int dim>

std::string UserInputParameters< dim >::parameter_summary ( )

inline

Ensure that the parameters are compatible with a set of fields and solvers.

◆ validate()

template<unsigned int dim>

void UserInputParameters< dim >::validate	(	const std::vector< FieldAttributes > &	field_attributes,
		const std::vector< SolveGroup > &	solve_groups
	)

inline

Ensure that the parameters are compatible with a set of fields and solvers.

Member Data Documentation

◆ boundary_parameters

template<unsigned int dim>

BoundaryParameters<dim> UserInputParameters< dim >::boundary_parameters

◆ checkpoint_parameters

template<unsigned int dim>

CheckpointParameters UserInputParameters< dim >::checkpoint_parameters

◆ linear_solve_parameters

template<unsigned int dim>

LinearSolveParameters UserInputParameters< dim >::linear_solve_parameters

◆ load_ic_parameters

template<unsigned int dim>

LoadInitialConditionParameters UserInputParameters< dim >::load_ic_parameters

◆ misc_parameters

template<unsigned int dim>

MiscellaneousParameters UserInputParameters< dim >::misc_parameters

◆ nonlinear_solve_parameters

template<unsigned int dim>

NonlinearSolveParameterSet UserInputParameters< dim >::nonlinear_solve_parameters

◆ nucleation_parameters

template<unsigned int dim>

NucleationParameters UserInputParameters< dim >::nucleation_parameters

◆ output_parameters

template<unsigned int dim>

OutputParameters UserInputParameters< dim >::output_parameters

◆ spatial_discretization

template<unsigned int dim>

SpatialDiscretization<dim> UserInputParameters< dim >::spatial_discretization

◆ temporal_discretization

template<unsigned int dim>

TemporalDiscretization UserInputParameters< dim >::temporal_discretization

◆ user_constants

template<unsigned int dim>

UserConstants<dim> UserInputParameters< dim >::user_constants

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

/home/runner/work/phaseField/phaseField/include/prismspf/core/initial_conditions.h
/home/runner/work/phaseField/phaseField/include/prismspf/user_inputs/user_input_parameters.h
/home/runner/work/phaseField/phaseField/src/user_inputs/user_input_parameters.cc

Public Attributes
SpatialDiscretization< dim >	spatial_discretization

TemporalDiscretization	temporal_discretization

LinearSolveParameters	linear_solve_parameters

NonlinearSolveParameterSet	nonlinear_solve_parameters

OutputParameters	output_parameters

CheckpointParameters	checkpoint_parameters

BoundaryParameters< dim >	boundary_parameters

LoadInitialConditionParameters	load_ic_parameters

NucleationParameters	nucleation_parameters

MiscellaneousParameters	misc_parameters

UserConstants< dim >	user_constants

Public Member Functions

Public Attributes

Private Member Functions

Constructor & Destructor Documentation

◆ UserInputParameters() [1/2]

◆ UserInputParameters() [2/2]

Member Function Documentation

◆ assign_boundary_parameters()

◆ assign_checkpoint_parameters()

◆ assign_grain_parameters()

◆ assign_linear_solve_parameters()

◆ assign_load_initial_condition_parameters()

◆ assign_miscellaneous_parameters()

◆ assign_nonlinear_solve_parameters()

◆ assign_nucleation_parameters()

◆ assign_output_parameters()

◆ assign_spatial_discretization_parameters()

◆ assign_temporal_discretization_parameters()

◆ load_model_constants()

◆ parameter_summary()

◆ validate()

Member Data Documentation

◆ boundary_parameters

◆ checkpoint_parameters

◆ linear_solve_parameters

◆ load_ic_parameters

◆ misc_parameters

◆ nonlinear_solve_parameters

◆ nucleation_parameters

◆ output_parameters

◆ spatial_discretization

◆ temporal_discretization

◆ user_constants