CheckpointParameters Struct Reference

Struct that holds checkpoint parameters. More...

#include <checkpoint_parameters.h>

Public Member Functions
bool	should_checkpoint (unsigned int increment) const
	Return if the increment should be checkpointted.
void	validate ()
	Postprocess and validate parameters.
void	print_parameter_summary () const
	Print parameters to summary.log.
template<typename ListType >
void	add_checkpoint_list (const ListType &list)
	Set the user checkpoint list.
void	add_equal_spacing_checkpoints (unsigned int num_checkpoints, unsigned int num_increments)
	Set the user checkpoint list.
void	add_log_spacing_checkpoints (unsigned int num_checkpoints, unsigned int num_increments)
	Set the user checkpoint list.
void	add_n_per_decade_checkpoints (unsigned int num_checkpoints, unsigned int num_increments)
	Set the user checkpoint list.
void	clear_checkpoint_list ()
	Set the user checkpoint list.
unsigned int	get_num_checkpoints () const
	Get the number of checkpoints that will be made.

Public Attributes
bool	should_load_checkpoint = false
std::string	file_name
bool	print_timing_with_checkpoint = false
std::set< unsigned int >	checkpoint_list

Detailed Description

Struct that holds checkpoint parameters.

Member Function Documentation

add_checkpoint_list()

template<typename ListType >

void CheckpointParameters::add_checkpoint_list ( const ListType &  list )

inline

Set the user checkpoint list.

add_equal_spacing_checkpoints()

void CheckpointParameters::add_equal_spacing_checkpoints ( unsigned int  num_checkpoints, unsigned int  num_increments  )

inline

Set the user checkpoint list.

add_log_spacing_checkpoints()

void CheckpointParameters::add_log_spacing_checkpoints ( unsigned int  num_checkpoints, unsigned int  num_increments  )

inline

Set the user checkpoint list.

add_n_per_decade_checkpoints()

void CheckpointParameters::add_n_per_decade_checkpoints ( unsigned int  num_checkpoints, unsigned int  num_increments  )

inline

Set the user checkpoint list.

clear_checkpoint_list()

void CheckpointParameters::clear_checkpoint_list ( )

inline

Set the user checkpoint list.

get_num_checkpoints()

unsigned int CheckpointParameters::get_num_checkpoints ( ) const

inline

Get the number of checkpoints that will be made.

print_parameter_summary()

void CheckpointParameters::print_parameter_summary ( ) const

inline

Print parameters to summary.log.

should_checkpoint()

bool CheckpointParameters::should_checkpoint ( unsigned int  increment ) const

inline

Return if the increment should be checkpointted.

validate()

void CheckpointParameters::validate ( )

inline

Postprocess and validate parameters.

Member Data Documentation

checkpoint_list

std::set<unsigned int> CheckpointParameters::checkpoint_list

file_name

std::string CheckpointParameters::file_name

print_timing_with_checkpoint

bool CheckpointParameters::print_timing_with_checkpoint = false

should_load_checkpoint

bool CheckpointParameters::should_load_checkpoint = false

---

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

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