ParameterBase Struct Reference

Virtual base class for parameter groups. More...

#include <parameter_base.h>

Inheritance diagram for ParameterBase:

Public Member Functions
	ParameterBase ()=default
virtual	~ParameterBase ()=default
	ParameterBase (const ParameterBase &)=default
	ParameterBase (ParameterBase &&)=default
ParameterBase &	operator= (const ParameterBase &)=default
ParameterBase &	operator= (ParameterBase &&)=default
virtual void	assign (dealii::ParameterHandler &parameter_handler, unsigned int n_subsections=Numbers::default_subsections)=0
	Assign the parameters from file.
virtual void	validate (const std::vector< FieldAttributes > &field_attributes, const std::vector< SolveBlock > &solve_blocks) const =0
	Validate.

Detailed Description

Virtual base class for parameter groups.

This virtual base class ensures that we always have the following execution order.

1. declare
2. assign
3. validate

Constructor & Destructor Documentation

ParameterBase() [1/3]

ParameterBase::ParameterBase ( )

default

~ParameterBase()

virtual ParameterBase::~ParameterBase ( )

virtualdefault

ParameterBase() [2/3]

ParameterBase::ParameterBase ( const ParameterBase & )

default

ParameterBase() [3/3]

ParameterBase::ParameterBase ( ParameterBase && )

default

Member Function Documentation

assign()

virtual void ParameterBase::assign ( dealii::ParameterHandler & parameter_handler, unsigned int n_subsections = Numbers::default_subsections )

pure virtual

Assign the parameters from file.

Implemented in FieldInputParameters, FieldOutputParameters, LinearSolveParameters, LinearSolverParameters, MiscellaneousParameters, NonlinearSolveParameters, NonlinearSolverParameters, NucleationParameters, RestartOutputParameters, SpatialDiscretization< dim >, TemporalDiscretization, and UserInputParameters< dim >.

operator=() [1/2]

ParameterBase & ParameterBase::operator= ( const ParameterBase & )

default

operator=() [2/2]

ParameterBase & ParameterBase::operator= ( ParameterBase && )

default

validate()

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

pure virtual

Validate.

Implemented in FieldInputParameters, FieldOutputParameters, LinearSolveParameters, LinearSolverParameters, MiscellaneousParameters, NonlinearSolveParameters, NonlinearSolverParameters, NucleationParameters, RestartOutputParameters, SpatialDiscretization< dim >, TemporalDiscretization, and UserInputParameters< dim >.

---

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

• /__w/phaseField/phaseField/include/prismspf/user_inputs/parameter_base.h