ole – NECI

type, private, extends(rectangle) :: ole

Variables

k_to_sym sym_to_k mult_table inv_table

Type-Bound Procedures

get_nsites get_ndim get_nconnect_max is_periodic_x is_periodic_y get_site_index get_neighbors get_num_neighbors get_spinorb_neighbors is_k_space print_lat add_k_vec inv_k_vec get_sym subtract_k_vec get_sym_from_k set_sym get_name dispersion_rel_orb dispersion_rel_spin_orb get_k_vec get_r_vec round_sym map_k_vec get_orb_from_k_vec init_hop_cache_bounds get_length is_periodic dot_prod dispersion_rel calc_nsites initialize_sites find_periodic_neighbors inside_bz

Source Code

ole

Components

Type	Visibility	Attributes		Name
integer,	public,	allocatable	::	k_to_sym(:,:,:)
integer,	public,	allocatable	::	sym_to_k(:,:)
integer,	public,	allocatable	::	mult_table(:,:)
integer,	public,	allocatable	::	inv_table(:)

Type-Bound Procedures

procedure, public :: get_nsites

private elemental function get_nsites(this)

Arguments

Type	Intent	Optional	Attributes		Name
class(lattice),	intent(in)			::	this

Return Value integer

procedure, public :: get_ndim

private elemental function get_ndim(this)

Arguments

Type	Intent	Optional	Attributes		Name
class(lattice),	intent(in)			::	this

Return Value integer

procedure, public :: get_nconnect_max

private function get_nconnect_max(this)

Arguments

Type	Intent	Optional	Attributes		Name
class(lattice)				::	this

Return Value integer

procedure, public :: is_periodic_x

private function is_periodic_x(this)

Arguments

Type	Intent	Optional	Attributes		Name
class(lattice)				::	this

Return Value logical

procedure, public :: is_periodic_y

private function is_periodic_y(this)

Arguments

Type	Intent	Optional	Attributes		Name
class(lattice)				::	this

Return Value logical

procedure, public :: get_site_index

private function get_site_index(this, ind)

Arguments

Type	Intent	Optional	Attributes		Name
class(lattice)				::	this
integer,	intent(in)			::	ind

Return Value integer

procedure, public :: get_neighbors => get_neighbors_lattice

private function get_neighbors_lattice(this, ind) result(neighbors)

Arguments

Type	Intent	Optional	Attributes		Name
class(lattice)				::	this
integer,	intent(in)			::	ind

Return Value integer, allocatable, (:)

procedure, public :: get_num_neighbors => get_num_neighbors_lattice

private function get_num_neighbors_lattice(this, ind) result(n_neighbors)

Arguments

Type	Intent	Optional	Attributes		Name
class(lattice)				::	this
integer,	intent(in)			::	ind

Return Value integer

procedure, public :: get_spinorb_neighbors => get_spinorb_neighbors_lat

private function get_spinorb_neighbors_lat(this, spinorb) result(neighbors)

Arguments

Type	Intent	Optional	Attributes		Name
class(lattice)				::	this
integer,	intent(in)			::	spinorb

Return Value integer, allocatable, (:)

procedure, public :: is_k_space

private function is_k_space(this)

Arguments

Type	Intent	Optional	Attributes		Name
class(lattice)				::	this

Return Value logical

procedure, public :: print_lat

private subroutine print_lat(this)

Arguments

Type	Intent	Optional	Attributes		Name
class(lattice)				::	this

procedure, public :: add_k_vec

private pure function add_k_vec(this, k_1, k_2) result(k_out)

Arguments

Type	Intent		Name
class(lattice),	intent(in)	::	this
integer,	intent(in)	::	k_1(3)
integer,	intent(in)	::	k_2(3)

Return Value integer, (3)

procedure, public :: inv_k_vec

private function inv_k_vec(this, k) result(k_inv)

Arguments

Type	Intent	Optional	Attributes		Name
class(lattice)				::	this
integer,	intent(in)			::	k(3)

Return Value integer, (3)

procedure, public :: get_sym

private pure function get_sym(this, orb) result(sym)

Arguments

Type	Intent	Optional	Attributes		Name
class(lattice),	intent(in)			::	this
integer,	intent(in)			::	orb

