Documentation for module cp_result_methods

set of type/routines to handle the storage of results in force_envs

source: cp_result_methods.F
Loading...

Generic procedures:

get_results
put_results

public Subroutines/Functions:

erase a part of result_list
broadcast results type
FUNCTION
LOGICAL
test_for_result (results, description)
test for a certain result in the result_list

Generic procedure get_results

gets the required part out of the result_list

POINTER
:: results × × ×
:: description × × ×
REAL(dp)
:: values(:) ×
REAL(dp)
:: values(:,:) ×
INTEGER,
OPTIONAL
:: nval × ×
INTEGER,
OPTIONAL
:: n_rep × × ×
INTEGER,
OPTIONAL
:: n_entries × × ×
INTEGER,
OPTIONAL
:: type_in_use ×

Generic procedure put_results

...

POINTER
:: results × ×
:: description × ×
REAL(dp)
:: values(:) ×
REAL(dp)
:: values(:,:) ×

SUBROUTINEcp_results_erase(results, description, nval)

erase a part of result_list

Arguments:
POINTER
:: results ...
OPTIONAL
:: description ...
INTEGER,
OPTIONAL
:: nval if more than one entry for a given description is given you may choose which entry you want to delete

SUBROUTINEcp_results_mp_bcast(results, source, para_env)

broadcast results type

Arguments:
POINTER
:: results ...
INTEGER,
INTENT(in)
:: source ...
POINTER
:: para_env ...

FUNCTIONtest_for_result(results, description)

test for a certain result in the result_list

Return Value ::
LOGICAL
Arguments:
POINTER
:: results ...
:: description ...

SUBROUTINEget_result_r1(results, description, values, nval, n_rep, n_entries)

gets the required part out of the result_list

Arguments:
POINTER
:: results ...
:: description ...
REAL(dp)
:: values(:) ...
INTEGER,
OPTIONAL
:: nval if more than one entry for a given description is given you may choose which entry you want
INTEGER,
OPTIONAL
:: n_rep integer indicating how many times the section exists in result_list
INTEGER,
OPTIONAL
:: n_entries gets the number of lines used for a given description

SUBROUTINEget_result_r2(results, description, values, nval, n_rep, n_entries)

gets the required part out of the result_list

Arguments:
POINTER
:: results ...
:: description ...
REAL(dp)
:: values(:,:) ...
INTEGER,
OPTIONAL
:: nval if more than one entry for a given description is given you may choose which entry you want
INTEGER,
OPTIONAL
:: n_rep integer indicating how many times the section exists in result_list
INTEGER,
OPTIONAL
:: n_entries gets the number of lines used for a given description

SUBROUTINEget_nreps(results, description, n_rep, n_entries, type_in_use)

gets the required part out of the result_list

Arguments:
POINTER
:: results ...
:: description ...
INTEGER,
OPTIONAL
:: n_rep integer indicating how many times the section exists in result_list
INTEGER,
OPTIONAL
:: n_entries gets the number of lines used for a given description
INTEGER,
OPTIONAL
:: type_in_use ...

SUBROUTINEput_result_r1(results, description, values)

Store a 1D array of reals in result_list

Arguments:
POINTER
:: results ...
:: description ...
REAL(dp)
:: values(:) ...

SUBROUTINEput_result_r2(results, description, values)

Store a 2D array of reals in result_list

Arguments:
POINTER
:: results ...
:: description ...
REAL(dp)
:: values(:,:) ...