#include <debug_writer.h>

Inheritance diagram for ug::VectorDebugWritingObject< TVector >:

Public Types
typedef TVector	vector_type
	type of vector More...

Public Member Functions
virtual void	set_debug (SmartPtr< IVectorDebugWriter< vector_type > > spDebugWriter)
	set debug writer More...

SmartPtr< IVectorDebugWriter< vector_type > >	vector_debug_writer ()
	returns the debug writer More...

ConstSmartPtr< IVectorDebugWriter< vector_type > >	vector_debug_writer () const

bool	vector_debug_writer_valid () const
	returns true if the debug writer is set More...

	VectorDebugWritingObject ()

	VectorDebugWritingObject (SmartPtr< IVectorDebugWriter< vector_type > > spDebugWriter)

void	write_debug (const vector_type &vec, const char *filename)
	writing debug output for a vector (if debug writer set) More...

virtual	~VectorDebugWritingObject ()
	virtual destructor More...

Protected Member Functions
void	enter_vector_debug_writer_section (const char *secDir)
	enters a debugging section More...

void	enter_vector_debug_writer_section (std::string secDir)
	enters a debugging section More...

void	leave_vector_debug_writer_section ()
	leaves a debugging section More...

void	print_debugger_message (const char *msg)
	prints a debugger message (listing all the sections) More...

void	print_debugger_message (std::string msg)
	prints a debugger message (listing all the sections) More...

virtual void	write_debug (const vector_type &vec, std::string name)
	writing debug output for a vector (if debug writer set) More...

Protected Attributes
SmartPtr< IVectorDebugWriter< vector_type > >	m_spVectorDebugWriter
	Debug Writer. More...

Member Typedef Documentation

◆ vector_type

template<typename TVector >

typedef TVector ug::VectorDebugWritingObject< TVector >::vector_type

type of vector

Constructor & Destructor Documentation

◆ VectorDebugWritingObject() [1/2]

template<typename TVector >

ug::VectorDebugWritingObject< TVector >::VectorDebugWritingObject ( )

inline

◆ VectorDebugWritingObject() [2/2]

template<typename TVector >

ug::VectorDebugWritingObject< TVector >::VectorDebugWritingObject ( SmartPtr< IVectorDebugWriter< vector_type > > spDebugWriter )

inline

◆ ~VectorDebugWritingObject()

template<typename TVector >

virtual ug::VectorDebugWritingObject< TVector >::~VectorDebugWritingObject ( )

inlinevirtual

virtual destructor

Member Function Documentation

◆ enter_vector_debug_writer_section() [1/2]

template<typename TVector >

void ug::VectorDebugWritingObject< TVector >::enter_vector_debug_writer_section ( const char * secDir )

inlineprotected

enters a debugging section

References ug::VectorDebugWritingObject< TVector >::m_spVectorDebugWriter.

◆ enter_vector_debug_writer_section() [2/2]

template<typename TVector >

void ug::VectorDebugWritingObject< TVector >::enter_vector_debug_writer_section ( std::string secDir )

inlineprotected

enters a debugging section

Referenced by ug::CG< TVector >::enter_precond_debug_section(), ug::LinearSolver< TVector >::enter_precond_debug_section(), and ug::BiCGStab< TVector >::enter_precond_debug_section().

◆ leave_vector_debug_writer_section()

template<typename TVector >

void ug::VectorDebugWritingObject< TVector >::leave_vector_debug_writer_section ( )

inlineprotected

leaves a debugging section

References ug::VectorDebugWritingObject< TVector >::m_spVectorDebugWriter.

Referenced by ug::BiCGStab< TVector >::apply_return_defect(), ug::CG< TVector >::apply_return_defect(), and ug::LinearSolver< TVector >::apply_return_defect().

◆ print_debugger_message() [1/2]

template<typename TVector >

void ug::VectorDebugWritingObject< TVector >::print_debugger_message ( const char * msg )

inlineprotected

prints a debugger message (listing all the sections)

References ug::VectorDebugWritingObject< TVector >::m_spVectorDebugWriter.

◆ print_debugger_message() [2/2]

template<typename TVector >

void ug::VectorDebugWritingObject< TVector >::print_debugger_message ( std::string msg )

inlineprotected

prints a debugger message (listing all the sections)

◆ set_debug()

template<typename TVector >

virtual void ug::VectorDebugWritingObject< TVector >::set_debug ( SmartPtr< IVectorDebugWriter< vector_type > > spDebugWriter )

