Octopus
states_elec_restart_oct_m Module Reference

This module handles reading and writing restart information for the states_elec_t. More...

Detailed Description

This module handles reading and writing restart information for the states_elec_t.

Functions/Subroutines

subroutine, public states_elec_look_and_load (restart, namespace, space, st, mesh, kpoints, is_complex, packed)
 
subroutine, public states_elec_dump (restart, space, st, mesh, kpoints, ierr, iter, lr, verbose)
 
subroutine states_elec_dump_adios2 (restart, st, mesh, ierr)
 
subroutine, public states_elec_load (restart, namespace, space, st, mesh, kpoints, ierr, iter, lr, lowest_missing, label, verbose, skip)
 returns in ierr: <0 => Fatal error, or nothing read =0 => read all wavefunctions >0 => could only read ierr wavefunctions More...
 
subroutine states_elec_load_adios2 (restart, st, mesh, iread, filled, ierr)
 
subroutine, public states_elec_dump_rho (restart, space, st, mesh, ierr, iter)
 
subroutine, public states_elec_load_rho (restart, space, st, mesh, ierr)
 
subroutine, public states_elec_dump_frozen (restart, space, st, mesh, ierr)
 
subroutine, public states_elec_load_frozen (restart, space, st, mesh, ierr)
 
subroutine, public states_elec_read_user_def_orbitals (mesh, namespace, space, st)
 the routine reads formulas for user-defined wavefunctions from the input file and fills the respective orbitals More...
 
subroutine, public states_elec_dump_spin (restart, st, ierr)
 
subroutine, public states_elec_load_spin (restart, st, ierr)
 returns in ierr: <0 => Fatal error, or nothing read =0 => read all wavefunctions >0 => could only read ierr wavefunctions More...
 
subroutine, public states_elec_transform (st, namespace, space, restart, mesh, kpoints, prefix)
 

Function/Subroutine Documentation

◆ states_elec_look_and_load()

subroutine, public states_elec_restart_oct_m::states_elec_look_and_load ( type(restart_t), intent(in)  restart,
type(namespace_t), intent(in)  namespace,
class(space_t), intent(in)  space,
type(states_elec_t), intent(inout), target  st,
class(mesh_t), intent(in)  mesh,
type(kpoints_t), intent(in)  kpoints,
logical, intent(in), optional  is_complex,
logical, intent(in), optional  packed 
)
Parameters
[in]packedDo we allocate packed wavefunctions or not. False means not on GPU

Definition at line 176 of file states_elec_restart.F90.

◆ states_elec_dump()

subroutine, public states_elec_restart_oct_m::states_elec_dump ( type(restart_t), intent(in)  restart,
class(space_t), intent(in)  space,
type(states_elec_t), intent(in), target  st,
class(mesh_t), intent(in)  mesh,
type(kpoints_t), intent(in)  kpoints,
integer, intent(out)  ierr,
integer, intent(in), optional  iter,
type(lr_t), intent(in), optional  lr,
logical, intent(in), optional  verbose 
)
Parameters
[in]lrif present, the linear response wfs are stored instead of the gs wfs

Definition at line 254 of file states_elec_restart.F90.

◆ states_elec_dump_adios2()

subroutine states_elec_restart_oct_m::states_elec_dump_adios2 ( type(restart_t), intent(in)  restart,
type(states_elec_t), intent(in), target  st,
class(mesh_t), intent(in)  mesh,
integer, intent(out)  ierr 
)
private

Definition at line 436 of file states_elec_restart.F90.

◆ states_elec_load()

subroutine, public states_elec_restart_oct_m::states_elec_load ( type(restart_t), intent(in)  restart,
type(namespace_t), intent(in)  namespace,
class(space_t), intent(in)  space,
type(states_elec_t), intent(inout), target  st,
class(mesh_t), intent(in)  mesh,
type(kpoints_t), intent(in)  kpoints,
integer, intent(out)  ierr,
integer, intent(out), optional  iter,
type(lr_t), intent(inout), optional  lr,
integer, dimension(:, :), intent(out), optional  lowest_missing,
character(len=*), intent(in), optional  label,
logical, intent(in), optional  verbose,
logical, dimension(:), intent(in), optional  skip 
)

