multi step time stepping scheme More...

#include <theta_time_step.h>

Inheritance diagram for ug::MultiStepTimeDiscretization< TAlgebra >:

Public Types
typedef TAlgebra	algebra_type
	Type of algebra. More...

typedef IDomainDiscretization< algebra_type >	domain_discretization_type
	Domain Discretization type. More...

typedef CPUAlgebra::vector_type	error_vector_type
	Type of algebra vector. More...

typedef algebra_type::matrix_type	matrix_type
	Type of algebra matrix. More...

typedef algebra_type::vector_type	vector_type
	Type of algebra vector. More...

Public Types inherited from ug::ITimeDiscretization< TAlgebra >
typedef TAlgebra	algebra_type
	Algebra type. More...

typedef IDomainDiscretization< TAlgebra >	domain_discretization_type
	Domain Discretization type. More...

typedef algebra_type::vector_type	vector_type
	Vector type. More...

Public Types inherited from ug::IAssemble< TAlgebra >
typedef TAlgebra	algebra_type
	Algebra type. More...

typedef TAlgebra::matrix_type	matrix_type
	Type of algebra matrix. More...

typedef TAlgebra::vector_type	vector_type
	Type of algebra vector. More...

Public Member Functions
void	adjust_solution (vector_type &u, const GridLevel &gl)
	sets dirichlet values in solution vector More...

void	assemble_defect (vector_type &d, const vector_type &u, const GridLevel &gl)
	assembles Defect More...

void	assemble_jacobian (matrix_type &J, const vector_type &u, const GridLevel &gl)
	assembles Jacobian (or Approximation of Jacobian) More...

void	assemble_linear (matrix_type &A, vector_type &b, const GridLevel &gl)
	Assembles Matrix and Right-Hand-Side for a linear problem. More...

void	assemble_rhs (vector_type &b, const GridLevel &gl)
	Assembles Right-Hand-Side for a linear problem. More...

void	assemble_rhs (vector_type &b, const vector_type &u, const GridLevel &gl)
	assembles rhs More...

void	calc_error (const vector_type &u)

void	calc_error (const vector_type &u, error_vector_type &u_vtk)

void	calc_error (const vector_type &u, error_vector_type *u_vtk)
	Error estimator ///. More...

virtual void	finish_step (SmartPtr< VectorTimeSeries< vector_type > > currSol)

virtual void	finish_step_elem (SmartPtr< VectorTimeSeries< vector_type > > currSol, const GridLevel &gl)

virtual number	future_time () const
	returns the future time point (i.e. the one that will be computed) More...

void	invalidate_error ()

bool	is_error_valid ()
	returns whether error indicators are valid More...

	MultiStepTimeDiscretization (SmartPtr< IDomainDiscretization< algebra_type > > spDD)
	constructor More...

virtual size_t	num_prev_steps () const
	returns number of previous time steps needed More...

virtual void	prepare_step (SmartPtr< VectorTimeSeries< vector_type > > prevSol, number dt)
	prepares the assembling of Defect/Jacobian for a time step More...

virtual void	prepare_step_elem (SmartPtr< VectorTimeSeries< vector_type > > prevSol, number dt, const GridLevel &gl)
	prepares the assembling of Defect/Jacobian for a time step More...

virtual	~MultiStepTimeDiscretization ()

Public Member Functions inherited from ug::ITimeDiscretization< TAlgebra >
virtual SmartPtr< IConstraint< TAlgebra > >	constraint (size_t i)
	returns the i'th constraint More...

SmartPtr< IDomainDiscretization< TAlgebra > >	domain_disc () const
	return underlying domain disc More...

	ITimeDiscretization (SmartPtr< IDomainDiscretization< TAlgebra > > spDD)
	create and set domain discretization More...

virtual size_t	num_constraints () const
	returns the number of constraint More...

virtual size_t	num_stages () const =0
	returns the number of stages More...

virtual void	set_stage (size_t stage)=0
	sets the stage More...

void	prepare_step_elem (SmartPtr< VectorTimeSeries< vector_type > > prevSol, number dt)
	prepares the assembling of Defect/Jacobian for a time step More...

