seams_rings Derived Type

type, public :: seams_rings

Primitive rings. histogram is 0-based: index k is rings of size k.


Finalization Procedures

final :: ring_final

  • private subroutine ring_final(self)

    Release this owner’s reference to the ring set.

    Arguments

    Type IntentOptional Attributes Name
    type(seams_rings), intent(inout) :: self

Type-Bound Procedures

procedure, public :: count => ring_count

  • interface

    private module function ring_count(self) result(n)

    Arguments

    Type IntentOptional Attributes Name
    class(seams_rings), intent(in) :: self

    Return Value integer(kind=seams_int)

procedure, public :: histogram => ring_histogram

  • interface

    private module subroutine ring_histogram(self, counts, stat, errmsg)

    Arguments

    Type IntentOptional Attributes Name
    class(seams_rings), intent(in) :: self
    integer(kind=seams_int), intent(out), allocatable :: counts(:)
    integer(kind=seams_int), intent(out), optional :: stat
    character(len=:), intent(out), optional, allocatable :: errmsg

procedure, public :: fraction => ring_fraction

  • interface

    private module subroutine ring_fraction(self, size, fraction, stat, errmsg)

    size 0 counts atoms that sit on any ring.

    Arguments

    Type IntentOptional Attributes Name
    class(seams_rings), intent(in) :: self
    integer(kind=seams_int), intent(in) :: size
    real(kind=seams_real), intent(out) :: fraction
    integer(kind=seams_int), intent(out), optional :: stat
    character(len=:), intent(out), optional, allocatable :: errmsg

procedure, public :: sizes => ring_sizes

  • interface

    private module subroutine ring_sizes(self, sizes, stat, errmsg)

    Arguments

    Type IntentOptional Attributes Name
    class(seams_rings), intent(in) :: self
    integer(kind=seams_int), intent(out), allocatable :: sizes(:)
    integer(kind=seams_int), intent(out), optional :: stat
    character(len=:), intent(out), optional, allocatable :: errmsg

procedure, public :: symmetry => ring_symmetry

  • interface

    private module subroutine ring_symmetry(self, codes, stat, errmsg)

    Arguments

    Type IntentOptional Attributes Name
    class(seams_rings), intent(in) :: self
    integer(kind=seams_int), intent(out), allocatable :: codes(:)
    integer(kind=seams_int), intent(out), optional :: stat
    character(len=:), intent(out), optional, allocatable :: errmsg

procedure, public :: vertices => ring_vertices

  • interface

    private module subroutine ring_vertices(self, index, atoms, stat, errmsg)

    index is 1-based.

    Arguments

    Type IntentOptional Attributes Name
    class(seams_rings), intent(in) :: self
    integer(kind=seams_int), intent(in) :: index
    integer(kind=seams_int), intent(out), allocatable :: atoms(:)
    integer(kind=seams_int), intent(out), optional :: stat
    character(len=:), intent(out), optional, allocatable :: errmsg

procedure, public :: close => ring_close

  • private subroutine ring_close(self)

    Release this owner’s reference to the ring set.

    Arguments

    Type IntentOptional Attributes Name
    class(seams_rings), intent(inout) :: self

Source Code

  type, public :: seams_rings
    private
    type(handle_box), pointer :: box => null()
    integer(seams_int) :: max_depth = 0_seams_int
  contains
    procedure, public :: count => ring_count
    procedure, public :: histogram => ring_histogram
    procedure, public :: fraction => ring_fraction
    procedure, public :: sizes => ring_sizes
    procedure, public :: symmetry => ring_symmetry
    procedure, public :: vertices => ring_vertices
    procedure, public :: close => ring_close
    final :: ring_final
  end type seams_rings