Base class for LIMEX time integrator. More...

#include <limex_integrator.hpp>

Inheritance diagram for ug::LimexTimeIntegrator< TDomain, TAlgebra >:

Classes
class	ThreadData
	Contains all data for parallel execution of time steps. More...

Public Types
typedef TAlgebra	algebra_type

typedef INonlinearTimeIntegrator< TDomain, TAlgebra >	base_type

typedef IDomainDiscretization< algebra_type >	domain_discretization_type

typedef ISubDiagErrorEst< vector_type >	error_estim_type

typedef GridFunction< TDomain, TAlgebra >	grid_function_type

typedef INonlinearTimeIntegrator< TDomain, TAlgebra >	itime_integrator_type

typedef algebra_type::matrix_type	matrix_type

typedef base_type::solver_type	solver_type

typedef std::vector< SmartPtr< ThreadData > >	thread_vector_type

typedef SimpleTimeIntegrator< TDomain, TAlgebra >	time_integrator_type

typedef LinearImplicitEuler< algebra_type >	timestep_type

typedef AitkenNevilleTimex< vector_type >	timex_type

typedef algebra_type::vector_type	vector_type

Public Types inherited from ug::INonlinearTimeIntegrator< TDomain, TAlgebra >
typedef AssembledOperator< TAlgebra >	assembled_operator_type

typedef ITimeIntegrator< TDomain, TAlgebra >	base_type

typedef IOperatorInverse< vector_type >	solver_type

typedef base_type::vector_type	vector_type

Public Types inherited from ug::ITimeIntegrator< TDomain, TAlgebra >
typedef TAlgebra	algebra_type

typedef TDomain	domain_type

typedef GridFunction< TDomain, TAlgebra >	grid_function_type

typedef TAlgebra::matrix_type	matrix_type

typedef TAlgebra::vector_type	vector_type

Public Types inherited from ug::IOperator< GridFunction< TDomain, TAlgebra > >
typedef Y	codomain_function_type

typedef X	domain_function_type

Public Types inherited from ug::TimeIntegratorSubject< TDomain, TAlgebra >
typedef ITimeIntegratorStageObserver_end< TDomain, TAlgebra >	end_observer_type

typedef ITimeIntegratorStageObserver_finalize< TDomain, TAlgebra >	finalize_observer_type

typedef GridFunction< TDomain, TAlgebra >	grid_function_type

typedef ITimeIntegratorStageObserver_init< TDomain, TAlgebra >	init_observer_type

enum	observer_group_type

typedef ITimeIntegratorStageObserver_postprocess< TDomain, TAlgebra >	postprocess_observer_type

typedef ITimeIntegratorStageObserver_preprocess< TDomain, TAlgebra >	preprocess_observer_type

typedef std::vector< SmartPtr< process_observer_type > >	process_observer_container_type

typedef ITimeIntegratorObserver< TDomain, TAlgebra >	process_observer_type

typedef ITimeIntegratorStageObserver_rewind< TDomain, TAlgebra >	rewind_observer_type

typedef ITimeIntegratorStageObserver_start< TDomain, TAlgebra >	start_observer_type

Public Types inherited from ug::DebugWritingObject< TAlgebra >
typedef TAlgebra	algebra_type

typedef TAlgebra::matrix_type	matrix_type

typedef TAlgebra::vector_type	vector_type

Public Types inherited from ug::VectorDebugWritingObject< TAlgebra::vector_type >
typedef TVector	vector_type

Public Member Functions
void	add_error_estimator (SmartPtr< error_estim_type > spErrorEstim)
	add an error estimator

void	add_stage (size_t i, size_t nsteps, SmartPtr< domain_discretization_type > spDD, SmartPtr< solver_type > solver)
	! TODO: remove this function!

void	add_stage (size_t nsteps, SmartPtr< solver_type > solver, SmartPtr< domain_discretization_type > spDD)

void	add_stage_base (size_t nsteps, SmartPtr< solver_type > solver, SmartPtr< domain_discretization_type > spDD, SmartPtr< domain_discretization_type > spGamma=SPNULL)
	add a new stage (at end of list)

void	add_stage_ext (size_t nsteps, SmartPtr< solver_type > solver, SmartPtr< domain_discretization_type > spDD, SmartPtr< domain_discretization_type > spGamma)

bool	apply (SmartPtr< grid_function_type > u, number t1, ConstSmartPtr< grid_function_type > u0, number t0)
	Integrating from t0 -> t1.

std::string	config_string () const

void	disable_matrix_cache ()
	Select approximate Newton (default)

void	enable_matrix_cache ()
	Select classic LIMEX.

number	get_cost (size_t i)

number	get_gamma (size_t i)

SmartPtr< grid_function_type >	get_time_derivative ()
	getter for time derivative info (optional for setting $\Gamma$)

SmartPtr< timestep_type >	get_time_stepper (size_t i)

number	get_workload (size_t i)

bool	has_time_derivative ()
	status for time derivative info (optional for setting $\Gamma$)