returns in ierr: <0 => Fatal error, or nothing read =0 => read all wavefunctions >0 => could only read ierr wavefunctions

Parameters
[in,out]lrif present, the lr wfs are read instead of the gs wfs
[out]lowest_missingall states below this one were read successfully
[in]skipA mask for reading or skipping the states. For expert use only.

Definition at line 457 of file states_elec_restart.F90.

◆ states_elec_load_adios2()

subroutine states_elec_restart_oct_m::states_elec_load_adios2 ( type(restart_t), intent(in)  restart,
type(states_elec_t), intent(inout), target  st,
class(mesh_t), intent(in)  mesh,
integer, intent(out)  iread,
logical, dimension(1:, st%st_start:, st%d%kpt%start:), intent(out)  filled,
integer, intent(out)  ierr 
)
private

Definition at line 901 of file states_elec_restart.F90.

◆ states_elec_dump_rho()

subroutine, public states_elec_restart_oct_m::states_elec_dump_rho ( type(restart_t), intent(in)  restart,
class(space_t), intent(in)  space,
type(states_elec_t), intent(in)  st,
class(mesh_t), intent(in)  mesh,
integer, intent(out)  ierr,
integer, intent(in), optional  iter 
)

Definition at line 917 of file states_elec_restart.F90.

◆ states_elec_load_rho()

subroutine, public states_elec_restart_oct_m::states_elec_load_rho ( type(restart_t), intent(in)  restart,
class(space_t), intent(in)  space,
type(states_elec_t), intent(inout)  st,
class(mesh_t), intent(in)  mesh,
integer, intent(out)  ierr 
)

Definition at line 984 of file states_elec_restart.F90.

◆ states_elec_dump_frozen()

subroutine, public states_elec_restart_oct_m::states_elec_dump_frozen ( type(restart_t), intent(in)  restart,
class(space_t), intent(in)  space,
type(states_elec_t), intent(in)  st,
class(mesh_t), intent(in)  mesh,
integer, intent(out)  ierr 
)

Definition at line 1032 of file states_elec_restart.F90.

◆ states_elec_load_frozen()

subroutine, public states_elec_restart_oct_m::states_elec_load_frozen ( type(restart_t), intent(in)  restart,
class(space_t), intent(in)  space,
type(states_elec_t), intent(inout)  st,
class(mesh_t), intent(in)  mesh,
integer, intent(out)  ierr 
)

Definition at line 1103 of file states_elec_restart.F90.

◆ states_elec_read_user_def_orbitals()

subroutine, public states_elec_restart_oct_m::states_elec_read_user_def_orbitals ( class(mesh_t), intent(in)  mesh,
type(namespace_t), intent(in)  namespace,
class(space_t), intent(in)  space,
type(states_elec_t), intent(inout)  st 
)

the routine reads formulas for user-defined wavefunctions from the input file and fills the respective orbitals

Definition at line 1171 of file states_elec_restart.F90.

◆ states_elec_dump_spin()

subroutine, public states_elec_restart_oct_m::states_elec_dump_spin ( type(restart_t), intent(in)  restart,
type(states_elec_t), intent(in)  st,
integer, intent(out)  ierr 
)

Definition at line 1407 of file states_elec_restart.F90.

◆ states_elec_load_spin()

subroutine, public states_elec_restart_oct_m::states_elec_load_spin ( type(restart_t), intent(in)  restart,
type(states_elec_t), intent(inout)  st,
integer, intent(out)  ierr 
)

returns in ierr: <0 => Fatal error, or nothing read =0 => read all wavefunctions >0 => could only read ierr wavefunctions

Definition at line 1464 of file states_elec_restart.F90.

◆ states_elec_transform()

subroutine, public states_elec_restart_oct_m::states_elec_transform ( type(states_elec_t), intent(inout)  st,
type(namespace_t), intent(in)  namespace,
class(space_t), intent(in)  space,
type(restart_t), intent(inout)  restart,
class(mesh_t), intent(in)  mesh,
type(kpoints_t), intent(in)  kpoints,
character(len=*), intent(in), optional  prefix 
)

Definition at line 1527 of file states_elec_restart.F90.