Octopus
scf_oct_m Module Reference

Data Types

type  scf_t
 some variables used for the SCF cycle More...
 

Functions/Subroutines

subroutine, public scf_init (scf, namespace, gr, ions, st, mc, hm, space)
 
subroutine, public scf_end (scf)
 
subroutine, public scf_mix_clear (scf)
 
subroutine, public scf_run (scf, namespace, space, mc, gr, ions, ext_partners, st, ks, hm, outp, verbosity, iters_done, restart_load, restart_dump)
 
subroutine, public scf_state_info (namespace, st)
 
subroutine, public scf_print_mem_use (namespace)
 
subroutine scf_update_initial_quantity (scf, hm, criterion)
 Update the quantity at the begining of a SCF cycle. More...
 
subroutine scf_update_diff_quantity (scf, hm, st, gr, rhoout, rhoin, criterion)
 Update the quantity at the begining of a SCF cycle. More...
 

Variables

integer, parameter, public verb_no = 0
 
integer, parameter, public verb_compact = 1
 
integer, parameter, public verb_full = 3
 

Function/Subroutine Documentation

◆ scf_init()

subroutine, public scf_oct_m::scf_init ( type(scf_t), intent(inout)  scf,
type(namespace_t), intent(in)  namespace,
type(grid_t), intent(in)  gr,
type(ions_t), intent(in)  ions,
type(states_elec_t), intent(in)  st,
type(multicomm_t), intent(in)  mc,
type(hamiltonian_elec_t), intent(inout)  hm,
class(space_t), intent(in)  space 
)

Definition at line 236 of file scf.F90.

◆ scf_end()

subroutine, public scf_oct_m::scf_end ( type(scf_t), intent(inout)  scf)

Definition at line 525 of file scf.F90.

◆ scf_mix_clear()

subroutine, public scf_oct_m::scf_mix_clear ( type(scf_t), intent(inout)  scf)

Definition at line 555 of file scf.F90.

◆ scf_run()

subroutine, public scf_oct_m::scf_run ( type(scf_t), intent(inout)  scf,
type(namespace_t), intent(in)  namespace,
type(electron_space_t), intent(in)  space,
type(multicomm_t), intent(in)  mc,
type(grid_t), intent(inout)  gr,
type(ions_t), intent(inout)  ions,
type(partner_list_t), intent(in)  ext_partners,
type(states_elec_t), intent(inout)  st,
type(v_ks_t), intent(inout)  ks,
type(hamiltonian_elec_t), intent(inout)  hm,
type(output_t), intent(in), optional  outp,
integer, intent(in), optional  verbosity,
integer, intent(out), optional  iters_done,
type(restart_t), intent(in), optional  restart_load,
type(restart_t), intent(in), optional  restart_dump 
)
Parameters
[in,out]scfself consistent cycle
[in,out]grgrid
[in,out]ionsgeometry
[in,out]stStates
[in,out]ksKohn-Sham
[in,out]hmHamiltonian

Definition at line 572 of file scf.F90.

◆ scf_state_info()

subroutine, public scf_oct_m::scf_state_info ( type(namespace_t), intent(in)  namespace,
class(states_abst_t), intent(in)  st 
)

Definition at line 1427 of file scf.F90.

◆ scf_print_mem_use()

subroutine, public scf_oct_m::scf_print_mem_use ( type(namespace_t), intent(in)  namespace)

Definition at line 1445 of file scf.F90.

◆ scf_update_initial_quantity()

subroutine scf_oct_m::scf_update_initial_quantity ( type(scf_t), intent(inout)  scf,
type(hamiltonian_elec_t), intent(in)  hm,
class(convergence_criterion_t), intent(in)  criterion 
)
private

Update the quantity at the begining of a SCF cycle.

Definition at line 1465 of file scf.F90.

◆ scf_update_diff_quantity()

subroutine scf_oct_m::scf_update_diff_quantity ( type(scf_t), intent(inout)  scf,
type(hamiltonian_elec_t), intent(in)  hm,
type(states_elec_t), intent(in)  st,
type(grid_t), intent(in)  gr,
real(real64), dimension(:,:), intent(in)  rhoout,
real(real64), dimension(:,:), intent(in)  rhoin,
class(convergence_criterion_t), intent(in)  criterion 
)
private

Update the quantity at the begining of a SCF cycle.

Definition at line 1488 of file scf.F90.

Variable Documentation

◆ verb_no

integer, parameter, public scf_oct_m::verb_no = 0

Definition at line 197 of file scf.F90.

◆ verb_compact

integer, parameter, public scf_oct_m::verb_compact = 1

Definition at line 197 of file scf.F90.

◆ verb_full

integer, parameter, public scf_oct_m::verb_full = 3

Definition at line 197 of file scf.F90.