void	interrupt ()
	interrupt execution of apply() by external call via observer

	LimexTimeIntegrator (int nstages)

void	select_cost_strategy (SmartPtr< ILimexCostStrategy > cost)

void	set_asymptotic_order (size_t q)

void	set_conservative (bool c)

void	set_debug_for_timestepper (SmartPtr< IDebugWriter< algebra_type > > spDebugWriter)
	forward debug info to time integrators

void	set_max_reductions (size_t nred)

void	set_space (SmartPtr< IGridFunctionSpace< grid_function_type > > spSpace)
	set banach space (e.g. for computing consistency error)

void	set_start_step (size_t step)

void	set_stepsize_greedy_order_factor (double sigma)

void	set_stepsize_reduction_factor (double sigma)

void	set_stepsize_safety_factor (double rho)

void	set_time_derivative (SmartPtr< grid_function_type > udot)
	setter for time derivative info (optional for setting $\Gamma$)

void	set_tolerance (double tol)
	tolerance

Public Member Functions inherited from ug::INonlinearTimeIntegrator< TDomain, TAlgebra >
double	get_dt_max ()

double	get_dt_min ()

double	get_increase_factor ()

double	get_reduction_factor ()

SmartPtr< solver_type >	get_solver ()

ConstSmartPtr< solver_type >	get_solver () const

	INonlinearTimeIntegrator ()

void	set_dt_max (double max)

void	set_dt_min (double min)

void	set_increase_factor (double inc)

void	set_reduction_factor (double dec)

void	set_solver (SmartPtr< solver_type > solver)

Public Member Functions inherited from ug::ITimeIntegrator< TDomain, TAlgebra >
void	apply (grid_function_type &u1, const grid_function_type &u0)
	Apply operator.

double	get_time_step ()

void	init ()
	init operator

virtual void	init (grid_function_type const &u)
	init operator depending on a function u

	ITimeIntegrator ()

void	prepare (grid_function_type &u)
	prepares functions for application

void	set_no_log_out (bool bNoLogOut)

void	set_precision_bound (double precisionBound)

void	set_time_step (double dt)
	Set initial time step.

virtual	~ITimeIntegrator ()
	virtual destructor

Public Member Functions inherited from ug::IOperator< GridFunction< TDomain, TAlgebra > >
virtual void	apply (Y &d, const X &u)=0

virtual void	prepare (X &u)=0

virtual	~IOperator ()

Public Member Functions inherited from ug::TimeIntegratorSubject< TDomain, TAlgebra >
void	attach_end_observer (SmartPtr< process_observer_type > obs)

void	attach_finalize_observer (SmartPtr< process_observer_type > obs)

void	attach_init_observer (SmartPtr< process_observer_type > obs)

void	attach_observer (SmartPtr< process_observer_type > obs)

void	attach_postprocess_observer (SmartPtr< process_observer_type > obs)

void	attach_preprocess_observer (SmartPtr< process_observer_type > obs)

void	attach_rewind_observer (SmartPtr< process_observer_type > obs)

void	attach_start_observer (SmartPtr< process_observer_type > obs)

void	reset_observers ()

Public Member Functions inherited from ug::DebugWritingObject< TAlgebra >
SmartPtr< IDebugWriter< algebra_type > >	debug_writer ()

ConstSmartPtr< IDebugWriter< algebra_type > >	debug_writer () const

bool	debug_writer_valid () const

	DebugWritingObject ()

	DebugWritingObject (const DebugWritingObject< algebra_type > &parent)

	DebugWritingObject (SmartPtr< IDebugWriter< algebra_type > > spDebugWriter)

virtual void	set_debug (SmartPtr< IDebugWriter< algebra_type > > spDebugWriter)

virtual	~DebugWritingObject ()

Public Member Functions inherited from ug::VectorDebugWritingObject< TAlgebra::vector_type >
virtual void	set_debug (SmartPtr< IVectorDebugWriter< vector_type > > spDebugWriter)

SmartPtr< IVectorDebugWriter< vector_type > >	vector_debug_writer ()

ConstSmartPtr< IVectorDebugWriter< vector_type > >	vector_debug_writer () const

bool	vector_debug_writer_valid () const

	VectorDebugWritingObject ()

	VectorDebugWritingObject (SmartPtr< IVectorDebugWriter< vector_type > > spDebugWriter)

void	write_debug (const vector_type &vec, const char *filename)

virtual	~VectorDebugWritingObject ()

Public Member Functions inherited from ug::LimexTimeIntegratorConfig
std::string	config_string () const

	LimexTimeIntegratorConfig ()

	LimexTimeIntegratorConfig (unsigned int nstages)

Protected Member Functions
int	apply_integrator_threads (number dtcurr, ConstSmartPtr< grid_function_type > u0, number t0, size_t nstages)
	(Tentatively) apply integrators

void	dispose_integrator_threads ()
	Dispose integrator threads (w/ solutions)

size_t	find_optimal_solution (const std::vector< number > &eps, size_t ntest, size_t &qpred)