void	finish_step_elem (SmartPtr< VectorTimeSeries< vector_type > > currSol)

Public Member Functions inherited from ug::IAssemble< TAlgebra >
void	adjust_solution (vector_type &u)

void	assemble_defect (vector_type &d, const vector_type &u)

void	assemble_jacobian (matrix_type &J, const vector_type &u)

void	assemble_linear (matrix_type &A, vector_type &b)

void	assemble_mass_matrix (matrix_type &M, const vector_type &u)

virtual void	assemble_mass_matrix (matrix_type &M, const vector_type &u, const GridLevel &gl)
	assembles mass matrix More...

void	assemble_rhs (vector_type &b)

virtual void	assemble_rhs (vector_type &rhs, const vector_type &u)

void	assemble_stiffness_matrix (matrix_type &A, const vector_type &u)

virtual void	assemble_stiffness_matrix (matrix_type &A, const vector_type &u, const GridLevel &gl)
	assembles stiffness matrix More...

virtual	~IAssemble ()
	Virtual Destructor. More...

Protected Member Functions
virtual number	update_scaling (std::vector< number > &vSM, std::vector< number > &vSA, number dt, number currentTime, ConstSmartPtr< VectorTimeSeries< vector_type > > prevSol)=0
	Error estimator ///. More...

Protected Attributes
number	m_dt
	Time Step size. More...

number	m_futureTime
	Future Time. More...

SmartPtr< VectorTimeSeries< vector_type > >	m_pPrevSol
	Previous solutions. More...

size_t	m_prevSteps
	number of previous steps needed. More...

std::vector< number >	m_vScaleMass
	Scaling for mass part. More...

std::vector< number >	m_vScaleStiff
	Scaling for stiffness part. More...

Protected Attributes inherited from ug::ITimeDiscretization< TAlgebra >
SmartPtr< IDomainDiscretization< TAlgebra > >	m_spDomDisc
	Domain Discretization. More...

Detailed Description

template<typename TAlgebra>
class ug::MultiStepTimeDiscretization< TAlgebra >

multi step time stepping scheme

Member Typedef Documentation

◆ algebra_type

template<typename TAlgebra >

typedef TAlgebra ug::MultiStepTimeDiscretization< TAlgebra >::algebra_type

Type of algebra.

◆ domain_discretization_type

template<typename TAlgebra >

typedef IDomainDiscretization<algebra_type> ug::MultiStepTimeDiscretization< TAlgebra >::domain_discretization_type

Domain Discretization type.

◆ error_vector_type

template<typename TAlgebra >

typedef CPUAlgebra::vector_type ug::MultiStepTimeDiscretization< TAlgebra >::error_vector_type

Type of algebra vector.

◆ matrix_type

template<typename TAlgebra >

typedef algebra_type::matrix_type ug::MultiStepTimeDiscretization< TAlgebra >::matrix_type

Type of algebra matrix.

◆ vector_type

template<typename TAlgebra >

typedef algebra_type::vector_type ug::MultiStepTimeDiscretization< TAlgebra >::vector_type

Type of algebra vector.

Constructor & Destructor Documentation

◆ MultiStepTimeDiscretization()

template<typename TAlgebra >

ug::MultiStepTimeDiscretization< TAlgebra >::MultiStepTimeDiscretization ( SmartPtr< IDomainDiscretization< algebra_type > > spDD )

inline

constructor

◆ ~MultiStepTimeDiscretization()

template<typename TAlgebra >

virtual ug::MultiStepTimeDiscretization< TAlgebra >::~MultiStepTimeDiscretization ( )

inlinevirtual

Member Function Documentation

◆ adjust_solution()

template<typename TAlgebra >

void ug::MultiStepTimeDiscretization< TAlgebra >::adjust_solution	(	vector_type &	u,
		const GridLevel &	gl
	)

virtual

sets dirichlet values in solution vector

Sets dirichlet values of the NumericalSolution u when components are dirichlet

Parameters

