suanPan
RelResidual Class Referencefinal

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

#include <RelResidual.h>

Inheritance diagram for RelResidual:
Collaboration diagram for RelResidual:

Public Member Functions

 RelResidual (unsigned=0, double=1E-8, unsigned=7, bool=false)
 
unique_ptr< Convergerget_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
 
Convergeroperator= (const Converger &)=delete
 
Convergeroperator= (Converger &&)=delete
 
 ~Converger () override=default
 
virtual int initialize ()
 
virtual unique_ptr< Convergerget_copy ()=0
 
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...
 
virtual bool is_converged (unsigned)=0
 
- Public Member Functions inherited from Tag
 Tag (unsigned=0)
 
 Tag (const Tag &)=default
 
 Tag (Tag &&)=default
 
Tagoperator= (const Tag &)=delete
 
Tagoperator= (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 Converger class handles converger test to indicate if the iteration converges according to various rules.

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

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

Author
tlc
Date
27/08/2017
Version
0.1.0

Constructor & Destructor Documentation

◆ RelResidual()

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

Member Function Documentation

◆ get_copy()

unique_ptr< Converger > RelResidual::get_copy ( )
overridevirtual

Implements Converger.

◆ is_converged()

bool RelResidual::is_converged ( unsigned  counter)
overridevirtual

Implements Converger.

Here is the call graph for this function:

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