void	init_gamma ()
	aux: compute exponents gamma_k (for roots)

void	init_integrator_threads (ConstSmartPtr< grid_function_type > u)
	Initialize integrator threads (w/ solutions)

void	join_integrator_threads ()
	e.g. wait for all threads to complete

number &	monitor (size_t k, size_t q)

void	update_cost ()
	Updating workloads A_i for computing T_ii.

void	update_integrator_threads (ConstSmartPtr< grid_function_type > ucommon, number t)
	Override thread-wise solutions with common solution.

void	update_monitor ()
	convergence monitor

Protected Member Functions inherited from ug::TimeIntegratorSubject< TDomain, TAlgebra >
void	attach_to_group (int tGroup, SmartPtr< process_observer_type > obs)

void	attach_to_group (SmartPtr< process_observer_type > obs)

bool	notify_group (SmartPtr< grid_function_type > u, int step, number time, number dt)

Protected Member Functions inherited from ug::DebugWritingObject< TAlgebra >
void	enter_debug_writer_section (const char *secDir)

void	enter_debug_writer_section (std::string secDir)

void	leave_debug_writer_section ()

void	write_debug (const matrix_type &mat, const char *filename)

void	write_debug (const matrix_type &mat, std::string name)

Protected Member Functions inherited from ug::VectorDebugWritingObject< TAlgebra::vector_type >
void	enter_vector_debug_writer_section (const char *secDir)

void	enter_vector_debug_writer_section (std::string secDir)

void	leave_vector_debug_writer_section ()

void	print_debugger_message (const char *msg)

void	print_debugger_message (std::string msg)

virtual void	write_debug (const vector_type &vec, std::string name)

Protected Attributes
bool	m_bInterrupt

std::vector< number >	m_consistency_error
	Consistency error.

std::vector< number >	m_costA
	Cost A_i (for completing stage i)

std::vector< number >	m_gamma
	gamma_i: exponent

std::vector< number >	m_lambda

int	m_limex_step
	Current counter.

std::vector< number >	m_monitor
	Convergence monitor \alpha.

std::vector< size_t >	m_num_reductions
	history of reductions

SmartPtr< IGridFunctionSpace< grid_function_type > >	m_spBanachSpace
	metric space

SmartPtr< ILimexCostStrategy >	m_spCostStrategy

SmartPtr< grid_function_type >	m_spDtSol
	Time derivative.

SmartPtr< error_estim_type >	m_spErrorEstimator

std::vector< size_t >	m_vSteps
	generating sequence for extrapolation

std::vector< ThreadData >	m_vThreadData
	vector with thread information

std::vector< number >	m_workload

Protected Attributes inherited from ug::INonlinearTimeIntegrator< TDomain, TAlgebra >
TimeStepBounds	m_dtBounds

SmartPtr< solver_type >	m_spSolver

Protected Attributes inherited from ug::ITimeIntegrator< TDomain, TAlgebra >
bool	m_bNoLogOut

double	m_dt

double	m_lower_tim

double	m_precisionBound

double	m_upper_tim

Protected Attributes inherited from ug::TimeIntegratorSubject< TDomain, TAlgebra >
std::vector< SmartPtr< end_observer_type > >	m_vEndObservers

std::vector< SmartPtr< finalize_observer_type > >	m_vFinalizeObservers

std::vector< SmartPtr< init_observer_type > >	m_vInitObservers

std::vector< SmartPtr< postprocess_observer_type > >	m_vPostprocessObservers

std::vector< SmartPtr< preprocess_observer_type > >	m_vPreprocessObservers

process_observer_container_type	m_vProcessObservers [TIO_GROUP_SIZE]

std::vector< SmartPtr< rewind_observer_type > >	m_vRewindObservers

std::vector< SmartPtr< start_observer_type > >	m_vStartObservers

Protected Attributes inherited from ug::DebugWritingObject< TAlgebra >
SmartPtr< IDebugWriter< algebra_type > >	m_spDebugWriter

Protected Attributes inherited from ug::VectorDebugWritingObject< TAlgebra::vector_type >
SmartPtr< IVectorDebugWriter< vector_type > >	m_spVectorDebugWriter

Protected Attributes inherited from ug::LimexTimeIntegratorConfig
size_t	m_asymptotic_order
	For PDEs, we may apply an symptotic order reduction.

unsigned int	m_conservative

double	m_greedyOrderIncrease

size_t	m_max_reductions

unsigned int	m_nstages
	Number of Aitken-Neville stages.

double	m_rhoSafety

double	m_sigmaReduction

double	m_tol

bool	m_useCachedMatrices

Additional Inherited Members
Public Attributes inherited from ug::TimeIntegratorSubject< TDomain, TAlgebra >
	TIO_GROUP_END

	TIO_GROUP_FINALIZE_STEP

	TIO_GROUP_INIT_STEP

	TIO_GROUP_POSTPROCESS_STEP

	TIO_GROUP_PREPROCESS_STEP

	TIO_GROUP_REWIND_STEP

	TIO_GROUP_SIZE

	TIO_GROUP_START