[out]	u	Numerical Solution
[in]	gl	Grid Level

Implements ug::IAssemble< TAlgebra >.

Reimplemented in ug::SDIRK< TAlgebra >.

References PROFILE_BEGIN_GROUP, and UG_CATCH_THROW.

◆ assemble_defect()

template<typename TAlgebra >

void ug::MultiStepTimeDiscretization< TAlgebra >::assemble_defect	(	vector_type &	d,
		const vector_type &	u,
		const GridLevel &	gl
	)

virtual

assembles Defect

Assembles Defect at a given Solution u.

Parameters

[out]	d	Defect d(u) to be filled
[in]	u	Current iterate
[in]	gl	Grid Level

Implements ug::IAssemble< TAlgebra >.

Reimplemented in ug::SDIRK< TAlgebra >.

References PROFILE_BEGIN_GROUP, UG_CATCH_THROW, and UG_THROW.

◆ assemble_jacobian()

template<typename TAlgebra >

void ug::MultiStepTimeDiscretization< TAlgebra >::assemble_jacobian	(	matrix_type &	J,
		const vector_type &	u,
		const GridLevel &	gl
	)

virtual

assembles Jacobian (or Approximation of Jacobian)

Assembles Jacobian at a given iterate u.

Parameters

[out]	J	Jacobian J(u) matrix to be filled
[in]	u	Current iterate
[in]	gl	Grid Level

Implements ug::IAssemble< TAlgebra >.

Reimplemented in ug::SDIRK< TAlgebra >.

References PROFILE_BEGIN_GROUP, UG_CATCH_THROW, and UG_THROW.

◆ assemble_linear()

template<typename TAlgebra >

void ug::MultiStepTimeDiscretization< TAlgebra >::assemble_linear	(	matrix_type &	A,
		vector_type &	b,
		const GridLevel &	gl
	)

virtual

Assembles Matrix and Right-Hand-Side for a linear problem.

Assembles matrix_type and Right-Hand-Side for a linear problem

Parameters

[out]	A	Mass-/Stiffness- Matrix
[out]	b	Right-Hand-Side
[in]	gl	Grid Level

Implements ug::IAssemble< TAlgebra >.

Reimplemented in ug::SDIRK< TAlgebra >.

References PROFILE_BEGIN_GROUP, UG_CATCH_THROW, and UG_THROW.

◆ assemble_rhs() [1/2]

template<typename TAlgebra >

void ug::MultiStepTimeDiscretization< TAlgebra >::assemble_rhs	(	vector_type &	b,
		const GridLevel &	gl
	)

virtual

Assembles Right-Hand-Side for a linear problem.

Assembles Right-Hand-Side for a linear problem

Parameters

[out]	b	Right-Hand-Side
[in]	gl	Grid Level

Implements ug::IAssemble< TAlgebra >.

Reimplemented in ug::SDIRK< TAlgebra >.

References PROFILE_BEGIN_GROUP, UG_CATCH_THROW, and UG_THROW.

◆ assemble_rhs() [2/2]

template<typename TAlgebra >

void ug::MultiStepTimeDiscretization< TAlgebra >::assemble_rhs	(	vector_type &	rhs,
		const vector_type &	u,
		const GridLevel &	gl
	)

virtual

assembles rhs

Implements ug::IAssemble< TAlgebra >.

Reimplemented in ug::SDIRK< TAlgebra >.

References PROFILE_BEGIN_GROUP, UG_CATCH_THROW, and UG_THROW.

◆ calc_error() [1/3]

template<typename TAlgebra >

void ug::MultiStepTimeDiscretization< TAlgebra >::calc_error ( const vector_type & u )

inline

References ug::MultiStepTimeDiscretization< TAlgebra >::calc_error().

Referenced by ug::MultiStepTimeDiscretization< TAlgebra >::calc_error().

◆ calc_error() [2/3]

template<typename TAlgebra >

void ug::MultiStepTimeDiscretization< TAlgebra >::calc_error	(	const vector_type &	u,
		error_vector_type &	u_vtk
	)

inline

