(git:6a2e663)
arnoldi_data_methods Module Reference

The methods which allow to analyze and manipulate the arnoldi procedure The main routine and this should eb the only public access point for the method. More...

Functions/Subroutines

subroutine, public setup_arnoldi_data (arnoldi_data, matrix, max_iter, threshold, selection_crit, nval_request, nrestarts, generalized_ev, iram)
 This routine sets the environment for the arnoldi iteration and the krylov subspace creation. All simulation parameters have to be given at this stage so the rest can run fully automated In addition, this routine allocates the data necessary for. More...
 
subroutine, public get_selected_ritz_vector (arnoldi_data, ind, matrix, vector)
 Deallocate the data in arnoldi_data. More...
 
subroutine, public deallocate_arnoldi_data (arnoldi_data)
 Deallocate the data in arnoldi_data. More...
 
subroutine, public select_evals (arnoldi_data)
 perform the selection of eigenvalues, fills the selected_ind array More...
 
integer function, public get_nrestart (arnoldi_data)
 returns the number of restarts allowed for arnoldi More...
 
logical function, public arnoldi_is_converged (ar_data)
 Find out whether the method with the current search criterion is converged. More...
 
complex(real_8) function, public get_selected_ritz_val (ar_data, ind)
 get a single specific Ritz value from the set of selected More...
 
subroutine, public set_arnoldi_initial_vector (ar_data, vector)
 ... More...
 

Detailed Description

The methods which allow to analyze and manipulate the arnoldi procedure The main routine and this should eb the only public access point for the method.

History
2014.09 created [Florian Schiffmann]
Author
Florian Schiffmann

Function/Subroutine Documentation

◆ setup_arnoldi_data()

subroutine, public arnoldi_data_methods::setup_arnoldi_data ( type(arnoldi_data_type arnoldi_data,
type(dbcsr_p_type), dimension(:)  matrix,
integer  max_iter,
real(real_8)  threshold,
integer  selection_crit,
integer  nval_request,
integer  nrestarts,
logical  generalized_ev,
logical  iram 
)

This routine sets the environment for the arnoldi iteration and the krylov subspace creation. All simulation parameters have to be given at this stage so the rest can run fully automated In addition, this routine allocates the data necessary for.

Parameters
arnoldi_datathis type which gets filled with information and on output contains all information necessary to extract whatever the user desires
matrixvector of matrices, only the first gets used to get some dimensions and parallel information needed later on
max_itermaximum dimension of the krylov subspace
thresholdconvergence threshold, this is used for both subspace and eigenval
selection_critinteger defining according to which criterion the eigenvalues are selected for the subspace
nval_requestfor some sel_crit useful, how many eV to select
nrestarts...
generalized_ev...
iram...

Definition at line 62 of file arnoldi_data_methods.F.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ get_selected_ritz_vector()

subroutine, public arnoldi_data_methods::get_selected_ritz_vector ( type(arnoldi_data_type arnoldi_data,
integer  ind,
type(dbcsr_type)  matrix,
type(dbcsr_type)  vector 
)

Deallocate the data in arnoldi_data.

Parameters
arnoldi_data...
ind...
matrix...
vector...

Definition at line 172 of file arnoldi_data_methods.F.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ deallocate_arnoldi_data()

subroutine, public arnoldi_data_methods::deallocate_arnoldi_data ( type(arnoldi_data_type arnoldi_data)

Deallocate the data in arnoldi_data.

Parameters
arnoldi_data...

Definition at line 186 of file arnoldi_data_methods.F.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ select_evals()

subroutine, public arnoldi_data_methods::select_evals ( type(arnoldi_data_type arnoldi_data)

perform the selection of eigenvalues, fills the selected_ind array

Parameters
arnoldi_data...

Definition at line 204 of file arnoldi_data_methods.F.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ get_nrestart()

integer function, public arnoldi_data_methods::get_nrestart ( type(arnoldi_data_type arnoldi_data)

returns the number of restarts allowed for arnoldi

Parameters
arnoldi_data...
Returns
...

Definition at line 232 of file arnoldi_data_methods.F.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ arnoldi_is_converged()

logical function, public arnoldi_data_methods::arnoldi_is_converged ( type(arnoldi_data_type ar_data)

Find out whether the method with the current search criterion is converged.

Parameters
ar_data...
Returns
...

Definition at line 281 of file arnoldi_data_methods.F.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ get_selected_ritz_val()

complex(real_8) function, public arnoldi_data_methods::get_selected_ritz_val ( type(arnoldi_data_type ar_data,
integer  ind 
)

get a single specific Ritz value from the set of selected

Parameters
ar_data...
ind...
Returns
...

Definition at line 298 of file arnoldi_data_methods.F.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ set_arnoldi_initial_vector()

subroutine, public arnoldi_data_methods::set_arnoldi_initial_vector ( type(arnoldi_data_type ar_data,
type(dbcsr_type)  vector 
)

...

Parameters
ar_data...
vector...

Definition at line 354 of file arnoldi_data_methods.F.

Here is the call graph for this function:
Here is the caller graph for this function: