UserInputParameters< dim > Struct Template Reference

#include <user_input_parameters.h>

Collaboration diagram for UserInputParameters< dim >:

Public Member Functions
	UserInputParameters ()=default
	Default Constructor.
	UserInputParameters (const std::string &file_name, unsigned int max_criteria=default_max_criteria)
	Constructor. Reads in user input parameters from file and loads them into member variables.
void	declare_parameters (dealii::ParameterHandler &parameter_handler, unsigned int max_criteria=default_max_criteria) const
	Tell parameter handler to expect the parameters by declaring them.
void	assign_parameters (dealii::ParameterHandler &parameter_handler, unsigned int max_criteria=default_max_criteria)
	Read the parameters from the parameter handler and assign them to the appropriate member variables.
void	validate (const std::vector< FieldAttributes > &field_attributes, const std::vector< SolveBlock > &solve_blocks)
	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.

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

Static Public Attributes
static constexpr unsigned int	default_max_criteria = 5
	Number of subsections to declare for certain field and solver parameters.

Constructor & Destructor Documentation

UserInputParameters() [1/2]

template<unsigned int dim>

UserInputParameters< dim >::UserInputParameters ( )

default

Default Constructor.

UserInputParameters() [2/2]

template<unsigned int dim>

UserInputParameters< dim >::UserInputParameters ( const std::string & file_name, unsigned int max_criteria = default_max_criteria )

inlineexplicit

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

Member Function Documentation

assign_parameters()

template<unsigned int dim>

void UserInputParameters< dim >::assign_parameters ( dealii::ParameterHandler & parameter_handler, unsigned int max_criteria = default_max_criteria )

inline

Read the parameters from the parameter handler and assign them to the appropriate member variables.

declare_parameters()

template<unsigned int dim>

void UserInputParameters< dim >::declare_parameters ( dealii::ParameterHandler & parameter_handler, unsigned int max_criteria = default_max_criteria ) const

inline

Tell parameter handler to expect the parameters by declaring them.

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< SolveBlock > & solve_blocks )

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

default_max_criteria

template<unsigned int dim>

unsigned int UserInputParameters< dim >::default_max_criteria = 5

staticconstexpr

Number of subsections to declare for certain field and solver 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:

• include/prismspf/core/dirichlet.h
• include/prismspf/user_inputs/user_input_parameters.h