Return Value integer

procedure, public :: subtract_k_vec

private function subtract_k_vec(this, k_1, k_2) result(k_out)

Arguments

Type	Intent		Name
class(lattice)		::	this
integer,	intent(in)	::	k_1(3)
integer,	intent(in)	::	k_2(3)

Return Value integer, (3)

procedure, public :: get_sym_from_k

private pure function get_sym_from_k(this, k) result(sym)

Arguments

Type	Intent	Optional	Attributes		Name
class(lattice),	intent(in)			::	this
integer,	intent(in)			::	k(3)

Return Value integer

procedure, public :: set_sym

private subroutine set_sym(this, orb, sym)

Arguments

Type	Intent		Name
class(lattice)		::	this
integer,	intent(in)	::	orb
integer,	intent(in)	::	sym

procedure, public :: get_name

private function get_name(this) result(lattice_name)

Arguments

Type	Intent	Optional	Attributes		Name
class(lattice)				::	this

Return Value character(len=NAME_LEN)

procedure, public :: dispersion_rel_orb

private function dispersion_rel_orb(this, orb) result(disp)

Arguments

Type	Intent	Optional	Attributes		Name
class(lattice)				::	this
integer,	intent(in)			::	orb

Return Value real(kind=dp)

procedure, public :: dispersion_rel_spin_orb

private function dispersion_rel_spin_orb(this, orb) result(disp)

Arguments

Type	Intent	Optional	Attributes		Name
class(lattice)				::	this
integer,	intent(in)			::	orb

Return Value real(kind=dp)

procedure, public :: get_k_vec

private pure function get_k_vec(this, orb) result(k_vec)

Arguments

Type	Intent	Optional	Attributes		Name
class(lattice),	intent(in)			::	this
integer,	intent(in)			::	orb

Return Value integer, (3)

procedure, public :: get_r_vec

private function get_r_vec(this, orb) result(r_vec)

Arguments

Type	Intent	Optional	Attributes		Name
class(lattice)				::	this
integer,	intent(in)			::	orb

Return Value integer, (3)

procedure, public :: round_sym

private elemental function round_sym(this, sym_in) result(sym_out)

Arguments

Type	Intent	Optional	Attributes		Name
class(lattice),	intent(in)			::	this
type(BasisFN),	intent(in)			::	sym_in

Return Value type(BasisFN)

procedure, public :: map_k_vec

private pure function map_k_vec(this, k_in) result(k_out)

Arguments

Type	Intent	Optional	Attributes		Name
class(lattice),	intent(in)			::	this
integer,	intent(in)			::	k_in(3)

Return Value integer, (3)

procedure, public :: get_orb_from_k_vec

private function get_orb_from_k_vec(this, k_in, spin) result(orb)

Arguments

Type	Intent	Optional		Name
class(lattice)			::	this
integer,	intent(in)		::	k_in(3)
integer,	intent(in),	optional	::	spin

Return Value integer

procedure, public :: init_hop_cache_bounds

private subroutine init_hop_cache_bounds(this, r_min, r_max)

Arguments

Type	Intent	Optional		Name
class(lattice)			::	this
integer,	intent(out),	optional	::	r_min(3)
integer,	intent(out),	optional	::	r_max(3)

procedure, public :: get_length => get_length_rect

private pure function get_length_rect(this, dimen)

Arguments

Type	Intent	Optional	Attributes		Name
class(rectangle),	intent(in)			::	this
integer,	intent(in),	optional		::	dimen

Return Value integer

procedure, public :: is_periodic => is_periodic_rect

private pure function is_periodic_rect(this, dimen)

Arguments

Type	Intent	Optional	Attributes		Name
class(rectangle),	intent(in)			::	this
integer,	intent(in),	optional		::	dimen

Return Value logical

procedure, public :: dot_prod => dot_prod_rect

private function dot_prod_rect(this, k_vec, r_vec) result(dot)

Arguments

Type	Intent		Name
class(rectangle)		::	this
integer,	intent(in)	::	k_vec(3)
integer,	intent(in)	::	r_vec(3)

Return Value real(kind=dp)

procedure, public :: dispersion_rel => dispersion_rel_ole

