NTPoly
Data Types | Functions/Subroutines
iterativesolversmodule Module Reference

A Module For Storing The Parameters For Iterative Solvers. More...

Data Types

interface  iterativesolverparameters_t
 A class for passing parameters to an iterative solver. More...
 

Functions/Subroutines

pure subroutine, public setiterativeconvergediff (this, new_value)
 Set the value of the convergence difference. More...
 
pure subroutine, public setiterativemaxiterations (this, new_value)
 Set the value of the max iterations. More...
 
pure subroutine, public setiterativethreshold (this, new_value)
 Set the value of the threshold. More...
 
pure subroutine, public setiterativebeverbose (this, new_value)
 Set the value of the verbosity. More...
 
pure subroutine, public setiterativeloadbalance (this, new_value)
 Set the value of the load balance. More...
 
subroutine, public printiterativesolverparameters (this)
 Print out the convergence values. More...
 

Detailed Description

A Module For Storing The Parameters For Iterative Solvers.

Function/Subroutine Documentation

◆ printiterativesolverparameters()

subroutine, public iterativesolversmodule::printiterativesolverparameters ( type(iterativesolverparameters_t), intent(in)  this)

Print out the convergence values.

Parameters
[in,out]thisthe parameter object.

◆ setiterativebeverbose()

pure subroutine, public iterativesolversmodule::setiterativebeverbose ( type(iterativesolverparameters_t), intent(inout)  this,
logical, intent(in)  new_value 
)

Set the value of the verbosity.

Parameters
[in,out]thisthe parameter object.
[in]new_valueto set it to.

◆ setiterativeconvergediff()

pure subroutine, public iterativesolversmodule::setiterativeconvergediff ( type(iterativesolverparameters_t), intent(inout)  this,
real(ntreal), intent(in)  new_value 
)

Set the value of the convergence difference.

Parameters
[in,out]thisthe parameter object.
[in]new_valueto set it to.

◆ setiterativeloadbalance()

pure subroutine, public iterativesolversmodule::setiterativeloadbalance ( type(iterativesolverparameters_t), intent(inout)  this,
type(permutation_t), intent(in)  new_value 
)

Set the value of the load balance.

Parameters
[in,out]thisthe parameter object.
[in]new_valueto set it to.

◆ setiterativemaxiterations()

pure subroutine, public iterativesolversmodule::setiterativemaxiterations ( type(iterativesolverparameters_t), intent(inout)  this,
integer, intent(in)  new_value 
)

Set the value of the max iterations.

Parameters
[in,out]thisthe parameter object.
[in]new_valueto set it to.

◆ setiterativethreshold()

pure subroutine, public iterativesolversmodule::setiterativethreshold ( type(iterativesolverparameters_t), intent(inout)  this,
real(ntreal), intent(in)  new_value 
)

Set the value of the threshold.

Parameters
[in,out]thisthe parameter object.
[in]new_valueto set it to.