Sample class for integration observer: Output to VTK. More...

#include <time_integrator.hpp>

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

Public Types
typedef ITimeIntegratorObserver< TDomain, TAlgebra >	base_type

typedef GridFunction< TDomain, TAlgebra >	grid_function_type

typedef VTKOutput< TDomain::dim >	vtk_type

Public Types inherited from ug::ITimeIntegratorObserver< TDomain, TAlgebra >
typedef GridFunction< TDomain, TAlgebra >	grid_function_type

Public Member Functions
bool	end_action (SmartPtr< grid_function_type > u, int step, number time, number dt) OVERRIDE

bool	finalize_action (SmartPtr< grid_function_type > uNew, int step, number time, number dt) OVERRIDE

void	set_output_scales (const std::vector< number > &vScales)

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

bool	step_process (SmartPtr< grid_function_type > uNew, int step, number time, number dt) OVERRIDE

	VTKOutputObserver ()

	VTKOutputObserver (const char *filename, SmartPtr< vtk_type > vtk)

	VTKOutputObserver (const char *filename, SmartPtr< vtk_type > vtk, number plotStep)

virtual	~VTKOutputObserver ()

Public Member Functions inherited from ug::ITimeIntegratorObserver< TDomain, TAlgebra >
virtual	~ITimeIntegratorObserver ()

Protected Attributes
std::string	m_filename

number	m_plotStep

SmartPtr< vtk_type >	m_sp_vtk

number	m_startTime

SmartPtr< grid_function_type >	m_uOld

std::vector< number >	m_vOutputScales

Private Member Functions
void	writeToFile (SmartPtr< grid_function_type > u, int step, number time)

Detailed Description

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

Sample class for integration observer: Output to VTK.

Member Typedef Documentation

◆ base_type

template<class TDomain , class TAlgebra >

typedef ITimeIntegratorObserver<TDomain, TAlgebra> ug::VTKOutputObserver< TDomain, TAlgebra >::base_type

◆ grid_function_type

template<class TDomain , class TAlgebra >

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

◆ vtk_type

template<class TDomain , class TAlgebra >

typedef VTKOutput<TDomain::dim> ug::VTKOutputObserver< TDomain, TAlgebra >::vtk_type

Constructor & Destructor Documentation

◆ VTKOutputObserver() [1/3]

template<class TDomain , class TAlgebra >

ug::VTKOutputObserver< TDomain, TAlgebra >::VTKOutputObserver ( )

inline

◆ VTKOutputObserver() [2/3]

template<class TDomain , class TAlgebra >

ug::VTKOutputObserver< TDomain, TAlgebra >::VTKOutputObserver	(	const char *	filename,
		SmartPtr< vtk_type >	vtk
	)

inline

◆ VTKOutputObserver() [3/3]

template<class TDomain , class TAlgebra >

ug::VTKOutputObserver< TDomain, TAlgebra >::VTKOutputObserver	(	const char *	filename,
		SmartPtr< vtk_type >	vtk,
		number	plotStep
	)

inline

◆ ~VTKOutputObserver()

template<class TDomain , class TAlgebra >

virtual ug::VTKOutputObserver< TDomain, TAlgebra >::~VTKOutputObserver ( )

inlinevirtual

References ug::VTKOutputObserver< TDomain, TAlgebra >::m_sp_vtk, and SPNULL.

Member Function Documentation

◆ end_action()

template<class TDomain , class TAlgebra >

bool ug::VTKOutputObserver< TDomain, TAlgebra >::end_action	(	SmartPtr< grid_function_type >	u,
		int	step,
		number	time,
		number	dt
	)

inline

References ug::VTKOutputObserver< TDomain, TAlgebra >::m_filename, and ug::VTKOutputObserver< TDomain, TAlgebra >::m_sp_vtk.

◆ finalize_action()

template<class TDomain , class TAlgebra >

bool ug::VTKOutputObserver< TDomain, TAlgebra >::finalize_action	(	SmartPtr< grid_function_type >	uNew,
		int	step,
		number	time,
		number	dt
	)

inline

References ug::VTKOutputObserver< TDomain, TAlgebra >::m_plotStep, ug::VTKOutputObserver< TDomain, TAlgebra >::m_sp_vtk, ug::VTKOutputObserver< TDomain, TAlgebra >::m_startTime, ug::VTKOutputObserver< TDomain, TAlgebra >::m_uOld, ug::VecScaleAdd(), and ug::VTKOutputObserver< TDomain, TAlgebra >::writeToFile().

◆ set_output_scales()

template<class TDomain , class TAlgebra >

void ug::VTKOutputObserver< TDomain, TAlgebra >::set_output_scales ( const std::vector< number > & vScales )