private function dispersion_rel_ole(this, k_vec) result(disp)

Arguments

Type	Intent	Optional	Attributes		Name
class(ole)				::	this
integer,	intent(in)			::	k_vec(3)

Return Value real(kind=dp)

procedure, private, :: calc_nsites => calc_nsites_ole

private function calc_nsites_ole(this, length_x, length_y, length_z) result(n_sites)

Arguments

Type	Intent	Optional		Name
class(ole)			::	this
integer,	intent(in)		::	length_x
integer,	intent(in)		::	length_y
integer,	intent(in),	optional	::	length_z

Return Value integer

procedure, private, :: initialize_sites => init_sites_ole

private subroutine init_sites_ole(this)

Arguments

Type	Intent	Optional	Attributes		Name
class(ole)				::	this

procedure, private, :: find_periodic_neighbors => find_periodic_neighbors_ole

private function find_periodic_neighbors_ole(this, ind, A)

Arguments

Type	Intent		Name
class(ole)		::	this
integer,	intent(in)	::	ind(2)
integer,	intent(in)	::	A(:,:)

Return Value integer

procedure, private, :: inside_bz => inside_bz_ole

private pure function inside_bz_ole(this, k_vec)

Arguments

Type	Intent	Optional	Attributes		Name
class(ole),	intent(in)			::	this
integer,	intent(in)			::	k_vec(sdim)

Return Value logical

Source Code

    type, extends(rectangle) :: ole
        private

    contains
        private
        procedure, public :: dispersion_rel => dispersion_rel_ole
        procedure :: calc_nsites => calc_nsites_ole
        procedure :: initialize_sites => init_sites_ole
        procedure :: find_periodic_neighbors => find_periodic_neighbors_ole

        procedure :: inside_bz => inside_bz_ole

    end type ole

ole Derived Type

Contents

Variables

Type-Bound Procedures

Source Code

type, private, extends(rectangle) :: ole

Contents

Variables

Type-Bound Procedures

Source Code

Components

Type-Bound Procedures

procedure, public :: get_nsites

private elemental function get_nsites(this)

Arguments

Return Value integer

procedure, public :: get_ndim

private elemental function get_ndim(this)

Arguments

Return Value integer

procedure, public :: get_nconnect_max

private function get_nconnect_max(this)

Arguments

Return Value integer

procedure, public :: is_periodic_x

private function is_periodic_x(this)

Arguments

Return Value logical

procedure, public :: is_periodic_y

private function is_periodic_y(this)

Arguments

Return Value logical

procedure, public :: get_site_index

private function get_site_index(this, ind)

Arguments

Return Value integer

procedure, public :: get_neighbors => get_neighbors_lattice

private function get_neighbors_lattice(this, ind) result(neighbors)

Arguments

Return Value integer, allocatable, (:)

procedure, public :: get_num_neighbors => get_num_neighbors_lattice

private function get_num_neighbors_lattice(this, ind) result(n_neighbors)

Arguments

Return Value integer

procedure, public :: get_spinorb_neighbors => get_spinorb_neighbors_lat

private function get_spinorb_neighbors_lat(this, spinorb) result(neighbors)

Arguments

Return Value integer, allocatable, (:)

procedure, public :: is_k_space

private function is_k_space(this)

Arguments

Return Value logical

procedure, public :: print_lat

private subroutine print_lat(this)

Arguments

procedure, public :: add_k_vec

private pure function add_k_vec(this, k_1, k_2) result(k_out)

Arguments

Return Value integer, (3)

procedure, public :: inv_k_vec

private function inv_k_vec(this, k) result(k_inv)

Arguments

Return Value integer, (3)

procedure, public :: get_sym

private pure function get_sym(this, orb) result(sym)

Arguments

Return Value integer

procedure, public :: subtract_k_vec

private function subtract_k_vec(this, k_1, k_2) result(k_out)

Arguments

Return Value integer, (3)

procedure, public :: get_sym_from_k

private pure function get_sym_from_k(this, k) result(sym)

Arguments

Return Value integer

procedure, public :: set_sym

private subroutine set_sym(this, orb, sym)

Arguments

procedure, public :: get_name

private function get_name(this) result(lattice_name)