One frame. The finalizer frees the C frame.
Release this owner’s reference to the frame.
| Type | Intent | Optional | Attributes | Name | ||
|---|---|---|---|---|---|---|
| type(seams_frame), | intent(inout) | :: | self |
xyz has shape (3, n). Lengths are angstrom. The origin defaults to zero.
| Type | Intent | Optional | Attributes | Name | ||
|---|---|---|---|---|---|---|
| class(seams_frame), | intent(inout) | :: | self | |||
| real(kind=seams_real), | intent(in), | contiguous | :: | xyz(:,:) | ||
| real(kind=seams_real), | intent(in) | :: | lx | |||
| real(kind=seams_real), | intent(in) | :: | ly | |||
| real(kind=seams_real), | intent(in) | :: | lz | |||
| real(kind=seams_real), | intent(in), | optional | :: | ox | ||
| real(kind=seams_real), | intent(in), | optional | :: | oy | ||
| real(kind=seams_real), | intent(in), | optional | :: | oz | ||
| integer(kind=seams_int), | intent(in), | optional, | contiguous | :: | types(:) | |
| integer(kind=seams_int), | intent(in), | optional, | contiguous | :: | ids(:) | |
| integer(kind=seams_int), | intent(out), | optional | :: | stat | ||
| character(len=:), | intent(out), | optional, | allocatable | :: | errmsg |
box is ox, oy, oz, lx, ly, lz, xy, xz, yz.
| Type | Intent | Optional | Attributes | Name | ||
|---|---|---|---|---|---|---|
| class(seams_frame), | intent(inout) | :: | self | |||
| real(kind=seams_real), | intent(in), | contiguous | :: | xyz(:,:) | ||
| real(kind=seams_real), | intent(in) | :: | box(9) | |||
| integer(kind=seams_int), | intent(in), | optional, | contiguous | :: | types(:) | |
| integer(kind=seams_int), | intent(in), | optional, | contiguous | :: | ids(:) | |
| integer(kind=seams_int), | intent(out), | optional | :: | stat | ||
| character(len=:), | intent(out), | optional, | allocatable | :: | errmsg |
frame is 1-based. A negative type_filter keeps every atom. Zero guesses oxygen.
| Type | Intent | Optional | Attributes | Name | ||
|---|---|---|---|---|---|---|
| class(seams_frame), | intent(inout) | :: | self | |||
| character(len=*), | intent(in) | :: | path | |||
| integer(kind=seams_int), | intent(in), | optional | :: | frame | ||
| integer(kind=seams_int), | intent(in), | optional | :: | type_filter | ||
| integer(kind=seams_int), | intent(out), | optional | :: | stat | ||
| character(len=:), | intent(out), | optional, | allocatable | :: | errmsg |
| Type | Intent | Optional | Attributes | Name | ||
|---|---|---|---|---|---|---|
| class(seams_frame), | intent(in) | :: | self |
Release this owner’s reference to the frame.
| Type | Intent | Optional | Attributes | Name | ||
|---|---|---|---|---|---|---|
| class(seams_frame), | intent(inout) | :: | self |
| Type | Intent | Optional | Attributes | Name | ||
|---|---|---|---|---|---|---|
| class(seams_frame), | intent(inout) | :: | self | |||
| integer(kind=seams_int), | intent(out), | allocatable | :: | labels(:) | ||
| integer(kind=seams_int), | intent(out), | optional, | allocatable | :: | counts(:) | |
| real(kind=seams_real), | intent(in), | optional | :: | cutoff | ||
| integer(kind=seams_int), | intent(in), | optional | :: | typ | ||
| integer(kind=seams_int), | intent(in), | optional | :: | graph | ||
| integer(kind=seams_int), | intent(in), | optional | :: | rule | ||
| integer(kind=seams_int), | intent(out), | optional | :: | stat | ||
| character(len=:), | intent(out), | optional, | allocatable | :: | errmsg |
| Type | Intent | Optional | Attributes | Name | ||
|---|---|---|---|---|---|---|
| class(seams_frame), | intent(inout) | :: | self | |||
| integer(kind=seams_int), | intent(out), | allocatable | :: | labels(:) | ||
| integer(kind=seams_int), | intent(out), | optional, | allocatable | :: | counts(:) | |
| real(kind=seams_real), | intent(in), | optional | :: | cutoff | ||
| integer(kind=seams_int), | intent(in), | optional | :: | typ | ||
| integer(kind=seams_int), | intent(in), | optional | :: | graph | ||
| integer(kind=seams_int), | intent(in), | optional | :: | rule | ||
| integer(kind=seams_int), | intent(out), | optional | :: | stat | ||
| character(len=:), | intent(out), | optional, | allocatable | :: | errmsg |
| Type | Intent | Optional | Attributes | Name | ||
|---|---|---|---|---|---|---|
| class(seams_frame), | intent(inout) | :: | self | |||
| real(kind=seams_real), | intent(out), | allocatable | :: | q4(:) | ||
| real(kind=seams_real), | intent(out), | allocatable | :: | q6(:) | ||
| real(kind=seams_real), | intent(in), | optional | :: | cutoff | ||
| integer(kind=seams_int), | intent(in), | optional | :: | typ | ||
| integer(kind=seams_int), | intent(out), | optional | :: | stat | ||
| character(len=:), | intent(out), | optional, | allocatable | :: | errmsg |
order_l is 3, 4, 6, 8, or 12. qlbar is omitted to skip the average.
| Type | Intent | Optional | Attributes | Name | ||
|---|---|---|---|---|---|---|
| class(seams_frame), | intent(inout) | :: | self | |||
| integer(kind=seams_int), | intent(in) | :: | order_l | |||
| real(kind=seams_real), | intent(out), | allocatable | :: | ql(:) | ||
| real(kind=seams_real), | intent(out), | optional, | allocatable | :: | qlbar(:) | |
| real(kind=seams_real), | intent(in), | optional | :: | cutoff | ||
| integer(kind=seams_int), | intent(in), | optional | :: | typ | ||
| integer(kind=seams_int), | intent(in), | optional | :: | graph | ||
| integer(kind=seams_int), | intent(out), | optional | :: | stat | ||
| character(len=:), | intent(out), | optional, | allocatable | :: | errmsg |
| Type | Intent | Optional | Attributes | Name | ||
|---|---|---|---|---|---|---|
| class(seams_frame), | intent(inout) | :: | self | |||
| integer(kind=seams_int), | intent(in) | :: | order_l | |||
| real(kind=seams_real), | intent(out), | allocatable | :: | ql(:) | ||
| real(kind=seams_real), | intent(out), | optional, | allocatable | :: | qlbar(:) | |
| real(kind=seams_real), | intent(in), | optional | :: | cutoff | ||
| integer(kind=seams_int), | intent(in), | optional | :: | typ | ||
| integer(kind=seams_int), | intent(out), | optional | :: | stat | ||
| character(len=:), | intent(out), | optional, | allocatable | :: | errmsg |
ice_cut defaults to 0.36. At least one of the outputs is required.
| Type | Intent | Optional | Attributes | Name | ||
|---|---|---|---|---|---|---|
| class(seams_frame), | intent(inout) | :: | self | |||
| real(kind=seams_real), | intent(out), | optional, | allocatable | :: | q6bar(:) | |
| real(kind=seams_real), | intent(out), | optional | :: | mean | ||
| real(kind=seams_real), | intent(out), | optional | :: | median | ||
| integer(kind=seams_int), | intent(out), | optional | :: | n_ice | ||
| real(kind=seams_real), | intent(in), | optional | :: | cutoff | ||
| integer(kind=seams_int), | intent(in), | optional | :: | typ | ||
| real(kind=seams_real), | intent(in), | optional | :: | ice_cut | ||
| integer(kind=seams_int), | intent(out), | optional | :: | stat | ||
| character(len=:), | intent(out), | optional, | allocatable | :: | errmsg |
| Type | Intent | Optional | Attributes | Name | ||
|---|---|---|---|---|---|---|
| class(seams_frame), | intent(inout) | :: | self | |||
| real(kind=seams_real), | intent(in), | optional | :: | cutoff | ||
| integer(kind=seams_int), | intent(in), | optional | :: | typ | ||
| integer(kind=seams_int), | intent(in), | optional | :: | graph | ||
| integer(kind=seams_int), | intent(out), | optional | :: | stat | ||
| character(len=:), | intent(out), | optional, | allocatable | :: | errmsg |
mutual defaults to true.
| Type | Intent | Optional | Attributes | Name | ||
|---|---|---|---|---|---|---|
| class(seams_frame), | intent(inout) | :: | self | |||
| integer(kind=seams_int), | intent(in) | :: | k | |||
| real(kind=seams_real), | intent(in), | optional | :: | cutoff | ||
| integer(kind=seams_int), | intent(in), | optional | :: | typ | ||
| logical, | intent(in), | optional | :: | mutual | ||
| integer(kind=seams_int), | intent(out), | optional | :: | stat | ||
| character(len=:), | intent(out), | optional, | allocatable | :: | errmsg |
max_depth defaults to 6 and must be from 3 through 12.
| Type | Intent | Optional | Attributes | Name | ||
|---|---|---|---|---|---|---|
| class(seams_frame), | intent(inout) | :: | self | |||
| real(kind=seams_real), | intent(in), | optional | :: | cutoff | ||
| integer(kind=seams_int), | intent(in), | optional | :: | typ | ||
| integer(kind=seams_int), | intent(in), | optional | :: | graph | ||
| integer(kind=seams_int), | intent(in), | optional | :: | max_depth | ||
| integer(kind=seams_int), | intent(out), | optional | :: | stat | ||
| character(len=:), | intent(out), | optional, | allocatable | :: | errmsg |
graph defaults to the seeded cage graph. k defaults to 4.
| Type | Intent | Optional | Attributes | Name | ||
|---|---|---|---|---|---|---|
| class(seams_frame), | intent(inout) | :: | self | |||
| real(kind=seams_real), | intent(in), | optional | :: | cutoff | ||
| integer(kind=seams_int), | intent(in), | optional | :: | typ | ||
| integer(kind=seams_int), | intent(in), | optional | :: | graph | ||
| integer(kind=seams_int), | intent(in), | optional | :: | k | ||
| logical, | intent(in), | optional | :: | complete | ||
| integer(kind=seams_int), | intent(out), | optional | :: | stat | ||
| character(len=:), | intent(out), | optional, | allocatable | :: | errmsg |
spec is a census such as “512” or a name such as “hc”.
| Type | Intent | Optional | Attributes | Name | ||
|---|---|---|---|---|---|---|
| class(seams_frame), | intent(inout) | :: | self | |||
| character(len=*), | intent(in) | :: | spec | |||
| integer(kind=seams_int), | intent(out) | :: | n_cages | |||
| integer(kind=seams_int), | intent(out) | :: | n_atoms | |||
| real(kind=seams_real), | intent(in), | optional | :: | cutoff | ||
| integer(kind=seams_int), | intent(in), | optional | :: | typ | ||
| integer(kind=seams_int), | intent(in), | optional | :: | graph | ||
| integer(kind=seams_int), | intent(out), | optional | :: | stat | ||
| character(len=:), | intent(out), | optional, | allocatable | :: | errmsg |
| Type | Intent | Optional | Attributes | Name | ||
|---|---|---|---|---|---|---|
| class(seams_frame), | intent(inout) | :: | self | |||
| real(kind=seams_real), | intent(out), | allocatable | :: | r(:) | ||
| real(kind=seams_real), | intent(out), | allocatable | :: | g(:) | ||
| real(kind=seams_real), | intent(out), | optional | :: | volume | ||
| real(kind=seams_real), | intent(in), | optional | :: | rmax | ||
| integer(kind=seams_int), | intent(in), | optional | :: | bins | ||
| integer(kind=seams_int), | intent(in), | optional | :: | type_i | ||
| integer(kind=seams_int), | intent(in), | optional | :: | type_j | ||
| integer(kind=seams_int), | intent(out), | optional, | allocatable | :: | count(:) | |
| integer(kind=seams_int), | intent(out), | optional | :: | stat | ||
| character(len=:), | intent(out), | optional, | allocatable | :: | errmsg |
| Type | Intent | Optional | Attributes | Name | ||
|---|---|---|---|---|---|---|
| class(seams_frame), | intent(inout) | :: | self | |||
| real(kind=seams_real), | intent(out), | allocatable | :: | r(:) | ||
| real(kind=seams_real), | intent(out), | allocatable | :: | cn(:) | ||
| real(kind=seams_real), | intent(in), | optional | :: | rmax | ||
| integer(kind=seams_int), | intent(in), | optional | :: | bins | ||
| integer(kind=seams_int), | intent(in), | optional | :: | type_i | ||
| integer(kind=seams_int), | intent(in), | optional | :: | type_j | ||
| integer(kind=seams_int), | intent(out), | optional | :: | stat | ||
| character(len=:), | intent(out), | optional, | allocatable | :: | errmsg |
| Type | Intent | Optional | Attributes | Name | ||
|---|---|---|---|---|---|---|
| class(seams_frame), | intent(inout) | :: | self | |||
| real(kind=seams_real), | intent(in), | optional | :: | rmax | ||
| integer(kind=seams_int), | intent(in), | optional | :: | bins | ||
| integer(kind=seams_int), | intent(in), | optional | :: | type_i | ||
| integer(kind=seams_int), | intent(in), | optional | :: | type_j | ||
| integer(kind=seams_int), | intent(out), | optional | :: | stat | ||
| character(len=:), | intent(out), | optional, | allocatable | :: | errmsg |
| Type | Intent | Optional | Attributes | Name | ||
|---|---|---|---|---|---|---|
| class(seams_frame), | intent(inout) | :: | self | |||
| real(kind=seams_real), | intent(in), | optional | :: | cutoff | ||
| integer(kind=seams_int), | intent(in), | optional | :: | oxygen_type | ||
| integer(kind=seams_int), | intent(in), | optional | :: | hydrogen_type | ||
| real(kind=seams_real), | intent(in), | optional | :: | dist | ||
| real(kind=seams_real), | intent(in), | optional | :: | angle | ||
| integer(kind=seams_int), | intent(out), | optional | :: | stat | ||
| character(len=:), | intent(out), | optional, | allocatable | :: | errmsg |
axis is 0, 1, or 2. It defaults to 2.
| Type | Intent | Optional | Attributes | Name | ||
|---|---|---|---|---|---|---|
| class(seams_frame), | intent(inout) | :: | self | |||
| real(kind=seams_real), | intent(out), | allocatable | :: | z(:) | ||
| real(kind=seams_real), | intent(out), | allocatable | :: | rho(:) | ||
| integer(kind=seams_int), | intent(in), | optional | :: | typ | ||
| integer(kind=seams_int), | intent(in), | optional | :: | bins | ||
| integer(kind=seams_int), | intent(in), | optional | :: | axis | ||
| integer(kind=seams_int), | intent(out), | optional | :: | stat | ||
| character(len=:), | intent(out), | optional, | allocatable | :: | errmsg |
colors partitions keys by atom type. colours is the deprecated
spelling of that keyword. Giving both different values is an error.
| Type | Intent | Optional | Attributes | Name | ||
|---|---|---|---|---|---|---|
| class(seams_frame), | intent(inout) | :: | self | |||
| real(kind=seams_real), | intent(in), | optional | :: | cutoff | ||
| integer(kind=seams_int), | intent(in), | optional | :: | typ | ||
| integer(kind=seams_int), | intent(in), | optional | :: | k | ||
| integer(kind=seams_int), | intent(in), | optional | :: | graph | ||
| integer(kind=seams_int), | intent(in), | optional | :: | hops | ||
| logical, | intent(in), | optional | :: | colors | ||
| logical, | intent(in), | optional | :: | colours | ||
| integer(kind=seams_int), | intent(out), | optional | :: | stat | ||
| character(len=:), | intent(out), | optional, | allocatable | :: | errmsg |
| Type | Intent | Optional | Attributes | Name | ||
|---|---|---|---|---|---|---|
| class(seams_frame), | intent(inout) | :: | self | |||
| character(len=*), | intent(in) | :: | spec | |||
| integer(kind=seams_int), | intent(out) | :: | n_pairs | |||
| integer(kind=seams_int), | intent(out) | :: | n_cation | |||
| integer(kind=seams_int), | intent(out) | :: | n_anion | |||
| integer(kind=seams_int), | intent(out), | optional | :: | stat | ||
| character(len=:), | intent(out), | optional, | allocatable | :: | errmsg |
polar false is the apolar subset.
| Type | Intent | Optional | Attributes | Name | ||
|---|---|---|---|---|---|---|
| class(seams_frame), | intent(inout) | :: | self | |||
| character(len=*), | intent(in) | :: | spec | |||
| integer(kind=seams_int), | intent(out) | :: | n_subset | |||
| integer(kind=seams_int), | intent(out) | :: | largest | |||
| real(kind=seams_real), | intent(out) | :: | percolation | |||
| real(kind=seams_real), | intent(in), | optional | :: | cutoff | ||
| logical, | intent(in), | optional | :: | polar | ||
| integer(kind=seams_int), | intent(out), | optional | :: | stat | ||
| character(len=:), | intent(out), | optional, | allocatable | :: | errmsg |
| Type | Intent | Optional | Attributes | Name | ||
|---|---|---|---|---|---|---|
| class(seams_frame), | intent(inout) | :: | self | |||
| integer(kind=seams_int), | intent(out), | allocatable | :: | perfect(:) | ||
| integer(kind=seams_int), | intent(out), | allocatable | :: | imperfect(:) | ||
| real(kind=seams_real), | intent(in), | optional | :: | cutoff | ||
| integer(kind=seams_int), | intent(in), | optional | :: | typ | ||
| integer(kind=seams_int), | intent(out), | optional | :: | stat | ||
| character(len=:), | intent(out), | optional, | allocatable | :: | errmsg |
| Type | Intent | Optional | Attributes | Name | ||
|---|---|---|---|---|---|---|
| class(seams_frame), | intent(inout) | :: | self | |||
| integer(kind=seams_int), | intent(out), | allocatable | :: | counts(:) | ||
| real(kind=seams_real), | intent(in) | :: | sheet_area | |||
| real(kind=seams_real), | intent(in), | optional | :: | cutoff | ||
| integer(kind=seams_int), | intent(in), | optional | :: | typ | ||
| integer(kind=seams_int), | intent(in), | optional | :: | max_depth | ||
| integer(kind=seams_int), | intent(out), | optional | :: | stat | ||
| character(len=:), | intent(out), | optional, | allocatable | :: | errmsg |
| Type | Intent | Optional | Attributes | Name | ||
|---|---|---|---|---|---|---|
| class(seams_frame), | intent(inout) | :: | self | |||
| character(len=*), | intent(in) | :: | spec | |||
| integer(kind=seams_int), | intent(out), | allocatable | :: | kinds(:) | ||
| integer(kind=seams_int), | intent(out), | optional | :: | stat | ||
| character(len=:), | intent(out), | optional, | allocatable | :: | errmsg |
A non-positive shell_rmsd selects the library ceiling.
| Type | Intent | Optional | Attributes | Name | ||
|---|---|---|---|---|---|---|
| class(seams_frame), | intent(inout) | :: | self | |||
| integer(kind=seams_int), | intent(out), | allocatable | :: | labels(:) | ||
| real(kind=seams_real), | intent(in), | optional | :: | shell_rmsd | ||
| integer(kind=seams_int), | intent(out), | optional | :: | stat | ||
| character(len=:), | intent(out), | optional, | allocatable | :: | errmsg |
ice(i) nonzero marks atom i as ice. axis defaults to 2. n_bins 0 selects 20.
| Type | Intent | Optional | Attributes | Name | ||
|---|---|---|---|---|---|---|
| class(seams_frame), | intent(inout) | :: | self | |||
| integer(kind=seams_int), | intent(in), | contiguous | :: | ice(:) | ||
| integer(kind=seams_int), | intent(in), | optional | :: | water_type | ||
| integer(kind=seams_int), | intent(in), | optional | :: | ion_type | ||
| integer(kind=seams_int), | intent(in), | optional | :: | n_bins | ||
| integer(kind=seams_int), | intent(in), | optional | :: | axis | ||
| integer(kind=seams_int), | intent(out), | optional | :: | stat | ||
| character(len=:), | intent(out), | optional, | allocatable | :: | errmsg |
type, public :: seams_frame private type(handle_box), pointer :: box => null() contains procedure, public :: set_ortho => frame_set_ortho procedure, public :: set_frame => frame_set_frame procedure, public :: read => frame_read procedure, public :: count => frame_count procedure, public :: close => frame_close procedure, public :: chill => frame_chill procedure, public :: chill_plus => frame_chill_plus procedure, public :: q4q6 => frame_q4q6 procedure, public :: ql => frame_ql procedure, public :: steinhardt => frame_steinhardt procedure, public :: q6bar => frame_q6bar procedure, public :: neighbours => frame_neighbours procedure, public :: knn => frame_knn procedure, public :: rings => frame_rings procedure, public :: cages => frame_cages procedure, public :: signature => frame_signature procedure, public :: rdf => frame_rdf procedure, public :: running_cn => frame_running_cn procedure, public :: coordination => frame_coordination procedure, public :: hbonds => frame_hbonds procedure, public :: density => frame_density procedure, public :: fingerprint => frame_fingerprint procedure, public :: contact_pairs => frame_contact_pairs procedure, public :: domains => frame_domains procedure, public :: prisms => frame_prisms procedure, public :: monolayer => frame_monolayer procedure, public :: site_kinds => frame_site_kinds procedure, public :: symmetry => frame_symmetry procedure, public :: brine => frame_brine final :: frame_final end type seams_frame