References ug::MultiStepTimeDiscretization< TAlgebra >::calc_error().

Referenced by ug::MultiStepTimeDiscretization< TAlgebra >::calc_error().

◆ calc_error() [3/3]

template<typename TAlgebra >

void ug::MultiStepTimeDiscretization< TAlgebra >::calc_error	(	const vector_type &	u,
		error_vector_type *	u_vtk
	)

Error estimator ///.

calculates error indicators for elements from error estimators

References PROFILE_BEGIN_GROUP, UG_CATCH_THROW, and UG_THROW.

◆ finish_step()

template<typename TAlgebra >

void ug::MultiStepTimeDiscretization< TAlgebra >::finish_step ( SmartPtr< VectorTimeSeries< vector_type > > currSol )

virtual

finishes a time step and allows to adapt data depending on the current solution elemDisc-wise This function is called after the assembling routines at the end of a time step.

Parameters

[in]	currSol	the solution at the previous time steps
[in]	dt	size of time step

Implements ug::ITimeDiscretization< TAlgebra >.

References UG_CATCH_THROW, and UG_THROW.

◆ finish_step_elem()

template<typename TAlgebra >

void ug::MultiStepTimeDiscretization< TAlgebra >::finish_step_elem	(	SmartPtr< VectorTimeSeries< vector_type > >	currSol,
		const GridLevel &	gl
	)

virtual

finishes a time step and allows to adapt data depending on the current solution element-wise This function is called after the assembling routines at the end of a time step. Within this function "fsh_timestep_elem" is called which allows modifying data depending on the current solution at element-level.

Parameters

[in]	currSol	the current solution
[in]	dd	DoF Distribution

Implements ug::ITimeDiscretization< TAlgebra >.

References UG_CATCH_THROW, and UG_THROW.

◆ future_time()

template<typename TAlgebra >

virtual number ug::MultiStepTimeDiscretization< TAlgebra >::future_time ( ) const

inlinevirtual

returns the future time point (i.e. the one that will be computed)

Implements ug::ITimeDiscretization< TAlgebra >.

References ug::MultiStepTimeDiscretization< TAlgebra >::m_futureTime.

◆ invalidate_error()

template<typename TAlgebra >

void ug::MultiStepTimeDiscretization< TAlgebra >::invalidate_error ( )

inline

marks error indicators as invalid; in order to revalidate them, they will have to be newly calculated by a call to calc_error

References ug::ITimeDiscretization< TAlgebra >::m_spDomDisc.

◆ is_error_valid()

template<typename TAlgebra >

bool ug::MultiStepTimeDiscretization< TAlgebra >::is_error_valid ( )

inline

returns whether error indicators are valid

References ug::ITimeDiscretization< TAlgebra >::m_spDomDisc.

◆ num_prev_steps()

template<typename TAlgebra >

virtual size_t ug::MultiStepTimeDiscretization< TAlgebra >::num_prev_steps ( ) const

inlinevirtual

returns number of previous time steps needed

Implements ug::ITimeDiscretization< TAlgebra >.

References ug::MultiStepTimeDiscretization< TAlgebra >::m_prevSteps.

◆ prepare_step()

template<typename TAlgebra >

void ug::MultiStepTimeDiscretization< TAlgebra >::prepare_step	(	SmartPtr< VectorTimeSeries< vector_type > >	prevSol,
		number	dt
	)

virtual

prepares the assembling of Defect/Jacobian for a time step

This function supplies the TimeDiscretization with previous time steps and step size before the assembling routines can be called.

Parameters

[in]	prevSol	the solution at the previous time steps
[in]	dt	size of time step

Implements ug::ITimeDiscretization< TAlgebra >.

Reimplemented in ug::SDIRK< TAlgebra >.

References PROFILE_BEGIN_GROUP, UG_CATCH_THROW, and UG_THROW.

◆ prepare_step_elem()

template<typename TAlgebra >

void ug::MultiStepTimeDiscretization< TAlgebra >::prepare_step_elem	(	SmartPtr< VectorTimeSeries< vector_type > >	prevSol,
		number	dt,
		const GridLevel &	gl
	)

