The RelError class that handles converger test to indicate if the iteration converges. More...

#include <RelError.h>

Inheritance diagram for RelError:

Collaboration diagram for RelError:

Public Member Functions
	RelError (unsigned=0, double=1E-8, unsigned=7, bool=false)
	The default constructor.

unique_ptr< Converger >	get_copy () override

bool	is_converged (unsigned) override
	Method to return `conv_flag`.

Public Member Functions inherited from Converger
	Converger (unsigned=0, double=1E-8, unsigned=10, bool=false)
	the complete constructor.

	Converger (const Converger &)=default

	Converger (Converger &&)=default

Converger &	operator= (const Converger &)=delete

Converger &	operator= (Converger &&)=delete

	~Converger () override=default

virtual int	initialize ()

void	set_tolerance (double)
	method to set `tolerance`.

double	get_tolerance () const
	method to return `tolerance`.

void	set_max_iteration (unsigned)

unsigned	get_max_iteration () const

void	set_domain (const weak_ptr< DomainBase > &)
	method to set `DomainBase`.

const weak_ptr< DomainBase > &	get_domain () const
	method to return `DomainBase`.

virtual void	set_error (double)
	method to set `error`.

double	get_error () const
	method to return `error`.

virtual void	set_conv_flag (bool)
	method to set `conv_flag`.

bool	get_conv_flag () const
	method to return `conv_flag`.

Public Member Functions inherited from Tag
	Tag (unsigned=0)

	Tag (const Tag &)=default

	Tag (Tag &&)=default

Tag &	operator= (const Tag &)=delete

Tag &	operator= (Tag &&)=delete

virtual	~Tag ()=default

void	set_tag (unsigned) const

unsigned	get_tag () const

void	enable ()

void	disable ()

void	guard ()

void	unguard ()

bool	is_active () const

bool	is_guarded () const

virtual void	print ()

Additional Inherited Members
Protected Member Functions inherited from Converger
vec	get_residual () const

bool	is_print () const
	method to return `print_flag`.

Detailed Description

The RelError class that handles converger test to indicate if the iteration converges.

Constructor & Destructor Documentation

explicit

The default constructor.

Parameters

unique_ptr< Converger > RelError::get_copy ( )

overridevirtual

Implements Converger.

bool RelError::is_converged ( unsigned )

overridevirtual

Method to return conv_flag.

Implements Converger.

Here is the call graph for this function:

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