-
Notifications
You must be signed in to change notification settings - Fork 3
/
upf.xsd
1600 lines (1446 loc) · 55.8 KB
/
upf.xsd
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
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?xml version="1.0" encoding="UTF-8"?>
<?xml-stylesheet type="text/xsl" href="my.xsl"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified">
<!-- Definition of elements -->
<xs:element name="UPF">
<xs:annotation>
<xs:documentation>Root section</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element ref="PP_INFO" minOccurs="0"/>
<xs:element ref="PP_HEADER"/>
<xs:element ref="PP_MESH"/>
<xs:element ref="PP_NLCC" minOccurs="0"/>
<xs:element ref="PP_LOCAL"/>
<xs:element ref="PP_SEMILOCAL" minOccurs="0"/>
<xs:element ref="PP_NONLOCAL"/>
<xs:element ref="PP_PSWFC"/>
<xs:element ref="PP_RHOATOM"/>
<xs:element ref="PP_PAW" minOccurs="0"/>
</xs:sequence>
<xs:attribute name="version" use="required" type="upf-version-string"/>
</xs:complexType>
</xs:element>
<xs:element name="PP_INFO" type="xs:string">
<xs:annotation>
<xs:documentation>
For human-readable data (ignored by QE).
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="PP_HEADER">
<xs:annotation>
<xs:documentation>
Machine-readable minimal data on the pseudopotential.
</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:attribute name="element" use="required" type="upf-element">
<xs:annotation>
<xs:documentation>Element symbol</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="generated" use="optional" type="upf-string">
<xs:annotation>
<xs:documentation>Software used to generate the pseudopotential
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="author" use="optional" type="upf-string"
default="anonymous">
<xs:annotation>
<xs:documentation>Author of pseudopotential</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="date" use="optional">
<xs:annotation>
<xs:documentation>Generation date</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="comment" use="optional" type="upf-longstring"/>
<xs:attribute name="pseudo_type" use="required" type="upf-pseudotype">
<xs:annotation>
<xs:documentation>
Pseudopotential type (not used by the software,
human-readable alias)
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="relativistic" use="required" type="upf-relativistic-type">
<xs:annotation>
<xs:documentation>
Level of relativistic formalism used in atomic calculation
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="is_ultrasoft" use="required" type="upf-logical">
<xs:annotation>
<xs:documentation>
True if pseudopotential is ultrasoft or PAW,
i.e. if it has augmentation/compensation charge
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="is_paw" use="required" type="upf-logical">
<xs:annotation>
<xs:documentation>
True if pseudopotential is actually a PAW dataset
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="is_coulomb" use="optional" type="upf-logical"
default=".false.">
<xs:annotation>
<xs:documentation>
True if pseudopotential is a Coulombian 1/r potential
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="has_so" use="optional" type="upf-logical"
default=".false.">
<xs:annotation>
<xs:documentation>
True if spin-orbit information is present.
In this case, the PP_SPIN_ORB section must be present.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="has_gipaw" use="optional" type="upf-logical"
default=".false.">
<xs:annotation>
<xs:documentation>
True if additional information for GIPAW reconstruction is
present. In this case, the PP_GIPAW section must be present.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="core_correction" use="required" type="upf-logical">
<xs:annotation>
<xs:documentation>
True if the pseudopotential contains pseudized core charge
for non-linear core.
In this case, the PP_NLCC section must be present.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="functional" use="required" type="upf-shortstring">
<xs:annotation>
<xs:documentation>
Short-name for the DFT functional used.
It can either be an alias (such as PBE, LDA) or specify in order:
functional for exchange, functional for corellation,
gradient correction for exchange, gradient correction for corellation.
E.g. PBE is 'SLA PW PBX PBC'.
The list of short-names understood by QE is listed at the beginning
of file Modules/functional.f90 in its source tree.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="z_valence" use="required" type="xs:double">
<xs:annotation>
<xs:documentation>
Valence charge (atomic number - core charge) in units of
abs(electron charge). This will usually coincide with the
number of valence electrons.
If the pseudopotential has been generated with a charged
configuration, z_valence will *not* be affected, but the sum
of the occupations will not match this value.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="total_psenergy" use="optional" type="xs:double"
default="0.0">
<xs:annotation>
<xs:documentation>
Pseudopotential energy of the configuration used
for the pseudopotential configuration (Ry)
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="wfc_cutoff" use="optional" type="xs:double"
default="0.0">
<xs:annotation>
<xs:documentation>
Suggested plane wave cutoff (Ry)
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="rho_cutoff" use="optional" type="xs:double"
default="0.0">
<xs:annotation>
<xs:documentation>
Suggested charge density cutoff (Ry)
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="l_max" use="required" type="xs:integer">
<xs:annotation>
<xs:documentation>
Maximum angular momentum of a valence orbital.
!!CHECK!! if the local channel has the maximum angular momentum,
and it is not empty, is it counted here or not?
Would it have any effect if it is wrong?
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="l_max_rho" use="required" type="xs:integer">
<xs:annotation>
<xs:documentation>
Maximum angular momentum of atomic charge density,
should be 2*l_max.
!!CHECK!! same as l_max
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="l_local" use="optional" type="xs:integer">
<xs:annotation>
<xs:documentation>
If local potential was generated by inversion of a norm-conserving
wave function, then l_local is equal to the l of this channel.
If the local potential was generated by some other means,
e.g. smoothing the all-electron potential, then l_local < 0.
The atomic code in QE uses l_local=-1, if the smoothing was done
with two Bessel functions (RRKJ optimized)
and l_local=-2, of it was done with the Troullier-Martins recipe.
Note that the local potential always has spherical symmetry.
This attribute is actually unused in the plane-wave code
(stored only for reconstruction purposes).
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="mesh_size" use="required" type="xs:integer">
<xs:annotation>
<xs:documentation>
Number of points in the radial grid, on which potential,
wave functions and other quantities are stored.
Note: the number of mesh points for the potential and the
wave functions may in principle be different. This is not
allowed in the UPF 2.0.1 format.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="number_of_wfc" use="required" type="xs:integer">
<xs:annotation>
<xs:documentation>
Number of wave functions stored in the file.
These wave functions are used by QE programs only to bootstrap
self-consistency.
Note: In the PAW case, these are *not* the wave functions used
for the one-center terms. They are used ONLY to generate the
initial charge density to bootstrap the self-consistent cycle.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="number_of_proj" use="required" type="xs:integer">
<xs:annotation>
<xs:documentation>
Number of Kleinman-Bylander projectors in the pseudopotential.
In the PAW formalism, this is also the number of wavefunctions
used in one-center terms. Many other quantities, e.g. the number
of augmentation channels, depend on the value of number_of_proj.
If the pseudopotential has no projectors, number_of_proj must be
set to zero.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="has_wfc" use="required" type="xs:NCName">
<xs:annotation>
<xs:documentation>
Deprecated??
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="paw_as_gipaw" use="required" type="xs:NCName">
<xs:annotation>
<xs:documentation>
Deprecated??
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
</xs:element>
<xs:element name="PP_MESH">
<xs:annotation>
<xs:documentation>
Defines the mesh.
</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element ref="PP_R"/>
<xs:element ref="PP_RAB"/>
</xs:sequence>
<xs:attribute name="dx" use="optional" type="xs:double">
<xs:annotation>
<xs:documentation>
r(i) = exp ( xmin + (i-1) dx ) / zmesh i=1,mesh
r_ab(i) = r(i) * dx
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="xmin" use="optional" type="xs:double">
<xs:annotation>
<xs:documentation>
r(i) = exp ( xmin + (i-1) dx ) / zmesh i=1,mesh
r_ab(i) = r(i) * dx
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="zmesh" use="optional" type="xs:double">
<xs:annotation>
<xs:documentation>
r(i) = exp ( xmin + (i-1) dx ) / zmesh i=1,mesh
r_ab(i) = r(i) * dx
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="mesh" use="optional" type="xs:integer">
<xs:annotation>
<xs:documentation>
Deprecated. Use mesh_size in PP_HEADER instead.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="rmax" use="required" type="xs:double">
<xs:annotation>
<xs:documentation>
Deprecated??
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
</xs:element>
<xs:element name="PP_R" type="upf-data-section">
<xs:annotation>
<xs:documentation>
Data section containing the radial grid,
on which quantities such as local potential,
wave functions, projectors and augmentation charges are sampled.
The ith value of these quantities corresponds to the ith
element of the radial grid.
</xs:documentation>
</xs:annotation>
<!-- <xs:complexType>
<xs:simpleContent>
<xs:extension base="upf-list-of-doubles">
<xs:attribute name="type" use="required" type="xs:NCName"/>
<xs:attribute name="size" use="required" type="xs:integer"/>
<xs:attribute name="columns" use="required" type="xs:integer"/>
</xs:extension>
</xs:simpleContent>
</xs:complexType>
-->
</xs:element>
<xs:element name="PP_RAB" type="upf-data-section">
<xs:annotation>
<xs:documentation>
Data section containing the radial volume element.
These attributes have been used to generate the logarithmic grid on
which the pseudopotential is constructed.
The expression insode the atomic code of QE is:
r(i) = exp ( xmin + (i-1) dx ) / zmesh i=1,mesh
r_ab(i) = r(i) * dx
For PAW, this is the only acceptable grid (required in V_H).
Otherwise, any kind of grid is accepted, if it can be used to compute
a Simpson numerical integral according to the formula
\sum_i c_i f(i)*rab(i) = \int_0^\infty f_i dr
where c_i are alternativly 2/3 and 4/3, except c_1=c_mesh=1/3.
f_i is a generic function, such as the atomic wave function, sampled on
the grid r(i): f_i = f(r_i). An equivalent definition of rab is
rab(i) = dr(x) / dx | x= i
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="PP_NLCC" type="upf-data-section">
<xs:annotation>
<xs:documentation>
Data section containing the pseudized core charge
used for non-linear core correction
sampled on the radial grid stored in PP_R.
It is the true charge density, i.e. it will be
correctly integrated as
\sum_i 4 \pi r_i^2 nlcc_i
Ignored if core_correction is false.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="PP_LOCAL" type="upf-data-section">
<xs:annotation>
<xs:documentation>
Data section containing the local potential sampled in the radial grid
(Ry). The potential does not contain the effect of the net valence charge
(-e2*z_valence/r_i), which will be added directly in the plane-wave code.
Igonred if is_coulomb (PP_HEADER).
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="PP_SEMILOCAL">
<xs:annotation>
<xs:documentation>
Contains number_of_proj subsections PP_VNL for PPs in semilocal form.
Not used by QE.
</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element name="PP_VNL.1" minOccurs="0" maxOccurs="1"
type="upf-PP_VNL.n"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:complexType name="upf-PP_VNL.n">
<xs:annotation>
<xs:documentation>
Contains the pseudopotential for l and j specified in the attribute
list.
</xs:documentation>
</xs:annotation>
<xs:complexContent>
<xs:extension base="upf-data-section">
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:element name="PP_NONLOCAL">
<xs:annotation>
<xs:documentation>
Content of this section depends on several settings in PP_HEADER.
</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element name="PP_BETA.1" minOccurs="0" maxOccurs="1"
type="upf-PP_BETA.n"/>
<xs:element name="PP_BETA.2" minOccurs="0" maxOccurs="1"
type="upf-PP_BETA.n"/>
<xs:element name="PP_BETA.3" minOccurs="0" maxOccurs="1"
type="upf-PP_BETA.n"/>
<xs:element name="PP_BETA.4" minOccurs="0" maxOccurs="1"
type="upf-PP_BETA.n"/>
<xs:element name="PP_BETA.5" minOccurs="0" maxOccurs="1"
type="upf-PP_BETA.n"/>
<xs:element name="PP_BETA.6" minOccurs="0" maxOccurs="1"
type="upf-PP_BETA.n"/>
<xs:element ref="PP_DIJ"/>
<xs:element ref="PP_AUGMENTATION" minOccurs="0"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:complexType name="upf-PP_BETA.n">
<xs:annotation>
<xs:documentation>
Contains a Kleinman-Bylander projector sampled on the radial grid.
If number_of_proj > 0, there must be a PP_BETA.n section for each
n between 1 and number_of_proj.
</xs:documentation>
</xs:annotation>
<xs:complexContent>
<xs:extension base="upf-data-section">
<xs:attribute name="index" use="optional" type="xs:integer">
<xs:annotation>
<xs:documentation>
For PP_BETA.n, this is just n.
TODO do away with the PP_BETA.n naming scheme.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="angular_momentum" use="required" type="xs:integer">
<xs:annotation>
<xs:documentation>
The angular momentum of the projector.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="cutoff_radius_index" use="optional" type="xs:integer">
<xs:annotation>
<xs:documentation>
The projector is assumed to be zero beyond this point.
If it is not specified, it is assumed to be equal to the mesh size.
NOTE: Not specifying cutoff_radius can introduce a considerable
numerical noise in some integrals, especially in the PAW case.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="cutoff_radius" use="optional" type="xs:double">
<xs:annotation>
<xs:documentation>
The value of the radial mesh point corresponding to cutoff_radius_index.
This value is currently unused in the plane-wave code.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="norm_conserving_radius" use="optional" type="xs:double">
<xs:annotation>
<xs:documentation>
Value of norm conserving wave function used to generate the
ultrasoft pseudopotential.
Ununsed in the code, stored only for reconstruction purposes,
meaningless for PAW.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="ultrasoft_cutoff_radius" use="required" type="xs:double">
<xs:annotation>
<xs:documentation>
UNDOCUMENTED
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="label" use="required" type="xs:NMTOKEN">
<xs:annotation>
<xs:documentation>
UNDOCUMENTED
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:element name="PP_DIJ">
<xs:annotation>
<xs:documentation>
Hamiltonian pseudo coefficients as defined in the Vanderbilt paper
(PRB 1990).
If the pseudopotential is a PAW data set, they must contain the
kinetic energy difference as well.
!!CHECK!! a better/more accurate definition for these would be useful.
</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:simpleContent>
<xs:extension base="xs:double">
<xs:attribute name="columns" use="required" type="xs:integer"/>
<xs:attribute name="size" use="required" type="xs:integer"/>
<xs:attribute name="type" use="required" type="xs:NCName"/>
</xs:extension>
</xs:simpleContent>
</xs:complexType>
</xs:element>
<xs:element name="PP_AUGMENTATION">
<xs:annotation>
<xs:documentation>
Compulsory for pseudopotentials with augmentation charge,
i.e. when the pseudopotential is_ultrasoft
(presently ultrasoft or PAW).
</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element ref="PP_Q"/>
<xs:element ref="PP_MULTIPOLES"/>
<xs:element ref="PP_QFCOEFF"/>
<xs:element ref="PP_RINNER"/>
<xs:element name="PP_QIJL.1.1.0" minOccurs="0" maxOccurs="1"
type="upf-PP_QIJL.n.n.n"/>
</xs:sequence>
<xs:attribute name="q_with_l" use="required" type="upf-logical">
<xs:annotation>
<xs:documentation>
If true, the augmentation charge can depend on the value
of the angular momentum. I.e. if a certain channel has more
than one angular momentum component, there shall be a different
radial form of the augmentation for each component.
This attribute is false for Vanderbilt's original recipe.
It is true for PAW.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="nqf" use="optional" type="xs:integer">
<xs:annotation>
<xs:documentation>
Specifies the number of coefficients used to analytically expand
the augmentation charge at small radius,
according to Vanderbilt's recipe.
Note: The analytical expansion of augmentation charge is
currently not implemented for PAW.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="nqlc" use="optional" type="xs:integer">
<xs:annotation>
<xs:documentation>
Specifies the number of angular momentum components that can be
present in the charge density, when the maximum angular momentum
for wave functions is l_max (default: nqlc = 2*l_max+1).
If nqf > 0, nqlc is the dimension of several arrays.
If nqf = 0, nqlc is not used.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="shape" use="optional" type="upf-shortstring">
<xs:annotation>
<xs:documentation>
Describes the kind of pseudization used for the augmentation
function. Currently unused, stored only for reconstructio purpose.
Note: If the analytical overlap for PAW augmentation charge
(as defined by Bloechl) will ever be implemented, this field
will become necessary.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="iraug" use="optional" type="xs:integer">
<xs:annotation>
<xs:documentation>
All augmentation charge must be zero beyond this point.
Used only for PAW and only if it is greater than cutoff_radius
for all projectors.
If not specified, iraug is set to mesh size.
This default works, but can generate numerical noise in some
integrals. In order to avoid large round-off errors in
cancellation of PAW terms, it is important to set this paramter
as small as possible, i.e. just outside the augmentation radius.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="raug" use="optional" type="xs:double">
<xs:annotation>
<xs:documentation>
The value of the radial mesh point corresponding to iraug.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="augmentation_epsilon" use="optional" type="xs:double">
<xs:annotation>
<xs:documentation>
If augmentation_epsilon > 0, augmentation functions,
whose norm is less than augmentation_epsilon will be
considered zero.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="cutoff_r" use="optional" type="xs:double">
<xs:annotation>
<xs:documentation>
Deprecated?
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="cutoff_r_index" use="optional" type="xs:integer">
<xs:annotation>
<xs:documentation>
Deprecated?
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="l_max_aug" use="optional" type="xs:integer">
<xs:annotation>
<xs:documentation>
Deprecated?
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
</xs:element>
<xs:element name="PP_Q" type="upf-data-section">
<xs:annotation>
<xs:documentation>
The norm of the augmentation functions.
Note: The fact that Q is zero for a certain augmentation function
does not guarantee that the function will be identically zero.
This was erroneously assumed in UPF 2.0.0, causing small errors
in specific cases.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="PP_MULTIPOLES" type="upf-data-section">
<xs:annotation>
<xs:documentation>
The electrostatic multipoles of the corresponding augmentation channel.
If the absolute value of a multipole is less than augmentation_epsilon,
the corresponding function will be considered zero.
Note: This section is compulsory for PAW and ignored otherwise.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="PP_QFCOEFF" type="upf-data-section">
<xs:annotation>
<xs:documentation>
The coefficient used to perform a Taylor expansion of the augmentation
functions at small radii.
Note: Compulsory if nqf > 0, ignored otherwise.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="PP_RINNER" type="upf-data-section">
<xs:annotation>
<xs:documentation>
The radius before which the augmentation functions are expanded in a
Taylor series.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:complexType name="upf-PP_QIJL.n.n.n">
<xs:annotation>
<xs:documentation>
If q_with_l is true, there needs to be one PP_Q.i.j.l section
for each i and j from 1 to number_of_proj and l from 0 to l_max_rho.
If q_with_l is false, there needs to be one PP_Q.i.j section
for each i and j from 1 to number_of_proj.
An augmentation function can be omitted (or replaced with an empty
section of the same name), if at least one of the following conditions
is met:
- It is identically zero. In this case, an empty section must be
present (see is_null).
- j < i (Q_ij = Q_ji due to symmetry).
- The pseudo is of PAW type and the corresponding multipole
(PP_MULTIPOLES) is zero or less than augmentation_epsilon
- q_with_l is true and l is *not* taken from the list
abs(l_i-l_j), abs(l_i-l_j)+2 ... l_i+l_j-2, l_i+l_j .
Unnecessary sections with augmentation charges are ignored.
</xs:documentation>
</xs:annotation>
<xs:complexContent>
<xs:extension base="upf-data-section">
<xs:attribute name="angular_momentum" use="required" type="xs:integer">
<xs:annotation>
<xs:documentation>
To be documented.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="first_index" use="optional" type="xs:integer">
<xs:annotation>
<xs:documentation>
The index i of the function.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="second_index" use="optional" type="xs:integer">
<xs:annotation>
<xs:documentation>
The index j of the function.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="composite_index" use="optional" type="xs:integer">
<xs:annotation>
<xs:documentation>
A composite index k = j*(J-1)/2 + i,
used internally to save memory.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="is_null" use="optional" type="upf-logical">
<xs:annotation>
<xs:documentation>
If an augmentation function is identically zero,
the data section can be replaced by an empty section
that is_null.
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:element name="PP_PSWFC">
<xs:annotation>
<xs:documentation>
Contains number_of_wfc data sections of the radial sample of an atomic
wave function. These wave functions are used to set up the initial
wave functions for the self-consistent calculation.
</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element name="PP_CHI.1" minOccurs="0" maxOccurs="1"
type="upf-PP_CHI.n"/>
<xs:element name="PP_CHI.2" minOccurs="0" maxOccurs="1"
type="upf-PP_CHI.n"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:complexType name="upf-PP_CHI.n">
<xs:annotation>
<xs:documentation>
An atomic wave function sampled on the radial grid.
They are use in QE as initial conditions for the self-consistent
calculation.
Note: There is no link between these wave functions and the beta
projectors in PP_NONLOCAL. number_of_wfc can be different from
number_of_proj.
This quantity is stored multiplied by a factor r.
</xs:documentation>
</xs:annotation>
<xs:complexContent>
<xs:extension base="upf-data-section">
<xs:attribute name="l" use="required" type="xs:integer">
<xs:annotation>
<xs:documentation>
Angular momentum of the wave function.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="occupation" use="required" type="xs:double">
<xs:annotation>
<xs:documentation>
Occupation of the wave function in the reference configuration.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="index" use="optional" type="xs:integer">
<xs:annotation>
<xs:documentation>
The index n in PP_CHI.n
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="label" use="optional" type="upf-nl-label">
<xs:annotation>
<xs:documentation>
A conventional label, such as '2S', '3P', etc.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="n" use="optional" type="xs:integer">
<xs:annotation>
<xs:documentation>
Pseudo-principal quantum number.
Usually set to l-1. Only stored for reconstruction purposes.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="pseudo_energy" use="optional" type="xs:double">
<xs:annotation>
<xs:documentation>
Single-particle energy of the wave function in atomic
configuration.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="cutoff_radius" use="optional" type="xs:double">
<xs:annotation>
<xs:documentation>
Inner norm-conserving radius used by atomic code in QE.
Only stored for reconstruction purposes.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="ultrasoft_cutoff_radius" use="optional"
type="xs:double">
<xs:annotation>
<xs:documentation>
Outer ultrasoft radius used by atomic code in QE.
Only stored for reconstruction purposes.
A conventional label, such as '2S', '3P', etc.
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:element name="PP_RHOATOM" type="upf-data-section">
<xs:annotation>
<xs:documentation>
The valence charge density in the reference atomic configuration.
Can be used to genreate the initial charge density in the
self-consistent calculation.
This quantity is stored multiplied by a factor of r^2.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="PP_SPIN_ORB">
<xs:annotation>
<xs:documentation>
Contains additional information required to perform
self consistent calculations with spin-orbit coupling.
The section must be present if 'has_so' in section
PP_HEADER is true. Otherwise it is ignored.
</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element name="PP_RELWFC.1" minOccurs="0" maxOccurs="1"
type="upf-PP_RELWFC.n"/>
<xs:element name="PP_RELBETA.1" minOccurs="0" maxOccurs="1"
type="upf-PP_RELBETA.n"/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:complexType name="upf-PP_RELWFC.n">
<xs:annotation>
<xs:documentation>
Contains data necessary to perform a spin-orbit self-consistent
calculation.
For each wave function stored in the PP_PSWFC section,
there must be one empty section of this kind.
The index n runs from 1 to number_of_wfc.
</xs:documentation>
</xs:annotation>
<xs:complexContent>
<xs:extension base="upf-data-section">
<xs:attribute name="jchi" use="required" type="xs:double">
<xs:annotation>
<xs:documentation>
Total angular momentum of the wave function,
i.e. l+1/2, l-1/2 when l>0.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="index" use="optional" type="xs:integer">
<xs:annotation>
<xs:documentation>
The index n in PP_RELWFC.n
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="els" use="optional" type="upf-nl-label">
<xs:annotation>
<xs:documentation>
A conventional label for the wave function,
such as '2S', '3P', etc.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="nn" use="optional" type="xs:integer">
<xs:annotation>
<xs:documentation>
The actual principal quantum number.
Note: This can differ from the pseudo-principal quantum number
stored in the 'nchi' attribute of PP_CHI.n
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="lchi" use="optional" type="xs:integer">
<xs:annotation>
<xs:documentation>
See attribute 'lchi' of PP_CHI.n (which is used as default).
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="oc" use="optional" type="xs:double">
<xs:annotation>
<xs:documentation>
See attribute 'occupations' of PP_CHI.n
(which is used as default).
</xs:documentation>
</xs:annotation>
</xs:attribute>