(git:27c966b)
Loading...
Searching...
No Matches
qs_electrons_types Module Reference

State of the fictitious electronic degree of freedom (electron number q, its momentum, potentiostat and charge-mixing settings) used in constant-potential MD. More...

Data Types

type  qs_electrons_type

Functions/Subroutines

subroutine, public qs_electrons_init (electrons, q_init, p_init, mass, neutral_electrons, target_workfunction, tau_potentiostat, temp_potentiostat, potential_average_axis, potential_average_min, potential_average_max, charge_mixing_span, target_fermi_level, control_fermi, lambda_fixed, lambda_is_fixed, charge_mixing_inplace, report_only)
 Initialize the electronic coordinate/potentiostat state for constant-potential MD.
subroutine, public qs_electrons_dealloc (electrons)
 Release the electronic state.

Detailed Description

State of the fictitious electronic degree of freedom (electron number q, its momentum, potentiostat and charge-mixing settings) used in constant-potential MD.

Author
Nanchen DONGFANG

Function/Subroutine Documentation

◆ qs_electrons_init()

subroutine, public qs_electrons_types::qs_electrons_init ( type(qs_electrons_type), pointer electrons,
real(kind=dp), intent(in) q_init,
real(kind=dp), intent(in) p_init,
real(kind=dp), intent(in) mass,
real(kind=dp), intent(in) neutral_electrons,
real(kind=dp), intent(in) target_workfunction,
real(kind=dp), intent(in) tau_potentiostat,
real(kind=dp), intent(in) temp_potentiostat,
integer, intent(in) potential_average_axis,
real(kind=dp), intent(in) potential_average_min,
real(kind=dp), intent(in) potential_average_max,
integer, intent(in), optional charge_mixing_span,
real(kind=dp), intent(in), optional target_fermi_level,
logical, intent(in), optional control_fermi,
real(kind=dp), intent(in), optional lambda_fixed,
logical, intent(in), optional lambda_is_fixed,
logical, intent(in), optional charge_mixing_inplace,
logical, intent(in), optional report_only )

Initialize the electronic coordinate/potentiostat state for constant-potential MD.

Parameters
electrons...
q_init...
p_init...
mass...
neutral_electrons...
target_workfunction...
tau_potentiostatrelaxation time, a plain number in femtoseconds (converted to "number of thermostat calls" inside qs_electrons_thermostat_step)
temp_potentiostat...
potential_average_axisaxis (1=x, 2=y, 3=z) for the planar potential average
potential_average_minlower bound of the averaging slab, Angstrom
potential_average_maxupper bound of the averaging slab, Angstrom
charge_mixing_spanS: endpoint separation in electrons; presence of this argument is what enables charge mixing
target_fermi_leveltarget Fermi level in eV (absolute, on CP2K's internal scale)
control_fermiTRUE for Fermi-level control, FALSE for work-function control
lambda_fixedfrozen mixing weight, honoured only when lambda_is_fixed
lambda_is_fixedTRUE when LAMBDA was given: q is not propagated
charge_mixing_inplaceTRUE to mutate an endpoint's electron count in place rather than re-running qs_init on it
report_only...

Definition at line 104 of file qs_electrons_types.F.

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

◆ qs_electrons_dealloc()

subroutine, public qs_electrons_types::qs_electrons_dealloc ( type(qs_electrons_type), pointer electrons)

Release the electronic state.

Parameters
electrons...

Definition at line 179 of file qs_electrons_types.F.

Here is the caller graph for this function: