-
Notifications
You must be signed in to change notification settings - Fork 1
/
cell_methods.F
839 lines (742 loc) · 37.6 KB
/
cell_methods.F
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
!--------------------------------------------------------------------------------------------------!
! CP2K: A general program to perform molecular dynamics simulations !
! Copyright 2000-2024 CP2K developers group <https://cp2k.org> !
! !
! SPDX-License-Identifier: GPL-2.0-or-later !
!--------------------------------------------------------------------------------------------------!
! **************************************************************************************************
!> \brief Handles all functions related to the CELL
!> \par History
!> 11.2008 Teodoro Laino [tlaino] - deeply cleaning cell_type from units
!> 10.2014 Moved many routines to cell_types.F.
!> \author Matthias KracK (16.01.2002, based on a earlier version of CJM, JGH)
! **************************************************************************************************
MODULE cell_methods
USE cell_types, ONLY: &
cell_clone, cell_release, cell_sym_cubic, cell_sym_hexagonal_gamma_120, &
cell_sym_hexagonal_gamma_60, cell_sym_monoclinic, cell_sym_monoclinic_gamma_ab, &
cell_sym_none, cell_sym_orthorhombic, cell_sym_rhombohedral, cell_sym_tetragonal_ab, &
cell_sym_tetragonal_ac, cell_sym_tetragonal_bc, cell_sym_triclinic, cell_type, get_cell, &
plane_distance, use_perd_none, use_perd_x, use_perd_xy, use_perd_xyz, use_perd_xz, &
use_perd_y, use_perd_yz, use_perd_z
USE cp_log_handling, ONLY: cp_get_default_logger,&
cp_logger_type
USE cp_output_handling, ONLY: cp_print_key_finished_output,&
cp_print_key_unit_nr
USE cp_parser_methods, ONLY: parser_get_next_line,&
parser_get_object,&
parser_search_string
USE cp_parser_types, ONLY: cp_parser_type,&
parser_create,&
parser_release
USE cp_units, ONLY: cp_unit_from_cp2k,&
cp_unit_to_cp2k
USE input_constants, ONLY: do_cell_cif,&
do_cell_cp2k,&
do_cell_xsc
USE input_cp2k_subsys, ONLY: create_cell_section
USE input_enumeration_types, ONLY: enum_i2c,&
enumeration_type
USE input_keyword_types, ONLY: keyword_get,&
keyword_type
USE input_section_types, ONLY: &
section_get_keyword, section_release, section_type, section_vals_get, &
section_vals_get_subs_vals, section_vals_type, section_vals_val_get, section_vals_val_set, &
section_vals_val_unset
USE kinds, ONLY: default_path_length,&
default_string_length,&
dp
USE machine, ONLY: default_output_unit
USE mathconstants, ONLY: degree,&
sqrt3
USE mathlib, ONLY: angle,&
det_3x3,&
inv_3x3
USE message_passing, ONLY: mp_para_env_type
#include "./base/base_uses.f90"
IMPLICIT NONE
PRIVATE
CHARACTER(len=*), PARAMETER, PRIVATE :: moduleN = 'cell_methods'
PUBLIC :: cell_create, &
init_cell, &
read_cell, &
read_cell_cif, &
set_cell_param, &
write_cell
CONTAINS
! **************************************************************************************************
!> \brief allocates and initializes a cell
!> \param cell the cell to initialize
!> \param hmat the h matrix that defines the cell
!> \param periodic periodicity of the cell
!> \param tag ...
!> \par History
!> 09.2003 created [fawzi]
!> \author Fawzi Mohamed
! **************************************************************************************************
SUBROUTINE cell_create(cell, hmat, periodic, tag)
TYPE(cell_type), POINTER :: cell
REAL(KIND=dp), DIMENSION(3, 3), INTENT(IN), &
OPTIONAL :: hmat
INTEGER, DIMENSION(3), INTENT(IN), OPTIONAL :: periodic
CHARACTER(LEN=*), INTENT(IN), OPTIONAL :: tag
CPASSERT(.NOT. ASSOCIATED(cell))
ALLOCATE (cell)
cell%ref_count = 1
IF (PRESENT(periodic)) THEN
cell%perd = periodic
ELSE
cell%perd = 1
END IF
cell%orthorhombic = .FALSE.
cell%symmetry_id = cell_sym_none
IF (PRESENT(hmat)) CALL init_cell(cell, hmat)
IF (PRESENT(tag)) cell%tag = tag
END SUBROUTINE cell_create
! **************************************************************************************************
!> \brief Initialise/readjust a simulation cell after hmat has been changed
!> \param cell ...
!> \param hmat ...
!> \param periodic ...
!> \date 16.01.2002
!> \author Matthias Krack
!> \version 1.0
! **************************************************************************************************
SUBROUTINE init_cell(cell, hmat, periodic)
TYPE(cell_type), POINTER :: cell
REAL(KIND=dp), DIMENSION(3, 3), INTENT(IN), &
OPTIONAL :: hmat
INTEGER, DIMENSION(3), INTENT(IN), OPTIONAL :: periodic
REAL(KIND=dp), PARAMETER :: eps_hmat = 1.0E-14_dp
INTEGER :: dim
REAL(KIND=dp) :: a, acosa, acosah, acosg, alpha, asina, &
asinah, asing, beta, gamma, norm, &
norm_c
REAL(KIND=dp), DIMENSION(3) :: abc
CPASSERT(ASSOCIATED(cell))
IF (PRESENT(hmat)) cell%hmat(:, :) = hmat(:, :)
IF (PRESENT(periodic)) cell%perd(:) = periodic(:)
cell%deth = ABS(det_3x3(cell%hmat))
IF (cell%deth < 1.0E-10_dp) THEN
CALL write_cell_low(cell, "angstrom", default_output_unit)
CALL cp_abort(__LOCATION__, &
"An invalid set of cell vectors was specified. "// &
"The cell volume is too small")
END IF
SELECT CASE (cell%symmetry_id)
CASE (cell_sym_cubic, &
cell_sym_tetragonal_ab, &
cell_sym_tetragonal_ac, &
cell_sym_tetragonal_bc, &
cell_sym_orthorhombic)
CALL get_cell(cell=cell, abc=abc)
abc(2) = plane_distance(0, 1, 0, cell=cell)
abc(3) = plane_distance(0, 0, 1, cell=cell)
SELECT CASE (cell%symmetry_id)
CASE (cell_sym_cubic)
abc(1:3) = SUM(abc(1:3))/3.0_dp
CASE (cell_sym_tetragonal_ab, &
cell_sym_tetragonal_ac, &
cell_sym_tetragonal_bc)
SELECT CASE (cell%symmetry_id)
CASE (cell_sym_tetragonal_ab)
a = 0.5_dp*(abc(1) + abc(2))
abc(1) = a
abc(2) = a
CASE (cell_sym_tetragonal_ac)
a = 0.5_dp*(abc(1) + abc(3))
abc(1) = a
abc(3) = a
CASE (cell_sym_tetragonal_bc)
a = 0.5_dp*(abc(2) + abc(3))
abc(2) = a
abc(3) = a
END SELECT
END SELECT
cell%hmat(1, 1) = abc(1); cell%hmat(1, 2) = 0.0_dp; cell%hmat(1, 3) = 0.0_dp
cell%hmat(2, 1) = 0.0_dp; cell%hmat(2, 2) = abc(2); cell%hmat(2, 3) = 0.0_dp
cell%hmat(3, 1) = 0.0_dp; cell%hmat(3, 2) = 0.0_dp; cell%hmat(3, 3) = abc(3)
CASE (cell_sym_hexagonal_gamma_60, cell_sym_hexagonal_gamma_120)
CALL get_cell(cell=cell, abc=abc)
a = 0.5_dp*(abc(1) + abc(2))
acosg = 0.5_dp*a
asing = sqrt3*acosg
IF (cell%symmetry_id == cell_sym_hexagonal_gamma_120) acosg = -acosg
cell%hmat(1, 1) = a; cell%hmat(1, 2) = acosg; cell%hmat(1, 3) = 0.0_dp
cell%hmat(2, 1) = 0.0_dp; cell%hmat(2, 2) = asing; cell%hmat(2, 3) = 0.0_dp
cell%hmat(3, 1) = 0.0_dp; cell%hmat(3, 2) = 0.0_dp; cell%hmat(3, 3) = abc(3)
CASE (cell_sym_rhombohedral)
CALL get_cell(cell=cell, abc=abc)
a = SUM(abc(1:3))/3.0_dp
alpha = (angle(cell%hmat(:, 3), cell%hmat(:, 2)) + &
angle(cell%hmat(:, 1), cell%hmat(:, 3)) + &
angle(cell%hmat(:, 1), cell%hmat(:, 2)))/3.0_dp
acosa = a*COS(alpha)
asina = a*SIN(alpha)
acosah = a*COS(0.5_dp*alpha)
asinah = a*SIN(0.5_dp*alpha)
norm = acosa/acosah
norm_c = SQRT(1.0_dp - norm*norm)
cell%hmat(1, 1) = a; cell%hmat(1, 2) = acosa; cell%hmat(1, 3) = acosah*norm
cell%hmat(2, 1) = 0.0_dp; cell%hmat(2, 2) = asina; cell%hmat(2, 3) = asinah*norm
cell%hmat(3, 1) = 0.0_dp; cell%hmat(3, 2) = 0.0_dp; cell%hmat(3, 3) = a*norm_c
CASE (cell_sym_monoclinic)
CALL get_cell(cell=cell, abc=abc)
beta = angle(cell%hmat(:, 1), cell%hmat(:, 3))
cell%hmat(1, 1) = abc(1); cell%hmat(1, 2) = 0.0_dp; cell%hmat(1, 3) = abc(3)*COS(beta)
cell%hmat(2, 1) = 0.0_dp; cell%hmat(2, 2) = abc(2); cell%hmat(2, 3) = 0.0_dp
cell%hmat(3, 1) = 0.0_dp; cell%hmat(3, 2) = 0.0_dp; cell%hmat(3, 3) = abc(3)*SIN(beta)
CASE (cell_sym_monoclinic_gamma_ab)
! Cell symmetry with a = b, alpha = beta = 90 degree and gammma not equal 90 degree
CALL get_cell(cell=cell, abc=abc)
a = 0.5_dp*(abc(1) + abc(2))
gamma = angle(cell%hmat(:, 1), cell%hmat(:, 2))
acosg = a*COS(gamma)
asing = a*SIN(gamma)
cell%hmat(1, 1) = a; cell%hmat(1, 2) = acosg; cell%hmat(1, 3) = 0.0_dp
cell%hmat(2, 1) = 0.0_dp; cell%hmat(2, 2) = asing; cell%hmat(2, 3) = 0.0_dp
cell%hmat(3, 1) = 0.0_dp; cell%hmat(3, 2) = 0.0_dp; cell%hmat(3, 3) = abc(3)
CASE (cell_sym_triclinic)
! Nothing to do
END SELECT
! Do we have an (almost) orthorhombic cell?
IF ((ABS(cell%hmat(1, 2)) < eps_hmat) .AND. (ABS(cell%hmat(1, 3)) < eps_hmat) .AND. &
(ABS(cell%hmat(2, 1)) < eps_hmat) .AND. (ABS(cell%hmat(2, 3)) < eps_hmat) .AND. &
(ABS(cell%hmat(3, 1)) < eps_hmat) .AND. (ABS(cell%hmat(3, 2)) < eps_hmat)) THEN
cell%orthorhombic = .TRUE.
ELSE
cell%orthorhombic = .FALSE.
END IF
! Retain an exact orthorhombic cell
! (off-diagonal elements must remain zero identically to keep QS fast)
IF (cell%orthorhombic) THEN
cell%hmat(1, 2) = 0.0_dp
cell%hmat(1, 3) = 0.0_dp
cell%hmat(2, 1) = 0.0_dp
cell%hmat(2, 3) = 0.0_dp
cell%hmat(3, 1) = 0.0_dp
cell%hmat(3, 2) = 0.0_dp
END IF
dim = COUNT(cell%perd == 1)
IF ((dim == 1) .AND. (.NOT. cell%orthorhombic)) THEN
CPABORT("Non-orthorhombic and not periodic")
END IF
! Update deth and hmat_inv with enforced symmetry
cell%deth = ABS(det_3x3(cell%hmat))
IF (cell%deth < 1.0E-10_dp) THEN
CALL cp_abort(__LOCATION__, &
"An invalid set of cell vectors was obtained after applying "// &
"the requested cell symmetry. The cell volume is too small")
END IF
cell%h_inv = inv_3x3(cell%hmat)
END SUBROUTINE init_cell
! **************************************************************************************************
!> \brief ...
!> \param cell ...
!> \param cell_ref ...
!> \param use_ref_cell ...
!> \param cell_section ...
!> \param check_for_ref ...
!> \param para_env ...
!> \par History
!> 03.2005 created [teo]
!> \author Teodoro Laino
! **************************************************************************************************
RECURSIVE SUBROUTINE read_cell(cell, cell_ref, use_ref_cell, cell_section, &
check_for_ref, para_env)
TYPE(cell_type), POINTER :: cell, cell_ref
LOGICAL, INTENT(INOUT), OPTIONAL :: use_ref_cell
TYPE(section_vals_type), OPTIONAL, POINTER :: cell_section
LOGICAL, INTENT(IN), OPTIONAL :: check_for_ref
TYPE(mp_para_env_type), POINTER :: para_env
INTEGER :: my_per
INTEGER, DIMENSION(:), POINTER :: multiple_unit_cell
LOGICAL :: cell_read_a, cell_read_abc, cell_read_b, &
cell_read_c, cell_read_file, check, &
my_check
REAL(KIND=dp), DIMENSION(:), POINTER :: cell_angles, cell_par
TYPE(section_vals_type), POINTER :: cell_ref_section
my_check = .TRUE.
NULLIFY (cell_ref_section, cell_par, multiple_unit_cell)
IF (.NOT. ASSOCIATED(cell)) CALL cell_create(cell, tag="CELL")
IF (.NOT. ASSOCIATED(cell_ref)) CALL cell_create(cell_ref, tag="CELL_REF")
IF (PRESENT(check_for_ref)) my_check = check_for_ref
cell%deth = 0.0_dp
cell%orthorhombic = .FALSE.
cell%perd(:) = 1
cell%symmetry_id = cell_sym_none
cell%hmat(:, :) = 0.0_dp
cell%h_inv(:, :) = 0.0_dp
cell_read_file = .FALSE.
cell_read_a = .FALSE.
cell_read_b = .FALSE.
cell_read_c = .FALSE.
! Trying to read cell info from file
CALL section_vals_val_get(cell_section, "CELL_FILE_NAME", explicit=cell_read_file)
IF (cell_read_file) CALL read_cell_from_external_file(cell_section, para_env)
! Trying to read cell info from the separate A, B, C vectors
! If cell information is provided through file A,B,C contain the file information..
! a print warning is shown on screen..
CALL section_vals_val_get(cell_section, "A", explicit=cell_read_a)
IF (cell_read_a) THEN
CALL section_vals_val_get(cell_section, "A", r_vals=cell_par)
cell%hmat(:, 1) = cell_par(:)
END IF
CALL section_vals_val_get(cell_section, "B", explicit=cell_read_b)
IF (cell_read_b) THEN
CALL section_vals_val_get(cell_section, "B", r_vals=cell_par)
cell%hmat(:, 2) = cell_par(:)
END IF
CALL section_vals_val_get(cell_section, "C", explicit=cell_read_c)
IF (cell_read_c) THEN
CALL section_vals_val_get(cell_section, "C", r_vals=cell_par)
cell%hmat(:, 3) = cell_par(:)
END IF
check = ((cell_read_a .EQV. cell_read_b) .AND. (cell_read_b .EQV. cell_read_c))
IF (.NOT. check) &
CALL cp_warn(__LOCATION__, &
"Cell Information provided through vectors A, B and C. Not all three "// &
"vectors were provided! Cell setup may be incomplete!")
! Very last option.. Trying to read cell info from ABC keyword
CALL section_vals_val_get(cell_section, "ABC", explicit=cell_read_abc)
IF (cell_read_abc) THEN
check = (cell_read_a .OR. cell_read_b .OR. cell_read_c)
IF (check) &
CALL cp_warn(__LOCATION__, &
"Cell Information provided through vectors A, B and C in conjunction with ABC."// &
" The definition of the ABC keyword will override the one provided by A,B and C.")
cell%hmat = 0.0_dp
CALL section_vals_val_get(cell_section, "ABC", r_vals=cell_par)
CALL section_vals_val_get(cell_section, "ALPHA_BETA_GAMMA", r_vals=cell_angles)
CALL set_cell_param(cell, cell_par, cell_angles, do_init_cell=.FALSE.)
END IF
! Multiple unit cell
CALL section_vals_val_get(cell_section, "MULTIPLE_UNIT_CELL", i_vals=multiple_unit_cell)
IF (ANY(multiple_unit_cell /= 1)) CALL set_multiple_unit_cell(cell, multiple_unit_cell)
CALL section_vals_val_get(cell_section, "PERIODIC", i_val=my_per)
SELECT CASE (my_per)
CASE (use_perd_x)
cell%perd = (/1, 0, 0/)
CASE (use_perd_y)
cell%perd = (/0, 1, 0/)
CASE (use_perd_z)
cell%perd = (/0, 0, 1/)
CASE (use_perd_xy)
cell%perd = (/1, 1, 0/)
CASE (use_perd_xz)
cell%perd = (/1, 0, 1/)
CASE (use_perd_yz)
cell%perd = (/0, 1, 1/)
CASE (use_perd_xyz)
cell%perd = (/1, 1, 1/)
CASE (use_perd_none)
cell%perd = (/0, 0, 0/)
CASE DEFAULT
CPABORT("")
END SELECT
! Load requested cell symmetry
CALL section_vals_val_get(cell_section, "SYMMETRY", i_val=cell%symmetry_id)
! Initialize cell
CALL init_cell(cell)
IF (my_check) THEN
! Recursive check for reference cell requested
cell_ref_section => section_vals_get_subs_vals(cell_section, "CELL_REF")
IF (parsed_cp2k_input(cell_ref_section, check_this_section=.TRUE.)) THEN
IF (PRESENT(use_ref_cell)) use_ref_cell = .TRUE.
CALL read_cell(cell_ref, cell_ref, use_ref_cell=use_ref_cell, &
cell_section=cell_ref_section, check_for_ref=.FALSE., &
para_env=para_env)
ELSE
CALL cell_clone(cell, cell_ref, tag="CELL_REF")
IF (PRESENT(use_ref_cell)) use_ref_cell = .FALSE.
END IF
END IF
END SUBROUTINE read_cell
! **************************************************************************************************
!> \brief utility function to ease the transition to the new input.
!> returns true if the new input was parsed
!> \param input_file the parsed input file
!> \param check_this_section ...
!> \return ...
!> \author fawzi
! **************************************************************************************************
FUNCTION parsed_cp2k_input(input_file, check_this_section) RESULT(res)
TYPE(section_vals_type), POINTER :: input_file
LOGICAL, INTENT(IN), OPTIONAL :: check_this_section
LOGICAL :: res
LOGICAL :: my_check
TYPE(section_vals_type), POINTER :: glob_section
my_check = .FALSE.
IF (PRESENT(check_this_section)) my_check = check_this_section
res = ASSOCIATED(input_file)
IF (res) THEN
CPASSERT(input_file%ref_count > 0)
IF (.NOT. my_check) THEN
glob_section => section_vals_get_subs_vals(input_file, "GLOBAL")
CALL section_vals_get(glob_section, explicit=res)
ELSE
CALL section_vals_get(input_file, explicit=res)
END IF
END IF
END FUNCTION parsed_cp2k_input
! **************************************************************************************************
!> \brief Sets the cell using the internal parameters (a,b,c) (alpha,beta,gamma)
!> using the convention: a parallel to the x axis, b in the x-y plane and
!> and c univoquely determined; gamma is the angle between a and b; beta
!> is the angle between c and a and alpha is the angle between c and b
!> \param cell ...
!> \param cell_length ...
!> \param cell_angle ...
!> \param periodic ...
!> \param do_init_cell ...
!> \date 03.2008
!> \author Teodoro Laino
! **************************************************************************************************
SUBROUTINE set_cell_param(cell, cell_length, cell_angle, periodic, do_init_cell)
TYPE(cell_type), POINTER :: cell
REAL(KIND=dp), DIMENSION(3), INTENT(IN) :: cell_length, cell_angle
INTEGER, DIMENSION(3), INTENT(IN), OPTIONAL :: periodic
LOGICAL, INTENT(IN) :: do_init_cell
REAL(KIND=dp), PARAMETER :: eps = EPSILON(0.0_dp)
REAL(KIND=dp) :: cos_alpha, cos_beta, cos_gamma, sin_gamma
CPASSERT(ASSOCIATED(cell))
CPASSERT(ALL(cell_angle /= 0.0_dp))
cos_gamma = COS(cell_angle(3)); IF (ABS(cos_gamma) < eps) cos_gamma = 0.0_dp
IF (ABS(ABS(cos_gamma) - 1.0_dp) < eps) cos_gamma = SIGN(1.0_dp, cos_gamma)
sin_gamma = SIN(cell_angle(3)); IF (ABS(sin_gamma) < eps) sin_gamma = 0.0_dp
IF (ABS(ABS(sin_gamma) - 1.0_dp) < eps) sin_gamma = SIGN(1.0_dp, sin_gamma)
cos_beta = COS(cell_angle(2)); IF (ABS(cos_beta) < eps) cos_beta = 0.0_dp
IF (ABS(ABS(cos_beta) - 1.0_dp) < eps) cos_beta = SIGN(1.0_dp, cos_beta)
cos_alpha = COS(cell_angle(1)); IF (ABS(cos_alpha) < eps) cos_alpha = 0.0_dp
IF (ABS(ABS(cos_alpha) - 1.0_dp) < eps) cos_alpha = SIGN(1.0_dp, cos_alpha)
cell%hmat(:, 1) = (/1.0_dp, 0.0_dp, 0.0_dp/)
cell%hmat(:, 2) = (/cos_gamma, sin_gamma, 0.0_dp/)
cell%hmat(:, 3) = (/cos_beta, (cos_alpha - cos_gamma*cos_beta)/sin_gamma, 0.0_dp/)
cell%hmat(3, 3) = SQRT(1.0_dp - cell%hmat(1, 3)**2 - cell%hmat(2, 3)**2)
cell%hmat(:, 1) = cell%hmat(:, 1)*cell_length(1)
cell%hmat(:, 2) = cell%hmat(:, 2)*cell_length(2)
cell%hmat(:, 3) = cell%hmat(:, 3)*cell_length(3)
IF (do_init_cell) THEN
IF (PRESENT(periodic)) THEN
CALL init_cell(cell=cell, periodic=periodic)
ELSE
CALL init_cell(cell=cell)
END IF
END IF
END SUBROUTINE set_cell_param
! **************************************************************************************************
!> \brief Setup of the multiple unit_cell
!> \param cell ...
!> \param multiple_unit_cell ...
!> \date 05.2009
!> \author Teodoro Laino [tlaino]
!> \version 1.0
! **************************************************************************************************
SUBROUTINE set_multiple_unit_cell(cell, multiple_unit_cell)
TYPE(cell_type), POINTER :: cell
INTEGER, DIMENSION(:), POINTER :: multiple_unit_cell
CPASSERT(ASSOCIATED(cell))
! Abort, if one of the value is set to zero
IF (ANY(multiple_unit_cell <= 0)) &
CALL cp_abort(__LOCATION__, &
"CELL%MULTIPLE_UNIT_CELL accepts only integer values larger than 0! "// &
"A value of 0 or negative is meaningless!")
! Scale abc according to user request
cell%hmat(:, 1) = cell%hmat(:, 1)*multiple_unit_cell(1)
cell%hmat(:, 2) = cell%hmat(:, 2)*multiple_unit_cell(2)
cell%hmat(:, 3) = cell%hmat(:, 3)*multiple_unit_cell(3)
END SUBROUTINE set_multiple_unit_cell
! **************************************************************************************************
!> \brief Read cell information from an external file
!> \param cell_section ...
!> \param para_env ...
!> \date 02.2008
!> \author Teodoro Laino [tlaino] - University of Zurich
!> \version 1.0
! **************************************************************************************************
SUBROUTINE read_cell_from_external_file(cell_section, para_env)
TYPE(section_vals_type), POINTER :: cell_section
TYPE(mp_para_env_type), POINTER :: para_env
CHARACTER(LEN=default_path_length) :: cell_file_name
INTEGER :: i, idum, j, my_format, n_rep
LOGICAL :: explicit, my_end
REAL(KIND=dp) :: xdum
REAL(KIND=dp), DIMENSION(3, 3) :: hmat
REAL(KIND=dp), DIMENSION(:), POINTER :: cell_par
TYPE(cell_type), POINTER :: cell
TYPE(cp_parser_type) :: parser
CALL section_vals_val_get(cell_section, "CELL_FILE_NAME", c_val=cell_file_name)
CALL section_vals_val_get(cell_section, "CELL_FILE_FORMAT", i_val=my_format)
SELECT CASE (my_format)
CASE (do_cell_cp2k)
CALL parser_create(parser, cell_file_name, para_env=para_env)
CALL parser_get_next_line(parser, 1)
my_end = .FALSE.
DO WHILE (.NOT. my_end)
READ (parser%input_line, *) idum, xdum, hmat(:, 1), hmat(:, 2), hmat(:, 3)
CALL parser_get_next_line(parser, 1, at_end=my_end)
END DO
CALL parser_release(parser)
! Convert to CP2K units
DO i = 1, 3
DO j = 1, 3
hmat(j, i) = cp_unit_to_cp2k(hmat(j, i), "angstrom")
END DO
END DO
CASE (do_cell_xsc)
CALL parser_create(parser, cell_file_name, para_env=para_env)
CALL parser_get_next_line(parser, 1)
READ (parser%input_line, *) idum, hmat(:, 1), hmat(:, 2), hmat(:, 3)
CALL parser_release(parser)
! Convert to CP2K units
DO i = 1, 3
DO j = 1, 3
hmat(j, i) = cp_unit_to_cp2k(hmat(j, i), "angstrom")
END DO
END DO
CASE (do_cell_cif)
NULLIFY (cell)
CALL cell_create(cell)
CALL read_cell_cif(cell_file_name, cell, para_env)
hmat = cell%hmat
CALL cell_release(cell)
END SELECT
CALL section_vals_val_unset(cell_section, "CELL_FILE_NAME")
CALL section_vals_val_unset(cell_section, "CELL_FILE_FORMAT")
! Check if the cell was already defined
explicit = .FALSE.
CALL section_vals_val_get(cell_section, "A", n_rep_val=n_rep)
explicit = explicit .OR. (n_rep == 1)
CALL section_vals_val_get(cell_section, "B", n_rep_val=n_rep)
explicit = explicit .OR. (n_rep == 1)
CALL section_vals_val_get(cell_section, "C", n_rep_val=n_rep)
explicit = explicit .OR. (n_rep == 1)
CALL section_vals_val_get(cell_section, "ABC", n_rep_val=n_rep)
explicit = explicit .OR. (n_rep == 1)
! Possibly print a warning
IF (explicit) &
CALL cp_warn(__LOCATION__, &
"Cell specification (A,B,C or ABC) provided together with the external "// &
"cell setup! Ignoring (A,B,C or ABC) and proceeding with info read from the "// &
"external file! ")
! Copy cell information in the A, B, C fields..(we may need them later on..)
ALLOCATE (cell_par(3))
cell_par = hmat(:, 1)
CALL section_vals_val_set(cell_section, "A", r_vals_ptr=cell_par)
ALLOCATE (cell_par(3))
cell_par = hmat(:, 2)
CALL section_vals_val_set(cell_section, "B", r_vals_ptr=cell_par)
ALLOCATE (cell_par(3))
cell_par = hmat(:, 3)
CALL section_vals_val_set(cell_section, "C", r_vals_ptr=cell_par)
! Unset possible keywords
CALL section_vals_val_unset(cell_section, "ABC")
CALL section_vals_val_unset(cell_section, "ALPHA_BETA_GAMMA")
END SUBROUTINE read_cell_from_external_file
! **************************************************************************************************
!> \brief Reads cell information from CIF file
!> \param cif_file_name ...
!> \param cell ...
!> \param para_env ...
!> \date 12.2008
!> \par Format Information implemented:
!> _cell_length_a
!> _cell_length_b
!> _cell_length_c
!> _cell_angle_alpha
!> _cell_angle_beta
!> _cell_angle_gamma
!>
!> \author Teodoro Laino [tlaino]
!> moved from topology_cif (1/2019 JHU)
! **************************************************************************************************
SUBROUTINE read_cell_cif(cif_file_name, cell, para_env)
CHARACTER(len=*) :: cif_file_name
TYPE(cell_type), POINTER :: cell
TYPE(mp_para_env_type), POINTER :: para_env
CHARACTER(len=*), PARAMETER :: routineN = 'read_cell_cif'
INTEGER :: handle
INTEGER, DIMENSION(3) :: periodic
LOGICAL :: found
REAL(KIND=dp), DIMENSION(3) :: cell_angles, cell_lengths
TYPE(cp_parser_type) :: parser
CALL timeset(routineN, handle)
CALL parser_create(parser, cif_file_name, &
para_env=para_env, apply_preprocessing=.FALSE.)
! Parsing cell infos
periodic = 1
! Check for _cell_length_a
CALL parser_search_string(parser, "_cell_length_a", ignore_case=.FALSE., found=found, &
begin_line=.FALSE., search_from_begin_of_file=.TRUE.)
IF (.NOT. found) &
CPABORT("The field (_cell_length_a) was not found in CIF file! ")
CALL cif_get_real(parser, cell_lengths(1))
cell_lengths(1) = cp_unit_to_cp2k(cell_lengths(1), "angstrom")
! Check for _cell_length_b
CALL parser_search_string(parser, "_cell_length_b", ignore_case=.FALSE., found=found, &
begin_line=.FALSE., search_from_begin_of_file=.TRUE.)
IF (.NOT. found) &
CPABORT("The field (_cell_length_b) was not found in CIF file! ")
CALL cif_get_real(parser, cell_lengths(2))
cell_lengths(2) = cp_unit_to_cp2k(cell_lengths(2), "angstrom")
! Check for _cell_length_c
CALL parser_search_string(parser, "_cell_length_c", ignore_case=.FALSE., found=found, &
begin_line=.FALSE., search_from_begin_of_file=.TRUE.)
IF (.NOT. found) &
CPABORT("The field (_cell_length_c) was not found in CIF file! ")
CALL cif_get_real(parser, cell_lengths(3))
cell_lengths(3) = cp_unit_to_cp2k(cell_lengths(3), "angstrom")
! Check for _cell_angle_alpha
CALL parser_search_string(parser, "_cell_angle_alpha", ignore_case=.FALSE., found=found, &
begin_line=.FALSE., search_from_begin_of_file=.TRUE.)
IF (.NOT. found) &
CPABORT("The field (_cell_angle_alpha) was not found in CIF file! ")
CALL cif_get_real(parser, cell_angles(1))
cell_angles(1) = cp_unit_to_cp2k(cell_angles(1), "deg")
! Check for _cell_angle_beta
CALL parser_search_string(parser, "_cell_angle_beta", ignore_case=.FALSE., found=found, &
begin_line=.FALSE., search_from_begin_of_file=.TRUE.)
IF (.NOT. found) &
CPABORT("The field (_cell_angle_beta) was not found in CIF file! ")
CALL cif_get_real(parser, cell_angles(2))
cell_angles(2) = cp_unit_to_cp2k(cell_angles(2), "deg")
! Check for _cell_angle_gamma
CALL parser_search_string(parser, "_cell_angle_gamma", ignore_case=.FALSE., found=found, &
begin_line=.FALSE., search_from_begin_of_file=.TRUE.)
IF (.NOT. found) &
CPABORT("The field (_cell_angle_gamma) was not found in CIF file! ")
CALL cif_get_real(parser, cell_angles(3))
cell_angles(3) = cp_unit_to_cp2k(cell_angles(3), "deg")
! Create cell
CALL set_cell_param(cell, cell_lengths, cell_angles, periodic=periodic, &
do_init_cell=.TRUE.)
CALL parser_release(parser)
CALL timestop(handle)
END SUBROUTINE read_cell_cif
! **************************************************************************************************
!> \brief Reads REAL from the CIF file.. This wrapper is needed in order to
!> treat properly the accuracy specified in the CIF file, i.e. 3.45(6)
!> \param parser ...
!> \param r ...
!> \date 12.2008
!> \author Teodoro Laino [tlaino]
! **************************************************************************************************
SUBROUTINE cif_get_real(parser, r)
TYPE(cp_parser_type), INTENT(INOUT) :: parser
REAL(KIND=dp), INTENT(OUT) :: r
CHARACTER(LEN=default_string_length) :: s_tag
INTEGER :: iln
CALL parser_get_object(parser, s_tag)
iln = LEN_TRIM(s_tag)
IF (INDEX(s_tag, "(") /= 0) iln = INDEX(s_tag, "(") - 1
READ (s_tag(1:iln), *) r
END SUBROUTINE cif_get_real
! **************************************************************************************************
!> \brief Write the cell parameters to the output unit.
!> \param cell ...
!> \param subsys_section ...
!> \param tag ...
!> \date 02.06.2000
!> \par History
!> - 11.2008 Teodoro Laino [tlaino] - rewrite and enabling user driven units
!> \author Matthias Krack
!> \version 1.0
! **************************************************************************************************
SUBROUTINE write_cell(cell, subsys_section, tag)
TYPE(cell_type), POINTER :: cell
TYPE(section_vals_type), POINTER :: subsys_section
CHARACTER(LEN=*), INTENT(IN), OPTIONAL :: tag
CHARACTER(LEN=default_string_length) :: label, unit_str
INTEGER :: output_unit
TYPE(cp_logger_type), POINTER :: logger
NULLIFY (logger)
logger => cp_get_default_logger()
IF (PRESENT(tag)) THEN
label = TRIM(tag)//"|"
ELSE
label = TRIM(cell%tag)//"|"
END IF
output_unit = cp_print_key_unit_nr(logger, subsys_section, "PRINT%CELL", extension=".Log")
CALL section_vals_val_get(subsys_section, "PRINT%CELL%UNIT", c_val=unit_str)
CALL write_cell_low(cell, unit_str, output_unit, label)
CALL cp_print_key_finished_output(output_unit, logger, subsys_section, "PRINT%CELL")
END SUBROUTINE write_cell
! **************************************************************************************************
!> \brief Write the cell parameters to the output unit
!> \param cell ...
!> \param unit_str ...
!> \param output_unit ...
!> \param label ...
!> \date 17.05.2023
!> \par History
!> - Extracted from write_cell (17.05.2023, MK)
!> \version 1.0
! **************************************************************************************************
SUBROUTINE write_cell_low(cell, unit_str, output_unit, label)
TYPE(cell_type), POINTER :: cell
CHARACTER(LEN=*), INTENT(IN) :: unit_str
INTEGER, INTENT(IN) :: output_unit
CHARACTER(LEN=*), INTENT(IN), OPTIONAL :: label
CHARACTER(LEN=12) :: tag
CHARACTER(LEN=3) :: string
CHARACTER(LEN=default_string_length) :: my_label
REAL(KIND=dp) :: alpha, beta, gamma, val
REAL(KIND=dp), DIMENSION(3) :: abc
TYPE(enumeration_type), POINTER :: enum
TYPE(keyword_type), POINTER :: keyword
TYPE(section_type), POINTER :: section
NULLIFY (enum)
NULLIFY (keyword)
NULLIFY (section)
IF (output_unit > 0) THEN
CALL get_cell(cell=cell, abc=abc, alpha=alpha, beta=beta, gamma=gamma, tag=tag)
IF (PRESENT(label)) THEN
my_label = label
ELSE
my_label = TRIM(tag)//"|"
END IF
val = cp_unit_from_cp2k(cell%deth, TRIM(unit_str)//"^3")
WRITE (UNIT=output_unit, FMT="(/,T2,A,T61,F20.6)") &
TRIM(my_label)//" Volume ["//TRIM(unit_str)//"^3]:", val
val = cp_unit_from_cp2k(1.0_dp, TRIM(unit_str))
WRITE (UNIT=output_unit, FMT="(T2,A,T30,3F10.3,3X,A6,F12.6)") &
TRIM(my_label)//" Vector a ["//TRIM(unit_str)//"]:", cell%hmat(:, 1)*val, &
"|a| = ", abc(1)*val, &
TRIM(my_label)//" Vector b ["//TRIM(unit_str)//"]:", cell%hmat(:, 2)*val, &
"|b| = ", abc(2)*val, &
TRIM(my_label)//" Vector c ["//TRIM(unit_str)//"]:", cell%hmat(:, 3)*val, &
"|c| = ", abc(3)*val
WRITE (UNIT=output_unit, FMT="(T2,A,T69,F12.6)") &
TRIM(my_label)//" Angle (b,c), alpha [degree]: ", alpha, &
TRIM(my_label)//" Angle (a,c), beta [degree]: ", beta, &
TRIM(my_label)//" Angle (a,b), gamma [degree]: ", gamma
IF (cell%symmetry_id /= cell_sym_none) THEN
CALL create_cell_section(section)
keyword => section_get_keyword(section, "SYMMETRY")
CALL keyword_get(keyword, enum=enum)
WRITE (UNIT=output_unit, FMT="(T2,A,T61,A20)") &
TRIM(my_label)//" Requested initial symmetry: ", &
ADJUSTR(TRIM(enum_i2c(enum, cell%symmetry_id)))
CALL section_release(section)
END IF
IF (cell%orthorhombic) THEN
WRITE (UNIT=output_unit, FMT="(T2,A,T78,A3)") &
TRIM(my_label)//" Numerically orthorhombic: ", "YES"
ELSE
WRITE (UNIT=output_unit, FMT="(T2,A,T78,A3)") &
TRIM(my_label)//" Numerically orthorhombic: ", " NO"
END IF
IF (SUM(cell%perd(1:3)) == 0) THEN
WRITE (UNIT=output_unit, FMT="(T2,A,T77,A4)") &
TRIM(my_label)//" Periodicity", "NONE"
ELSE
string = ""
IF (cell%perd(1) == 1) string = TRIM(string)//"X"
IF (cell%perd(2) == 1) string = TRIM(string)//"Y"
IF (cell%perd(3) == 1) string = TRIM(string)//"Z"
WRITE (UNIT=output_unit, FMT="(T2,A,T78,A3)") &
TRIM(my_label)//" Periodicity", ADJUSTR(string)
END IF
END IF
END SUBROUTINE write_cell_low
END MODULE cell_methods