TemporalDiscretization Struct Reference

Struct that holds temporal discretization parameters. More...

#include <temporal_discretization.h>

Public Member Functions
	TemporalDiscretization (double _dt=1.0, unsigned int _num_increments=1)
	Construct from timestep and total number of increments,.
	TemporalDiscretization (double _dt, double final_time)
	Construct from timestep and final time.
void	validate ()
	Postprocess and validate parameters.
void	print_parameter_summary () const
	Print parameters to summary.log.

Public Attributes
double	dt = 1.0
unsigned int	num_increments = 1

Detailed Description

Struct that holds temporal discretization parameters.

Constructor & Destructor Documentation

TemporalDiscretization() [1/2]

TemporalDiscretization::TemporalDiscretization ( double  _dt = 1.0, unsigned int  _num_increments = 1  )

inlineexplicit

Construct from timestep and total number of increments,.

TemporalDiscretization() [2/2]

TemporalDiscretization::TemporalDiscretization ( double  _dt, double  final_time  )

inline

Construct from timestep and final time.

Member Function Documentation

print_parameter_summary()

void TemporalDiscretization::print_parameter_summary ( ) const

inline

Print parameters to summary.log.

validate()

void TemporalDiscretization::validate ( )

inline

Postprocess and validate parameters.

Member Data Documentation

dt

double TemporalDiscretization::dt = 1.0

num_increments

unsigned int TemporalDiscretization::num_increments = 1

---

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

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