Detailed Description

template<class TDomain, class TAlgebra>
class ug::LimexTimeIntegrator< TDomain, TAlgebra >

Base class for LIMEX time integrator.

Member Typedef Documentation

◆ algebra_type

template<class TDomain , class TAlgebra >

typedef TAlgebra ug::LimexTimeIntegrator< TDomain, TAlgebra >::algebra_type

◆ base_type

template<class TDomain , class TAlgebra >

typedef INonlinearTimeIntegrator<TDomain, TAlgebra> ug::LimexTimeIntegrator< TDomain, TAlgebra >::base_type

◆ domain_discretization_type

template<class TDomain , class TAlgebra >

typedef IDomainDiscretization<algebra_type> ug::LimexTimeIntegrator< TDomain, TAlgebra >::domain_discretization_type

◆ error_estim_type

template<class TDomain , class TAlgebra >

typedef ISubDiagErrorEst<vector_type> ug::LimexTimeIntegrator< TDomain, TAlgebra >::error_estim_type

◆ grid_function_type

template<class TDomain , class TAlgebra >

typedef GridFunction<TDomain, TAlgebra> ug::LimexTimeIntegrator< TDomain, TAlgebra >::grid_function_type

◆ itime_integrator_type

template<class TDomain , class TAlgebra >

typedef INonlinearTimeIntegrator<TDomain, TAlgebra> ug::LimexTimeIntegrator< TDomain, TAlgebra >::itime_integrator_type

◆ matrix_type

template<class TDomain , class TAlgebra >

typedef algebra_type::matrix_type ug::LimexTimeIntegrator< TDomain, TAlgebra >::matrix_type

◆ solver_type

template<class TDomain , class TAlgebra >

typedef base_type::solver_type ug::LimexTimeIntegrator< TDomain, TAlgebra >::solver_type

◆ thread_vector_type

template<class TDomain , class TAlgebra >

typedef std::vector<SmartPtr<ThreadData> > ug::LimexTimeIntegrator< TDomain, TAlgebra >::thread_vector_type

◆ time_integrator_type

template<class TDomain , class TAlgebra >

typedef SimpleTimeIntegrator<TDomain, TAlgebra> ug::LimexTimeIntegrator< TDomain, TAlgebra >::time_integrator_type

◆ timestep_type

template<class TDomain , class TAlgebra >

typedef LinearImplicitEuler<algebra_type> ug::LimexTimeIntegrator< TDomain, TAlgebra >::timestep_type

◆ timex_type

template<class TDomain , class TAlgebra >

typedef AitkenNevilleTimex<vector_type> ug::LimexTimeIntegrator< TDomain, TAlgebra >::timex_type

◆ vector_type

template<class TDomain , class TAlgebra >

typedef algebra_type::vector_type ug::LimexTimeIntegrator< TDomain, TAlgebra >::vector_type

Constructor & Destructor Documentation

◆ LimexTimeIntegrator()

template<class TDomain , class TAlgebra >

ug::LimexTimeIntegrator< TDomain, TAlgebra >::LimexTimeIntegrator ( int nstages )

inline

References ug::LimexTimeIntegrator< TDomain, TAlgebra >::init_gamma(), ug::LimexTimeIntegratorConfig::m_nstages, ug::LimexTimeIntegrator< TDomain, TAlgebra >::m_vSteps, ug::LimexTimeIntegrator< TDomain, TAlgebra >::m_vThreadData, and make_sp().

Member Function Documentation

◆ add_error_estimator()

template<class TDomain , class TAlgebra >

void ug::LimexTimeIntegrator< TDomain, TAlgebra >::add_error_estimator ( SmartPtr< error_estim_type > spErrorEstim )

inline

add an error estimator

References ug::LimexTimeIntegrator< TDomain, TAlgebra >::m_spErrorEstimator.

◆ add_stage() [1/2]

template<class TDomain , class TAlgebra >

void ug::LimexTimeIntegrator< TDomain, TAlgebra >::add_stage	(	size_t	i,
		size_t	nsteps,
		SmartPtr< domain_discretization_type >	spDD,
		SmartPtr< solver_type >	solver
	)

inline

! TODO: remove this function!

References ug::LimexTimeIntegrator< TDomain, TAlgebra >::add_stage(), and UG_LOG.

◆ add_stage() [2/2]

template<class TDomain , class TAlgebra >

void ug::LimexTimeIntegrator< TDomain, TAlgebra >::add_stage	(	size_t	nsteps,
		SmartPtr< solver_type >	solver,
		SmartPtr< domain_discretization_type >	spDD
	)

inline

References ug::LimexTimeIntegrator< TDomain, TAlgebra >::add_stage_base().

Referenced by ug::LimexTimeIntegrator< TDomain, TAlgebra >::add_stage().

◆ add_stage_base()

template<class TDomain , class TAlgebra >