inlinevirtual

set debug writer

References ug::VectorDebugWritingObject< TVector >::m_spVectorDebugWriter.

Referenced by ug::DebugWritingObject< TAlgebra >::set_debug(), and ug::FETISolver< TAlgebra >::set_debug().

◆ vector_debug_writer() [1/2]

template<typename TVector >

SmartPtr<IVectorDebugWriter<vector_type> > ug::VectorDebugWritingObject< TVector >::vector_debug_writer ( )

inline

returns the debug writer

References ug::VectorDebugWritingObject< TVector >::m_spVectorDebugWriter.

Referenced by ug::DebugIterator< TAlgebra >::clone().

◆ vector_debug_writer() [2/2]

template<typename TVector >

ConstSmartPtr<IVectorDebugWriter<vector_type> > ug::VectorDebugWritingObject< TVector >::vector_debug_writer ( ) const

inline

References ug::VectorDebugWritingObject< TVector >::m_spVectorDebugWriter.

◆ vector_debug_writer_valid()

template<typename TVector >

bool ug::VectorDebugWritingObject< TVector >::vector_debug_writer_valid ( ) const

inline

returns true if the debug writer is set

References ug::VectorDebugWritingObject< TVector >::m_spVectorDebugWriter.

Referenced by ug::LinearSolver< TVector >::apply_return_defect(), ug::CG< TVector >::enter_precond_debug_section(), ug::LinearSolver< TVector >::enter_precond_debug_section(), ug::BiCGStab< TVector >::enter_precond_debug_section(), ug::LinearSolver< TVector >::write_debugXCD(), ug::CG< TVector >::write_debugXR(), and ug::BiCGStab< TVector >::write_debugXR().

◆ write_debug() [1/2]

template<typename TVector >

void ug::VectorDebugWritingObject< TVector >::write_debug	(	const vector_type &	vec,
		const char *	filename
	)

inline

writing debug output for a vector (if debug writer set)

Referenced by ug::AutoLinearSolver< TVector >::apply_return_defect(), ug::LinearSolver< TVector >::apply_return_defect(), ug::LinearSolver< TVector >::write_debugXCD(), ug::CG< TVector >::write_debugXR(), and ug::BiCGStab< TVector >::write_debugXR().

◆ write_debug() [2/2]

template<typename TVector >

virtual void ug::VectorDebugWritingObject< TVector >::write_debug	(	const vector_type &	vec,
		std::string	name
	)

inlineprotectedvirtual

writing debug output for a vector (if debug writer set)

Reimplemented in ug::NewtonSolver< TAlgebra >.

References ug::VectorDebugWritingObject< TVector >::m_spVectorDebugWriter, name, PROFILE_FUNC_GROUP, and UG_THROW.

Member Data Documentation

◆ m_spVectorDebugWriter

template<typename TVector >

SmartPtr<IVectorDebugWriter<vector_type> > ug::VectorDebugWritingObject< TVector >::m_spVectorDebugWriter

protected

Debug Writer.

Referenced by ug::VectorDebugWritingObject< TVector >::enter_vector_debug_writer_section(), ug::VectorDebugWritingObject< TVector >::leave_vector_debug_writer_section(), ug::VectorDebugWritingObject< TVector >::print_debugger_message(), ug::VectorDebugWritingObject< TVector >::set_debug(), ug::VectorDebugWritingObject< TVector >::vector_debug_writer(), ug::VectorDebugWritingObject< TVector >::vector_debug_writer_valid(), and ug::VectorDebugWritingObject< TVector >::write_debug().

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

ugbase/lib_algebra/operator/debug_writer.h

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Member Typedef Documentation

◆ vector_type

Constructor & Destructor Documentation

◆ VectorDebugWritingObject() [1/2]

◆ VectorDebugWritingObject() [2/2]

◆ ~VectorDebugWritingObject()

Member Function Documentation

◆ enter_vector_debug_writer_section() [1/2]

◆ enter_vector_debug_writer_section() [2/2]

◆ leave_vector_debug_writer_section()

◆ print_debugger_message() [1/2]

◆ print_debugger_message() [2/2]

◆ set_debug()

◆ vector_debug_writer() [1/2]

◆ vector_debug_writer() [2/2]

◆ vector_debug_writer_valid()

◆ write_debug() [1/2]

◆ write_debug() [2/2]

Member Data Documentation

◆ m_spVectorDebugWriter