Octopus
ion_electron_local_potential_oct_m Module Reference

Data Types

interface  ion_electron_local_potential_t
 

Functions/Subroutines

class(ion_electron_local_potential_t) function, pointer ion_electron_local_potential_constructor (partner)
 
subroutine ion_electron_local_potential_init (this, mesh, psolver, ions, namespace, dgrid, atoms_dist_plane)
 
subroutine ion_electron_local_potential_bind (this, psolver, ions)
 Rebind ion-electron local potential helper pointers after a Hamiltonian copy. Ensure the local potential reuses the copied Poisson solver and ionic geometry. More...
 
subroutine ion_electron_local_potential_calculate (this)
 
subroutine ion_electron_local_potential_end (this)
 
subroutine ion_electron_local_potential_finalize (this)
 
subroutine ion_electron_local_potential_calculate_energy (this)
 

Function/Subroutine Documentation

◆ ion_electron_local_potential_constructor()

class(ion_electron_local_potential_t) function, pointer ion_electron_local_potential_oct_m::ion_electron_local_potential_constructor ( class(interaction_partner_t), intent(inout), target  partner)
private

Definition at line 174 of file ion_electron_local_potential.F90.

◆ ion_electron_local_potential_init()

subroutine ion_electron_local_potential_oct_m::ion_electron_local_potential_init ( class(ion_electron_local_potential_t), intent(inout)  this,
class(mesh_t), intent(in), target  mesh,
type(poisson_t), intent(in), target  psolver,
type(ions_t), intent(in), target  ions,
type(namespace_t), intent(in), target  namespace,
type(double_grid_t), intent(in), optional  dgrid,
type(distributed_t), intent(in), optional, target  atoms_dist_plane 
)
private
Parameters
[in]dgridWhen present and enabled, place the effective (double-grid) short-range potential
[in]atoms_dist_planeShared distribution of the per-atom placements over the kpoint-states plane

Definition at line 190 of file ion_electron_local_potential.F90.

◆ ion_electron_local_potential_bind()

subroutine ion_electron_local_potential_oct_m::ion_electron_local_potential_bind ( class(ion_electron_local_potential_t), intent(inout)  this,
type(poisson_t), intent(in), target  psolver,
type(ions_t), intent(in), target  ions 
)
private

Rebind ion-electron local potential helper pointers after a Hamiltonian copy. Ensure the local potential reuses the copied Poisson solver and ionic geometry.

Definition at line 235 of file ion_electron_local_potential.F90.

◆ ion_electron_local_potential_calculate()

subroutine ion_electron_local_potential_oct_m::ion_electron_local_potential_calculate ( class(ion_electron_local_potential_t), intent(inout)  this)
private

Definition at line 254 of file ion_electron_local_potential.F90.

◆ ion_electron_local_potential_end()

subroutine ion_electron_local_potential_oct_m::ion_electron_local_potential_end ( class(ion_electron_local_potential_t), intent(inout)  this)
private

Definition at line 346 of file ion_electron_local_potential.F90.

◆ ion_electron_local_potential_finalize()

subroutine ion_electron_local_potential_oct_m::ion_electron_local_potential_finalize ( type(ion_electron_local_potential_t), intent(inout)  this)
private

Definition at line 362 of file ion_electron_local_potential.F90.

◆ ion_electron_local_potential_calculate_energy()

subroutine ion_electron_local_potential_oct_m::ion_electron_local_potential_calculate_energy ( class(ion_electron_local_potential_t), intent(inout)  this)
private

This is not yet implemented. Therefore this routine should not be called at the moment.

Definition at line 373 of file ion_electron_local_potential.F90.