(git:9dda3dd)
Loading...
Searching...
No Matches
particle_methods Module Reference

Define methods related to particle_type. More...

Functions/Subroutines

subroutine, public get_particle_set (particle_set, qs_kind_set, first_sgf, last_sgf, nsgf, nmao, basis, ncgf)
 Get the components of a particle set.
 
subroutine, public write_particle_coordinates (particle_set, iunit, output_format, content, title, cell, array, unit_conv, charge_occup, charge_beta, charge_extended, print_kind)
 Should be able to write a few formats e.g. xmol, and some binary format (dcd) some format can be used for x,v,f.
 
subroutine, public write_fist_particle_coordinates (particle_set, subsys_section, charges)
 Write the atomic coordinates to the output unit.
 
subroutine, public write_qs_particle_coordinates (particle_set, qs_kind_set, subsys_section, label)
 Write the atomic coordinates to the output unit.
 
subroutine, public write_particle_distances (particle_set, cell, subsys_section)
 Write the matrix of the particle distances to the output unit.
 
subroutine, public write_particle_matrix (matrix, particle_set, iw, el_per_part, ilist, parts_per_line)
 ...
 
subroutine, public write_structure_data (particle_set, cell, input_section)
 Write structure data requested by a separate structure data input section to the output unit. input_section can be either motion_section or subsys_section.
 
subroutine, public write_final_structure (particle_set, cell, input_section, conv, keep_angles, keep_symmetry, keep_volume, gopt_env_label, constraint_label)
 Write the final geometry and cell information to files.
 

Detailed Description

Define methods related to particle_type.

History
10.2014 Move routines out of particle_types.F [Ole Schuett]
Author
Ole Schuett

Function/Subroutine Documentation

◆ get_particle_set()

subroutine, public particle_methods::get_particle_set ( type(particle_type), dimension(:), pointer  particle_set,
type(qs_kind_type), dimension(:), pointer  qs_kind_set,
integer, dimension(:), intent(inout), optional  first_sgf,
integer, dimension(:), intent(inout), optional  last_sgf,
integer, dimension(:), intent(inout), optional  nsgf,
integer, dimension(:), intent(inout), optional  nmao,
type(gto_basis_set_p_type), dimension(:), optional  basis,
integer, dimension(:), intent(inout), optional  ncgf 
)

Get the components of a particle set.

Parameters
particle_set...
qs_kind_set...
first_sgf...
last_sgf...
nsgf...
nmao...
basis...
ncgf...
Date
14.01.2002
History
  • particle type cleaned (13.10.2003,MK)
  • refactoring and add basis set option (17.08.2010,jhu)
Author
MK
Version
1.0

Definition at line 119 of file particle_methods.F.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ write_particle_coordinates()

subroutine, public particle_methods::write_particle_coordinates ( type(particle_type), dimension(:), pointer  particle_set,
integer  iunit,
integer  output_format,
character(len=*)  content,
character(len=*)  title,
type(cell_type), optional, pointer  cell,
real(kind=dp), dimension(:), intent(in), optional  array,
real(kind=dp), intent(in), optional  unit_conv,
logical, intent(in), optional  charge_occup,
logical, intent(in), optional  charge_beta,
logical, intent(in), optional  charge_extended,
logical, intent(in), optional  print_kind 
)

Should be able to write a few formats e.g. xmol, and some binary format (dcd) some format can be used for x,v,f.

FORMAT CONTENT UNITS x, v, f XMOL POS, VEL, FORCE, POS_VEL, POS_VEL_FORCE Angstrom, a.u., a.u.

Parameters
particle_set...
iunit...
output_format...
content...
title...
cell...
array...
unit_conv...
charge_occup...
charge_beta...
charge_extended...
print_kind...
Date
14.01.2002
Author
MK
Version
1.0

Definition at line 222 of file particle_methods.F.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ write_fist_particle_coordinates()

subroutine, public particle_methods::write_fist_particle_coordinates ( type(particle_type), dimension(:), pointer  particle_set,
type(section_vals_type), pointer  subsys_section,
real(kind=dp), dimension(:), optional  charges 
)