void ug::LimexTimeIntegrator< TDomain, TAlgebra >::add_stage_base	(	size_t	nsteps,
		SmartPtr< solver_type >	solver,
		SmartPtr< domain_discretization_type >	spDD,
		SmartPtr< domain_discretization_type >	spGamma = `SPNULL`
	)

inline

add a new stage (at end of list)

References ug::LimexTimeIntegratorConfig::m_nstages, ug::LimexTimeIntegrator< TDomain, TAlgebra >::m_vSteps, ug::LimexTimeIntegrator< TDomain, TAlgebra >::m_vThreadData, make_sp(), UG_ASSERT, and SmartPtr< typename T, template< class TT > class FreePolicy >::valid().

Referenced by ug::LimexTimeIntegrator< TDomain, TAlgebra >::add_stage(), and ug::LimexTimeIntegrator< TDomain, TAlgebra >::add_stage_ext().

◆ add_stage_ext()

template<class TDomain , class TAlgebra >

void ug::LimexTimeIntegrator< TDomain, TAlgebra >::add_stage_ext	(	size_t	nsteps,
		SmartPtr< solver_type >	solver,
		SmartPtr< domain_discretization_type >	spDD,
		SmartPtr< domain_discretization_type >	spGamma
	)

inline

References ug::LimexTimeIntegrator< TDomain, TAlgebra >::add_stage_base().

◆ apply()

template<class TDomain , class TAlgebra >

bool ug::LimexTimeIntegrator< TDomain, TAlgebra >::apply	(	SmartPtr< grid_function_type >	u,
		number	t1,
		ConstSmartPtr< grid_function_type >	u0,
		number	t0
	)

virtual

◆ apply_integrator_threads()

template<class TDomain , class TAlgebra >

int ug::LimexTimeIntegrator< TDomain, TAlgebra >::apply_integrator_threads	(	number	dtcurr,
		ConstSmartPtr< grid_function_type >	u0,
		number	t0,
		size_t	nstages
	)

protected

(Tentatively) apply integrators

◆ config_string()

template<class TDomain , class TAlgebra >

std::string ug::LimexTimeIntegrator< TDomain, TAlgebra >::config_string ( ) const

inline

References ug::LimexTimeIntegratorConfig::config_string().

◆ disable_matrix_cache()

template<class TDomain , class TAlgebra >

void ug::LimexTimeIntegrator< TDomain, TAlgebra >::disable_matrix_cache ( )

inline

Select approximate Newton (default)

References ug::LimexTimeIntegratorConfig::m_useCachedMatrices.

◆ dispose_integrator_threads()

template<class TDomain , class TAlgebra >

void ug::LimexTimeIntegrator< TDomain, TAlgebra >::dispose_integrator_threads ( )

protected

Dispose integrator threads (w/ solutions)

Create private solutions for each thread

References PROFILE_FUNC_GROUP, and SPNULL.

◆ enable_matrix_cache()

template<class TDomain , class TAlgebra >

void ug::LimexTimeIntegrator< TDomain, TAlgebra >::enable_matrix_cache ( )

inline

Select classic LIMEX.

References ug::LimexTimeIntegratorConfig::m_useCachedMatrices.

◆ find_optimal_solution()

template<class TDomain , class TAlgebra >

size_t ug::LimexTimeIntegrator< TDomain, TAlgebra >::find_optimal_solution	(	const std::vector< number > &	eps,
		size_t	ntest,
		size_t &	qpred
	)

protected

References UG_LOG.

◆ get_cost()

template<class TDomain , class TAlgebra >

number ug::LimexTimeIntegrator< TDomain, TAlgebra >::get_cost ( size_t i )

inline

References ug::LimexTimeIntegrator< TDomain, TAlgebra >::m_costA.

◆ get_gamma()

template<class TDomain , class TAlgebra >

number ug::LimexTimeIntegrator< TDomain, TAlgebra >::get_gamma ( size_t i )

inline

References ug::LimexTimeIntegrator< TDomain, TAlgebra >::m_gamma.

◆ get_time_derivative()

template<class TDomain , class TAlgebra >

SmartPtr< grid_function_type > ug::LimexTimeIntegrator< TDomain, TAlgebra >::get_time_derivative ( )

inline

getter for time derivative info (optional for setting $\Gamma$)

References ug::LimexTimeIntegrator< TDomain, TAlgebra >::m_spDtSol.

◆ get_time_stepper()

template<class TDomain , class TAlgebra >

SmartPtr< timestep_type > ug::LimexTimeIntegrator< TDomain, TAlgebra >::get_time_stepper ( size_t i )

inline

References ug::LimexTimeIntegrator< TDomain, TAlgebra >::m_vThreadData, and UG_ASSERT.

◆ get_workload()

template<class TDomain , class TAlgebra >

number ug::LimexTimeIntegrator< TDomain, TAlgebra >::get_workload ( size_t i )

inline

References ug::LimexTimeIntegrator< TDomain, TAlgebra >::m_workload.

◆ has_time_derivative()

template<class TDomain , class TAlgebra >

