(git:c5411e0)
Loading...
Searching...
No Matches
qs_cdft_types::cdft_group_type Type Reference

control parameters for CDFT simulations More...

Data Fields

integer, dimension(:), pointer atoms
 
integer constraint_type
 
logical is_fragment_constraint
 
real(kind=dp), dimension(:, :), allocatable d_sum_const_dr
 
real(kind=dp), dimension(:), pointer coeff
 
real(kind=dp), dimension(:, :), pointer integrated
 
real(kind=dp), dimension(:, :, :, :), pointer gradients
 
real(kind=dp), dimension(:, :, :, :), pointer gradients_x
 
real(kind=dp), dimension(:, :, :, :), pointer gradients_y
 
real(kind=dp), dimension(:, :, :, :), pointer gradients_z
 
type(pw_r3d_rs_type), pointer weight
 
type(pw_r3d_rs_type), dimension(:), pointer hw_rho_atomic
 
type(pw_r3d_rs_type), dimension(:), pointer hw_rho_atomic_dr
 
type(pw_r3d_rs_type), dimension(:), pointer hw_rho_atomic_charge
 
type(pw_r3d_rs_typehw_rho_total_constraint
 
type(pw_r3d_rs_typehw_rho_total
 

Detailed Description

control parameters for CDFT simulations

Parameters
fragment_a_fnamefilename of cube file holding the total electron density of isolated fragment a
fragment_b_fnamefilename of cube file holding the total electron density of isolated fragment b
fragment_a_spin_fnamefilename of cube file holding the spin difference density of isolated fragment a
fragment_b_spin_fnamefilename of cube file holding the spin difference density of isolated fragment b
ref_countthe ref count
need_potlogical which determines if the Becke potential needs to be built
save_potlogical which determines if the Becke potential should be saved until forces have been evaluated
atomic_chargesflag that determines if atomic CDFT charges should be computed
total_stepscounter to keep track of the total number of SCF steps
typethe type of CDFT constraint to use
precond_freqpreconditioner can be used if SCF converged in less than precond_freq steps
nreuseddetermines how many times the current OT preconditioner has been reused
max_reusethe same preconditioner can be used a maximum of max_reuse times
purge_freqdetermines how large nbad_conv can grow before purging the wfn/constraint history
nbad_conva running counter keeping track of the number of CDFT SCF loops when the first CDFT SCF iteration required more than 1 outer SCF loop. Reset when convergence is smooth
purge_offsetpurging is only allowed when more than purge_offset steps have passed since last purge
istepa counter to keep track of how many steps have passed since the last purge
ienergya counter tracking the total number of CDFT energy evaluations
natomsthe total number of atoms included in constraint/dummy atom groups
atomslist of constraint atoms
need_potlogical which determines if the constraint potential needs to be built
save_potlogical which determines if the constraint potential should be saved until forces have been evaluated
do_etlogical which determines if a ET coupling calculation was requested
reuse_precondlogical which determines if a preconditioner can be reused
purge_historylogical which determines if the wfn/constraint history can be purged
should_purgelogical which determines if purging should take place after this CDFT SCF loop
calculate_metriclogical which determines if the ET coupling reliability metric is computed
fragment_densityuse isolated fragment densities as a reference for the constraint
fragments_integratedlogical to determine if the fragment densities have been integrated
flip_fragmentshould the spin difference density of the either fragment be flipped
transfer_potlogical which determines if constraint should be saved for reuse later
external_controllogical which determines if the constraint has already been built in a mixed_env that holds multiple CDFT states
first_iterationa flag to mark the first iteration for printing of additional data
print_weightlogical which determines if CDFT weight functions should be saved to a file
in_memorylogical which determines if the gradients of the Becke potential should be
is_constraintlist of logicals which determines if an atom is included in a constraint group
strengthLagrangian multipliers of the constraints
targettarget values of the constraints
valueintegrated values of the constraints
charges_fragmentatomic partial charges computed from the isolated fragment densities
becke_controlcontrol parameters for Becke constraints
groupcontainer for atom groups each defining their own constraint
occupationsoccupation numbers in case non-uniform MO occupation (for do_et)
mo_coeffsave the MO coeffs (for do_et)
matrix_ssave the overlap matrix (for do_et)
wmatmatrix representation of the weight function (for do_et)
matrix_psave the density matrix (for calculate_metric)
hirshfeld_controlcontrol parameters for Hirshfeld constraints
constraint_controlthe outer_scf_control_type for the CDFT constraints
ot_controlthe outer_scf_control_type for OT where data is stashed when outside the OT outer loop
chargeatomic CDFT real space potentials needed to calculate CDFT charges
fragmentscontainer for isolated fragment densities read from cube files
constraintholds information about the CDFT SCF loop

Definition at line 186 of file qs_cdft_types.F.

Field Documentation

◆ atoms

integer, dimension(:), pointer qs_cdft_types::cdft_group_type::atoms

Definition at line 188 of file qs_cdft_types.F.

◆ constraint_type

integer qs_cdft_types::cdft_group_type::constraint_type

Definition at line 190 of file qs_cdft_types.F.

◆ is_fragment_constraint

logical qs_cdft_types::cdft_group_type::is_fragment_constraint

Definition at line 192 of file qs_cdft_types.F.

◆ d_sum_const_dr

real(kind=dp), dimension(:, :), allocatable qs_cdft_types::cdft_group_type::d_sum_const_dr

Definition at line 195 of file qs_cdft_types.F.

◆ coeff

real(kind=dp), dimension(:), pointer qs_cdft_types::cdft_group_type::coeff

Definition at line 198 of file qs_cdft_types.F.

◆ integrated

real(kind=dp), dimension(:, :), pointer qs_cdft_types::cdft_group_type::integrated

Definition at line 200 of file qs_cdft_types.F.

◆ gradients

real(kind=dp), dimension(:, :, :, :), pointer qs_cdft_types::cdft_group_type::gradients

Definition at line 203 of file qs_cdft_types.F.

◆ gradients_x

real(kind=dp), dimension(:, :, :, :), pointer qs_cdft_types::cdft_group_type::gradients_x

Definition at line 205 of file qs_cdft_types.F.

◆ gradients_y

real(kind=dp), dimension(:, :, :, :), pointer qs_cdft_types::cdft_group_type::gradients_y

Definition at line 207 of file qs_cdft_types.F.

◆ gradients_z

real(kind=dp), dimension(:, :, :, :), pointer qs_cdft_types::cdft_group_type::gradients_z

Definition at line 209 of file qs_cdft_types.F.

◆ weight

type(pw_r3d_rs_type), pointer qs_cdft_types::cdft_group_type::weight

Definition at line 212 of file qs_cdft_types.F.

◆ hw_rho_atomic

type(pw_r3d_rs_type), dimension(:), pointer qs_cdft_types::cdft_group_type::hw_rho_atomic

Definition at line 213 of file qs_cdft_types.F.

◆ hw_rho_atomic_dr

type(pw_r3d_rs_type), dimension(:), pointer qs_cdft_types::cdft_group_type::hw_rho_atomic_dr

Definition at line 214 of file qs_cdft_types.F.

◆ hw_rho_atomic_charge

type(pw_r3d_rs_type), dimension(:), pointer qs_cdft_types::cdft_group_type::hw_rho_atomic_charge

Definition at line 215 of file qs_cdft_types.F.

◆ hw_rho_total_constraint

type(pw_r3d_rs_type) qs_cdft_types::cdft_group_type::hw_rho_total_constraint

Definition at line 216 of file qs_cdft_types.F.

◆ hw_rho_total

type(pw_r3d_rs_type) qs_cdft_types::cdft_group_type::hw_rho_total

Definition at line 217 of file qs_cdft_types.F.


The documentation for this type was generated from the following file: