perturbation_magnetic_oct_m Module Reference

Data Types
interface	perturbation_magnetic_t

Functions/Subroutines
class(perturbation_magnetic_t) function, pointer	perturbation_magnetic_constructor (namespace, ions)
	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	perturbation_magnetic_init (this, namespace, ions)
subroutine	perturbation_magnetic_finalize (this)
subroutine	perturbation_magnetic_copy (this, source)
subroutine	perturbation_magnetic_info (this)
subroutine	dperturbation_magnetic_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_magnetic_apply_order_2 (this, namespace, space, gr, hm, ik, f_in, f_out)
subroutine	zperturbation_magnetic_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_magnetic_apply_order_2 (this, namespace, space, gr, hm, ik, f_in, f_out)

Variables
integer, parameter, public	gauge_gipaw = 1
integer, parameter, public	gauge_icl = 2

Function/Subroutine Documentation

perturbation_magnetic_constructor()

class(perturbation_magnetic_t) function, pointer perturbation_magnetic_oct_m::perturbation_magnetic_constructor ( type(namespace_t), intent(in)  namespace, type(ions_t), intent(in), target  ions  )

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 186 of file perturbation_magnetic.F90.

perturbation_magnetic_init()

subroutine perturbation_magnetic_oct_m::perturbation_magnetic_init ( type(perturbation_magnetic_t), intent(out)  this, type(namespace_t), intent(in)  namespace, type(ions_t), intent(in), target  ions  )

private

Definition at line 202 of file perturbation_magnetic.F90.

perturbation_magnetic_finalize()

subroutine perturbation_magnetic_oct_m::perturbation_magnetic_finalize ( type(perturbation_magnetic_t), intent(inout)  this )

private

Definition at line 238 of file perturbation_magnetic.F90.

perturbation_magnetic_copy()

subroutine perturbation_magnetic_oct_m::perturbation_magnetic_copy ( class(perturbation_magnetic_t), intent(out)  this, class(perturbation_magnetic_t), intent(in)  source  )

private

Definition at line 247 of file perturbation_magnetic.F90.

perturbation_magnetic_info()

subroutine perturbation_magnetic_oct_m::perturbation_magnetic_info ( class(perturbation_magnetic_t), intent(in)  this )

private

Definition at line 262 of file perturbation_magnetic.F90.

dperturbation_magnetic_apply()

subroutine perturbation_magnetic_oct_m::dperturbation_magnetic_apply ( class(perturbation_magnetic_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 342 of file perturbation_magnetic.F90.

dperturbation_magnetic_apply_order_2()

subroutine perturbation_magnetic_oct_m::dperturbation_magnetic_apply_order_2 ( class(perturbation_magnetic_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 460 of file perturbation_magnetic.F90.

zperturbation_magnetic_apply()

subroutine perturbation_magnetic_oct_m::zperturbation_magnetic_apply ( class(perturbation_magnetic_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 670 of file perturbation_magnetic.F90.

zperturbation_magnetic_apply_order_2()

subroutine perturbation_magnetic_oct_m::zperturbation_magnetic_apply_order_2 ( class(perturbation_magnetic_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 788 of file perturbation_magnetic.F90.

Variable Documentation

gauge_gipaw

integer, parameter, public perturbation_magnetic_oct_m::gauge_gipaw = 1

Definition at line 156 of file perturbation_magnetic.F90.

gauge_icl

integer, parameter, public perturbation_magnetic_oct_m::gauge_icl = 2

Definition at line 156 of file perturbation_magnetic.F90.