bool ug::LimexTimeIntegrator< TDomain, TAlgebra >::has_time_derivative ( )

inline

status for time derivative info (optional for setting $\Gamma$)

References ug::LimexTimeIntegrator< TDomain, TAlgebra >::m_spDtSol, and SPNULL.

◆ init_gamma()

template<class TDomain , class TAlgebra >

void ug::LimexTimeIntegrator< TDomain, TAlgebra >::init_gamma ( )

inlineprotected

aux: compute exponents gamma_k (for roots)

References ug::LimexTimeIntegrator< TDomain, TAlgebra >::m_gamma, and ug::LimexTimeIntegratorConfig::m_nstages.

Referenced by ug::LimexTimeIntegrator< TDomain, TAlgebra >::LimexTimeIntegrator().

◆ init_integrator_threads()

template<class TDomain , class TAlgebra >

void ug::LimexTimeIntegrator< TDomain, TAlgebra >::init_integrator_threads ( ConstSmartPtr< grid_function_type > u )

protected

Initialize integrator threads (w/ solutions)

Create private solutions for each thread

References PROFILE_FUNC_GROUP.

◆ interrupt()

template<class TDomain , class TAlgebra >

void ug::LimexTimeIntegrator< TDomain, TAlgebra >::interrupt ( )

inline

interrupt execution of apply() by external call via observer

References ug::LimexTimeIntegrator< TDomain, TAlgebra >::m_bInterrupt.

◆ join_integrator_threads()

template<class TDomain , class TAlgebra >

void ug::LimexTimeIntegrator< TDomain, TAlgebra >::join_integrator_threads ( )

protected

e.g. wait for all threads to complete

◆ monitor()

template<class TDomain , class TAlgebra >

number & ug::LimexTimeIntegrator< TDomain, TAlgebra >::monitor	(	size_t	k,
		size_t	q
	)

inlineprotected

References ug::LimexTimeIntegrator< TDomain, TAlgebra >::m_monitor, ug::LimexTimeIntegratorConfig::m_nstages, and UG_ASSERT.

Referenced by ug::LimexTimeIntegrator< TDomain, TAlgebra >::update_monitor().

◆ select_cost_strategy()

template<class TDomain , class TAlgebra >

void ug::LimexTimeIntegrator< TDomain, TAlgebra >::select_cost_strategy ( SmartPtr< ILimexCostStrategy > cost )

inline

References ug::LimexTimeIntegrator< TDomain, TAlgebra >::m_spCostStrategy.

◆ set_asymptotic_order()

template<class TDomain , class TAlgebra >

void ug::LimexTimeIntegrator< TDomain, TAlgebra >::set_asymptotic_order ( size_t q )

inline

References ug::LimexTimeIntegratorConfig::m_asymptotic_order.

◆ set_conservative()

template<class TDomain , class TAlgebra >

void ug::LimexTimeIntegrator< TDomain, TAlgebra >::set_conservative ( bool c )

inline

References ug::LimexTimeIntegratorConfig::m_conservative.

◆ set_debug_for_timestepper()

template<class TDomain , class TAlgebra >

void ug::LimexTimeIntegrator< TDomain, TAlgebra >::set_debug_for_timestepper ( SmartPtr< IDebugWriter< algebra_type > > spDebugWriter )

inline

forward debug info to time integrators

References ug::LimexTimeIntegrator< TDomain, TAlgebra >::m_vThreadData, and UG_LOG.

◆ set_max_reductions()

template<class TDomain , class TAlgebra >

void ug::LimexTimeIntegrator< TDomain, TAlgebra >::set_max_reductions ( size_t nred )

inline

References ug::LimexTimeIntegratorConfig::m_max_reductions.

◆ set_space()

template<class TDomain , class TAlgebra >

void ug::LimexTimeIntegrator< TDomain, TAlgebra >::set_space ( SmartPtr< IGridFunctionSpace< grid_function_type > > spSpace )

inline

set banach space (e.g. for computing consistency error)

References ug::LimexTimeIntegrator< TDomain, TAlgebra >::m_spBanachSpace, and UG_LOG.

◆ set_start_step()

template<class TDomain , class TAlgebra >

void ug::LimexTimeIntegrator< TDomain, TAlgebra >::set_start_step ( size_t step )

inline

References ug::LimexTimeIntegrator< TDomain, TAlgebra >::m_limex_step.

◆ set_stepsize_greedy_order_factor()

template<class TDomain , class TAlgebra >

void ug::LimexTimeIntegrator< TDomain, TAlgebra >::set_stepsize_greedy_order_factor ( double sigma )

inline

References ug::LimexTimeIntegratorConfig::m_greedyOrderIncrease.

◆ set_stepsize_reduction_factor()

template<class TDomain , class TAlgebra >

void ug::LimexTimeIntegrator< TDomain, TAlgebra >::set_stepsize_reduction_factor ( double sigma )

inline

References ug::LimexTimeIntegratorConfig::m_sigmaReduction.

◆ set_stepsize_safety_factor()

