TemporalDiscretization Struct Reference

Struct that holds temporal discretization parameters. More...

#include <temporal_discretization.h>

Inheritance diagram for TemporalDiscretization:

Collaboration diagram for TemporalDiscretization:

Public Member Functions
	TemporalDiscretization ()=default
	Constructor.
	TemporalDiscretization (double _dt, unsigned int _n_increments, double _initial_time=0.0)
	Constructor.
	TemporalDiscretization (double _dt, double _final_time, double _initial_time=0.0)
	Constructor.
void	assign (dealii::ParameterHandler &parameter_handler, unsigned int n_subsections=Numbers::default_subsections) override
	Assign the parameters from file.
void	validate (const std::vector< FieldAttributes > &field_attributes, const std::vector< SolveBlock > &solve_blocks) const override
	Validate.
Public Member Functions inherited from ParameterBase
	ParameterBase ()=default
virtual	~ParameterBase ()=default
	ParameterBase (const ParameterBase &)=default
	ParameterBase (ParameterBase &&)=default
ParameterBase &	operator= (const ParameterBase &)=default
ParameterBase &	operator= (ParameterBase &&)=default

Static Public Member Functions
static void	declare (dealii::ParameterHandler &parameter_handler, unsigned int n_subsections=Numbers::default_subsections)
	Declare the parameters to be read from file.

Public Attributes
double	dt = 1.0
double	initial_time = 0.0
unsigned int	n_increments = 0

Detailed Description

Struct that holds temporal discretization parameters.

Constructor & Destructor Documentation

TemporalDiscretization() [1/3]

TemporalDiscretization::TemporalDiscretization ( )

default

Constructor.

TemporalDiscretization() [2/3]

PRISMS_PF_BEGIN_NAMESPACE TemporalDiscretization::TemporalDiscretization	(	double	_dt,
		unsigned int	_n_increments,
		double	_initial_time = 0.0 )

Constructor.

TemporalDiscretization() [3/3]

TemporalDiscretization::TemporalDiscretization	(	double	_dt,
		double	_final_time,
		double	_initial_time = 0.0 )

Constructor.

Member Function Documentation

assign()

void TemporalDiscretization::assign ( dealii::ParameterHandler & parameter_handler, unsigned int n_subsections = Numbers::default_subsections )

overridevirtual

Assign the parameters from file.

Implements ParameterBase.

declare()

void TemporalDiscretization::declare ( dealii::ParameterHandler & parameter_handler, unsigned int n_subsections = Numbers::default_subsections )

static

Declare the parameters to be read from file.

validate()

void TemporalDiscretization::validate ( const std::vector< FieldAttributes > & field_attributes, const std::vector< SolveBlock > & solve_blocks ) const

overridevirtual

Validate.

Implements ParameterBase.

Member Data Documentation

dt

double TemporalDiscretization::dt = 1.0

initial_time

double TemporalDiscretization::initial_time = 0.0

n_increments

unsigned int TemporalDiscretization::n_increments = 0

---

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

• /__w/phaseField/phaseField/include/prismspf/user_inputs/temporal_discretization.h
• /__w/phaseField/phaseField/src/user_inputs/temporal_discretization.cc