Simple struct for restart output. More...

#include <io_parameters.h>

Inheritance diagram for RestartOutputParameters:

Collaboration diagram for RestartOutputParameters:

Public Member Functions
void	assign (dealii::ParameterHandler &parameter_handler, unsigned int n_subsections=Numbers::default_subsections) override
	Assign the parameters from file.

void	assign (dealii::ParameterHandler &parameter_handler, unsigned int n_increments, unsigned int n_subsections=Numbers::default_subsections)
	Assign the parameters from file.

void	validate (const std::vector< FieldAttributes > &field_attributes, const std::vector< SolveBlock > &solve_blocks) const override
	Validate.

bool	should_output (unsigned int increment) const
	Whether a given increment should be outputted.

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

Static Public Member Functions
static void	declare (dealii::ParameterHandler &parameter_handler, unsigned int n_subsections=Numbers::default_subsections)
	Declare the parameters to be read from file.

Public Attributes
bool	load_from_checkpoint = false
	Whether to load from a checkpoint.

std::string	folder = "solutions"
	Folder for checkpoint output.

std::string	file_name = "checkpoint"
	Base filename for checkpoint output.

std::set< unsigned int >	output_list = {0}
	A list of output steps.

Detailed Description

Simple struct for restart output.

Member Function Documentation

◆ assign() [1/2]

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

Assign the parameters from file.

◆ assign() [2/2]

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

overridevirtual

Assign the parameters from file.

WARN: This one should not be used

Implements ParameterBase.

◆ declare()

void RestartOutputParameters::declare	(	dealii::ParameterHandler &	parameter_handler,
		unsigned int	n_subsections = Numbers::default_subsections )

static

Declare the parameters to be read from file.

◆ should_output()

bool RestartOutputParameters::should_output ( unsigned int increment ) const

nodiscard

Whether a given increment should be outputted.

◆ validate()

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

overridevirtual

Validate.

Implements ParameterBase.

Member Data Documentation

◆ file_name

std::string RestartOutputParameters::file_name = "checkpoint"

Base filename for checkpoint output.

This is the base filename for the outputs. For example, solution-*.vtu or file_name-*.vtu

◆ folder

std::string RestartOutputParameters::folder = "solutions"

Folder for checkpoint output.

Choosing this will give you your results like solutions/solution-*.vtu

◆ load_from_checkpoint

bool RestartOutputParameters::load_from_checkpoint = false

Whether to load from a checkpoint.

TODO: This doesn't really belong here. Maybe it does? With loading from restart it overrides any other input conditions so it might not fit super well in the input section either. I don't see a good place to put it and it somewhat fits here so leaving it.

◆ output_list

std::set<unsigned int> RestartOutputParameters::output_list = {0}

A list of output steps.

This is determined by a combination of the number of outputs and the total number of steps. When we reach a step contained in the list, we output.

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

/__w/phaseField/phaseField/include/prismspf/user_inputs/io_parameters.h
/__w/phaseField/phaseField/src/user_inputs/io_parameters.cc

Public Member Functions

Static Public Member Functions

Public Attributes