Octopus
external_potential_oct_m::external_potential_t Interface Reference

Detailed Description

Definition at line 143 of file external_potential.F90.

Inheritance diagram for external_potential_oct_m::external_potential_t:
Inheritance graph

Public Attributes

integer, public type
 Type of external potential. More...
 
real(real64), dimension(:), allocatable, public pot
 
real(real64), dimension(:), allocatable, public b_field
 static magnetic field More...
 
real(real64), dimension(:,:), allocatable, public a_static
 static vector potential More...
 
real(real64), dimension(:), allocatable, public e_field
 static electric field More...
 
real(real64), dimension(:), allocatable, public v_ext
 static scalar potential - 1:grmeshnp_part More...
 
- Public Attributes inherited from interaction_partner_oct_m::interaction_partner_t
type(namespace_t), public namespace
 
integer, dimension(:), allocatable, public supported_interactions_as_partner
 list of interactions, which support this interaction_partner_t as partner More...
 
type(quantity_t), dimension(max_quantities), public quantities
 Array of all possible quantities. The elements of the array are accessed using the quantity`s identifiers. More...
 

Private Member Functions

procedure calculate => external_potential_calculate
 
procedure allocate_memory => external_potential_allocate
 
procedure deallocate_memory => external_potential_deallocate
 
procedure init_interaction_as_partner => external_potential_init_interaction_as_partner
 
procedure copy_quantities_to_interaction => external_potential_copy_quantities_to_interaction
 
final external_potential_finalize
 
class(external_potential_t) function, pointer external_potential_init (namespace)
 

Private Attributes

type(space_tspace
 Dimensions of physical space. More...
 
character(len=1024) potential_formula
 for the user-defined potential More...
 
character(len=200) density_formula
 If we have a charge distribution creating the potential. More...
 
character(len=max_path_len) filename
 for the potential read from a file. More...
 
real(real64) omega
 
integer gauge_2d
 

Member Function/Subroutine Documentation

◆ calculate()

procedure external_potential_oct_m::external_potential_t::calculate
private

Definition at line 166 of file external_potential.F90.

◆ allocate_memory()

procedure external_potential_oct_m::external_potential_t::allocate_memory
private

Definition at line 167 of file external_potential.F90.

◆ deallocate_memory()

procedure external_potential_oct_m::external_potential_t::deallocate_memory
private

Definition at line 168 of file external_potential.F90.

◆ init_interaction_as_partner()

procedure external_potential_oct_m::external_potential_t::init_interaction_as_partner
private

Definition at line 169 of file external_potential.F90.

◆ copy_quantities_to_interaction()

procedure external_potential_oct_m::external_potential_t::copy_quantities_to_interaction
private

Definition at line 170 of file external_potential.F90.

◆ external_potential_finalize()

final external_potential_oct_m::external_potential_t::external_potential_finalize
finalprivate

Definition at line 171 of file external_potential.F90.

◆ external_potential_init()

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

Definition at line 188 of file external_potential.F90.

Member Data Documentation

◆ space

type(space_t) external_potential_oct_m::external_potential_t::space
private

Dimensions of physical space.

Definition at line 146 of file external_potential.F90.

◆ type

integer, public external_potential_oct_m::external_potential_t::type

Type of external potential.

Definition at line 148 of file external_potential.F90.

◆ potential_formula

character(len=1024) external_potential_oct_m::external_potential_t::potential_formula
private

for the user-defined potential

Definition at line 150 of file external_potential.F90.

◆ density_formula

character(len=200) external_potential_oct_m::external_potential_t::density_formula
private

If we have a charge distribution creating the potential.

Definition at line 151 of file external_potential.F90.

◆ filename

character(len=max_path_len) external_potential_oct_m::external_potential_t::filename
private

for the potential read from a file.

Definition at line 152 of file external_potential.F90.

◆ omega

real(real64) external_potential_oct_m::external_potential_t::omega
private

Definition at line 153 of file external_potential.F90.

◆ pot

real(real64), dimension(:), allocatable, public external_potential_oct_m::external_potential_t::pot

Definition at line 155 of file external_potential.F90.

◆ b_field

real(real64), dimension(:), allocatable, public external_potential_oct_m::external_potential_t::b_field

static magnetic field

Definition at line 157 of file external_potential.F90.

◆ gauge_2d

integer external_potential_oct_m::external_potential_t::gauge_2d
private

Definition at line 158 of file external_potential.F90.

◆ a_static

real(real64), dimension(:,:), allocatable, public external_potential_oct_m::external_potential_t::a_static

static vector potential

Definition at line 159 of file external_potential.F90.

◆ e_field

real(real64), dimension(:), allocatable, public external_potential_oct_m::external_potential_t::e_field

static electric field

Definition at line 160 of file external_potential.F90.

◆ v_ext

real(real64), dimension(:), allocatable, public external_potential_oct_m::external_potential_t::v_ext

static scalar potential - 1:grmeshnp_part

Definition at line 163 of file external_potential.F90.


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