template<class TDomain , class TAlgebra >

void ug::LimexTimeIntegrator< TDomain, TAlgebra >::set_stepsize_safety_factor ( double rho )

inline

References ug::LimexTimeIntegratorConfig::m_rhoSafety.

◆ set_time_derivative()

template<class TDomain , class TAlgebra >

void ug::LimexTimeIntegrator< TDomain, TAlgebra >::set_time_derivative ( SmartPtr< grid_function_type > udot )

inline

setter for time derivative info (optional for setting $\Gamma$)

References ug::LimexTimeIntegrator< TDomain, TAlgebra >::m_spDtSol.

◆ set_tolerance()

template<class TDomain , class TAlgebra >

void ug::LimexTimeIntegrator< TDomain, TAlgebra >::set_tolerance ( double tol )

inline

tolerance

References ug::LimexTimeIntegratorConfig::m_tol.

◆ update_cost()

template<class TDomain , class TAlgebra >

void ug::LimexTimeIntegrator< TDomain, TAlgebra >::update_cost ( )

inlineprotected

Updating workloads A_i for computing T_ii.

References ug::LimexTimeIntegrator< TDomain, TAlgebra >::m_costA, ug::LimexTimeIntegratorConfig::m_nstages, ug::LimexTimeIntegrator< TDomain, TAlgebra >::m_spCostStrategy, and ug::LimexTimeIntegrator< TDomain, TAlgebra >::m_vSteps.

◆ update_integrator_threads()

template<class TDomain , class TAlgebra >

void ug::LimexTimeIntegrator< TDomain, TAlgebra >::update_integrator_threads	(	ConstSmartPtr< grid_function_type >	ucommon,
		number	t
	)

protected

Override thread-wise solutions with common solution.

References UG_ASSERT.

◆ update_monitor()

template<class TDomain , class TAlgebra >

void ug::LimexTimeIntegrator< TDomain, TAlgebra >::update_monitor ( )

inlineprotected

convergence monitor

References ug::LimexTimeIntegrator< TDomain, TAlgebra >::m_costA, ug::LimexTimeIntegrator< TDomain, TAlgebra >::m_gamma, ug::LimexTimeIntegratorConfig::m_nstages, ug::LimexTimeIntegratorConfig::m_rhoSafety, ug::LimexTimeIntegratorConfig::m_tol, ug::LimexTimeIntegrator< TDomain, TAlgebra >::monitor(), UG_ASSERT, and UG_LOG.

Member Data Documentation

◆ m_bInterrupt

template<class TDomain , class TAlgebra >

bool ug::LimexTimeIntegrator< TDomain, TAlgebra >::m_bInterrupt

protected

Referenced by ug::LimexTimeIntegrator< TDomain, TAlgebra >::interrupt().

◆ m_consistency_error

template<class TDomain , class TAlgebra >

std::vector<number> ug::LimexTimeIntegrator< TDomain, TAlgebra >::m_consistency_error

protected

Consistency error.

◆ m_costA

template<class TDomain , class TAlgebra >

std::vector<number> ug::LimexTimeIntegrator< TDomain, TAlgebra >::m_costA

protected

Cost A_i (for completing stage i)

Referenced by ug::LimexTimeIntegrator< TDomain, TAlgebra >::get_cost(), ug::LimexTimeIntegrator< TDomain, TAlgebra >::update_cost(), and ug::LimexTimeIntegrator< TDomain, TAlgebra >::update_monitor().

◆ m_gamma

template<class TDomain , class TAlgebra >

std::vector<number> ug::LimexTimeIntegrator< TDomain, TAlgebra >::m_gamma

protected

gamma_i: exponent

Referenced by ug::LimexTimeIntegrator< TDomain, TAlgebra >::get_gamma(), ug::LimexTimeIntegrator< TDomain, TAlgebra >::init_gamma(), and ug::LimexTimeIntegrator< TDomain, TAlgebra >::update_monitor().

◆ m_lambda

template<class TDomain , class TAlgebra >

std::vector<number> ug::LimexTimeIntegrator< TDomain, TAlgebra >::m_lambda

protected

◆ m_limex_step

template<class TDomain , class TAlgebra >

int ug::LimexTimeIntegrator< TDomain, TAlgebra >::m_limex_step

protected

Current counter.

Referenced by ug::LimexTimeIntegrator< TDomain, TAlgebra >::set_start_step().

◆ m_monitor

template<class TDomain , class TAlgebra >

std::vector<number> ug::LimexTimeIntegrator< TDomain, TAlgebra >::m_monitor

protected

Convergence monitor \alpha.

Referenced by ug::LimexTimeIntegrator< TDomain, TAlgebra >::monitor().

◆ m_num_reductions

template<class TDomain , class TAlgebra >

std::vector<size_t> ug::LimexTimeIntegrator< TDomain, TAlgebra >::m_num_reductions

protected

history of reductions

◆ m_spBanachSpace

template<class TDomain , class TAlgebra >

