OutputParameters Struct Reference

Struct that holds output parameters. More...

#include <output_parameters.h>

Public Member Functions
bool	should_output (unsigned int increment) const
	Return if the increment should be outputted.
void	validate ()
	Postprocess and validate parameters.
void	print_parameter_summary () const
	Print parameters to summary.log.
template<typename ListType >
void	add_output_list (const ListType &list)
	Set the user output list.
void	add_equal_spacing_outputs (unsigned int num_outputs, unsigned int num_increments)
	Set the user output list.
void	add_log_spacing_outputs (unsigned int num_outputs, unsigned int num_increments)
	Set the user output list.
void	add_n_per_decade_outputs (unsigned int num_outputs, unsigned int num_increments)
	Set the user output list.
void	clear_output_list ()
	Set the user output list.
unsigned int	get_num_outputs () const
	Get the number of outputs that will be made.

Public Attributes
std::string	file_type
std::string	file_name
unsigned int	patch_subdivisions = 0
unsigned int	print_output_period = UINT_MAX
bool	print_timing_with_output = false
std::set< unsigned int >	output_list = {0}

Detailed Description

Struct that holds output parameters.

Member Function Documentation

add_equal_spacing_outputs()

void OutputParameters::add_equal_spacing_outputs ( unsigned int  num_outputs, unsigned int  num_increments  )

inline

Set the user output list.

add_log_spacing_outputs()

void OutputParameters::add_log_spacing_outputs ( unsigned int  num_outputs, unsigned int  num_increments  )

inline

Set the user output list.

add_n_per_decade_outputs()

void OutputParameters::add_n_per_decade_outputs ( unsigned int  num_outputs, unsigned int  num_increments  )

inline

Set the user output list.

add_output_list()

template<typename ListType >

void OutputParameters::add_output_list ( const ListType &  list )

inline

Set the user output list.

clear_output_list()

void OutputParameters::clear_output_list ( )

inline

Set the user output list.

get_num_outputs()

unsigned int OutputParameters::get_num_outputs ( ) const

inline

Get the number of outputs that will be made.

print_parameter_summary()

void OutputParameters::print_parameter_summary ( ) const

inline

Print parameters to summary.log.

should_output()

bool OutputParameters::should_output ( unsigned int  increment ) const

inline

Return if the increment should be outputted.

validate()

void OutputParameters::validate ( )

inline

Postprocess and validate parameters.

Member Data Documentation

file_name

std::string OutputParameters::file_name

file_type

std::string OutputParameters::file_type

output_list

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

patch_subdivisions

unsigned int OutputParameters::patch_subdivisions = 0

print_output_period

unsigned int OutputParameters::print_output_period = UINT_MAX

print_timing_with_output

bool OutputParameters::print_timing_with_output = false

---

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

• /home/runner/work/phaseField/phaseField/include/prismspf/user_inputs/output_parameters.h