Integrate over a given time interval (for a linear problem) More...

#include <time_integrator.hpp>

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

Public Types
typedef ILinearTimeIntegrator< TDomain, TAlgebra >	base_type

typedef base_type::grid_function_type	grid_function_type

typedef ITimeDiscretization< TAlgebra >	time_disc_type

typedef VectorTimeSeries< typename base_type::vector_type >	vector_time_series_type

Public Types inherited from ug::ILinearTimeIntegrator< TDomain, TAlgebra >
typedef AssembledLinearOperator< TAlgebra >	assembled_operator_type

typedef ITimeIntegrator< TDomain, TAlgebra >	base_type

typedef ILinearOperatorInverse< vector_type >	linear_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::ITimeDiscDependentObject< TAlgebra >
typedef ITimeDiscretization< TAlgebra >	time_disc_type

Public Member Functions
bool	apply (SmartPtr< grid_function_type > u1, number t1, ConstSmartPtr< grid_function_type > u0, number t0)

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

void	set_time_step_max (number dt)

void	set_time_step_min (number dt)

void	set_tol (double tol)

	TimeIntegratorLinearAdaptive (SmartPtr< time_disc_type > tDisc1, SmartPtr< time_disc_type > tDisc2)

Public Member Functions inherited from ug::ILinearTimeIntegrator< TDomain, TAlgebra >
	ILinearTimeIntegrator ()

	ILinearTimeIntegrator (SmartPtr< linear_solver_type > lSolver)

void	set_linear_solver (SmartPtr< linear_solver_type > lSolver)

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

double	get_time_step ()

void	init ()
	init operator More...

	ITimeIntegrator ()

void	prepare (grid_function_type &u)
	prepares functions for application More...

void	set_no_log_out (bool bNoLogOut)

void	set_precision_bound (double precisionBound)

void	set_time_step (double dt)
	Set initial time step. More...

virtual	~ITimeIntegrator ()
	virtual destructor More...

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::ITimeDiscDependentObject< TAlgebra >
SmartPtr< time_disc_type >	get_time_disc ()

	ITimeDiscDependentObject (SmartPtr< time_disc_type > spTimeDisc)

Protected Types
typedef ITimeDiscDependentObject< TAlgebra >	tdisc_dep_type

Protected Attributes
double	m_dtmax

double	m_dtmin

SmartPtr< time_disc_type >	m_spTimeDisc2

double	m_tol

Protected Attributes inherited from ug::ILinearTimeIntegrator< TDomain, TAlgebra >
SmartPtr< linear_solver_type >	m_spLinearSolver

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::ITimeDiscDependentObject< TAlgebra >
SmartPtr< time_disc_type >	m_spTimeDisc

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

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)

Detailed Description

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

Integrate over a given time interval (for a linear problem)

Member Typedef Documentation

◆ base_type

template<class TDomain , class TAlgebra >

typedef ILinearTimeIntegrator<TDomain, TAlgebra> ug::TimeIntegratorLinearAdaptive< TDomain, TAlgebra >::base_type

◆ grid_function_type

template<class TDomain , class TAlgebra >

typedef base_type::grid_function_type ug::TimeIntegratorLinearAdaptive< TDomain, TAlgebra >::grid_function_type

◆ tdisc_dep_type

template<class TDomain , class TAlgebra >

typedef ITimeDiscDependentObject<TAlgebra> ug::TimeIntegratorLinearAdaptive< TDomain, TAlgebra >::tdisc_dep_type

protected

◆ time_disc_type

template<class TDomain , class TAlgebra >

typedef ITimeDiscretization<TAlgebra> ug::TimeIntegratorLinearAdaptive< TDomain, TAlgebra >::time_disc_type

◆ vector_time_series_type

template<class TDomain , class TAlgebra >

typedef VectorTimeSeries<typename base_type::vector_type> ug::TimeIntegratorLinearAdaptive< TDomain, TAlgebra >::vector_time_series_type

Constructor & Destructor Documentation

