Octopus
external_potential_oct_m Module Reference

Data Types

interface  external_potential_t
 

Functions/Subroutines

class(external_potential_t) function, pointer external_potential_init (namespace)
 
subroutine external_potential_finalize (this)
 
subroutine external_potential_allocate (this, mesh)
 
subroutine external_potential_deallocate (this)
 
subroutine external_potential_init_interaction_as_partner (partner, interaction)
 
subroutine external_potential_copy_quantities_to_interaction (partner, interaction)
 
subroutine external_potential_calculate (this, namespace, mesh, poisson)
 
subroutine, public load_external_potentials (external_potentials, namespace)
 
subroutine read_from_block (pot, namespace, blk, row, read_data)
 

Variables

integer, parameter, public external_pot_usdef = 201
 user-defined function for local potential More...
 
integer, parameter, public external_pot_from_file = 202
 potential, defined in a file More...
 
integer, parameter, public external_pot_charge_density = 203
 user-defined function for charge density More...
 
integer, parameter, public external_pot_static_bfield = 204
 Static magnetic field. More...
 
integer, parameter, public external_pot_static_efield = 205
 Static electric field. More...
 

Function/Subroutine Documentation

◆ external_potential_init()

class(external_potential_t) function, pointer external_potential_oct_m::external_potential_init ( type(namespace_t), intent(in)  namespace)
private

Definition at line 188 of file external_potential.F90.

◆ external_potential_finalize()

subroutine external_potential_oct_m::external_potential_finalize ( type(external_potential_t), intent(inout)  this)
private

Definition at line 215 of file external_potential.F90.

◆ external_potential_allocate()

subroutine external_potential_oct_m::external_potential_allocate ( class(external_potential_t), intent(inout)  this,
class(mesh_t), intent(in)  mesh 
)
private

Definition at line 226 of file external_potential.F90.

◆ external_potential_deallocate()

subroutine external_potential_oct_m::external_potential_deallocate ( class(external_potential_t), intent(inout)  this)
private

Definition at line 248 of file external_potential.F90.

◆ external_potential_init_interaction_as_partner()

subroutine external_potential_oct_m::external_potential_init_interaction_as_partner ( class(external_potential_t), intent(in)  partner,
class(interaction_surrogate_t), intent(inout)  interaction 
)
private

Definition at line 263 of file external_potential.F90.

◆ external_potential_copy_quantities_to_interaction()

subroutine external_potential_oct_m::external_potential_copy_quantities_to_interaction ( class(external_potential_t), intent(inout)  partner,
class(interaction_surrogate_t), intent(inout)  interaction 
)
private

Definition at line 281 of file external_potential.F90.

◆ external_potential_calculate()

subroutine external_potential_oct_m::external_potential_calculate ( class(external_potential_t), intent(inout)  this,
type(namespace_t), intent(in)  namespace,
class(mesh_t), intent(in)  mesh,
type(poisson_t), intent(in)  poisson 
)
private

Definition at line 315 of file external_potential.F90.

◆ load_external_potentials()

subroutine, public external_potential_oct_m::load_external_potentials ( class(partner_list_t), intent(inout)  external_potentials,
type(namespace_t), intent(in)  namespace 
)

Definition at line 443 of file external_potential.F90.

◆ read_from_block()

subroutine external_potential_oct_m::read_from_block ( type(external_potential_t), intent(inout)  pot,
type(namespace_t), intent(in)  namespace,
type(block_t), intent(in)  blk,
integer, intent(in)  row,
integer, intent(out)  read_data 
)
private

Definition at line 644 of file external_potential.F90.

Variable Documentation

◆ external_pot_usdef

integer, parameter, public external_potential_oct_m::external_pot_usdef = 201

user-defined function for local potential

Definition at line 174 of file external_potential.F90.

◆ external_pot_from_file

integer, parameter, public external_potential_oct_m::external_pot_from_file = 202

potential, defined in a file

Definition at line 174 of file external_potential.F90.

◆ external_pot_charge_density

integer, parameter, public external_potential_oct_m::external_pot_charge_density = 203

user-defined function for charge density

Definition at line 174 of file external_potential.F90.

◆ external_pot_static_bfield

integer, parameter, public external_potential_oct_m::external_pot_static_bfield = 204

Static magnetic field.

Definition at line 174 of file external_potential.F90.

◆ external_pot_static_efield

integer, parameter, public external_potential_oct_m::external_pot_static_efield = 205

Static electric field.

Definition at line 174 of file external_potential.F90.