mod_abstract_charge_equilibration
Lines: 169 |
Visibility: private
Abstract parent type for all charge equilibration schemes.
author: Jonas A. Finkler
Dependencies
Uses
module~~mod_abstract_charge_equilibration~~UsesGraph
module~mod_abstract_charge_equilibration
mod_abstract_charge_equilibration
module~mod_abstract_electrostatics
mod_abstract_electrostatics
module~mod_abstract_charge_equilibration->module~mod_abstract_electrostatics
module~mod_periodic_table
mod_periodic_table
module~mod_abstract_charge_equilibration->module~mod_periodic_table
module~mod_precision
mod_precision
module~mod_abstract_charge_equilibration->module~mod_precision
module~mod_structures
mod_structures
module~mod_abstract_charge_equilibration->module~mod_structures
module~mod_abstract_electrostatics->module~mod_precision
module~mod_abstract_electrostatics->module~mod_structures
module~mod_periodic_table->module~mod_precision
module~mod_array_helpers
mod_array_helpers
module~mod_periodic_table->module~mod_array_helpers
module~mod_constants
mod_constants
module~mod_periodic_table->module~mod_constants
module~mod_io
mod_io
module~mod_periodic_table->module~mod_io
module~mod_throw
mod_throw
module~mod_periodic_table->module~mod_throw
iso_c_binding
iso_c_binding
module~mod_precision->iso_c_binding
iso_fortran_env
iso_fortran_env
module~mod_precision->iso_fortran_env
module~mod_structures->module~mod_periodic_table
module~mod_structures->module~mod_precision
module~mod_structures->module~mod_array_helpers
module~mod_structures->module~mod_constants
module~mod_linalg
mod_linalg
module~mod_structures->module~mod_linalg
module~mod_mpi
mod_mpi
module~mod_structures->module~mod_mpi
module~mod_structures_helper
mod_structures_helper
module~mod_structures->module~mod_structures_helper
module~mod_structures->module~mod_throw
module~mod_array_helpers->module~mod_precision
module~mod_array_helpers->module~mod_throw
module~mod_constants->module~mod_precision
module~mod_constants->iso_c_binding
module~mod_io->module~mod_precision
module~mod_io->iso_fortran_env
module~mod_optional_args
mod_optional_args
module~mod_io->module~mod_optional_args
module~mod_linalg->module~mod_precision
module~mod_linalg->module~mod_throw
module~cublas_wrapper
cublas_wrapper
module~mod_linalg->module~cublas_wrapper
module~mod_settings
mod_settings
module~mod_linalg->module~mod_settings
module~mod_mpi->module~mod_precision
mpi_f08
mpi_f08
module~mod_mpi->mpi_f08
module~mod_structures_helper->module~mod_precision
module~mod_structures_helper->module~mod_linalg
module~mod_throw->module~mod_precision
module~mod_throw->iso_c_binding
module~mod_throw->iso_fortran_env
module~mod_throw->module~mod_io
module~mod_throw->module~mod_mpi
module~mod_sort
mod_sort
module~mod_throw->module~mod_sort
module~cublas_wrapper->iso_c_binding
module~cublas_wrapper->module~mod_settings
module~mod_settings->module~mod_periodic_table
module~mod_settings->module~mod_precision
module~mod_settings->module~mod_constants
module~mod_settings->module~mod_io
module~mod_settings->module~mod_throw
module~mod_cpu_vendor
mod_cpu_vendor
module~mod_settings->module~mod_cpu_vendor
module~mod_sort->module~mod_precision
module~mod_cpu_vendor->iso_c_binding
Nodes of different colours represent the following:
Graph Key
Module
Module
Submodule
Submodule
Subroutine
Subroutine
Function
Function
Program
Program
This Page's Entity
This Page's Entity
Solid arrows point from a submodule to the (sub)module which it is
descended from. Dashed arrows point from a module or program unit to
modules which it uses.
Where possible, edges connecting nodes are
given different colours to make them easier to distinguish in
large graphs.
Used By
module~~mod_abstract_charge_equilibration~~UsedByGraph
module~mod_abstract_charge_equilibration
mod_abstract_charge_equilibration
module~mod_abstract_iterative_charge_equilibration
mod_abstract_iterative_charge_equilibration
module~mod_abstract_iterative_charge_equilibration->module~mod_abstract_charge_equilibration
module~mod_direct_charge_equilibration
mod_direct_charge_equilibration
module~mod_direct_charge_equilibration->module~mod_abstract_charge_equilibration
module~mod_evaluate_4g_single_structure
mod_evaluate_4g_single_structure
module~mod_evaluate_4g_single_structure->module~mod_abstract_charge_equilibration
module~mod_initialize
mod_initialize
module~mod_initialize->module~mod_abstract_charge_equilibration
module~mod_initialize->module~mod_direct_charge_equilibration
module~mod_iterative_charge_equilibration_cg
mod_iterative_charge_equilibration_cg
module~mod_initialize->module~mod_iterative_charge_equilibration_cg
module~mod_iterative_charge_equilibration_sqnm
mod_iterative_charge_equilibration_sqnm
module~mod_initialize->module~mod_iterative_charge_equilibration_sqnm
module~mod_output_files_and_cost
mod_output_files_and_cost
module~mod_output_files_and_cost->module~mod_abstract_charge_equilibration
module~mod_predict_multiple_structures
mod_predict_multiple_structures
module~mod_output_files_and_cost->module~mod_predict_multiple_structures
module~mod_cost_calculator
mod_cost_calculator
module~mod_output_files_and_cost->module~mod_cost_calculator
module~mod_post_processing_4g_single_structure
mod_post_processing_4g_single_structure
module~mod_post_processing_4g_single_structure->module~mod_abstract_charge_equilibration
module~mod_post_processing_4g_single_structure->module~mod_evaluate_4g_single_structure
module~mod_post_processing_wrapper_single_structure
mod_post_processing_wrapper_single_structure
module~mod_post_processing_wrapper_single_structure->module~mod_abstract_charge_equilibration
module~mod_post_processing_wrapper_single_structure->module~mod_evaluate_4g_single_structure
module~mod_post_processing_wrapper_single_structure->module~mod_post_processing_4g_single_structure
module~mod_predict_all_chunks
mod_predict_all_chunks
module~mod_predict_all_chunks->module~mod_abstract_charge_equilibration
module~mod_predict_all_chunks->module~mod_predict_multiple_structures
module~mod_predict_mode
mod_predict_mode
module~mod_predict_mode->module~mod_abstract_charge_equilibration
module~mod_predict_mode->module~mod_initialize
module~mod_predict_mode->module~mod_predict_multiple_structures
module~mod_write_outfiles
mod_write_outfiles
module~mod_predict_mode->module~mod_write_outfiles
module~mod_predict_multiple_structures->module~mod_abstract_charge_equilibration
module~mod_predict_multiple_structures->module~mod_post_processing_wrapper_single_structure
module~mod_predict_single_structure
mod_predict_single_structure
module~mod_predict_single_structure->module~mod_abstract_charge_equilibration
module~mod_predict_single_structure->module~mod_post_processing_wrapper_single_structure
module~mod_runner_interface
mod_runner_interface
module~mod_runner_interface->module~mod_abstract_charge_equilibration
module~mod_train_loop_short_range
mod_train_loop_short_range
module~mod_train_loop_short_range->module~mod_abstract_charge_equilibration
module~mod_train_loop_short_range->module~mod_initialize
module~mod_train_loop_short_range->module~mod_output_files_and_cost
module~mod_train_energy_multiple_structures
mod_train_energy_multiple_structures
module~mod_train_loop_short_range->module~mod_train_energy_multiple_structures
module~mod_train_forces_multiple_structures
mod_train_forces_multiple_structures
module~mod_train_loop_short_range->module~mod_train_forces_multiple_structures
module~mod_train_loop_short_range->module~mod_cost_calculator
module~mod_output_files_and_cost_4g_short_range
mod_output_files_and_cost_4g_short_range
module~mod_train_loop_short_range->module~mod_output_files_and_cost_4g_short_range
module~mod_train_mode
mod_train_mode
module~mod_train_mode->module~mod_abstract_charge_equilibration
module~mod_train_mode->module~mod_initialize
module~mod_train_mode->module~mod_predict_all_chunks
module~mod_train_mode->module~mod_train_loop_short_range
module~mod_train_loop_4g_charges
mod_train_loop_4g_charges
module~mod_train_mode->module~mod_train_loop_4g_charges
module~mod_train_loop_atomic_property
mod_train_loop_atomic_property
module~mod_train_mode->module~mod_train_loop_atomic_property
module~mod_write_outfiles_training
mod_write_outfiles_training
module~mod_train_mode->module~mod_write_outfiles_training
program~runner
RuNNer
program~runner->module~mod_abstract_charge_equilibration
program~runner->module~mod_initialize
program~runner->module~mod_predict_mode
program~runner->module~mod_train_mode
module~mod_analyse_a_prime_matrix_eigenvalues
mod_analyse_a_prime_matrix_eigenvalues
module~mod_analyse_a_prime_matrix_eigenvalues->module~mod_direct_charge_equilibration
module~mod_feature_calc_interface
mod_feature_calc_interface
module~mod_feature_calc_interface->module~mod_runner_interface
module~mod_generic_interface
mod_generic_interface
module~mod_feature_calc_interface->module~mod_generic_interface
module~mod_generic_interface->module~mod_predict_single_structure
module~mod_generic_interface->module~mod_runner_interface
module~mod_iterative_charge_equilibration_cg->module~mod_abstract_iterative_charge_equilibration
module~mod_iterative_charge_equilibration_sqnm->module~mod_abstract_iterative_charge_equilibration
module~mod_lammps_interface
mod_lammps_interface
module~mod_lammps_interface->module~mod_runner_interface
module~mod_runner_interface_bindings
mod_runner_interface_bindings
module~mod_lammps_interface->module~mod_runner_interface_bindings
module~mod_runner_interface_bindings->module~mod_evaluate_4g_single_structure
module~mod_runner_interface_bindings->module~mod_initialize
module~mod_runner_interface_bindings->module~mod_runner_interface
module~mod_train_energy_multiple_structures->module~mod_initialize
module~mod_train_forces_multiple_structures->module~mod_initialize
module~mod_train_forces_multiple_structures->module~mod_train_energy_multiple_structures
module~mod_train_loop_4g_charges->module~mod_initialize
module~mod_train_loop_4g_charges->module~mod_cost_calculator
module~mod_output_files_and_cost_4g_charges
mod_output_files_and_cost_4g_charges
module~mod_train_loop_4g_charges->module~mod_output_files_and_cost_4g_charges
module~mod_train_loop_atomic_property->module~mod_initialize
module~mod_train_loop_atomic_property->module~mod_output_files_and_cost
module~mod_train_loop_atomic_property->module~mod_cost_calculator
module~mod_write_outfiles->module~mod_initialize
module~mod_write_outfiles_training->module~mod_write_outfiles
module~mod_cost_calculator->module~mod_write_outfiles_training
module~mod_output_files_and_cost_4g_charges->module~mod_cost_calculator
module~mod_output_files_and_cost_4g_short_range->module~mod_cost_calculator
Nodes of different colours represent the following:
Graph Key
Module
Module
Submodule
Submodule
Subroutine
Subroutine
Function
Function
Program
Program
This Page's Entity
This Page's Entity
Solid arrows point from a submodule to the (sub)module which it is
descended from. Dashed arrows point from a module or program unit to
modules which it uses.
Where possible, edges connecting nodes are
given different colours to make them easier to distinguish in
large graphs.
Derived Types Summary
Procedures Summary
Derived Types Details
type AbstractChargeEquilibrator
Components
Type-Bound Procedures
Name
Attributes
Binding
initialize_private
public
⇒ initialize_private
compute_charges
public
⇒ compute_charges
compute_dcharge_delectronegativity
public
⇒ compute_dcharge_delectronegativity
compute_dcharge_dhardness
public
⇒ compute_dcharge_dhardness
set_hardness
public
⇒ set_hardness
set_charges
public
⇒ set_charges
get_lagrange_charges
public
⇒ get_lagrange_charges
update_structure
public
⇒ update_structure
make_initial_charge_guess
public
⇒ set_zero_charge_and_lagrange_charge
solve_linear_system
public
⇒ solve_linear_system
initialize
public
⇒ initialize
Inherits
type~~abstractchargeequilibrator~~InheritsGraph
type~abstractchargeequilibrator
AbstractChargeEquilibrator
type~abstractelectrostaticscalculator
AbstractElectrostaticsCalculator
type~abstractchargeequilibrator->type~abstractelectrostaticscalculator
elec_calc
Nodes of different colours represent the following:
Graph Key
Type
Type
This Page's Entity
This Page's Entity
Solid arrows point from a derived type to the parent type which it
extends. Dashed arrows point from a derived type to the other
types it contains as a components, with a label listing the name(s) of
said component(s).
Where possible, edges connecting nodes are
given different colours to make them easier to distinguish in
large graphs.
Inherited By
type~~abstractchargeequilibrator~~InheritedByGraph
type~abstractchargeequilibrator
AbstractChargeEquilibrator
type~abstractiterativechargeequilibrator
AbstractIterativeChargeEquilibrator
type~abstractiterativechargeequilibrator->type~abstractchargeequilibrator
type~directchargeequilibrator
DirectChargeEquilibrator
type~directchargeequilibrator->type~abstractchargeequilibrator
type~runnerinterface
RuNNerInterface
type~runnerinterface->type~abstractchargeequilibrator
qeq_solver
type~iterativecgchargeequilibrator
IterativeCgChargeEquilibrator
type~iterativecgchargeequilibrator->type~abstractiterativechargeequilibrator
type~iterativesqnmchargeequilibrator
IterativeSQNMChargeEquilibrator
type~iterativesqnmchargeequilibrator->type~abstractiterativechargeequilibrator
Nodes of different colours represent the following:
Graph Key
Type
Type
This Page's Entity
This Page's Entity
Solid arrows point from a derived type to the parent type which it
extends. Dashed arrows point from a derived type to the other
types it contains as a components, with a label listing the name(s) of
said component(s).
Where possible, edges connecting nodes are
given different colours to make them easier to distinguish in
large graphs.
Interface Details
interface solve_linear_system_abstract
interface initialize_abstract
Precision of the electrostatic solver
Procedure Details
subroutine initialize_private
subroutine initialize_private ( & self, & num_atoms, & lperiodic, & pos, & lat, & elec_calc, & atomic_sigmas, & iter_tol, & electro_precision &)
Initializes the ChargeEquilibrator and other internal things
Precision of the electrostatic solver
Arguments
self :
class (AbstractChargeEquilibrator ) [out]
num_atoms :
integer [in]
lperiodic :
logical [in]
pos :
real (DP) (dim: (3,num_atoms)) [in]
lat :
real (DP) (dim: (3,3)) [in]
elec_calc :
class (AbstractElectrostaticsCalculator ) [in]
atomic_sigmas :
real (DP) (dim: (num_atoms)) [in]
iter_tol :
real (DP) [in]
electro_precision :
real (DP) [in]– Tolerance of the iterative solver
Called By
Nodes of different colours represent the following:
Graph Key
Subroutine
Subroutine
Function
Function
Interface
Interface
Type Bound Procedure
Type Bound Procedure
Unknown Procedure Type
Unknown Procedure Type
Program
Program
This Page's Entity
This Page's Entity
Solid arrows point from a procedure to one which it calls. Dashed
arrows point from an interface to procedures which implement that interface.
This could include the module procedures in a generic interface or the
implementation in a submodule of an interface in a parent module.
Where possible, edges connecting nodes are
given different colours to make them easier to distinguish in
large graphs.
subroutine set_hardness
subroutine set_hardness ( & self, & hardness &)
Arguments
Called By
Nodes of different colours represent the following:
Graph Key
Subroutine
Subroutine
Function
Function
Interface
Interface
Type Bound Procedure
Type Bound Procedure
Unknown Procedure Type
Unknown Procedure Type
Program
Program
This Page's Entity
This Page's Entity
Solid arrows point from a procedure to one which it calls. Dashed
arrows point from an interface to procedures which implement that interface.
This could include the module procedures in a generic interface or the
implementation in a submodule of an interface in a parent module.
Where possible, edges connecting nodes are
given different colours to make them easier to distinguish in
large graphs.
subroutine set_charges
subroutine set_charges ( & self, & charges &)
Arguments
Called By
Nodes of different colours represent the following:
Graph Key
Subroutine
Subroutine
Function
Function
Interface
Interface
Type Bound Procedure
Type Bound Procedure
Unknown Procedure Type
Unknown Procedure Type
Program
Program
This Page's Entity
This Page's Entity
Solid arrows point from a procedure to one which it calls. Dashed
arrows point from an interface to procedures which implement that interface.
This could include the module procedures in a generic interface or the
implementation in a submodule of an interface in a parent module.
Where possible, edges connecting nodes are
given different colours to make them easier to distinguish in
large graphs.
subroutine update_structure
subroutine update_structure ( & self, & pos, & lat, & charges &)
Arguments
self :
class (AbstractChargeEquilibrator ) [inout]
pos :
real (DP) (dim: (3,self%nat)) [in]
lat :
real (DP) (dim: (3,3)) [in]
charges :
real (DP) (dim: (self%nat)) [in]
Called By
Nodes of different colours represent the following:
Graph Key
Subroutine
Subroutine
Function
Function
Interface
Interface
Type Bound Procedure
Type Bound Procedure
Unknown Procedure Type
Unknown Procedure Type
Program
Program
This Page's Entity
This Page's Entity
Solid arrows point from a procedure to one which it calls. Dashed
arrows point from an interface to procedures which implement that interface.
This could include the module procedures in a generic interface or the
implementation in a submodule of an interface in a parent module.
Where possible, edges connecting nodes are
given different colours to make them easier to distinguish in
large graphs.
subroutine set_zero_charge_and_lagrange_charge
subroutine set_zero_charge_and_lagrange_charge ( & self, & electronegativities, & total_charge &)
Set charges and lagrange charges to zero as the initial guess for any solver.
This may/should be overriden to a more sensible default by child classes.
Arguments
self :
class (AbstractChargeEquilibrator ) [inout]
electronegativities :
real (DP) (dim: (self%nat)) [in]
total_charge :
real (DP) [in]
Called By
Nodes of different colours represent the following:
Graph Key
Subroutine
Subroutine
Function
Function
Interface
Interface
Type Bound Procedure
Type Bound Procedure
Unknown Procedure Type
Unknown Procedure Type
Program
Program
This Page's Entity
This Page's Entity
Solid arrows point from a procedure to one which it calls. Dashed
arrows point from an interface to procedures which implement that interface.
This could include the module procedures in a generic interface or the
implementation in a submodule of an interface in a parent module.
Where possible, edges connecting nodes are
given different colours to make them easier to distinguish in
large graphs.
subroutine compute_charges
subroutine compute_charges ( & self, & chis, & total_charge &)
Do the charge equilibration to compute the charges.
The resulting charges are stored on the object as
self%charges.
Arguments
Called By
Nodes of different colours represent the following:
Graph Key
Subroutine
Subroutine
Function
Function
Interface
Interface
Type Bound Procedure
Type Bound Procedure
Unknown Procedure Type
Unknown Procedure Type
Program
Program
This Page's Entity
This Page's Entity
Solid arrows point from a procedure to one which it calls. Dashed
arrows point from an interface to procedures which implement that interface.
This could include the module procedures in a generic interface or the
implementation in a submodule of an interface in a parent module.
Where possible, edges connecting nodes are
given different colours to make them easier to distinguish in
large graphs.
subroutine compute_dcharge_delectronegativity
subroutine compute_dcharge_delectronegativity ( & self &)
@todo Come up with something similar to the force trick for the loss
derivative
Arguments
subroutine compute_dcharge_dhardness
subroutine compute_dcharge_dhardness ( & self &)
Arguments
subroutine get_lagrange_charges
subroutine get_lagrange_charges ( & self, & de_dq &)
Calculate supplementary Lagrangian charges for the force trick.
Before calling this subroutine the electrostatics calculator needs
to be evaluated.
Arguments
self :
class (AbstractChargeEquilibrator ) [inout]
de_dq :
real (DP) (dim: (self%nat)) [in]– partial derivative of total energy w.r.t. the atomic charges
Called By
Nodes of different colours represent the following:
Graph Key
Subroutine
Subroutine
Function
Function
Interface
Interface
Type Bound Procedure
Type Bound Procedure
Unknown Procedure Type
Unknown Procedure Type
Program
Program
This Page's Entity
This Page's Entity
Solid arrows point from a procedure to one which it calls. Dashed
arrows point from an interface to procedures which implement that interface.
This could include the module procedures in a generic interface or the
implementation in a submodule of an interface in a parent module.
Where possible, edges connecting nodes are
given different colours to make them easier to distinguish in
large graphs.