UserInputParameters< dim > Struct Template Reference

#include <user_input_parameters.h>

Inheritance diagram for UserInputParameters< dim >:

Collaboration diagram for UserInputParameters< dim >:

Public Member Functions
	UserInputParameters ()=default
	Constructor.
	UserInputParameters (const std::string &file_name, unsigned int n_subsections=Numbers::default_subsections)
	Constructor.
void	declare (dealii::ParameterHandler &parameter_handler, unsigned int n_subsections=Numbers::default_subsections) const
	Declare the parameters to be read from file.
void	assign (dealii::ParameterHandler &parameter_handler, unsigned int n_subsections=Numbers::default_subsections) override
	Assign the parameters from file.
void	validate (const std::vector< FieldAttributes > &field_attributes, const std::vector< SolveBlock > &solve_blocks) const override
	Ensure that the parameters are compatible with a set of fields and solvers.
Public Member Functions inherited from ParameterBase
	ParameterBase ()=default
virtual	~ParameterBase ()=default
	ParameterBase (const ParameterBase &)=default
	ParameterBase (ParameterBase &&)=default
ParameterBase &	operator= (const ParameterBase &)=default
ParameterBase &	operator= (ParameterBase &&)=default

Public Attributes
SpatialDiscretization< dim >	spatial_discretization
TemporalDiscretization	temporal_discretization
BoundaryParameters	boundary_parameters
LinearSolveParameters	linear_solve_parameters
NonlinearSolveParameters	nonlinear_solve_parameters
FieldOutputParameters	output_parameters
RestartOutputParameters	restart_parameters
FieldInputParameters	input_parameters
MiscellaneousParameters	misc_parameters
NucleationParameters	nucleation_parameters
UserConstants< dim >	user_constants

Constructor & Destructor Documentation

UserInputParameters() [1/2]

template<unsigned int dim>

UserInputParameters< dim >::UserInputParameters ( )

default

Constructor.

UserInputParameters() [2/2]

template<unsigned int dim>

UserInputParameters< dim >::UserInputParameters ( const std::string & file_name, unsigned int n_subsections = Numbers::default_subsections )

inlineexplicit

Constructor.

Read in user input parameters from file and load them into member variables.

Member Function Documentation

assign()

template<unsigned int dim>

void UserInputParameters< dim >::assign ( dealii::ParameterHandler & parameter_handler, unsigned int n_subsections = Numbers::default_subsections )

inlineoverridevirtual

Assign the parameters from file.

Implements ParameterBase.

declare()

template<unsigned int dim>

void UserInputParameters< dim >::declare ( dealii::ParameterHandler & parameter_handler, unsigned int n_subsections = Numbers::default_subsections ) const

inline

Declare the parameters to be read from file.

validate()

template<unsigned int dim>

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

inlineoverridevirtual

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

This is an optional step.

Implements ParameterBase.

Member Data Documentation

boundary_parameters

template<unsigned int dim>

BoundaryParameters UserInputParameters< dim >::boundary_parameters

input_parameters

template<unsigned int dim>

FieldInputParameters UserInputParameters< dim >::input_parameters

linear_solve_parameters

template<unsigned int dim>

LinearSolveParameters UserInputParameters< dim >::linear_solve_parameters

misc_parameters

template<unsigned int dim>

MiscellaneousParameters UserInputParameters< dim >::misc_parameters

nonlinear_solve_parameters

template<unsigned int dim>

NonlinearSolveParameters UserInputParameters< dim >::nonlinear_solve_parameters

nucleation_parameters

template<unsigned int dim>

NucleationParameters UserInputParameters< dim >::nucleation_parameters

output_parameters

template<unsigned int dim>

FieldOutputParameters UserInputParameters< dim >::output_parameters

restart_parameters

template<unsigned int dim>

RestartOutputParameters UserInputParameters< dim >::restart_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:

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