virtual

prepares the assembling of Defect/Jacobian for a time step

This function supplies the TimeDiscretization with previous time steps and step size before the assembling routines can be called. A sub-routine at element-level ("prep_timestep_elem") is called within this function.

Parameters

[in]	prevSol	the solution at the previous time steps
[in]	dt	size of time step
[in]	dd	DoF Distribution

Implements ug::ITimeDiscretization< TAlgebra >.

References PROFILE_BEGIN_GROUP, UG_CATCH_THROW, and UG_THROW.

◆ update_scaling()

template<typename TAlgebra >

virtual number ug::MultiStepTimeDiscretization< TAlgebra >::update_scaling	(	std::vector< number > &	vSM,
		std::vector< number > &	vSA,
		number	dt,
		number	currentTime,
		ConstSmartPtr< VectorTimeSeries< vector_type > >	prevSol
	)

protectedpure virtual

Error estimator ///.

updates the scaling factors, returns the future time

Implemented in ug::SDIRK< TAlgebra >, ug::BDF< TAlgebra >, and ug::ThetaTimeStep< TAlgebra >.

Member Data Documentation

◆ m_dt

template<typename TAlgebra >

number ug::MultiStepTimeDiscretization< TAlgebra >::m_dt

protected

Time Step size.

◆ m_futureTime

template<typename TAlgebra >

number ug::MultiStepTimeDiscretization< TAlgebra >::m_futureTime

protected

Future Time.

Referenced by ug::MultiStepTimeDiscretization< TAlgebra >::future_time().

◆ m_pPrevSol

template<typename TAlgebra >

SmartPtr<VectorTimeSeries<vector_type> > ug::MultiStepTimeDiscretization< TAlgebra >::m_pPrevSol

protected

Previous solutions.

◆ m_prevSteps

template<typename TAlgebra >

size_t ug::MultiStepTimeDiscretization< TAlgebra >::m_prevSteps

protected

number of previous steps needed.

Referenced by ug::MultiStepTimeDiscretization< TAlgebra >::num_prev_steps(), ug::SDIRK< TAlgebra >::SDIRK(), ug::BDF< TAlgebra >::set_order(), and ug::ThetaTimeStep< TAlgebra >::ThetaTimeStep().

◆ m_vScaleMass

template<typename TAlgebra >

std::vector<number> ug::MultiStepTimeDiscretization< TAlgebra >::m_vScaleMass

protected

Scaling for mass part.

◆ m_vScaleStiff

template<typename TAlgebra >

std::vector<number> ug::MultiStepTimeDiscretization< TAlgebra >::m_vScaleStiff

protected

Scaling for stiffness part.

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

ugbase/lib_disc/time_disc/theta_time_step.h
ugbase/lib_disc/time_disc/theta_time_step_impl.h

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

template<typename TAlgebra> class ug::MultiStepTimeDiscretization< TAlgebra >

Member Typedef Documentation

◆ algebra_type

◆ domain_discretization_type

◆ error_vector_type

◆ matrix_type

◆ vector_type

Constructor & Destructor Documentation

◆ MultiStepTimeDiscretization()

◆ ~MultiStepTimeDiscretization()

Member Function Documentation

◆ adjust_solution()

◆ assemble_defect()

◆ assemble_jacobian()

◆ assemble_linear()

◆ assemble_rhs() [1/2]

◆ assemble_rhs() [2/2]

◆ calc_error() [1/3]

◆ calc_error() [2/3]

◆ calc_error() [3/3]

◆ finish_step()

◆ finish_step_elem()

◆ future_time()

◆ invalidate_error()

◆ is_error_valid()

◆ num_prev_steps()

◆ prepare_step()

◆ prepare_step_elem()

◆ update_scaling()

Member Data Documentation

◆ m_dt

◆ m_futureTime

◆ m_pPrevSol

◆ m_prevSteps

◆ m_vScaleMass

◆ m_vScaleStiff

template<typename TAlgebra>
class ug::MultiStepTimeDiscretization< TAlgebra >