Write the atomic coordinates to the output unit.

Parameters
particle_set...
subsys_section...
charges...
Date
05.06.2000
Author
MK
Version
1.0

Definition at line 526 of file particle_methods.F.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ write_qs_particle_coordinates()

subroutine, public particle_methods::write_qs_particle_coordinates ( type(particle_type), dimension(:), pointer  particle_set,
type(qs_kind_type), dimension(:), pointer  qs_kind_set,
type(section_vals_type), pointer  subsys_section,
character(len=*), intent(in)  label 
)

Write the atomic coordinates to the output unit.

Parameters
particle_set...
qs_kind_set...
subsys_section...
label...
Date
05.06.2000
Author
MK
Version
1.0

Definition at line 588 of file particle_methods.F.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ write_particle_distances()

subroutine, public particle_methods::write_particle_distances ( type(particle_type), dimension(:), pointer  particle_set,
type(cell_type), pointer  cell,
type(section_vals_type), pointer  subsys_section 
)

Write the matrix of the particle distances to the output unit.

Parameters
particle_set...
cell...
subsys_section...
Date
06.10.2000
Author
Matthias Krack
Version
1.0

Definition at line 648 of file particle_methods.F.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ write_particle_matrix()

subroutine, public particle_methods::write_particle_matrix ( real(kind=dp), dimension(:, :)  matrix,
type(particle_type), dimension(:), pointer  particle_set,
integer, intent(in)  iw,
integer, intent(in), optional  el_per_part,
integer, dimension(:), optional, pointer  ilist,
integer, intent(in), optional  parts_per_line 
)

...

Parameters
matrix...
particle_set...
iw...
el_per_part...
Ilist...
parts_per_line: number of particle columns to be printed in one line

Definition at line 758 of file particle_methods.F.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ write_structure_data()

subroutine, public particle_methods::write_structure_data ( type(particle_type), dimension(:), pointer  particle_set,
type(cell_type), pointer  cell,
type(section_vals_type), pointer  input_section 
)

Write structure data requested by a separate structure data input section to the output unit. input_section can be either motion_section or subsys_section.

Parameters
particle_set...
cell...
input_section...
Date
11.03.04
History
Recovered (23.03.06,MK)
Author
MK
Version
1.0

Definition at line 828 of file particle_methods.F.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ write_final_structure()

subroutine, public particle_methods::write_final_structure ( type(particle_type), dimension(:), pointer  particle_set,
type(cell_type), intent(in), pointer  cell,
type(section_vals_type), intent(in), pointer  input_section,
logical, intent(in)  conv,
logical, intent(in)  keep_angles,
logical, intent(in)  keep_symmetry,
logical, intent(in)  keep_volume,
character(len=default_string_length), intent(in)  gopt_env_label,
character(len=4), intent(in)  constraint_label 
)

Write the final geometry and cell information to files.

Parameters
particle_setpointer to particles with atm_name, element_symbol and position
cellpointer to cell with abc, angle_alpha, angle_beta, angle_gamma and deth
input_sectionpointer to motion_section which has PRINTFINAL_STRUCTURE
convflag for whether convergence is achieved or not in optimization
keep_anglesflag for whether cell optimization keeps initial angles
keep_symmetryflag for whether cell optimization keeps initial symmetry
keep_volumeflag for whether cell optimization keeps initial volume
gopt_env_labelthe geometry optimization label "GEO_OPT", "CELL_OPT", ...
constraint_labellabel for directions with constraint in cell optimization
Intended to be invoked in gopt_f_methods:write_final_info.
This implementation does not consider higher space groups even if one is detected, and the chemical formulae are neither written in the sorted "Hill notation" nor expressed in groups of molecules. Other potentially useful but yet to be written information includes: the external pressure from CELL_OPT/EXTERNAL_POTENTIAL and the stress tensor (virial) for CELL_OPT; the fixed atoms from MOTION/CONSTRAINT/FIXED_ATOMS for all.

History 04.2026 - Created

Author
HE Zilong
Version
1.0

Definition at line 1080 of file particle_methods.F.

Here is the call graph for this function:
Here is the caller graph for this function: