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

#include <AbsIncreEnergy.h>

Inheritance diagram for AbsIncreEnergy:

Collaboration diagram for AbsIncreEnergy:

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

unique_ptr< Converger >	get_copy () override

bool	is_converged (unsigned) override

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

	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`. More...

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

void	set_max_iteration (unsigned)

unsigned	get_max_iteration () const

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

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

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

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

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

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

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`. More...

Detailed Description

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

The criterion:

\begin{gather} \big|\big|\Delta{}u\cdot{}\Delta{}r\big|\big|_2<E, \end{gather}

where \(E\) is the tolerance.

Author: tlc

Date: 16/09/2017

Version: 0.1.0

Constructor & Destructor Documentation

◆ AbsIncreEnergy()

AbsIncreEnergy::AbsIncreEnergy	(	unsigned	T = `0`,
		double	E = `1E-8`,
		unsigned	M = `7`,
		bool	P = `false`
	)

explicit

The complete constructor.

Parameters

T	`unique_tag`
E	`tolerance`
M	`max_iteration`
P	`print_flag`

Member Function Documentation

◆ get_copy()

unique_ptr< Converger > AbsIncreEnergy::get_copy ( )

overridevirtual

Implements Converger.

◆ is_converged()

bool AbsIncreEnergy::is_converged ( unsigned )

overridevirtual

Implements Converger.

Here is the call graph for this function:

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

Converger/AbsIncreEnergy.h
Converger/AbsIncreEnergy.cpp