inline

References ug::VTKOutputObserver< TDomain, TAlgebra >::m_vOutputScales.

◆ start_action()

template<class TDomain , class TAlgebra >

bool ug::VTKOutputObserver< TDomain, TAlgebra >::start_action	(	SmartPtr< grid_function_type >	u,
		int	step,
		number	time,
		number	dt
	)

inline

References ug::VTKOutputObserver< TDomain, TAlgebra >::m_sp_vtk, ug::VTKOutputObserver< TDomain, TAlgebra >::m_startTime, ug::VTKOutputObserver< TDomain, TAlgebra >::m_uOld, and ug::VTKOutputObserver< TDomain, TAlgebra >::writeToFile().

◆ step_process()

template<class TDomain , class TAlgebra >

bool ug::VTKOutputObserver< TDomain, TAlgebra >::step_process	(	SmartPtr< grid_function_type >	uNew,
		int	step,
		number	time,
		number	dt
	)

inlinevirtual

Implements ug::ITimeIntegratorObserver< TDomain, TAlgebra >.

◆ writeToFile()

template<class TDomain , class TAlgebra >

void ug::VTKOutputObserver< TDomain, TAlgebra >::writeToFile	(	SmartPtr< grid_function_type >	u,
		int	step,
		number	time
	)

inlineprivate

References ug::VTKOutputObserver< TDomain, TAlgebra >::m_filename, ug::VTKOutputObserver< TDomain, TAlgebra >::m_sp_vtk, and ug::VTKOutputObserver< TDomain, TAlgebra >::m_vOutputScales.

Referenced by ug::VTKOutputObserver< TDomain, TAlgebra >::finalize_action(), and ug::VTKOutputObserver< TDomain, TAlgebra >::start_action().

Member Data Documentation

◆ m_filename

template<class TDomain , class TAlgebra >

std::string ug::VTKOutputObserver< TDomain, TAlgebra >::m_filename

protected

Referenced by ug::VTKOutputObserver< TDomain, TAlgebra >::end_action(), and ug::VTKOutputObserver< TDomain, TAlgebra >::writeToFile().

◆ m_plotStep

template<class TDomain , class TAlgebra >

number ug::VTKOutputObserver< TDomain, TAlgebra >::m_plotStep

protected

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

◆ m_sp_vtk

template<class TDomain , class TAlgebra >

SmartPtr<vtk_type> ug::VTKOutputObserver< TDomain, TAlgebra >::m_sp_vtk

protected

Referenced by ug::VTKOutputObserver< TDomain, TAlgebra >::end_action(), ug::VTKOutputObserver< TDomain, TAlgebra >::finalize_action(), ug::VTKOutputObserver< TDomain, TAlgebra >::start_action(), ug::VTKOutputObserver< TDomain, TAlgebra >::writeToFile(), and ug::VTKOutputObserver< TDomain, TAlgebra >::~VTKOutputObserver().

◆ m_startTime

template<class TDomain , class TAlgebra >

number ug::VTKOutputObserver< TDomain, TAlgebra >::m_startTime

protected

Referenced by ug::VTKOutputObserver< TDomain, TAlgebra >::finalize_action(), and ug::VTKOutputObserver< TDomain, TAlgebra >::start_action().

◆ m_uOld

template<class TDomain , class TAlgebra >

SmartPtr<grid_function_type> ug::VTKOutputObserver< TDomain, TAlgebra >::m_uOld

protected

Referenced by ug::VTKOutputObserver< TDomain, TAlgebra >::finalize_action(), and ug::VTKOutputObserver< TDomain, TAlgebra >::start_action().

◆ m_vOutputScales

template<class TDomain , class TAlgebra >

std::vector<number> ug::VTKOutputObserver< TDomain, TAlgebra >::m_vOutputScales

protected

Referenced by ug::VTKOutputObserver< TDomain, TAlgebra >::set_output_scales(), and ug::VTKOutputObserver< TDomain, TAlgebra >::writeToFile().

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 Attributes

Private Member Functions

Detailed Description

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

Member Typedef Documentation

◆ base_type

◆ grid_function_type

◆ vtk_type

Constructor & Destructor Documentation

◆ VTKOutputObserver() [1/3]

◆ VTKOutputObserver() [2/3]

◆ VTKOutputObserver() [3/3]

◆ ~VTKOutputObserver()

Member Function Documentation

◆ end_action()

◆ finalize_action()

◆ set_output_scales()

◆ start_action()

◆ step_process()

◆ writeToFile()

Member Data Documentation

◆ m_filename

◆ m_plotStep

◆ m_sp_vtk

◆ m_startTime

◆ m_uOld

◆ m_vOutputScales

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