◆ TimeIntegratorLinearAdaptive()

template<class TDomain , class TAlgebra >

ug::TimeIntegratorLinearAdaptive< TDomain, TAlgebra >::TimeIntegratorLinearAdaptive	(	SmartPtr< time_disc_type >	tDisc1,
		SmartPtr< time_disc_type >	tDisc2
	)

inline

References ug::TimeIntegratorLinearAdaptive< TDomain, TAlgebra >::m_spTimeDisc2.

Member Function Documentation

◆ apply()

template<typename TDomain , typename TAlgebra >

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

virtual

Implements ug::ITimeIntegrator< TDomain, TAlgebra >.

References ug::AitkenNevilleTimex< TVector >::apply(), ug::IAssemble< class >::assemble_linear(), ug::AitkenNevilleTimex< TVector >::get_error_estimates(), make_sp(), ug::ITimeDiscretization< class >::prepare_step(), ug::AitkenNevilleTimex< TVector >::set_solution(), UG_LOG, and ug::VecAssign().

◆ init()

template<typename TDomain , typename TAlgebra >

void ug::TimeIntegratorLinearAdaptive< TDomain, TAlgebra >::init ( grid_function_type const & u )

virtual

init operator depending on a function u

This method initializes the operator. Once initialized the 'apply'-method can be called. The function u is passed here, since the linear operator may be the linearization of some non-linear operator. Thus, the operator depends on the linearization point. If the operator is not a linearization, this method can be implemented by simply calling init() and forgetting about the linearization point.

Parameters

[in] u function (linearization point)

Returns: bool success flag

Reimplemented from ug::ITimeIntegrator< TDomain, TAlgebra >.

◆ set_time_step_max()

template<class TDomain , class TAlgebra >

void ug::TimeIntegratorLinearAdaptive< TDomain, TAlgebra >::set_time_step_max ( number dt )

inline

References ug::TimeIntegratorLinearAdaptive< TDomain, TAlgebra >::m_dtmax.

◆ set_time_step_min()

template<class TDomain , class TAlgebra >

void ug::TimeIntegratorLinearAdaptive< TDomain, TAlgebra >::set_time_step_min ( number dt )

inline

References ug::TimeIntegratorLinearAdaptive< TDomain, TAlgebra >::m_dtmin.

◆ set_tol()

template<class TDomain , class TAlgebra >

void ug::TimeIntegratorLinearAdaptive< TDomain, TAlgebra >::set_tol ( double tol )

inline

References ug::TimeIntegratorLinearAdaptive< TDomain, TAlgebra >::m_tol.

Member Data Documentation

◆ m_dtmax

template<class TDomain , class TAlgebra >

double ug::TimeIntegratorLinearAdaptive< TDomain, TAlgebra >::m_dtmax

protected

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

◆ m_dtmin

template<class TDomain , class TAlgebra >

double ug::TimeIntegratorLinearAdaptive< TDomain, TAlgebra >::m_dtmin

protected

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

◆ m_spTimeDisc2

template<class TDomain , class TAlgebra >

SmartPtr<time_disc_type> ug::TimeIntegratorLinearAdaptive< TDomain, TAlgebra >::m_spTimeDisc2

protected

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

◆ m_tol

template<class TDomain , class TAlgebra >

double ug::TimeIntegratorLinearAdaptive< TDomain, TAlgebra >::m_tol

protected

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

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

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

Public Types

Public Member Functions

Protected Types

Protected Attributes

Additional Inherited Members

Detailed Description

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

Member Typedef Documentation

◆ base_type

◆ grid_function_type

◆ tdisc_dep_type

◆ time_disc_type

◆ vector_time_series_type

Constructor & Destructor Documentation

◆ TimeIntegratorLinearAdaptive()

Member Function Documentation

◆ apply()

◆ init()

◆ set_time_step_max()

◆ set_time_step_min()

◆ set_tol()

Member Data Documentation

◆ m_dtmax

◆ m_dtmin

◆ m_spTimeDisc2

◆ m_tol

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