LoadInitialConditionParameters Struct Reference

Struct that stores relevant load initial condition information. More...

#include <load_initial_condition_parameters.h>

Public Member Functions
void	postprocess_and_validate ()
	Postprocess and validate parameters.
void	print_parameter_summary () const
	Print parameters to summary.log.
void	clear ()
	Clear the initial condition parameters.
void	set_read_initial_conditions_from_file (bool _read_initial_conditions_from_file)
	Set the read initial conditions from file flag.
bool	get_read_initial_conditions_from_file () const
	Get the read initial conditions from file flag.
void	add_initial_condition_file (InitialConditionFile _ic_file)
	Add a initial condition file.
unsigned int	get_n_initial_condition_files () const
	Get the number of initial condition files.
const std::vector< InitialConditionFile > &	get_initial_condition_files () const
	Get the initial condition files.

Static Public Attributes
static constexpr unsigned int	max_files = 8
	Maximum number of initial condition files.

Private Attributes
bool	read_initial_conditions_from_file = false
std::vector< InitialConditionFile >	ic_files

Detailed Description

Struct that stores relevant load initial condition information.

Member Function Documentation

add_initial_condition_file()

void LoadInitialConditionParameters::add_initial_condition_file ( InitialConditionFile  _ic_file )

inline

Add a initial condition file.

clear()

void LoadInitialConditionParameters::clear ( )

inline

Clear the initial condition parameters.

get_initial_condition_files()

const std::vector< InitialConditionFile > & LoadInitialConditionParameters::get_initial_condition_files ( ) const

inline

Get the initial condition files.

get_n_initial_condition_files()

unsigned int LoadInitialConditionParameters::get_n_initial_condition_files ( ) const

inline

Get the number of initial condition files.

get_read_initial_conditions_from_file()

bool LoadInitialConditionParameters::get_read_initial_conditions_from_file ( ) const

inline

Get the read initial conditions from file flag.

postprocess_and_validate()

void LoadInitialConditionParameters::postprocess_and_validate ( )

inline

Postprocess and validate parameters.

print_parameter_summary()

void LoadInitialConditionParameters::print_parameter_summary ( ) const

inline

Print parameters to summary.log.

set_read_initial_conditions_from_file()

void LoadInitialConditionParameters::set_read_initial_conditions_from_file ( bool  _read_initial_conditions_from_file )

inline

Set the read initial conditions from file flag.

Member Data Documentation

ic_files

std::vector<InitialConditionFile> LoadInitialConditionParameters::ic_files

private

max_files

constexpr unsigned int LoadInitialConditionParameters::max_files = 8

staticconstexpr

Maximum number of initial condition files.

read_initial_conditions_from_file

bool LoadInitialConditionParameters::read_initial_conditions_from_file = false

private

---

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

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