MiscellaneousParameters Struct Reference

Struct that holds miscellaneous parameters. More...

#include <miscellaneous_parameters.h>

Public Member Functions
void	postprocess_and_validate ()
	Postprocess and validate parameters.
void	print_parameter_summary () const
	Print parameters to summary.log.
void	set_random_seed (const unsigned int &_random_seed)
	Set the random seed and initialize the RNG.
void	declare_parameters (dealii::ParameterHandler &parameter_handler) const
	Declare the parameters to be read from an input file.
void	assign_parameters (dealii::ParameterHandler &parameter_handler)
	Assign the parameters read from an input file to this object.

Public Attributes
unsigned int	random_seed = 2025
RNGEngine	rng {random_seed}

Detailed Description

Struct that holds miscellaneous parameters.

Member Function Documentation

assign_parameters()

void MiscellaneousParameters::assign_parameters ( dealii::ParameterHandler & parameter_handler )

inline

Assign the parameters read from an input file to this object.

declare_parameters()

void MiscellaneousParameters::declare_parameters ( dealii::ParameterHandler & parameter_handler ) const

inline

Declare the parameters to be read from an input file.

postprocess_and_validate()

void MiscellaneousParameters::postprocess_and_validate ( )

inline

Postprocess and validate parameters.

print_parameter_summary()

void MiscellaneousParameters::print_parameter_summary ( ) const

inline

Print parameters to summary.log.

set_random_seed()

void MiscellaneousParameters::set_random_seed ( const unsigned int & _random_seed )

inline

Set the random seed and initialize the RNG.

Member Data Documentation

random_seed

unsigned int MiscellaneousParameters::random_seed = 2025

rng

RNGEngine MiscellaneousParameters::rng {random_seed}

mutable

---

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

• include/prismspf/user_inputs/miscellaneous_parameters.h