rcis¶

class rcis.rcis.CycleControls(max_iterations=1000, max_restarts=10, verbose=0)[source]¶

Bases: object

Class containg controls and infos to apply iterative solver.

This class contains variables and a reverse communicaiton method for applying iterative a solver. Constructor procedure setting main controls (e.g., maximum iterations number, verbosity) and setting to zero counter variables (e.g. number of iterations performed)

__init__(max_iterations=1000, max_restarts=10, verbose=0)[source]¶

Constructor of CycleControls setting main controls.

Constructor procedure setting main controls (e.g., maximum iterations number, verbosity) and setting to zero counter variables (e.g. number of iterations performed)

Parameters

max_iterations (int) – maximum iterations number
max_restarts (int) – maximum restart number
verbose (int) – verbosity level

max_iterations¶

Maximum iteration number

Type: int

max_restarts¶

Maximum number of restart

Type: int

verbose¶

Algorithm verbosity. verbose==0 silent verbose>0 more infos are printed

Type: int

flag¶: User comunication flag 1->set inputs, 2->stop criteria 3->study

ierr¶

State comunication flag

Type: int

iterations¶

Iterations counter

Type: int

restarts¶: Statistics of iterative algorithm

cpu_time¶

Cpu conter

Type: float

task_description(flag)[source]¶

Produce a string describing the task associated to flag :Parameters: flag (int) – Flag

Returns: msg (str) – Task description

reverse_communication()[source]¶

Subroutine to run reverse communition approach of iterative solver.

Parameters: self (CycleControls) – Counters and statistics
Returns: self (CycleControls) – Returning changed class.