Converger Class Reference

The Converger class handles converger test to indicate if the iteration converges according to various rules. More...

#include <Converger.h>

Inheritance diagram for Converger:

Collaboration diagram for Converger:

Public Member Functions
	Converger (unsigned=0, double=1E-8, unsigned=10, bool=false)
	the complete constructor.
virtual int	initialize ()
virtual unique_ptr< Converger >	unique_copy ()=0
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 std::weak_ptr< DomainBase > &)
	method to set DomainBase.
const std::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.
virtual bool	is_converged (unsigned)=0
Public Member Functions inherited from CopyableTag
	CopyableTag (const CopyableTag &)=default
	CopyableTag (CopyableTag &&)=default
CopyableTag &	operator= (const CopyableTag &)=delete
CopyableTag &	operator= (CopyableTag &&)=delete
	~CopyableTag () override=default
	Tag (unsigned=0)
	Tag (const Tag &)=default
	Tag (Tag &&) noexcept=default
Public Member Functions inherited from Tag
	Tag (unsigned=0)
	Tag (const Tag &)=default
	Tag (Tag &&) noexcept=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 ()

Protected Member Functions
vec	get_residual () const
bool	is_print () const
	method to return print_flag.

Detailed Description

The Converger class handles converger test to indicate if the iteration converges according to various rules.

The class stores a pointer factory pointed to the Workshop and get information from this Workshop. The tolerance and error are stored independently so that the Workshop will not be modified.

The class further provides a print_flag to indicate if the test information should be printed out.

Author

tlc

Date

15/09/2017

Version

0.2.1

Constructor & Destructor Documentation

Converger()

Converger::Converger ( unsigned  T = 0, double  E = 1E-8, unsigned  M = 10, bool  P = false  )

explicit

the complete constructor.

Parameters

T	unique_tag
E	tolerance
M	maximum_iteration
P	print_flag

Member Function Documentation

get_conv_flag()

bool Converger::get_conv_flag

(

)

const

method to return conv_flag.

Returns

conv_flag

Here is the caller graph for this function:

get_domain()

const std::weak_ptr< DomainBase > & Converger::get_domain

(

)

const

method to return DomainBase.

Returns

DomainBase

Here is the caller graph for this function:

get_error()

double Converger::get_error

(

)

const

method to return error.

Returns

error

Here is the caller graph for this function:

get_max_iteration()

unsigned Converger::get_max_iteration

(

)

const

Here is the caller graph for this function:

get_residual()

vec Converger::get_residual ( ) const

protected

Here is the call graph for this function:

Here is the caller graph for this function:

get_tolerance()

double Converger::get_tolerance

(

)

const

method to return tolerance.

Returns

tolerance

Here is the caller graph for this function:

initialize()

int Converger::initialize ( )

virtual

Reimplemented in LogicConverger.

is_converged()

virtual bool Converger::is_converged ( unsigned  )

pure virtual

Implemented in AbsDisp, AbsError, AbsIncreAcc, AbsIncreDisp, AbsIncreEnergy, AbsResidual, FixedNumber, LogicAND, LogicOR, LogicXOR, RelDisp, RelError, RelIncreAcc, RelIncreDisp, RelIncreEnergy, and RelResidual.

is_print()

bool Converger::is_print ( ) const

protected

method to return print_flag.

Returns

print_flag

Here is the caller graph for this function:

set_conv_flag()

void Converger::set_conv_flag ( bool  C )

virtual

method to set conv_flag.

Parameters

C

conv_flag

Here is the caller graph for this function:

set_domain()

void Converger::set_domain

(

const std::weak_ptr< DomainBase > &

D

)

method to set DomainBase.

Parameters

D	DomainBase

set_error()

void Converger::set_error ( double  E )

virtual

method to set error.

Parameters

E

error

Here is the caller graph for this function:

set_max_iteration()

void Converger::set_max_iteration

(

unsigned

M

)

set_tolerance()

void Converger::set_tolerance

(

double

T

)

method to set tolerance.

Parameters

T

tolerance

unique_copy()

virtual unique_ptr< Converger > Converger::unique_copy ( )

pure virtual

Implemented in AbsDisp, AbsError, AbsIncreAcc, AbsIncreDisp, AbsIncreEnergy, AbsResidual, FixedNumber, LogicAND, LogicOR, LogicXOR, RelDisp, RelError, RelIncreAcc, RelIncreDisp, RelIncreEnergy, and RelResidual.

---

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

• Converger/Converger.h
• Converger/Converger.cpp