Octopus
perturbation_electric_oct_m Module Reference

Data Types

interface  perturbation_electric_t
 

Functions/Subroutines

class(perturbation_electric_t) function, pointer perturbation_electric_constructor (namespace)
 The factory routine (or constructor) allocates a pointer of the corresponding type and then calls the init routine which is a type-bound procedure of the corresponding type. With this design, also derived classes can use the init routine of the parent class. More...
 
subroutine, public perturbation_electric_init (this, namespace)
 
subroutine perturbation_electric_finalize (this)
 
subroutine perturbation_electric_copy (this, source)
 
subroutine perturbation_electric_info (this)
 
subroutine perturbation_electric_apply_batch (this, namespace, space, gr, hm, f_in, f_out)
 
subroutine dperturbation_electric_apply (this, namespace, space, gr, hm, ik, f_in, f_out, set_bc)
 Returns f_out = H' f_in, where H' is perturbation Hamiltonian Note that e^ikr phase is applied to f_in, then is removed afterward. More...
 
subroutine dperturbation_electric_apply_order_2 (this, namespace, space, gr, hm, ik, f_in, f_out)
 
subroutine zperturbation_electric_apply (this, namespace, space, gr, hm, ik, f_in, f_out, set_bc)
 Returns f_out = H' f_in, where H' is perturbation Hamiltonian Note that e^ikr phase is applied to f_in, then is removed afterward. More...
 
subroutine zperturbation_electric_apply_order_2 (this, namespace, space, gr, hm, ik, f_in, f_out)
 

Function/Subroutine Documentation

◆ perturbation_electric_constructor()

class(perturbation_electric_t) function, pointer perturbation_electric_oct_m::perturbation_electric_constructor ( type(namespace_t), intent(in)  namespace)
private

The factory routine (or constructor) allocates a pointer of the corresponding type and then calls the init routine which is a type-bound procedure of the corresponding type. With this design, also derived classes can use the init routine of the parent class.

Definition at line 166 of file perturbation_electric.F90.

◆ perturbation_electric_init()

subroutine, public perturbation_electric_oct_m::perturbation_electric_init ( type(perturbation_electric_t), intent(out)  this,
type(namespace_t), intent(in)  namespace 
)

Definition at line 180 of file perturbation_electric.F90.

◆ perturbation_electric_finalize()

subroutine perturbation_electric_oct_m::perturbation_electric_finalize ( type(perturbation_electric_t), intent(inout)  this)
private

Definition at line 193 of file perturbation_electric.F90.

◆ perturbation_electric_copy()

subroutine perturbation_electric_oct_m::perturbation_electric_copy ( class(perturbation_electric_t), intent(out)  this,
class(perturbation_electric_t), intent(in)  source 
)
private

Definition at line 202 of file perturbation_electric.F90.

◆ perturbation_electric_info()

subroutine perturbation_electric_oct_m::perturbation_electric_info ( class(perturbation_electric_t), intent(in)  this)
private

Definition at line 215 of file perturbation_electric.F90.

◆ perturbation_electric_apply_batch()

subroutine perturbation_electric_oct_m::perturbation_electric_apply_batch ( class(perturbation_electric_t), intent(in)  this,
type(namespace_t), intent(in)  namespace,
class(space_t), intent(in)  space,
type(grid_t), intent(in)  gr,
type(hamiltonian_elec_t), intent(in)  hm,
type(wfs_elec_t), intent(in)  f_in,
type(wfs_elec_t), intent(inout)  f_out 
)
private

Definition at line 224 of file perturbation_electric.F90.

◆ dperturbation_electric_apply()

subroutine perturbation_electric_oct_m::dperturbation_electric_apply ( class(perturbation_electric_t), intent(in)  this,
type(namespace_t), intent(in)  namespace,
class(space_t), intent(in)  space,
type(grid_t), intent(in)  gr,
type(hamiltonian_elec_t), intent(in)  hm,
integer, intent(in)  ik,
real(real64), dimension(:, :), intent(in), contiguous  f_in,
real(real64), dimension(:, :), intent(out), contiguous  f_out,
logical, intent(in), optional  set_bc 
)
private

Returns f_out = H' f_in, where H' is perturbation Hamiltonian Note that e^ikr phase is applied to f_in, then is removed afterward.

Definition at line 368 of file perturbation_electric.F90.

◆ dperturbation_electric_apply_order_2()

subroutine perturbation_electric_oct_m::dperturbation_electric_apply_order_2 ( class(perturbation_electric_t), intent(in)  this,
type(namespace_t), intent(in)  namespace,
class(space_t), intent(in)  space,
type(grid_t), intent(in)  gr,
type(hamiltonian_elec_t), intent(in)  hm,
integer, intent(in)  ik,
real(real64), dimension(:, :), intent(in), contiguous  f_in,
real(real64), dimension(:, :), intent(out), contiguous  f_out 
)
private

Definition at line 399 of file perturbation_electric.F90.

◆ zperturbation_electric_apply()

subroutine perturbation_electric_oct_m::zperturbation_electric_apply ( class(perturbation_electric_t), intent(in)  this,
type(namespace_t), intent(in)  namespace,
class(space_t), intent(in)  space,
type(grid_t), intent(in)  gr,
type(hamiltonian_elec_t), intent(in)  hm,
integer, intent(in)  ik,
complex(real64), dimension(:, :), intent(in), contiguous  f_in,
complex(real64), dimension(:, :), intent(out), contiguous  f_out,
logical, intent(in), optional  set_bc 
)
private

Returns f_out = H' f_in, where H' is perturbation Hamiltonian Note that e^ikr phase is applied to f_in, then is removed afterward.

Definition at line 492 of file perturbation_electric.F90.

◆ zperturbation_electric_apply_order_2()

subroutine perturbation_electric_oct_m::zperturbation_electric_apply_order_2 ( class(perturbation_electric_t), intent(in)  this,
type(namespace_t), intent(in)  namespace,
class(space_t), intent(in)  space,
type(grid_t), intent(in)  gr,
type(hamiltonian_elec_t), intent(in)  hm,
integer, intent(in)  ik,
complex(real64), dimension(:, :), intent(in), contiguous  f_in,
complex(real64), dimension(:, :), intent(out), contiguous  f_out 
)
private

Definition at line 523 of file perturbation_electric.F90.