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

#include <LogicConverger.h>

Inheritance diagram for LogicConverger:

Collaboration diagram for LogicConverger:

Public Member Functions
	LogicConverger (unsigned, unsigned, unsigned)

int	initialize () override

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

virtual unique_ptr< Converger >	get_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 CopiableTag
	CopiableTag (const CopiableTag &)=default

	CopiableTag (CopiableTag &&)=default

CopiableTag &	operator= (const CopiableTag &)=delete

CopiableTag &	operator= (CopiableTag &&)=delete

	~CopiableTag () 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 Attributes
shared_ptr< Converger >	converger_a

shared_ptr< Converger >	converger_b

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 LogicConverger class that handles converger test to indicate if the iteration converges.

Author: tlc

Date: 26/03/2022

Version: 0.1.0

Constructor & Destructor Documentation

◆ LogicConverger()

LogicConverger::LogicConverger	(	unsigned	T,
		unsigned	TA,
		unsigned	TB
	)

Member Function Documentation

◆ initialize()

int LogicConverger::initialize ( )

overridevirtual

Reimplemented from Converger.

Here is the call graph for this function:

Member Data Documentation

◆ converger_a

shared_ptr<Converger> LogicConverger::converger_a

protected

◆ converger_b

shared_ptr<Converger> LogicConverger::converger_b

protected

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

Converger/LogicConverger.h
Converger/LogicConverger.cpp

Public Member Functions

Protected Attributes

Additional Inherited Members