Documentation for module reference_manager

provides a uniform framework to add references to CP2K cite and output these

source: reference_manager.F
Loading...

public Subroutines/Functions:

add a reference to the bibliography
SUBROUTINE
cite_reference (key)
marks a given reference as cited.
Checks for each reference if any mpi-rank has marked it for citation.
...
printout of all references in a specific format optionally printing only those that are actually cited during program execution
printout of a specified reference to a given unit in a selectable format
deallocate the bibliography

Parameters:

INTEGER
::
INTEGER
::
INTEGER
::

SUBROUTINEadd_reference(key, isi_record, doi)

add a reference to the bibliography

Arguments:
INTEGER,
INTENT(out)
:: key output, this handle is needed to cite this reference later
CHARACTER(*)
:: isi_record(:) ...
CHARACTER(*)
:: doi ...

SUBROUTINEcite_reference(key)

marks a given reference as cited.

Arguments:
INTEGER,
INTENT(in)
:: key citation key as returned from add_reference

SUBROUTINEcollect_citations_from_ranks(para_env)

Checks for each reference if any mpi-rank has marked it for citation.

Arguments:
POINTER
:: para_env ...

FUNCTIONget_citation_key(key)

...

Return Value ::
Arguments:
INTEGER
:: key ...

SUBROUTINEremove_all_references()

deallocate the bibliography