MeltPoolDG::TimeIntegration::TimeIterator< number > Class Template Reference

#include <time_iterator.hpp>

Public Member Functions
	TimeIterator (const TimeSteppingData< number > &data_in)
bool	is_finished () const
number	compute_next_time_increment ()
void	resize_current_time_increment (const number factor)
void	set_current_time_increment (const number value, const number factor=1.0)
void	reset_max_n_time_steps (const unsigned int time_steps_in)
number	get_current_time () const
number	get_current_time_increment () const
unsigned int	get_current_time_step_number () const
number	get_old_time_increment () const
number	get_old_time () const
void	reset ()
void	print_me (const ConditionalOStream &pcout) const
bool	check_time_step_limit (const number &time_step_limit)
template<class Archive >
void	serialize (Archive &ar, const unsigned int)

Private Attributes
TimeSteppingData< number >	time_data
number	old_time
number	current_time
number	current_time_increment
number	old_time_increment
unsigned int	n_time_steps
dealii::FunctionParser< 1 >	time_step_size_function

Constructor & Destructor Documentation

TimeIterator()

template<typename number >

MeltPoolDG::TimeIntegration::TimeIterator< number >::TimeIterator

(

const TimeSteppingData< number > &

data_in

)

Member Function Documentation

check_time_step_limit()

template<typename number >

bool MeltPoolDG::TimeIntegration::TimeIterator< number >::check_time_step_limit

(

const number &

time_step_limit

)

Check whether the current time increment is smaller than the time_step_limit.

compute_next_time_increment()

template<typename number >

number MeltPoolDG::TimeIntegration::TimeIterator< number >::compute_next_time_increment

(

)

get_current_time()

template<typename number >

number MeltPoolDG::TimeIntegration::TimeIterator< number >::get_current_time

(

)

const

get_current_time_increment()

template<typename number >

number MeltPoolDG::TimeIntegration::TimeIterator< number >::get_current_time_increment

(

)

const

get_current_time_step_number()

template<typename number >

unsigned int MeltPoolDG::TimeIntegration::TimeIterator< number >::get_current_time_step_number

(

)

const

get_old_time()

template<typename number >

number MeltPoolDG::TimeIntegration::TimeIterator< number >::get_old_time

(

)

const

get_old_time_increment()

template<typename number >

number MeltPoolDG::TimeIntegration::TimeIterator< number >::get_old_time_increment

(

)

const

is_finished()

template<typename number >

bool MeltPoolDG::TimeIntegration::TimeIterator< number >::is_finished

(

)

const

print_me()

template<typename number >

void MeltPoolDG::TimeIntegration::TimeIterator< number >::print_me

(

const ConditionalOStream &

pcout

)

const

reset()

template<typename number >

void MeltPoolDG::TimeIntegration::TimeIterator< number >::reset

(

)

reset_max_n_time_steps()

template<typename number >

void MeltPoolDG::TimeIntegration::TimeIterator< number >::reset_max_n_time_steps

(

const unsigned int

time_steps_in

)

resize_current_time_increment()

template<typename number >

void MeltPoolDG::TimeIntegration::TimeIterator< number >::resize_current_time_increment

(

const number

factor

)

serialize()

template<typename number >

template<class Archive >

void MeltPoolDG::TimeIntegration::TimeIterator< number >::serialize ( Archive &  ar, const unsigned int    )

inline

set_current_time_increment()

template<typename number >

void MeltPoolDG::TimeIntegration::TimeIterator< number >::set_current_time_increment	(	const number	value,
		const number	factor = 1.0
	)

Member Data Documentation

current_time

template<typename number >

number MeltPoolDG::TimeIntegration::TimeIterator< number >::current_time

private

current_time_increment

template<typename number >

number MeltPoolDG::TimeIntegration::TimeIterator< number >::current_time_increment

private

n_time_steps

template<typename number >

unsigned int MeltPoolDG::TimeIntegration::TimeIterator< number >::n_time_steps

private

old_time

template<typename number >

number MeltPoolDG::TimeIntegration::TimeIterator< number >::old_time

private

old_time_increment

template<typename number >

number MeltPoolDG::TimeIntegration::TimeIterator< number >::old_time_increment

private

time_data

template<typename number >

TimeSteppingData<number> MeltPoolDG::TimeIntegration::TimeIterator< number >::time_data

private

time_step_size_function

template<typename number >

dealii::FunctionParser<1> MeltPoolDG::TimeIntegration::TimeIterator< number >::time_step_size_function

private

---

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

• include/meltpooldg/time_integration/time_iterator.hpp
• source/time_integration/time_iterator.cpp