SmartPtr<IGridFunctionSpace<grid_function_type> > ug::LimexTimeIntegrator< TDomain, TAlgebra >::m_spBanachSpace

protected

metric space

Referenced by ug::LimexTimeIntegrator< TDomain, TAlgebra >::set_space().

◆ m_spCostStrategy

template<class TDomain , class TAlgebra >

SmartPtr<ILimexCostStrategy> ug::LimexTimeIntegrator< TDomain, TAlgebra >::m_spCostStrategy

protected

Referenced by ug::LimexTimeIntegrator< TDomain, TAlgebra >::select_cost_strategy(), and ug::LimexTimeIntegrator< TDomain, TAlgebra >::update_cost().

◆ m_spDtSol

template<class TDomain , class TAlgebra >

SmartPtr<grid_function_type> ug::LimexTimeIntegrator< TDomain, TAlgebra >::m_spDtSol

protected

Time derivative.

Referenced by ug::LimexTimeIntegrator< TDomain, TAlgebra >::get_time_derivative(), ug::LimexTimeIntegrator< TDomain, TAlgebra >::has_time_derivative(), and ug::LimexTimeIntegrator< TDomain, TAlgebra >::set_time_derivative().

◆ m_spErrorEstimator

template<class TDomain , class TAlgebra >

SmartPtr<error_estim_type> ug::LimexTimeIntegrator< TDomain, TAlgebra >::m_spErrorEstimator

protected

Referenced by ug::LimexTimeIntegrator< TDomain, TAlgebra >::add_error_estimator().

◆ m_vSteps

template<class TDomain , class TAlgebra >

std::vector<size_t> ug::LimexTimeIntegrator< TDomain, TAlgebra >::m_vSteps

protected

generating sequence for extrapolation

Referenced by ug::LimexTimeIntegrator< TDomain, TAlgebra >::add_stage_base(), ug::LimexTimeIntegrator< TDomain, TAlgebra >::LimexTimeIntegrator(), and ug::LimexTimeIntegrator< TDomain, TAlgebra >::update_cost().

◆ m_vThreadData

template<class TDomain , class TAlgebra >

std::vector<ThreadData> ug::LimexTimeIntegrator< TDomain, TAlgebra >::m_vThreadData

protected

vector with thread information

Referenced by ug::LimexTimeIntegrator< TDomain, TAlgebra >::add_stage_base(), ug::LimexTimeIntegrator< TDomain, TAlgebra >::get_time_stepper(), ug::LimexTimeIntegrator< TDomain, TAlgebra >::LimexTimeIntegrator(), and ug::LimexTimeIntegrator< TDomain, TAlgebra >::set_debug_for_timestepper().

◆ m_workload

template<class TDomain , class TAlgebra >

std::vector<number> ug::LimexTimeIntegrator< TDomain, TAlgebra >::m_workload

protected

Referenced by ug::LimexTimeIntegrator< TDomain, TAlgebra >::get_workload().

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

/home/runner/work/docs/docs/ug4/plugins/Limex/time_disc/limex_integrator.hpp

Classes

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ algebra_type

◆ base_type

◆ domain_discretization_type

◆ error_estim_type

◆ grid_function_type

◆ itime_integrator_type

◆ matrix_type

◆ solver_type

◆ thread_vector_type

◆ time_integrator_type

◆ timestep_type

◆ timex_type

◆ vector_type

Constructor & Destructor Documentation

◆ LimexTimeIntegrator()

Member Function Documentation

◆ add_error_estimator()

◆ add_stage() [1/2]

◆ add_stage() [2/2]

◆ add_stage_base()

◆ add_stage_ext()

◆ apply()

◆ apply_integrator_threads()

◆ config_string()

◆ disable_matrix_cache()

◆ dispose_integrator_threads()

◆ enable_matrix_cache()

◆ find_optimal_solution()

◆ get_cost()

◆ get_gamma()

◆ get_time_derivative()

◆ get_time_stepper()

◆ get_workload()

◆ has_time_derivative()

◆ init_gamma()

◆ init_integrator_threads()

◆ interrupt()

◆ join_integrator_threads()

◆ monitor()

◆ select_cost_strategy()

◆ set_asymptotic_order()

◆ set_conservative()

◆ set_debug_for_timestepper()

◆ set_max_reductions()

◆ set_space()

◆ set_start_step()

◆ set_stepsize_greedy_order_factor()

◆ set_stepsize_reduction_factor()

◆ set_stepsize_safety_factor()

◆ set_time_derivative()

◆ set_tolerance()

◆ update_cost()

◆ update_integrator_threads()

◆ update_monitor()

Member Data Documentation

◆ m_bInterrupt

◆ m_consistency_error

◆ m_costA

◆ m_gamma

◆ m_lambda

◆ m_limex_step

◆ m_monitor

◆ m_num_reductions

◆ m_spBanachSpace

◆ m_spCostStrategy

◆ m_spDtSol

◆ m_spErrorEstimator

◆ m_vSteps

◆ m_vThreadData

◆ m_workload