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 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 3214 3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 3233 3234 3235 3236 3237 3238 3239 3240 3241 3242 3243 3244 3245 3246 3247 3248 3249 3250 3251 3252 3253 3254 3255 3256 3257 3258 3259 3260 3261 3262 3263 3264 3265 3266 3267 3268 3269 3270 3271 3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283 3284 3285 3286 3287 3288 3289 3290 3291 3292 3293 3294 3295 3296 3297 3298 3299 3300 3301 3302 3303 3304 3305 3306 3307 3308 3309 3310 3311 3312 3313 3314 3315 3316 3317 3318 3319 3320 3321 3322 3323 3324 3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 3338 3339 3340 3341 3342 3343 3344 3345 3346 3347 3348 3349 3350 3351 3352 3353 3354 3355 3356 3357 3358 3359 3360 3361 3362 3363 3364 3365 3366 3367 3368 3369 3370 3371 3372 3373 3374 3375 3376 3377 3378 3379 3380 3381 3382 3383 3384 3385 3386 3387 3388 3389 3390 3391 3392 3393 3394 3395 3396 3397 3398 3399 3400 3401 3402 3403 3404 3405 3406 3407 3408 3409 3410 3411 3412 3413 3414 3415 3416 3417 3418 3419 3420 3421 3422 3423 3424 3425 3426 3427 3428 3429 3430 3431 3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 3444 3445 3446 3447 3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 3652 3653 3654 3655 3656 3657 3658 3659 3660 3661 3662 3663 3664 3665 3666 3667 3668 3669 3670 3671 3672 3673 3674 3675 3676 3677 3678 3679 3680 3681 3682 3683 3684 3685 3686 3687 3688 3689 3690 3691 3692 3693 3694 3695 3696 3697 3698 3699 3700 3701 3702 3703 3704 3705 3706 3707 3708 3709 3710 3711 3712 3713 3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 3726 3727 3728 3729 3730 3731 3732 3733 3734 3735 3736 3737 3738 3739 3740 3741 3742 3743 3744 3745 3746 3747 3748 3749 3750 3751 3752 3753 3754 3755 3756 3757 3758 3759 3760 3761 3762 3763 3764 3765 3766 3767 3768 3769 3770 3771 3772 3773 3774 3775 3776 3777 3778 3779 3780 3781 3782 3783 3784 3785 3786 3787 3788 3789 3790 3791 3792 3793 3794 3795 3796 3797 3798 3799 3800 3801 3802 3803 3804 3805 3806 3807 3808 3809 3810 3811 3812 3813 3814 3815 3816 3817 3818 3819 3820 3821 3822 3823 3824 3825 3826 3827 3828 3829 3830 3831 3832 3833 3834 3835 3836 3837 3838 3839 3840 3841 3842 3843 3844 3845 3846 3847 3848 3849 3850 3851 3852 3853 3854 3855 3856 3857 3858 3859 3860 3861 3862 3863 3864 3865 3866 3867 3868 3869 3870 3871 3872 3873 3874 3875 3876 3877 3878 3879 3880 3881 3882 3883 3884 3885 3886 3887 3888 3889 3890 3891 3892 3893 3894 3895 3896 3897 3898 3899 3900 3901 3902 3903 3904 3905 3906 3907 3908 3909 3910 3911 3912 3913 3914 3915 3916 3917 3918 3919 3920 3921 3922 3923 3924 3925 3926 3927 3928 3929 3930 3931 3932 3933 3934 3935 3936 3937 3938 3939 3940 3941 3942 3943 3944 3945 3946 3947 3948 3949 3950 3951 3952 3953 3954 3955 3956 3957 3958 3959 3960 3961 3962 3963 3964 3965 3966 3967 3968 3969 3970 3971 3972 3973 3974 3975 3976 3977 3978 3979 3980 3981 3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997 3998 3999 4000 4001 4002 4003 4004 4005 4006 4007 4008 4009 4010 4011 4012 4013 4014 4015 4016 4017 4018 4019 4020 4021 4022 4023 4024 4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 4036 4037 4038 4039 4040 4041 4042 4043 4044 4045 4046 4047 4048 4049 4050 4051 4052 4053 4054 4055 4056 4057 4058 4059 4060 4061 4062 4063 4064 4065 4066 4067 4068 4069 4070 4071 4072 4073 4074 4075 4076 4077 4078 4079 4080 4081 4082 4083 4084 4085 4086 4087 4088 4089 4090 4091 4092 4093 4094 4095 4096 4097 4098 4099 4100 4101 4102 4103 4104 4105 4106 4107 4108 4109 4110 4111 4112 4113 4114 4115 4116 4117 4118 4119 4120 4121 4122 4123 4124 4125 4126 4127 4128 4129 4130 4131 4132 4133 4134 4135 4136 4137 4138 4139 4140 4141 4142 4143 4144 4145 4146 4147 4148 4149 4150 4151 4152 4153 4154 4155 4156 4157 4158 4159 4160 4161 4162 4163 4164 4165 4166 4167 4168 4169 4170 4171 4172 4173 4174 4175 4176 4177 4178 4179 4180 4181 4182 4183 4184 4185 4186 4187 4188 4189 4190 4191 4192 4193 4194 4195 4196 4197 4198 4199 4200 4201 4202 4203 4204 4205 4206 4207 4208 4209 4210 4211 4212 4213 4214 4215 4216 4217 4218 4219 4220 4221 4222 4223 4224 4225 4226 4227 4228 4229 4230 4231 4232 4233 4234 4235 4236 4237 4238 4239 4240 4241 4242 4243 4244 4245 4246 4247 4248 4249 4250 4251 4252 4253 4254 4255 4256 4257 4258 4259 4260 4261 4262 4263 4264 4265 4266 4267 4268 4269 4270 4271 4272 4273 4274 4275 4276 4277 4278 4279 4280 4281 4282 4283 4284 4285 4286 4287 4288 4289 4290 4291 4292 4293 4294 4295 4296 4297 4298 4299 4300 4301 4302 4303 4304 4305 4306 4307 4308 4309 4310 4311 4312 4313 4314 4315 4316 4317 4318 4319 4320 4321 4322 4323 4324 4325 4326 4327 4328 4329 4330 4331 4332 4333 4334 4335 4336 4337 4338 4339 4340 4341 4342 4343 4344 4345 4346 4347 4348 4349 4350 4351 4352 4353 4354 4355 4356 4357 4358 4359 4360 4361 4362 4363 4364 4365 4366 4367 4368 4369 4370 4371 4372 4373 4374 4375 4376 4377 4378 4379 4380 4381 4382 4383 4384 4385 4386 4387 4388 4389 4390 4391 4392 4393 4394 4395 4396 4397 4398 4399 4400 4401 4402 4403 4404 4405 4406 4407 4408 4409 4410 4411 4412 4413 4414 4415 4416 4417 4418 4419 4420 4421 4422 4423 4424 4425 4426 4427 4428 4429 4430 4431 4432 4433 4434 4435 4436 4437 4438 4439 4440 4441 4442 4443 4444 4445 4446 4447 4448 4449 4450 4451 4452 4453 4454 4455 4456 4457 4458 4459 4460 4461 4462 4463 4464 4465 4466 4467 4468 4469 4470 4471 4472 4473 4474 4475 4476 4477 4478 4479 4480 4481 4482 4483 4484 4485 4486 4487 4488 4489 4490 4491 4492 4493 4494 4495 4496 4497 4498 4499 4500 4501 4502 4503 4504 4505 4506 4507 4508 4509 4510 4511 4512 4513 4514 4515 4516 4517 4518 4519 4520 4521 4522 4523 4524 4525 4526 4527 4528 4529 4530 4531 4532 4533 4534 4535 4536 4537 4538 4539 4540 4541 4542 4543 4544 4545 4546 4547 4548 4549 4550 4551 4552 4553 4554 4555 4556 4557 4558 4559 4560 4561 4562 4563 4564 4565 4566 4567 4568 4569 4570 4571 4572 4573 4574 4575 4576 4577 4578 4579 4580 4581 4582 4583 4584 4585 4586 4587 4588 4589 4590 4591 4592 4593 4594 4595 4596 4597 4598 4599 4600 4601 4602 4603 4604 4605 4606 4607 4608 4609 4610 4611 4612 4613 4614 4615 4616 4617 4618 4619 4620 4621 4622 4623 4624 4625 4626 4627 4628 4629 4630 4631 4632 4633 4634 4635 4636 4637 4638 4639 4640 4641 4642 4643 4644 4645 4646 4647 4648 4649 4650 4651 4652 4653 4654 4655 4656 4657 4658 4659 4660 4661 4662 4663 4664 4665 4666 4667 4668 4669 4670 4671 4672 4673 4674 4675 4676 4677 4678 4679 4680 4681 4682 4683 4684 4685 4686 4687 4688 4689 4690 4691 4692 4693 4694 4695 4696 4697 4698 4699 4700 4701 4702 4703 4704 4705 4706 4707 4708 4709 4710 4711 4712 4713 4714 4715 4716 4717 4718 4719 4720 4721 4722 4723 4724 4725 4726 4727 4728 4729 4730 4731 4732 4733 4734 4735 4736 4737 4738 4739 4740 4741 4742 4743 4744 4745 4746 4747 4748 4749 4750 4751 4752 4753 4754 4755 4756 4757 4758 4759 4760 4761 4762 4763 4764 4765 4766 4767 4768 4769 4770 4771 4772 4773 4774 4775 4776 4777 4778 4779 4780 4781 4782 4783 4784 4785 4786 4787 4788 4789 4790 4791 4792 4793 4794 4795 4796 4797 4798 4799 4800 4801 4802 4803 4804 4805 4806 4807 4808 4809 4810 4811 4812 4813 4814 4815 4816 4817 4818 4819 4820 4821 4822 4823 4824 4825 4826 4827 4828 4829 4830 4831 4832 4833 4834 4835 4836 4837 4838 4839 4840 4841 4842 4843 4844 4845 4846 4847 4848 4849 4850 4851 4852 4853 4854 4855 4856 4857 4858 4859 4860 4861 4862 4863 4864 4865 4866 4867 4868 4869 4870 4871 4872 4873 4874 4875 4876 4877 4878 4879 4880 4881 4882 4883 4884 4885 4886 4887 4888 4889 4890 4891 4892 4893 4894 4895 4896 4897 4898 4899 4900 4901 4902 4903 4904 4905 4906 4907 4908 4909 4910 4911 4912 4913 4914 4915 4916 4917 4918 4919 4920 4921 4922 4923 4924 4925 4926 4927 4928 4929 4930 4931 4932 4933 4934 4935 4936 4937 4938 4939 4940 4941 4942 4943 4944 4945 4946 4947 4948 4949 4950 4951 4952 4953 4954 4955 4956 4957 4958 4959 4960 4961 4962 4963 4964 4965 4966 4967 4968 4969 4970 4971 4972 4973 4974 4975 4976 4977 4978 4979 4980 4981 4982 4983 4984 4985 4986 4987 4988 4989 4990 4991 4992 4993 4994 4995 4996 4997 4998 4999 5000 5001 5002 5003 5004 5005 5006 5007 5008 5009 5010 5011 5012 5013 5014 5015 5016 5017 5018 5019 5020 5021 5022 5023 5024 5025 5026 5027 5028 5029 5030 5031 5032 5033 5034 5035 5036 5037 5038 5039 5040 5041 5042 5043 5044 5045 5046 5047 5048 5049 5050 5051 5052 5053 5054 5055 5056 5057 5058 5059 5060 5061 5062 5063 5064 5065 5066 5067 5068 5069 5070 5071 5072 5073 5074 5075 5076 5077 5078 5079 5080 5081 5082 5083 5084 5085 5086 5087 5088 5089 5090 5091 5092 5093 5094 5095 5096 5097 5098 5099 5100 5101 5102 5103 5104 5105 5106 5107 5108 5109 5110 5111 5112 5113 5114 5115 5116 5117 5118 5119 5120 5121 5122 5123 5124 5125 5126 5127 5128 5129 5130 5131 5132 5133 5134 5135 5136 5137 5138 5139 5140 5141 5142 5143 5144 5145 5146 5147 5148 5149 5150 5151 5152 5153 5154 5155 5156 5157 5158 5159 5160 5161 5162 5163 5164 5165 5166 5167 5168 5169 5170 5171 5172 5173 5174 5175 5176 5177 5178 5179 5180 5181 5182 5183 5184 5185 5186 5187 5188 5189 5190 5191 5192 5193 5194 5195 5196 5197 5198 5199 5200 5201 5202 5203 5204 5205 5206 5207 5208 5209 5210 5211 5212 5213 5214 5215 5216 5217 5218 5219 5220 5221 5222 5223 5224 5225 5226 5227 5228 5229 5230 5231 5232 5233 5234 5235 5236 5237 5238 5239 5240 5241 5242 5243 5244 5245 5246 5247 5248 5249 5250 5251 5252 5253 5254 5255 5256 5257 5258 5259 5260 5261 5262 5263 5264 5265 5266 5267 5268 5269 5270 5271 5272 5273 5274 5275 5276 5277 5278 5279 5280 5281 5282 5283 5284 5285 5286 5287 5288 5289 5290 5291 5292 5293 5294 5295 5296 5297 5298 5299 5300 5301 5302 5303 5304 5305 5306 5307 5308 5309 5310 5311 5312 5313 5314 5315 5316 5317 5318 5319 5320 5321 5322 5323 5324 5325 5326 5327 5328 5329 5330 5331 5332 5333 5334 5335 5336 5337 5338 5339 5340 5341 5342 5343 5344 5345 5346 5347 5348 5349 5350 5351 5352 5353 5354 5355 5356 5357 5358 5359 5360 5361 5362 5363 5364 5365 5366 5367 5368 5369 5370 5371 5372 5373 5374 5375 5376 5377 5378 5379 5380 5381 5382 5383 5384 5385 5386 5387 5388 5389 5390 5391 5392 5393 5394 5395 5396 5397 5398 5399 5400 5401 5402 5403 5404 5405 5406 5407 5408 5409 5410 5411 5412 5413 5414 5415 5416 5417 5418 5419 5420 5421 5422 5423 5424 5425 5426 5427 5428 5429 5430 5431 5432 5433 5434 5435 5436 5437 5438 5439 5440 5441 5442 5443 5444 5445 5446 5447 5448 5449 5450 5451 5452 5453 5454 5455 5456 5457 5458 5459 5460 5461 5462 5463 5464 5465 5466 5467 5468 5469 5470 5471 5472 5473 5474 5475 5476 5477 5478 5479 5480 5481 5482 5483 5484 5485 5486 5487 5488 5489 5490 5491 5492 5493 5494 5495 5496 5497 5498 5499 5500 5501 5502 5503 5504 5505 5506 5507 5508 5509 5510 5511 5512 5513 5514 5515 5516 5517 5518 5519 5520 5521 5522 5523 5524 5525 5526 5527 5528 5529 5530 5531 5532 5533 5534 5535 5536 5537 5538 5539 5540 5541 5542 5543 5544 5545 5546 5547 5548 5549 5550 5551 5552 5553 5554 5555 5556 5557 5558 5559 5560 5561 5562 5563 5564 5565 5566 5567 5568 5569 5570 5571 5572 5573 5574 5575 5576 5577 5578 5579 5580 5581 5582 5583 5584 5585 5586 5587 5588 5589 5590 5591 5592 5593 5594 5595 5596 5597 5598 5599 5600 5601 5602 5603 5604 5605 5606 5607 5608 5609 5610 5611 5612 5613 5614 5615 5616 5617 5618 5619 5620 5621 5622 5623 5624 5625 5626 5627 5628 5629 5630 5631 5632 5633 5634 5635 5636 5637 5638 5639 5640 5641 5642 5643 5644 5645 5646 5647 5648 5649 5650 5651 5652 5653 5654 5655 5656 5657 5658 5659 5660 5661 5662 5663 5664 5665 5666 5667 5668 5669 5670 5671 5672 5673 5674 5675 5676 5677 5678 5679 5680 5681 5682 5683 5684 5685 5686 5687 5688 5689 5690 5691 5692 5693 5694 5695 5696 5697 5698 5699 5700 5701 5702 5703 5704 5705 5706 5707 5708 5709 5710 5711 5712 5713 5714 5715 5716 5717 5718 5719 5720 5721 5722 5723 5724 5725 5726 5727 5728 5729 5730 5731 5732 5733 5734 5735 5736 5737 5738 5739 5740 5741 5742 5743 5744 5745 5746 5747 5748 5749 5750 5751 5752 5753 5754 5755 5756 5757 5758 5759 5760 5761 5762 5763 5764 5765 5766 5767 5768 5769 5770 5771 5772 5773 5774 5775 5776 5777 5778 5779 5780 5781 5782 5783 5784 5785 5786 5787 5788 5789 5790 5791 5792 5793 5794 5795 5796 5797 5798 5799 5800 5801 5802 5803 5804 5805 5806 5807 5808 5809 5810 5811 5812 5813 5814 5815 5816 5817 5818 5819 5820 5821 5822 5823 5824 5825 5826 5827 5828 5829 5830 5831 5832 5833 5834 5835 5836 5837 5838 5839 5840 5841 5842 5843 5844 5845 5846 5847 5848 5849 5850 5851 5852 5853 5854 5855 5856 5857 5858 5859 5860 5861 5862 5863 5864 5865 5866 5867 5868 5869 5870 5871 5872 5873 5874 5875 5876 5877 5878 5879 5880 5881 5882 5883 5884 5885 5886 5887 5888 5889 5890 5891 5892 5893 5894 5895 5896 5897 5898 5899 5900 5901 5902 5903 5904 5905 5906 5907 5908 5909 5910 5911 5912 5913 5914 5915 5916 5917 5918 5919 5920 5921 5922 5923 5924 5925 5926 5927 5928 5929 5930 5931 5932 5933 5934 5935 5936 5937 5938 5939 5940 5941 5942 5943 5944 5945 5946 5947 5948 5949 5950 5951 5952 5953 5954 5955 5956 5957 5958 5959 5960 5961 5962 5963 5964 5965 5966 5967 5968 5969 5970 5971 5972 5973 5974 5975 5976 5977 5978 5979 5980 5981 5982 5983 5984 5985 5986 5987 5988 5989 5990 5991 5992 5993 5994 5995 5996 5997 5998 5999 6000 6001 6002 6003 6004 6005 6006 6007 6008 6009 6010 6011 6012 6013 6014 6015 6016 6017 6018 6019 6020 6021 6022 6023 6024 6025 6026 6027 6028 6029 6030 6031 6032 6033 6034 6035 6036 6037 6038 6039 6040 6041 6042 6043 6044 6045 6046 6047 6048 6049 6050 6051 6052 6053 6054 6055 6056 6057 6058 6059 6060 6061 6062 6063 6064 6065 6066 6067 6068 6069 6070 6071 6072 6073 6074 6075 6076 6077 6078 6079 6080 6081 6082 6083 6084 6085 6086 6087 6088 6089 6090 6091 6092 6093 6094 6095 6096 6097 6098 6099 6100 6101 6102 6103 6104 6105 6106 6107 6108 6109 6110 6111 6112 6113 6114 6115 6116 6117 6118 6119 6120 6121 6122 6123 6124 6125 6126 6127 6128 6129 6130 6131 6132 6133 6134 6135 6136 6137 6138 6139 6140 6141 6142 6143 6144 6145 6146 6147 6148 6149 6150 6151 6152 6153 6154 6155 6156 6157 6158 6159 6160 6161 6162 6163 6164 6165 6166 6167 6168 6169 6170 6171 6172 6173 6174 6175 6176 6177 6178 6179 6180 6181 6182 6183 6184 6185 6186 6187 6188 6189 6190 6191 6192 6193 6194 6195 6196 6197 6198 6199 6200 6201 6202 6203 6204 6205 6206 6207 6208 6209 6210 6211 6212 6213 6214 6215 6216 6217 6218 6219 6220 6221 6222 6223 6224 6225 6226 6227 6228 6229 6230 6231 6232 6233 6234 6235 6236 6237 6238 6239 6240 6241 6242 6243 6244 6245 6246 6247 6248 6249 6250 6251 6252 6253 6254 6255 6256 6257 6258 6259 6260 6261 6262 6263 6264 6265 6266 6267 6268 6269 6270 6271 6272 6273 6274 6275 6276 6277 6278 6279 6280 6281 6282 6283 6284 6285 6286 6287 6288 6289 6290 6291 6292 6293 6294 6295 6296 6297 6298 6299 6300 6301 6302 6303 6304 6305 6306 6307 6308 6309 6310 6311 6312 6313 6314 6315 6316 6317 6318 6319 6320 6321 6322 6323 6324 6325 6326 6327 6328 6329 6330 6331 6332 6333 6334 6335 6336 6337 6338 6339 6340 6341 6342 6343 6344 6345 6346 6347 6348 6349 6350 6351 6352 6353 6354 6355 6356 6357 6358 6359 6360 6361 6362 6363 6364 6365 6366 6367 6368 6369 6370 6371 6372 6373 6374 6375 6376 6377 6378 6379 6380 6381 6382 6383 6384 6385 6386 6387 6388 6389 6390 6391 6392 6393 6394 6395 6396 6397 6398 6399 6400 6401 6402 6403 6404 6405 6406 6407 6408 6409 6410 6411 6412 6413 6414 6415 6416 6417 6418 6419 6420 6421 6422 6423 6424 6425 6426 6427 6428 6429 6430 6431 6432 6433 6434 6435 6436 6437 6438 6439 6440 6441 6442 6443 6444 6445 6446 6447 6448 6449 6450 6451 6452 6453 6454 6455 6456 6457 6458 6459 6460 6461 6462 6463 6464 6465 6466 6467 6468 6469 6470 6471 6472 6473 6474 6475 6476 6477 6478 6479 6480 6481 6482 6483 6484 6485 6486 6487 6488 6489 6490 6491 6492 6493 6494 6495 6496 6497 6498 6499 6500 6501 6502 6503 6504 6505 6506 6507 6508 6509 6510 6511 6512 6513 6514 6515 6516 6517 6518 6519 6520 6521 6522 6523 6524 6525 6526 6527 6528 6529 6530 6531 6532 6533 6534 6535 6536 6537 6538 6539 6540 6541 6542 6543 6544 6545 6546 6547 6548 6549 6550 6551 6552 6553 6554 6555 6556 6557 6558 6559 6560 6561 6562 6563 6564 6565 6566 6567 6568 6569 6570 6571 6572 6573 6574 6575 6576 6577 6578 6579 6580 6581 6582 6583 6584 6585 6586 6587 6588 6589 6590 6591 6592 6593 6594 6595 6596 6597 6598 6599 6600 6601 6602 6603 6604 6605 6606 6607 6608 6609 6610 6611 6612 6613 6614 6615 6616 6617 6618 6619 6620 6621 6622 6623 6624 6625 6626 6627 6628 6629 6630 6631 6632 6633 6634 6635 6636 6637 6638 6639 6640 6641 6642 6643 6644 6645 6646 6647 6648 6649 6650 6651 6652 6653 6654 6655 6656 6657 6658 6659 6660 6661 6662 6663 6664 6665 6666 6667 6668 6669 6670 6671 6672 6673 6674 6675 6676 6677 6678 6679 6680 6681 6682 6683 6684 6685 6686 6687 6688 6689 6690 6691 6692 6693 6694 6695 6696 6697 6698 6699 6700 6701 6702 6703 6704 6705 6706 6707 6708 6709 6710 6711 6712 6713 6714 6715 6716 6717 6718 6719 6720 6721 6722 6723 6724 6725 6726 6727 6728 6729 6730 6731 6732 6733 6734 6735 6736 6737 6738 6739 6740 6741 6742 6743 6744 6745 6746 6747 6748 6749 6750 6751 6752 6753 6754 6755 6756 6757 6758 6759 6760 6761 6762 6763 6764 6765 6766 6767 6768 6769 6770 6771 6772 6773 6774 6775 6776 6777 6778 6779 6780 6781 6782 6783 6784 6785 6786 6787 6788 6789 6790 6791 6792 6793 6794 6795 6796 6797 6798 6799 6800 6801 6802 6803 6804 6805 6806 6807 6808 6809 6810 6811 6812 6813 6814 6815 6816 6817 6818 6819 6820 6821 6822 6823 6824 6825 6826 6827 6828 6829 6830 6831 6832 6833 6834 6835 6836 6837 6838 6839 6840 6841 6842 6843 6844 6845 6846 6847 6848 6849 6850 6851 6852 6853 6854 6855 6856 6857 6858 6859 6860 6861 6862 6863 6864 6865 6866 6867 6868 6869 6870 6871 6872 6873 6874 6875 6876 6877 6878 6879 6880 6881 6882 6883 6884 6885 6886 6887 6888 6889 6890 6891 6892 6893 6894 6895 6896 6897 6898 6899 6900 6901 6902 6903 6904 6905 6906 6907 6908 6909 6910 6911 6912 6913 6914 6915 6916 6917 6918 6919 6920 6921 6922 6923 6924 6925 6926 6927 6928 6929 6930 6931 6932 6933 6934 6935 6936 6937 6938 6939 6940 6941 6942 6943 6944 6945 6946 6947 6948 6949 6950 6951 6952 6953 6954 6955 6956 6957 6958 6959 6960 6961 6962 6963 6964 6965 6966 6967 6968 6969 6970 6971 6972 6973 6974 6975 6976 6977 6978 6979 6980 6981 6982 6983 6984 6985 6986 6987 6988 6989 6990 6991 6992 6993 6994 6995 6996 6997 6998 6999 7000 7001 7002 7003 7004 7005 7006 7007 7008 7009 7010 7011 7012 7013 7014 7015 7016 7017 7018 7019 7020 7021 7022 7023 7024 7025 7026 7027 7028 7029 7030 7031 7032 7033 7034 7035 7036 7037 7038 7039 7040 7041 7042 7043 7044 7045 7046 7047 7048 7049 7050 7051 7052 7053 7054 7055 7056 7057 7058 7059 7060 7061 7062 7063 7064 7065 7066 7067 7068 7069 7070 7071 7072 7073 7074 7075 7076 7077 7078 7079 7080 7081 7082 7083 7084 7085 7086 7087 7088 7089 7090 7091 7092 7093 7094 7095 7096 7097 7098 7099 7100 7101 7102 7103 7104 7105 7106 7107 7108 7109 7110 7111 7112 7113 7114 7115 7116 7117 7118 7119 7120 7121 7122 7123 7124 7125 7126 7127 7128 7129 7130 7131 7132 7133 7134 7135 7136 7137 7138 7139 7140 7141 7142 7143 7144 7145 7146 7147 7148 7149 7150 7151 7152 7153 7154 7155 7156 7157 7158 7159 7160 7161 7162 7163 7164 7165 7166 7167 7168 7169 7170 7171 7172 7173 7174 7175 7176 7177 7178 7179 7180 7181 7182 7183 7184 7185 7186 7187 7188 7189 7190 7191 7192 7193 7194 7195 7196 7197 7198 7199 7200 7201 7202 7203 7204 7205 7206 7207 7208 7209 7210 7211 7212 7213 7214 7215 7216 7217 7218 7219 7220 7221 7222 7223 7224 7225 7226 7227 7228 7229 7230 7231 7232 7233 7234 7235 7236 7237 7238 7239 7240 7241 7242 7243 7244 7245 7246 7247 7248 7249 7250 7251 7252 7253 7254 7255 7256 7257 7258 7259 7260 7261 7262 7263 7264 7265 7266 7267 7268 7269 7270 7271 7272 7273 7274 7275 7276 7277 7278 7279 7280 7281 7282 7283 7284 7285 7286 7287 7288 7289 7290 7291 7292 7293 7294 7295 7296 7297 7298 7299 7300 7301 7302 7303 7304 7305 7306 7307 7308 7309 7310 7311 7312 7313 7314 7315 7316 7317 7318 7319 7320 7321 7322 7323 7324 7325 7326 7327 7328 7329 7330 7331 7332 7333 7334 7335 7336 7337 7338 7339 7340 7341 7342 7343 7344 7345 7346 7347 7348 7349 7350 7351 7352 7353 7354 7355 7356 7357 7358 7359 7360 7361 7362 7363 7364 7365 7366 7367 7368 7369 7370 7371 7372 7373 7374 7375 7376 7377 7378 7379 7380 7381 7382 7383 7384 7385 7386 7387 7388 7389 7390 7391 7392 7393 7394 7395 7396 7397 7398 7399 7400 7401 7402 7403 7404 7405 7406 7407 7408 7409 7410 7411 7412 7413 7414 7415 7416 7417 7418 7419 7420 7421 7422 7423 7424 7425 7426 7427 7428 7429 7430 7431 7432 7433 7434 7435 7436 7437 7438 7439 7440 7441 7442 7443 7444 7445 7446 7447 7448 7449 7450 7451 7452 7453 7454 7455 7456 7457 7458 7459 7460 7461 7462 7463 7464 7465 7466 7467 7468 7469 7470 7471 7472 7473 7474 7475 7476 7477 7478 7479 7480 7481 7482 7483 7484 7485 7486 7487 7488 7489 7490 7491 7492 7493 7494 7495 7496 7497 7498 7499 7500 7501 7502 7503 7504 7505 7506 7507 7508 7509 7510 7511 7512 7513 7514 7515 7516 7517 7518 7519 7520 7521 7522 7523 7524 7525 7526 7527 7528 7529 7530 7531 7532 7533 7534 7535 7536 7537 7538 7539 7540 7541 7542 7543 7544 7545 7546 7547 7548 7549 7550 7551 7552 7553 7554 7555 7556 7557 7558 7559 7560 7561 7562 7563 7564 7565 7566 7567 7568 7569 7570 7571 7572 7573 7574 7575 7576 7577 7578 7579 7580 7581 7582 7583 7584 7585 7586 7587 7588 7589 7590 7591 7592 7593 7594 7595 7596 7597 7598 7599 7600 7601 7602 7603 7604 7605 7606 7607 7608 7609 7610 7611 7612 7613 7614 7615 7616 7617 7618 7619 7620 7621 7622 7623 7624 7625 7626 7627 7628 7629 7630 7631 7632 7633 7634 7635 7636 7637 7638 7639 7640 7641 7642 7643 7644 7645 7646 7647 7648 7649 7650 7651 7652 7653 7654 7655 7656 7657 7658 7659 7660 7661 7662 7663 7664 7665 7666 7667 7668 7669 7670 7671 7672 7673 7674 7675 7676 7677 7678 7679 7680 7681 7682 7683 7684 7685 7686 7687 7688 7689 7690 7691 7692 7693 7694 7695 7696 7697 7698 7699 7700 7701 7702 7703 7704 7705 7706 7707 7708 7709 7710 7711 7712 7713 7714 7715 7716 7717 7718 7719 7720 7721 7722 7723 7724 7725 7726 7727 7728 7729 7730 7731 7732 7733 7734 7735 7736 7737 7738 7739 7740 7741 7742 7743 7744 7745 7746 7747 7748 7749 7750 7751 7752 7753 7754 7755 7756 7757 7758 7759 7760 7761 7762 7763 7764 7765 7766 7767 7768 7769 7770 7771 7772 7773 7774 7775 7776 7777 7778 7779 7780 7781 7782 7783 7784 7785 7786 7787 7788 7789 7790 7791 7792 7793 7794 7795 7796 7797 7798 7799 7800 7801 7802 7803 7804 7805 7806 7807 7808 7809 7810 7811 7812 7813 7814 7815 7816 7817 7818 7819 7820 7821 7822 7823 7824 7825 7826 7827 7828 7829 7830 7831 7832 7833 7834 7835 7836 7837 7838 7839 7840 7841 7842 7843 7844 7845 7846 7847 7848 7849 7850 7851 7852 7853 7854 7855 7856 7857 7858 7859 7860 7861 7862 7863 7864 7865 7866 7867 7868 7869 7870 7871 7872 7873 7874 7875 7876 7877 7878 7879 7880 7881 7882 7883 7884 7885 7886 7887 7888 7889 7890 7891 7892 7893 7894 7895 7896 7897 7898 7899 7900 7901 7902 7903 7904 7905 7906 7907 7908 7909 7910 7911 7912 7913 7914 7915 7916 7917 7918 7919 7920 7921 7922 7923 7924 7925 7926 7927 7928 7929 7930 7931 7932 7933 7934 7935 7936 7937 7938 7939 7940 7941 7942 7943 7944 7945 7946 7947 7948 7949 7950 7951 7952 7953 7954 7955 7956 7957 7958 7959 7960 7961 7962 7963 7964 7965 7966 7967 7968 7969 7970 7971 7972 7973 7974 7975 7976 7977 7978 7979 7980 7981 7982 7983 7984 7985 7986 7987 7988 7989 7990 7991 7992 7993 7994 7995 7996 7997 7998 7999 8000 8001 8002 8003 8004 8005 8006 8007 8008 8009 8010 8011 8012 8013 8014 8015 8016 8017 8018 8019 8020 8021 8022 8023 8024 8025 8026 8027 8028 8029 8030 8031 8032 8033 8034 8035 8036 8037 8038 8039 8040 8041 8042 8043 8044 8045 8046 8047 8048 8049 8050 8051 8052 8053 8054 8055 8056 8057 8058 8059 8060 8061 8062 8063 8064 8065 8066 8067 8068 8069 8070 8071 8072 8073 8074 8075 8076 8077 8078 8079 8080 8081 8082 8083 8084 8085 8086 8087 8088 8089 8090 8091 8092 8093 8094 8095 8096 8097 8098 8099 8100 8101 8102 8103 8104 8105 8106 8107 8108 8109 8110 8111 8112 8113 8114 8115 8116 8117 8118 8119 8120 8121 8122 8123 8124 8125 8126 8127 8128 8129 8130 8131 8132 8133 8134 8135 8136 8137 8138 8139 8140 8141 8142 8143 8144 8145 8146 8147 8148 8149 8150 8151 8152 8153 8154 8155 8156 8157 8158 8159 8160 8161 8162 8163 8164 8165 8166 8167 8168 8169 8170 8171 8172 8173 8174 8175 8176 8177 8178 8179 8180 8181 8182 8183 8184 8185 8186 8187 8188 8189 8190 8191 8192 8193 8194 8195 8196 8197 8198 8199 8200 8201 8202 8203 8204 8205 8206 8207 8208 8209 8210 8211 8212 8213 8214 8215 8216 8217 8218 8219 8220 8221 8222 8223 8224 8225 8226 8227 8228 8229 8230 8231 8232 8233 8234 8235 8236 8237 8238 8239 8240 8241 8242 8243 8244 8245 8246 8247 8248 8249 8250 8251 8252 8253 8254 8255 8256 8257 8258 8259 8260 8261 8262 8263 8264 8265 8266 8267 8268 8269 8270 8271 8272 8273 8274 8275 8276 8277 8278 8279 8280 8281 8282 8283 8284 8285 8286 8287 8288 8289 8290 8291 8292 8293 8294 8295 8296 8297 8298 8299 8300 8301 8302 8303 8304 8305 8306 8307 8308 8309 8310 8311 8312 8313 8314 8315 8316 8317 8318 8319 8320 8321 8322 8323 8324 8325 8326 8327 8328 8329 8330 8331 8332 8333 8334 8335 8336 8337 8338 8339 8340 8341 8342 8343 8344 8345 8346 8347 8348 8349 8350 8351 8352 8353 8354 8355 8356 8357 8358 8359 8360 8361 8362 8363 8364 8365 8366 8367 8368 8369 8370 8371 8372 8373 8374 8375 8376 8377 8378 8379 8380 8381 8382 8383 8384 8385 8386 8387 8388 8389 8390 8391 8392 8393 8394 8395 8396 8397 8398 8399 8400 8401 8402 8403 8404 8405 8406 8407 8408 8409 8410 8411 8412 8413 8414 8415 8416 8417 8418 8419 8420 8421 8422 8423 8424 8425 8426 8427 8428 8429 8430 8431 8432 8433 8434 8435 8436 8437 8438 8439 8440 8441 8442 8443 8444 8445 8446 8447 8448 8449 8450 8451 8452 8453 8454 8455 8456 8457 8458 8459 8460 8461 8462 8463 8464 8465 8466 8467 8468 8469 8470 8471 8472 8473 8474 8475 8476 8477 8478 8479 8480 8481 8482 8483 8484 8485 8486 8487 8488 8489 8490 8491 8492 8493 8494 8495 8496 8497 8498 8499 8500 8501 8502 8503 8504 8505 8506 8507 8508 8509 8510 8511 8512 8513 8514 8515 8516 8517 8518 8519 8520 8521 8522 8523 8524 8525 8526 8527 8528 8529 8530 8531 8532 8533 8534 8535 8536 8537 8538 8539 8540 8541 8542 8543 8544 8545 8546 8547 8548 8549 8550 8551 8552 8553 8554 8555 8556 8557 8558 8559 8560 8561 8562 8563 8564 8565 8566 8567 8568 8569 8570 8571 8572 8573 8574 8575 8576 8577 8578 8579 8580 8581 8582 8583 8584 8585 8586 8587 8588 8589 8590 8591 8592 8593 8594 8595 8596 8597 8598 8599 8600 8601 8602 8603 8604 8605 8606 8607 8608 8609 8610 8611 8612 8613 8614 8615 8616 8617 8618 8619 8620 8621 8622 8623 8624 8625 8626 8627 8628 8629 8630 8631 8632 8633 8634 8635 8636 8637 8638 8639 8640 8641 8642 8643 8644 8645 8646 8647 8648 8649 8650 8651 8652 8653 8654 8655 8656 8657 8658 8659 8660 8661 8662 8663 8664 8665 8666 8667 8668 8669 8670 8671 8672 8673 8674 8675 8676 8677 8678 8679 8680 8681 8682 8683 8684 8685 8686 8687 8688 8689 8690 8691 8692 8693 8694 8695 8696 8697 8698 8699 8700 8701 8702 8703 8704 8705 8706 8707 8708 8709 8710 8711 8712 8713 8714 8715 8716 8717 8718 8719 8720 8721 8722 8723 8724 8725 8726 8727 8728 8729 8730 8731 8732 8733 8734 8735 8736 8737 8738 8739 8740 8741 8742 8743 8744 8745 8746 8747 8748 8749 8750 8751 8752 8753 8754 8755 8756 8757 8758 8759 8760 8761 8762 8763 8764 8765 8766 8767 8768 8769 8770 8771 8772 8773 8774 8775 8776 8777 8778 8779 8780 8781 8782 8783 8784 8785 8786 8787 8788 8789 8790 8791 8792 8793 8794 8795 8796 8797 8798 8799 8800 8801 8802 8803 8804 8805 8806 8807 8808 8809 8810 8811 8812 8813 8814 8815 8816 8817 8818 8819 8820 8821 8822 8823 8824 8825 8826 8827 8828 8829 8830 8831 8832 8833 8834 8835 8836 8837 8838 8839 8840 8841 8842 8843 8844 8845 8846 8847 8848 8849 8850 8851 8852 8853 8854 8855 8856 8857 8858 8859 8860 8861 8862 8863 8864 8865 8866 8867 8868 8869 8870 8871 8872 8873 8874 8875 8876 8877 8878 8879 8880 8881 8882 8883 8884 8885 8886 8887 8888 8889 8890 8891 8892 8893 8894 8895 8896 8897 8898 8899 8900 8901 8902 8903 8904 8905 8906 8907 8908 8909 8910 8911 8912 8913 8914 8915 8916 8917 8918
|
!--------------------------------------------------------------------------------------------------!
! CP2K: A general program to perform molecular dynamics simulations !
! Copyright (C) 2000 - 2018 CP2K developers group !
!--------------------------------------------------------------------------------------------------!
! **************************************************************************************************
!> \brief function that build the dft section of the input
!> \par History
!> 10.2005 moved out of input_cp2k [fawzi]
!> \author fawzi
! **************************************************************************************************
MODULE input_cp2k_dft
USE bibliography, ONLY: &
Andermatt2016, Andreussi2012, Avezac2005, BaniHashemian2016, Becke1988b, Bengtsson1999, &
Blochl1995, Brelaz1979, Dewar1977, Dewar1985, Dudarev1997, Dudarev1998, Ehrhardt1985, &
Elstner1998, Fattebert2002, Golze2017a, Golze2017b, Guidon2010, Heinzmann1976, &
Holmberg2017, Hu2007, Hunt2003, Iannuzzi2005, Iannuzzi2006, Iannuzzi2007, Kolafa2004, &
Krack2000, Krack2002, Kunert2003, Lippert1997, Lippert1999, Lu2004, Perdew1981, &
Porezag1995, Repasky2002, Rocha2006, Schenter2008, Schiffmann2015, Seifert1996, &
Stewart1982, Stewart1989, Stewart2007, Thiel1992, Tozer1996, VanVoorhis2015, &
VandeVondele2003, VandeVondele2005a, VandeVondele2005b, VandeVondele2006, Weber2008, &
Zhao1994, Zhechkov2005
USE cp_output_handling, ONLY: add_last_numeric,&
cp_print_key_section_create,&
debug_print_level,&
high_print_level,&
low_print_level,&
medium_print_level,&
silent_print_level
USE cp_units, ONLY: cp_unit_to_cp2k
USE input_constants, ONLY: &
atomic_guess, becke_cutoff_element, becke_cutoff_global, broyden_type_1, &
broyden_type_1_explicit, broyden_type_1_explicit_ls, broyden_type_1_ls, broyden_type_2, &
broyden_type_2_explicit, broyden_type_2_explicit_ls, broyden_type_2_ls, casci_canonical, &
cdft_alpha_constraint, cdft_beta_constraint, cdft_charge_constraint, &
cdft_magnetization_constraint, cholesky_dbcsr, cholesky_inverse, cholesky_off, &
cholesky_reduce, cholesky_restore, core_guess, diag_block_davidson, diag_block_krylov, &
diag_filter_matrix, diag_ot, diag_standard, dispersion_d3, dispersion_uff, dmft_model, &
do_admm_aux_exch_func_bee, do_admm_aux_exch_func_default, do_admm_aux_exch_func_none, &
do_admm_aux_exch_func_opt, do_admm_aux_exch_func_pbex, do_admm_basis_projection, &
do_admm_blocked_projection, do_admm_blocking_purify_full, &
do_admm_charge_constrained_projection, do_admm_exch_scaling_merlot, &
do_admm_exch_scaling_none, do_admm_purify_cauchy, do_admm_purify_cauchy_subspace, &
do_admm_purify_mcweeny, do_admm_purify_mo_diag, do_admm_purify_mo_no_diag, &
do_admm_purify_none, do_admm_purify_none_dm, do_arnoldi, do_bch, do_cn, &
do_ddapc_constraint, do_ddapc_restraint, do_em, do_etrs, do_full_density, do_gapw_gcs, &
do_gapw_gct, do_gapw_log, do_loc_both, do_loc_crazy, do_loc_direct, do_loc_homo, &
do_loc_jacobi, do_loc_l1_norm_sd, do_loc_lumo, do_loc_max, do_loc_min, do_loc_none, &
do_lri_inv, do_lri_inv_auto, do_lri_opt_all, do_lri_opt_coeff, do_lri_opt_exps, &
do_lri_pseudoinv_diag, do_lri_pseudoinv_svd, do_method_am1, do_method_dftb, &
do_method_gapw, do_method_gapw_xc, do_method_gpw, do_method_lrigpw, do_method_mndo, &
do_method_mndod, do_method_ofgpw, do_method_pdg, do_method_pm3, do_method_pm6, &
do_method_pm6fm, do_method_pnnl, do_method_rigpw, do_method_rm1, do_pade, do_ppl_analytic, &
do_ppl_grid, do_pwgrid_ns_fullspace, do_pwgrid_ns_halfspace, do_pwgrid_spherical, &
do_s2_constraint, do_s2_restraint, do_se_is_kdso, do_se_is_kdso_d, do_se_is_slater, &
do_se_lr_ewald, do_se_lr_ewald_gks, do_se_lr_ewald_r3, do_se_lr_none, do_spin_density, &
do_taylor, ehrenfest, embed_level_shift, embed_quasi_newton, embed_steep_desc, &
eri_method_full_gpw, eri_method_gpw_ht, eri_operator_coulomb, eri_operator_erf, &
eri_operator_erfc, eri_operator_gaussian, eri_operator_yukawa, gaussian, general_roks, &
hf_model, high_spin_roks, history_guess, jacobian_fd1, jacobian_fd1_backward, &
jacobian_fd1_central, jacobian_fd2, jacobian_fd2_backward, kg_cholesky, kg_color_dsatur, &
kg_color_greedy, kg_ec_diagonalization, kg_ec_functional_harris, kg_tnadd_atomic, &
kg_tnadd_embed, kg_tnadd_embed_ri, kg_tnadd_none, ls_2pnt, ls_3pnt, ls_gold, ls_none, &
mao_basis_ext, mao_basis_orb, mao_basis_prim, mao_projection, mopac_guess, no_excitations, &
no_guess, numerical, oe_gllb, oe_lb, oe_none, oe_saop, oe_sic, op_loc_berry, op_loc_boys, &
op_loc_pipek, orb_dx2, orb_dxy, orb_dy2, orb_dyz, orb_dz2, orb_dzx, orb_px, orb_py, &
orb_pz, orb_s, ot_algo_irac, ot_algo_taylor_or_diag, ot_chol_irac, ot_lwdn_irac, &
ot_mini_broyden, ot_mini_cg, ot_mini_diis, ot_mini_sd, ot_poly_irac, ot_precond_full_all, &
ot_precond_full_kinetic, ot_precond_full_single, ot_precond_full_single_inverse, &
ot_precond_none, ot_precond_s_inverse, ot_precond_solver_default, &
ot_precond_solver_direct, ot_precond_solver_inv_chol, ot_precond_solver_update, &
outer_scf_basis_center_opt, outer_scf_becke_constraint, outer_scf_cdft_constraint, &
outer_scf_ddapc_constraint, outer_scf_hirshfeld_constraint, outer_scf_none, &
outer_scf_optimizer_bisect, outer_scf_optimizer_broyden, outer_scf_optimizer_diis, &
outer_scf_optimizer_newton, outer_scf_optimizer_newton_ls, outer_scf_optimizer_none, &
outer_scf_optimizer_sd, outer_scf_optimizer_secant, outer_scf_s2_constraint, &
plus_u_lowdin, plus_u_mulliken, plus_u_mulliken_charges, pw_interp, radius_covalent, &
radius_default, radius_single, radius_user, radius_vdw, random_guess, &
real_time_propagation, ref_charge_atomic, ref_charge_mulliken, rel_dkh, rel_none, &
rel_pot_erfc, rel_pot_full, rel_sczora_mp, rel_trans_atom, rel_trans_full, &
rel_trans_molecule, rel_zora, rel_zora_full, rel_zora_mp, restart_guess, rsdft_model, &
sccs_andreussi, sccs_derivative_cd3, sccs_derivative_cd5, sccs_derivative_cd7, &
sccs_derivative_fft, sccs_fattebert_gygi, shape_function_density, shape_function_gaussian, &
sic_ad, sic_eo, sic_list_all, sic_list_unpaired, sic_mauri_spz, sic_mauri_us, sic_none, &
slater, smear_energy_window, smear_fermi_dirac, smear_list, sparse_guess, &
spline3_nopbc_interp, spline3_pbc_interp, tddfpt_davidson, tddfpt_excitations, &
tddfpt_lanczos, tddfpt_singlet, tddfpt_triplet, use_coulomb, use_diff, use_no, &
use_restart_wfn, use_rt_restart, use_scf_wfn, wannier_projection, weight_type_mass, &
weight_type_unit, wfi_aspc_nr, wfi_frozen_method_nr, wfi_linear_p_method_nr, &
wfi_linear_ps_method_nr, wfi_linear_wf_method_nr, wfi_ps_method_nr, &
wfi_use_guess_method_nr, wfi_use_prev_p_method_nr, wfi_use_prev_rho_r_method_nr, &
wfi_use_prev_wf_method_nr, xas_1s_type, xas_2p_type, xas_2s_type, xas_dip_len, &
xas_dip_vel, xas_dscf, xas_none, xas_tp_fh, xas_tp_flex, xas_tp_hh, xas_tp_xfh, &
xas_tp_xhh, xes_tp_val
USE input_cp2k_almo, ONLY: create_almo_scf_section
USE input_cp2k_distribution, ONLY: create_distribution_section
USE input_cp2k_field, ONLY: create_efield_section,&
create_per_efield_section
USE input_cp2k_kpoints, ONLY: create_kpoints_section
USE input_cp2k_ls, ONLY: create_ls_scf_section
USE input_cp2k_mm, ONLY: create_dipoles_section,&
create_neighbor_lists_section
USE input_cp2k_motion_print, ONLY: add_format_keyword
USE input_cp2k_poisson, ONLY: create_poisson_section
USE input_cp2k_rsgrid, ONLY: create_rsgrid_section
USE input_cp2k_transport, ONLY: create_transport_section
USE input_cp2k_xc, ONLY: create_xc_section
USE input_keyword_types, ONLY: keyword_create,&
keyword_release,&
keyword_type
USE input_section_types, ONLY: section_add_keyword,&
section_add_subsection,&
section_create,&
section_release,&
section_type
USE input_val_types, ONLY: char_t,&
integer_t,&
lchar_t,&
logical_t,&
real_t
USE kinds, ONLY: dp
USE pw_grids, ONLY: do_pw_grid_blocked_false,&
do_pw_grid_blocked_free,&
do_pw_grid_blocked_true
USE pw_spline_utils, ONLY: no_precond,&
precond_spl3_1,&
precond_spl3_2,&
precond_spl3_3,&
precond_spl3_aint,&
precond_spl3_aint2
USE qs_density_mixing_types, ONLY: create_mixing_section
USE qs_fb_input, ONLY: create_filtermatrix_section
USE qs_mom_types, ONLY: create_mom_section
USE string_utilities, ONLY: newline,&
s2a
#include "./base/base_uses.f90"
IMPLICIT NONE
PRIVATE
CHARACTER(len=*), PARAMETER, PRIVATE :: moduleN = 'input_cp2k_dft'
PUBLIC :: create_dft_section
PUBLIC :: create_bsse_section, create_qs_section
PUBLIC :: create_scf_section
PUBLIC :: create_interp_section, create_localize_section
PUBLIC :: create_becke_constraint_section, create_ddapc_restraint_section
PUBLIC :: create_mgrid_section
CONTAINS
! **************************************************************************************************
!> \brief creates the dft section
!> \param section the section to be created
!> \author fawzi
! **************************************************************************************************
SUBROUTINE create_dft_section(section)
TYPE(section_type), POINTER :: section
CHARACTER(len=*), PARAMETER :: routineN = 'create_dft_section', &
routineP = moduleN//':'//routineN
TYPE(keyword_type), POINTER :: keyword
TYPE(section_type), POINTER :: subsection
CPASSERT(.NOT. ASSOCIATED(section))
CALL section_create(section, name="dft", &
description="parameter needed by dft programs", &
n_keywords=3, n_subsections=4, repeats=.FALSE.)
NULLIFY (keyword)
CALL keyword_create(keyword, name="BASIS_SET_FILE_NAME", &
description="Name of the basis set file, may include a path", &
usage="BASIS_SET_FILE_NAME <FILENAME>", &
type_of_var=lchar_t, repeats=.TRUE., &
default_lc_val="BASIS_SET", n_var=1)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="POTENTIAL_FILE_NAME", &
description="Name of the pseudo potential file, may include a path", &
usage="POTENTIAL_FILE_NAME <FILENAME>", &
default_lc_val="POTENTIAL")
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="WFN_RESTART_FILE_NAME", &
variants=(/"RESTART_FILE_NAME"/), &
description="Name of the wavefunction restart file, may include a path."// &
" If no file is specified, the default is to open the file as generated by the wfn restart print key.", &
usage="WFN_RESTART_FILE_NAME <FILENAME>", &
type_of_var=lchar_t)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword=keyword, &
name="UKS", &
variants=s2a("UNRESTRICTED_KOHN_SHAM", &
"LSD", &
"SPIN_POLARIZED"), &
description="Requests a spin-polarized calculation using alpha "// &
"and beta orbitals, i.e. no spin restriction is applied", &
usage="LSD", &
default_l_val=.FALSE., &
lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword=keyword, &
name="ROKS", &
variants=(/"RESTRICTED_OPEN_KOHN_SHAM"/), &
description="Requests a restricted open Kohn-Sham calculation", &
usage="ROKS", &
default_l_val=.FALSE., &
lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword=keyword, &
name="MULTIPLICITY", &
variants=(/"MULTIP"/), &
description="Two times the total spin plus one. "// &
"Specify 3 for a triplet, 4 for a quartet, "// &
"and so on. Default is 1 (singlet) for an "// &
"even number and 2 (doublet) for an odd number "// &
"of electrons.", &
usage="MULTIPLICITY 3", &
default_i_val=0) ! this default value is just a flag to get the above
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="CHARGE", &
description="The total charge of the system", &
usage="CHARGE -1", &
default_i_val=0)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="EXCITATIONS", &
description="If excitations should be calculated", &
usage="EXCITATIONS", &
enum_c_vals=s2a("NONE", "TDLR", "TDDFPT"), &
enum_i_vals=(/no_excitations, tddfpt_excitations, &
tddfpt_excitations/), &
default_i_val=no_excitations)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, &
name="PLUS_U_METHOD", &
description="Method employed for the calculation of the DFT+U contribution", &
repeats=.FALSE., &
enum_c_vals=s2a("LOWDIN", "MULLIKEN", "MULLIKEN_CHARGES"), &
enum_i_vals=(/plus_u_lowdin, plus_u_mulliken, plus_u_mulliken_charges/), &
enum_desc=s2a("Method based on Lowdin population analysis "// &
"(computationally expensive, since the diagonalization of the "// &
"overlap matrix is required, but possibly more robust than Mulliken)", &
"Method based on Mulliken population analysis using the net AO and "// &
"overlap populations (computationally cheap method)", &
"Method based on Mulliken gross orbital populations (GOP)"), &
n_var=1, &
default_i_val=plus_u_mulliken, &
usage="METHOD Lowdin")
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, &
name="RELAX_MULTIPLICITY", &
variants=(/"RELAX_MULTIP"/), &
description="Do not enforce the occupation of alpha and beta MOs due to the initially "// &
"defined multiplicity, but rather follow an Aufbau principle. "// &
"A threshold value greater than zero activates this option. "// &
"Larger threshold values increase the probability for a spin flip. "// &
"This option is only valid for unrestricted (i.e. spin polarised) "// &
"Kohn-Sham (UKS) calculations.", &
usage="RELAX_MULTIPLICITY 0.00001", &
repeats=.FALSE., &
default_r_val=0.0_dp)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="SUBCELLS", &
description="Read the grid size for subcell generation in the construction of "// &
"neighbor lists.", usage="SUBCELLS 1.5", &
n_var=1, default_r_val=2.0_dp)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="AUTO_BASIS", &
description="Specify size of automatically generated auxiliary basis sets: "// &
"Options={small,medium,large,huge}", &
usage="AUTO_BASIS {basis_type} {basis_size}", &
type_of_var=char_t, repeats=.TRUE., n_var=-1, default_c_vals=(/"X", "X"/))
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword=keyword, &
name="SURFACE_DIPOLE_CORRECTION", &
variants=s2a("SURFACE_DIPOLE", &
"SURF_DIP"), &
description="For slab calculations with asymmetric geometries, activate the correction of "// &
" the electrostatic potential with "// &
"by compensating for the surface dipole. Implemented only for slabs with normal "// &
" parallel to one Cartesian axis. The normal direction is given by the keyword SURF_DIP_DIR ", &
usage="SURF_DIP", &
default_l_val=.FALSE., &
lone_keyword_l_val=.TRUE., &
citations=(/Bengtsson1999/))
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword=keyword, &
name="SURF_DIP_DIR", &
description="Cartesian axis parallel to surface normal.", &
enum_c_vals=s2a("X", "Y", "Z"), &
enum_i_vals=(/1, 2, 3/), &
enum_desc=s2a("Along x", "Along y", "Along z"), &
n_var=1, &
default_i_val=3, &
usage="SURF_DIP_DIR Z")
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
NULLIFY (subsection)
CALL create_scf_section(subsection)
CALL section_add_subsection(section, subsection)
CALL section_release(subsection)
CALL create_ls_scf_section(subsection)
CALL section_add_subsection(section, subsection)
CALL section_release(subsection)
CALL create_almo_scf_section(subsection)
CALL section_add_subsection(section, subsection)
CALL section_release(subsection)
CALL create_kg_section(subsection)
CALL section_add_subsection(section, subsection)
CALL section_release(subsection)
CALL create_admm_section(subsection)
CALL section_add_subsection(section, subsection)
CALL section_release(subsection)
CALL create_qs_section(subsection)
CALL section_add_subsection(section, subsection)
CALL section_release(subsection)
CALL create_tddfpt_section(subsection)
CALL section_add_subsection(section, subsection)
CALL section_release(subsection)
CALL create_mgrid_section(subsection, create_subsections=.TRUE.)
CALL section_add_subsection(section, subsection)
CALL section_release(subsection)
CALL create_xc_section(subsection)
CALL section_add_subsection(section, subsection)
CALL section_release(subsection)
CALL create_relativistic_section(subsection)
CALL section_add_subsection(section, subsection)
CALL section_release(subsection)
CALL create_sic_section(subsection)
CALL section_add_subsection(section, subsection)
CALL section_release(subsection)
CALL create_low_spin_roks_section(subsection)
CALL section_add_subsection(section, subsection)
CALL section_release(subsection)
CALL create_efield_section(subsection)
CALL section_add_subsection(section, subsection)
CALL section_release(subsection)
CALL create_per_efield_section(subsection)
CALL section_add_subsection(section, subsection)
CALL section_release(subsection)
CALL create_ext_pot_section(subsection)
CALL section_add_subsection(section, subsection)
CALL section_release(subsection)
CALL create_transport_section(subsection)
CALL section_add_subsection(section, subsection)
CALL section_release(subsection)
! ZMP sections to include the external density or v_xc potential
CALL create_ext_den_section(subsection)
CALL section_add_subsection(section, subsection)
CALL section_release(subsection)
CALL create_ext_vxc_section(subsection)
CALL section_add_subsection(section, subsection)
CALL section_release(subsection)
CALL create_poisson_section(subsection)
CALL section_add_subsection(section, subsection)
CALL section_release(subsection)
CALL create_kpoints_section(subsection)
CALL section_add_subsection(section, subsection)
CALL section_release(subsection)
CALL create_implicit_solv_section(subsection)
CALL section_add_subsection(section, subsection)
CALL section_release(subsection)
CALL create_density_fitting_section(subsection)
CALL section_add_subsection(section, subsection)
CALL section_release(subsection)
CALL create_xas_section(subsection)
CALL section_add_subsection(section, subsection)
CALL section_release(subsection)
CALL create_localize_section(subsection)
CALL section_add_subsection(section, subsection)
CALL section_release(subsection)
CALL create_rtp_section(subsection)
CALL section_add_subsection(section, subsection)
CALL section_release(subsection)
CALL create_print_dft_section(subsection)
CALL section_add_subsection(section, subsection)
CALL section_release(subsection)
CALL create_sccs_section(subsection)
CALL section_add_subsection(section, subsection)
CALL section_release(subsection)
END SUBROUTINE create_dft_section
! **************************************************************************************************
!> \brief Implicit Solvation Model
!> \param section ...
!> \author tlaino
! **************************************************************************************************
SUBROUTINE create_implicit_solv_section(section)
TYPE(section_type), POINTER :: section
CHARACTER(len=*), PARAMETER :: routineN = 'create_implicit_solv_section', &
routineP = moduleN//':'//routineN
TYPE(keyword_type), POINTER :: keyword
TYPE(section_type), POINTER :: print_key, subsection
NULLIFY (keyword, subsection, print_key)
CPASSERT(.NOT. ASSOCIATED(section))
CALL section_create(section, name="SCRF", &
description="Adds an implicit solvation model to the DFT calculation."// &
" Know also as Self Consistent Reaction Field.", &
n_keywords=0, n_subsections=0, repeats=.FALSE.)
CALL keyword_create(keyword, name="EPS_OUT", &
description="Value of the dielectric constant outside the sphere", &
usage="EPS_OUT <REAL>", &
default_r_val=1.0_dp)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="LMAX", &
description="Maximum value of L used in the multipole expansion", &
usage="LMAX <INTEGER>", &
default_i_val=3)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL create_sphere_section(subsection)
CALL section_add_subsection(section, subsection)
CALL section_release(subsection)
CALL cp_print_key_section_create(print_key, "program_run_info", &
description="Controls the printing basic info about the method", &
print_level=low_print_level, add_last=add_last_numeric, filename="__STD_OUT__")
CALL section_add_subsection(section, print_key)
CALL section_release(print_key)
END SUBROUTINE create_implicit_solv_section
! **************************************************************************************************
!> \brief Create Sphere cavity
!> \param section ...
!> \author tlaino
! **************************************************************************************************
SUBROUTINE create_sphere_section(section)
TYPE(section_type), POINTER :: section
CHARACTER(len=*), PARAMETER :: routineN = 'create_sphere_section', &
routineP = moduleN//':'//routineN
TYPE(keyword_type), POINTER :: keyword
TYPE(section_type), POINTER :: subsection
NULLIFY (keyword, subsection)
CPASSERT(.NOT. ASSOCIATED(section))
CALL section_create(section, name="SPHERE", &
description="Treats the implicit solvent environment like a sphere", &
n_keywords=0, n_subsections=0, repeats=.FALSE.)
CALL keyword_create(keyword, name="RADIUS", &
description="Value of the spherical cavity in the dielectric medium", &
usage="RADIUS <REAL>", &
unit_str="angstrom", &
type_of_var=real_t)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL create_center_section(subsection)
CALL section_add_subsection(section, subsection)
CALL section_release(subsection)
END SUBROUTINE create_sphere_section
! **************************************************************************************************
!> \brief ...
!> \param section ...
!> \author tlaino
! **************************************************************************************************
SUBROUTINE create_center_section(section)
TYPE(section_type), POINTER :: section
CHARACTER(len=*), PARAMETER :: routineN = 'create_center_section', &
routineP = moduleN//':'//routineN
TYPE(keyword_type), POINTER :: keyword
NULLIFY (keyword)
CPASSERT(.NOT. ASSOCIATED(section))
CALL section_create(section, name="CENTER", &
description="Defines the center of the sphere.", &
n_keywords=0, n_subsections=0, repeats=.FALSE.)
CALL keyword_create(keyword, name="XYZ", &
description="Coordinates of the center of the sphere", &
usage="XYZ <REAL> <REAL> <REAL>", &
unit_str="angstrom", &
type_of_var=real_t, n_var=3)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="ATOM_LIST", &
description="Defines a list of atoms to define the center of the sphere", &
usage="ATOM_LIST <INTEGER> .. <INTEGER>", &
type_of_var=integer_t, n_var=-1)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="WEIGHT_TYPE", &
description="Defines the weight used to define the center of the sphere"// &
" (if ATOM_LIST is provided)", &
usage="WEIGHT (UNIT|MASS)", &
enum_c_vals=(/"UNIT", "MASS"/), &
enum_i_vals=(/weight_type_unit, weight_type_mass/), &
default_i_val=weight_type_unit)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="FIXED", &
description="Specify if the center of the sphere should be fixed or"// &
" allowed to move", &
usage="FIXED <LOGICAL>", &
default_l_val=.TRUE.)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
END SUBROUTINE create_center_section
! **************************************************************************************************
!> \brief parameters fo the localization of wavefunctions
!> \param section ...
!> \par History
!> 03.2005 created [MI]
! **************************************************************************************************
SUBROUTINE create_localize_section(section)
TYPE(section_type), POINTER :: section
CHARACTER(len=*), PARAMETER :: routineN = 'create_localize_section', &
routineP = moduleN//':'//routineN
TYPE(keyword_type), POINTER :: keyword
TYPE(section_type), POINTER :: print_key, print_section, subsection
CPASSERT(.NOT. ASSOCIATED(section))
NULLIFY (keyword, print_key)
CALL section_create(section, name="LOCALIZE", &
description="Use one of the available methods to define the localization "// &
" and possibly to optimize it to a minimum or a maximum.", &
n_keywords=8, n_subsections=0, repeats=.FALSE.)
CALL keyword_create(keyword, name="_SECTION_PARAMETERS_", &
description="controls the activation of the MOS localization procedure", &
usage="&LOCALIZE T", default_l_val=.FALSE., lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="MAX_ITER", &
description="Maximum number of iterations used for localization methods", &
usage="MAX_ITER 2000", default_i_val=10000)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create( &
keyword, name="MAX_CRAZY_ANGLE", &
description="Largest allowed angle for the crazy rotations algorithm (smaller is slower but more stable).", &
usage="MAX_CRAZY_ANGLE 0.1", unit_str="rad", default_r_val=0.2_dp)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="CRAZY_SCALE", &
description="scale angles", &
usage="CRAZY_SCALE 0.9", default_r_val=1.0_dp)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="CRAZY_USE_DIAG", &
description="Use diagonalization (slow) or pade based calculation of matrix exponentials.", &
usage="CRAZY_USE_DIAG ", default_l_val=.FALSE., lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create( &
keyword, name="USE_HISTORY", &
description="Generate an improved initial guess based on a history of results, which is useful during MD."// &
"Will only work if the number of states to be localized remains constant.", &
usage="USE_HISTORY ", default_l_val=.FALSE., lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create( &
keyword, name="EPS_OCCUPATION", &
description="Tolerance in the occupation number to select only fully occupied orbitals for the rotation", &
usage="EPS_OCCUPATION 1.E-5", default_r_val=1.0E-8_dp)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="OUT_ITER_EACH", &
description="Every how many iterations of the localization algorithm"// &
"(Jacobi) the tolerance value is printed out", &
usage="OUT_ITER_EACH 100", default_i_val=100)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="EPS_LOCALIZATION", &
description="Tolerance used in the convergence criterion of the localization methods.", &
usage="EPS_LOCALIZATION 1.0E-2", default_r_val=1.0E-4_dp)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="MIN_OR_MAX", &
description="Requires the maximization of the spread of the wfn", &
usage="MIN_OR_MAX (SPREADMIN|SPREADMAX)", &
enum_c_vals=(/"SPREADMIN", "SPREADMAX"/), &
enum_i_vals=(/do_loc_min, do_loc_max/), &
default_i_val=do_loc_min)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create( &
keyword, name="METHOD", &
description="Method of optimization if any", &
usage="METHOD (JACOBI|CRAZY|DIRECT|L1SD|NONE)", &
enum_c_vals=s2a("NONE", "JACOBI", "CRAZY", "L1SD", "DIRECT"), &
enum_i_vals=(/do_loc_none, &
do_loc_jacobi, &
do_loc_crazy, &
do_loc_l1_norm_sd, &
do_loc_direct/), &
enum_desc=s2a("No localization is applied", &
"Using 2 x 2 rotations of the orbitals, slow but robust", &
"A new fast method is applied, might be slightly less robust than jacobi, but usually much faster", &
"Steepest descent minimization of an approximate l1 norm", &
"Using a direct minimisation approach"), &
default_i_val=do_loc_jacobi)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="JACOBI_FALLBACK", &
description="Use Jacobi method in case no convergence was achieved"// &
" by using the crazy rotations method.", &
usage="JACOBI_FALLBACK", default_l_val=.TRUE., &
lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="RESTART", &
description="Restart the localization from a set of orbitals"// &
" read from a localization restart file.", &
usage="RESTART", default_l_val=.FALSE., &
lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="LOCHOMO_RESTART_FILE_NAME", &
description="File name where to read the MOS from"// &
"which to restart the localization procedure for occupied states", &
usage="LOCHOMO_RESTART_FILE_NAME <FILENAME>", &
type_of_var=lchar_t)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="LOCLUMO_RESTART_FILE_NAME", &
description="File name where to read the MOS from"// &
"which to restart the localization procedure for unoccupied states", &
usage="LOCLUMO_RESTART_FILE_NAME <FILENAME>", &
type_of_var=lchar_t)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="OPERATOR", &
description="Type of opertator which defines the spread functional", &
usage="OPERATOR (BERRY|BOYS|PIPEK)", &
enum_c_vals=s2a("BERRY", "BOYS", "PIPEK"), &
enum_i_vals=(/op_loc_berry, op_loc_boys, op_loc_pipek/), &
default_i_val=op_loc_berry)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="LIST", &
description="Indexes of the occupied wfn to be localized"// &
"This keyword can be repeated several times"// &
"(useful if you have to specify many indexes).", &
usage="LIST 1 2", &
n_var=-1, type_of_var=integer_t, repeats=.TRUE.)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="LIST_UNOCCUPIED", &
description="Indexes of the unoccupied states to be localized, "// &
"up to now only valid in combination with GPW. "// &
"This keyword has to be present if unoccupied states should be localized. "// &
"This keyword can be repeated several times"// &
"(useful if you have to specify many indexes).", &
usage="LIST 1 2", &
n_var=-1, type_of_var=integer_t, repeats=.TRUE.)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="STATES", &
description="Which states to localize, LUMO up to now only available in GPW", &
usage="STATES (HOMO|LUMO|ALL)", &
enum_c_vals=s2a("OCCUPIED", "UNOCCUPIED", "ALL"), &
enum_i_vals=(/do_loc_homo, do_loc_lumo, do_loc_both/), &
default_i_val=do_loc_homo)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create( &
keyword=keyword, &
name="ENERGY_RANGE", &
description="Select the orbitals to be localized within the given energy range."// &
"This type of selection cannot be added on top of the selection through a LIST. It reads to reals that are"// &
" lower and higher boundaries of the energy range.", &
usage=" ENERGY_RANGE lower_bound {real}, higher_bound {real}", &
repeats=.FALSE., &
n_var=2, default_r_vals=(/0._dp, 0._dp/), unit_str='eV', &
type_of_var=real_t)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
NULLIFY (print_section)
CALL section_create(print_section, name="PRINT", &
description="Collects all printing options related to the Wannier centers and "// &
"properties computed with Wannier centers.", &
n_keywords=0, n_subsections=1, repeats=.FALSE.)
NULLIFY (print_key)
CALL cp_print_key_section_create(print_key, "program_run_info", &
description="Controls the printing basic info about the method", &
print_level=low_print_level, add_last=add_last_numeric, filename="__STD_OUT__")
CALL section_add_subsection(print_section, print_key)
CALL section_release(print_key)
! Add printing of wannier infos
CALL print_wanniers(print_section)
NULLIFY (subsection)
! Total Dipoles with wannier
CALL create_dipoles_section(subsection, "TOTAL_DIPOLE", debug_print_level+1)
CALL section_add_subsection(print_section, subsection)
CALL section_release(subsection)
! Molecular Dipoles with wannier
CALL create_dipoles_section(subsection, "MOLECULAR_DIPOLES", debug_print_level+1)
CALL section_add_subsection(print_section, subsection)
CALL section_release(subsection)
! Molecular States with wannier
CALL create_molecular_states_section(subsection)
CALL section_add_subsection(print_section, subsection)
CALL section_release(subsection)
! Wannier States with wannier
CALL create_wannier_states_section(subsection)
CALL section_add_subsection(print_section, subsection)
CALL section_release(subsection)
CALL section_add_subsection(section, print_section)
CALL section_release(print_section)
END SUBROUTINE create_localize_section
! **************************************************************************************************
!> \brief Controls the printing of the basic info coming from the LOCALIZE
!> section
!> \param section ...
!> \author teo
! **************************************************************************************************
SUBROUTINE print_wanniers(section)
TYPE(section_type), POINTER :: section
CHARACTER(len=*), PARAMETER :: routineN = 'print_wanniers', routineP = moduleN//':'//routineN
TYPE(keyword_type), POINTER :: keyword
TYPE(section_type), POINTER :: print_key
CPASSERT(ASSOCIATED(section))
NULLIFY (print_key, keyword)
CALL cp_print_key_section_create(print_key, "WANNIER_CUBES", &
description="Controls the printing of the wannier functions ", &
print_level=high_print_level, add_last=add_last_numeric, filename="")
CALL keyword_create(keyword, name="stride", &
description="The stride (X,Y,Z) used to write the cube file "// &
"(larger values result in smaller cube files). You can provide 3 numbers (for X,Y,Z) or"// &
" 1 number valid for all components.", &
usage="STRIDE 2 2 2", n_var=-1, default_i_vals=(/2, 2, 2/), type_of_var=integer_t)
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="CUBES_LU_BOUNDS", &
variants=(/"CUBES_LU"/), &
description="The lower and upper index of the states to be printed as cube", &
usage="CUBES_LU_BOUNDS integer integer", &
n_var=2, default_i_vals=(/0, -2/), type_of_var=integer_t)
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="CUBES_LIST", &
description="Indexes of the states to be printed as cube files"// &
"This keyword can be repeated several times"// &
"(useful if you have to specify many indexes).", &
usage="CUBES_LIST 1 2", &
n_var=-1, type_of_var=integer_t, repeats=.TRUE.)
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="APPEND", &
description="append the cube files when they already exist", &
default_l_val=.FALSE., lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
CALL section_add_subsection(section, print_key)
CALL section_release(print_key)
NULLIFY (print_key)
CALL cp_print_key_section_create(print_key, "WANNIER_CENTERS", &
description="Controls the printing of the wannier functions", &
print_level=high_print_level, add_last=add_last_numeric, filename="", &
unit_str="angstrom")
CALL keyword_create(keyword, name="IONS+CENTERS", &
description="prints out the wannier centers together with the particles", &
usage="IONS+CENTERS", default_l_val=.FALSE., &
lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
CALL add_format_keyword(keyword, print_key, pos=.TRUE., &
description="Specifies the format of the output file when IONS+CENTERS is enabled.")
CALL section_add_subsection(section, print_key)
CALL section_release(print_key)
NULLIFY (print_key)
CALL cp_print_key_section_create(print_key, "WANNIER_SPREADS", &
description="Controls the printing of the wannier functions", &
print_level=high_print_level, add_last=add_last_numeric, filename="")
CALL section_add_subsection(section, print_key)
CALL section_release(print_key)
NULLIFY (print_key)
CALL cp_print_key_section_create(print_key, "LOC_RESTART", &
description="Controls the printing of restart file for localized MOS", &
print_level=high_print_level, add_last=add_last_numeric, filename="")
CALL section_add_subsection(section, print_key)
CALL section_release(print_key)
END SUBROUTINE print_wanniers
! **************************************************************************************************
!> \brief Create the print dft section
!> \param section the section to create
!> \author teo
! **************************************************************************************************
SUBROUTINE create_print_dft_section(section)
TYPE(section_type), POINTER :: section
CHARACTER(len=*), PARAMETER :: routineN = 'create_print_dft_section', &
routineP = moduleN//':'//routineN
TYPE(keyword_type), POINTER :: keyword
TYPE(section_type), POINTER :: print_key, sub_print_key, subsection
CPASSERT(.NOT. ASSOCIATED(section))
CALL section_create(section, name="PRINT", &
description="Section of possible print options in DFT code.", &
n_keywords=0, n_subsections=1, repeats=.FALSE.)
NULLIFY (print_key, keyword, subsection)
CALL cp_print_key_section_create(print_key, "PROGRAM_BANNER", &
description="Controls the printing of the banner of the MM program", &
print_level=silent_print_level, filename="__STD_OUT__")
CALL section_add_subsection(section, print_key)
CALL section_release(print_key)
CALL cp_print_key_section_create(print_key, "BASIS_SET_FILE", &
description="Controls the printing of a file with all basis sets used.", &
print_level=high_print_level, filename="LOCAL_BASIS_SETS")
CALL section_add_subsection(section, print_key)
CALL section_release(print_key)
CALL cp_print_key_section_create(print_key, "KINETIC_ENERGY", &
description="Controls the printing of the kinetic energy", &
print_level=high_print_level, filename="__STD_OUT__")
CALL section_add_subsection(section, print_key)
CALL section_release(print_key)
CALL cp_print_key_section_create(print_key, "DERIVATIVES", &
description="Print all derivatives after the DFT calculation", &
print_level=high_print_level, filename="__STD_OUT__")
CALL keyword_create(keyword=keyword, &
name="ndigits", &
description="Specify the number of digits used to print derivatives", &
default_i_val=6)
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
CALL section_add_subsection(section, print_key)
CALL section_release(print_key)
CALL cp_print_key_section_create(print_key_section=print_key, &
name="neighbor_lists", &
description="Controls the printing of the neighbor lists", &
print_level=debug_print_level, filename="", unit_str="angstrom")
CALL keyword_create(keyword=keyword, &
name="sab_orb", &
description="Activates the printing of the orbital "// &
"orbital neighbor lists, "// &
"i.e. the overlap neighbor lists", &
default_l_val=.FALSE., &
lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword=keyword, &
name="sab_aux_fit", &
description="Activates the printing of the orbital "// &
"orbital neighbor lists wavefunction fitting basis, "// &
"i.e. the overlap neighbor lists", &
default_l_val=.FALSE., &
lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword=keyword, &
name="sab_aux_fit_vs_orb", &
description="Activates the printing of the orbital "// &
"orbital mixed neighbor lists of wavefunction fitting basis, "// &
"and the orbital basis, i.e. the overlap neighbor lists", &
default_l_val=.FALSE., &
lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword=keyword, &
name="sab_scp", &
description="Activates the printing of the vdW SCP "// &
"neighbor lists ", &
default_l_val=.FALSE., &
lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword=keyword, &
name="sab_vdw", &
description="Activates the printing of the vdW "// &
"neighbor lists (from DFT, DFTB, SE), "// &
"i.e. the dispersion neighbor lists", &
default_l_val=.FALSE., &
lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword=keyword, &
name="sab_cn", &
description="Activates the printing of the "// &
"neighbor lists used for coordination numbers in vdW DFT-D3", &
default_l_val=.FALSE., &
lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword=keyword, &
name="sac_ae", &
description="Activates the printing of the orbital "// &
"nuclear attraction neighbor lists (erfc potential)", &
default_l_val=.FALSE., &
lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword=keyword, &
name="sac_ppl", &
description="Activates the printing of the orbital "// &
"GTH-PPL neighbor lists (local part of the "// &
"Goedecker-Teter-Hutter pseudo potentials)", &
default_l_val=.FALSE., &
lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword=keyword, &
name="sap_ppnl", &
description="Activates the printing of the orbital "// &
"GTH-PPNL neighbor lists (non-local part of the"// &
"Goedecker-Teter-Hutter pseudo potentials)", &
default_l_val=.FALSE., &
lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword=keyword, &
name="sap_oce", &
description="Activates the printing of the orbital "// &
"PAW-projector neighbor lists (only GAPW)", &
default_l_val=.FALSE., &
lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword=keyword, &
name="sab_se", &
description="Activates the printing of the two-center "// &
"neighbor lists for Coulomb type interactions in NDDO ", &
default_l_val=.FALSE., &
lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword=keyword, &
name="sab_lrc", &
description="Activates the printing of the long-range SE correction "// &
"neighbor lists (only when doing long-range SE with integral scheme KDSO and KDSO-d)", &
default_l_val=.FALSE., lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword=keyword, &
name="sab_tbe", &
description="Activates the printing of the DFTB Ewald "// &
"neighbor lists ", &
default_l_val=.FALSE., &
lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword=keyword, &
name="sab_core", &
description="Activates the printing of core interaction "// &
"neighbor lists ", &
default_l_val=.FALSE., &
lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword=keyword, &
name="soo_list", &
description="Activates the printing of RI orbital-orbital "// &
"neighbor lists ", &
default_l_val=.FALSE., &
lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword=keyword, &
name="sip_list", &
description="Activates the printing of RI basis-projector interaction "// &
"neighbor lists ", &
default_l_val=.FALSE., &
lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
CALL section_add_subsection(section, print_key)
CALL section_release(print_key)
CALL cp_print_key_section_create(print_key, "SUBCELL", &
description="Activates the printing of the subcells used for the"// &
"generation of neighbor lists.", unit_str="angstrom", &
print_level=high_print_level, filename="__STD_OUT__")
CALL section_add_subsection(section, print_key)
CALL section_release(print_key)
CALL cp_print_key_section_create(print_key, "AO_MATRICES", &
description="Controls the printing of the ao (i.e. contracted gaussian) matrices (debug).", &
print_level=debug_print_level, filename="__STD_OUT__")
CALL keyword_create(keyword=keyword, name="OMIT_HEADERS", &
description="Print only the matrix data, not the row and column headers", &
default_l_val=.FALSE., lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword=keyword, name="NDIGITS", &
description="Specify the number of digits used to print the AO matrices", &
default_i_val=6)
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="CORE_HAMILTONIAN", &
description="If the printkey is activated controls the printing of the hamiltonian matrix", &
default_l_val=.FALSE., lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="DENSITY", &
description="If the printkey is activated controls the printing of the density (P) matrix", &
default_l_val=.FALSE., lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="KINETIC_ENERGY", &
description="If the printkey is activated controls the printing of the kinetic energy matrix", &
default_l_val=.FALSE., lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="KOHN_SHAM_MATRIX", &
description="If the printkey is activated controls the printing of the kohn-sham matrix", &
default_l_val=.FALSE., lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
CALL keyword_create( &
keyword, name="MATRIX_VXC", &
description="If the printkey is activated compute and print the matrix of the exchange and correlation potential."// &
"Only the GGA part for GPW is printed", &
default_l_val=.FALSE., lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="ORTHO", &
description="If the printkey is activated controls the printing of the orthogonalization matrix", &
default_l_val=.FALSE., lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="OVERLAP", &
description="If the printkey is activated controls the printing of the overlap matrix", &
default_l_val=.FALSE., lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="COMMUTATOR_HR", &
description="Controls the printing of the [H,r] commutator matrix", &
default_l_val=.FALSE., lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="FERMI_CONTACT", &
description="If the printkey is activated controls the printing of the Fermi contact matrix", &
default_l_val=.FALSE., lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
CALL keyword_create( &
keyword, name="PSO", &
description="If the printkey is activated controls the printing of the paramagnetic spin-orbit matrices", &
default_l_val=.FALSE., lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
CALL keyword_create( &
keyword, name="EFG", &
description="If the printkey is activated controls the printing of the electric field gradient matrices", &
default_l_val=.FALSE., lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="POTENTIAL_ENERGY", &
description="If the printkey is activated controls the printing of the potential energy matrix", &
default_l_val=.FALSE., lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="OCE_HARD", &
description="If the printkey is activated controls the printing of the OCE HARD matrix", &
default_l_val=.FALSE., lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="OCE_SOFT", &
description="If the printkey is activated controls the printing of the OCE SOFT matrix", &
default_l_val=.FALSE., lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="W_MATRIX", &
description="If the printkey is activated controls the printing of the w matrix", &
default_l_val=.FALSE., lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="W_MATRIX_AUX_FIT", &
description="If the printkey is activated controls the printing of the w matrix", &
default_l_val=.FALSE., lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="DERIVATIVES", &
description="If the printkey is activated controls the printing "// &
"of derivatives (for the matrixes that support this)", &
default_l_val=.FALSE., lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
CALL section_add_subsection(section, print_key)
CALL section_release(print_key)
CALL cp_print_key_section_create( &
print_key, "MO", &
description="Controls the printing of the molecular orbitals. "// &
"Note that this is only functional with diagonalization based methods, in particular not with OT (see MO_CUBES)", &
print_level=high_print_level, filename="__STD_OUT__")
CALL keyword_create(keyword, name="Cartesian", &
description="If the printkey is activated controls the printing of the mo in the cartesian basis", &
default_l_val=.FALSE., lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="EIGENVALUES", variants=s2a("EIGVALS"), &
description="If the printkey is activated controls the printing of the eigenvalues of the mos", &
default_l_val=.FALSE., lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="EIGENVECTORS", variants=s2a("EIGVECS"), &
description="If the printkey is activated controls the printing of the eigenvectors of the mos", &
default_l_val=.FALSE., lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="OCCUPATION_NUMBERS", variants=s2a("OCCNUMS"), &
description="If the printkey is activated controls the printing of the occupation numbers of the mos", &
default_l_val=.FALSE., lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword=keyword, name="NDIGITS", &
description="Specify the number of digits used to print the MO eigenvalues and occupation numbers", &
default_i_val=6)
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, &
name="MO_INDEX_RANGE", &
variants=s2a("MO_RANGE", "RANGE"), &
description="Allows to print only a subset of the MO eigenvectors or eigenvalues. "// &
"The indices of the first and the last MO have to be specified", &
repeats=.FALSE., &
n_var=2, &
type_of_var=integer_t, &
default_i_vals=(/0, 0/), &
usage="MO_INDEX_RANGE 10 15")
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
CALL section_add_subsection(section, print_key)
CALL section_release(print_key)
CALL create_mo_cubes_section(print_key)
CALL section_add_subsection(section, print_key)
CALL section_release(print_key)
CALL create_stm_section(print_key)
CALL section_add_subsection(section, print_key)
CALL section_release(print_key)
CALL create_wfn_mix_section(subsection)
CALL section_add_subsection(section, subsection)
CALL section_release(subsection)
CALL create_active_space_section(subsection)
CALL section_add_subsection(section, subsection)
CALL section_release(subsection)
CALL section_create(subsection, name="GAPW", &
description="Controls the printing of some gapw related information (debug).", &
n_keywords=0, n_subsections=1, repeats=.FALSE.)
CALL cp_print_key_section_create(print_key, "projectors", &
description="If the printkey is activated controls if information on"// &
" the projectors is printed.", &
print_level=debug_print_level, filename="__STD_OUT__")
CALL section_add_subsection(subsection, print_key)
CALL section_release(print_key)
CALL cp_print_key_section_create(print_key, "rho0_information", &
description="If the printkey is activated controls if information on rho0 is printed.", &
print_level=debug_print_level, filename="__STD_OUT__", unit_str="angstrom")
CALL section_add_subsection(subsection, print_key)
CALL section_release(print_key)
CALL section_add_subsection(section, subsection)
CALL section_release(subsection)
CALL cp_print_key_section_create(print_key, "dft_control_parameters", &
description="Controls the printing of dft control parameters.", &
print_level=medium_print_level, filename="__STD_OUT__")
CALL section_add_subsection(section, print_key)
CALL section_release(print_key)
CALL cp_print_key_section_create(print_key, "KPOINTS", &
description="Controls the printing of kpoint information.", &
print_level=medium_print_level, filename="__STD_OUT__")
CALL section_add_subsection(section, print_key)
CALL section_release(print_key)
NULLIFY (subsection)
CALL create_bandstructure_section(subsection)
CALL section_add_subsection(section, subsection)
CALL section_release(subsection)
CALL cp_print_key_section_create(print_key, "OVERLAP_CONDITION", &
description="Controls the the checking and printing of and estimate "// &
"of the overlap matrix condition number", &
print_level=debug_print_level, filename="__STD_OUT__")
CALL keyword_create(keyword, name="1-NORM", &
description="Calculate an estimate of the 1-norm condition number", &
default_l_val=.TRUE., lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="DIAGONALIZATION", &
description="Calculate the 1- and 2-norm condition numbers using diagonalization", &
default_l_val=.FALSE., lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="ARNOLDI", &
description="Calculate the 2-norm condition number using the Arnoldi code (may not be reliable)", &
default_l_val=.FALSE., lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
CALL section_add_subsection(section, print_key)
CALL section_release(print_key)
CALL cp_print_key_section_create(print_key, &
name="E_DENSITY_CUBE", &
description="Controls the printing of cube files with "// &
"the electronic density and, for LSD "// &
"calculations, the spin density", &
print_level=high_print_level, filename="")
CALL keyword_create(keyword, name="stride", &
description="The stride (X,Y,Z) used to write the cube file "// &
"(larger values result in smaller cube files). You can provide 3 numbers (for X,Y,Z) or"// &
" 1 number valid for all components.", &
usage="STRIDE 2 2 2", n_var=-1, default_i_vals=(/2, 2, 2/), type_of_var=integer_t)
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, &
name="TOTAL_DENSITY", &
description="Print the total electronic density in the case "// &
"of a GAPW run. This keyword has only an effect, "// &
"if PAW atoms are present. The default is to print "// &
"only the soft part of the electronic density and "// &
"to ignore the hard part. NOTE: The total density in "// &
"real space might exhibit unphysical features like "// &
"spikes due to the finite and thus truncated g vector "// &
"expansion", &
usage="TOTAL_DENSITY {logical}", &
repeats=.FALSE., &
n_var=1, &
default_l_val=.FALSE., &
lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="APPEND", &
description="append the cube files when they already exist", &
default_l_val=.FALSE., lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="XRD_INTERFACE", &
description="It activates the print out of exponents and coefficients for the "// &
" Gaussian expansion of the core densities, based on atom calculations for each kind."// &
" The resulting core dansities are needed to compute the form factors."// &
" If GAPW the local densities are also given in terms of a Gaussian expansion,"// &
" by fitting the difference between local-fhard and local-soft density for each atom."// &
" In this case the keyword TOTAL_DENSITY is set to FALSE", &
default_l_val=.FALSE., lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="NGAUSS", &
description="Number of Gaussian functions used in the expansion of atomic (core) density", &
usage="NGAUSS 10", n_var=1, default_i_val=12, type_of_var=integer_t)
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
CALL section_add_subsection(section, print_key)
CALL section_release(print_key)
CALL cp_print_key_section_create(print_key, "tot_density_cube", &
description="Controls printing of cube files with "// &
"the total density (electrons+atomic core). Note that "// &
"the value of the total density is positive where the "// &
"electron density dominates and negative where the core is.", &
print_level=high_print_level, filename="")
CALL keyword_create(keyword, name="stride", &
description="The stride (X,Y,Z) used to write the cube file "// &
"(larger values result in smaller cube files). You can provide 3 numbers (for X,Y,Z) or"// &
" 1 number valid for all components.", &
usage="STRIDE 2 2 2", n_var=-1, default_i_vals=(/2, 2, 2/), type_of_var=integer_t)
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="APPEND", &
description="append the cube files when they already exist", &
default_l_val=.FALSE., lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
CALL section_add_subsection(section, print_key)
CALL section_release(print_key)
CALL cp_print_key_section_create(print_key, "v_hartree_cube", &
description="Controls the printing of a cube file with eletrostatic "// &
" potential generated by the total density (electrons+ions). It is "// &
" valid only for QS with GPW formalism."// &
" Note that by convention the potential has opposite sign than the expected physical one.", &
print_level=high_print_level, filename="")
CALL keyword_create(keyword, name="stride", &
description="The stride (X,Y,Z) used to write the cube file "// &
"(larger values result in smaller cube files). You can provide 3 numbers (for X,Y,Z) or"// &
" 1 number valid for all components.", &
usage="STRIDE 2 2 2", n_var=-1, default_i_vals=(/2, 2, 2/), type_of_var=integer_t)
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="APPEND", &
description="append the cube files when they already exist", &
default_l_val=.FALSE., lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
CALL section_add_subsection(section, print_key)
CALL section_release(print_key)
CALL cp_print_key_section_create(print_key, "external_potential_cube", &
description="Controls the printing of a cube file with external "// &
" potential from the DFT%EXTERNAL_POTENTIAL section only.", &
print_level=high_print_level, filename="")
CALL keyword_create(keyword, name="stride", &
description="The stride (X,Y,Z) used to write the cube file "// &
"(larger values result in smaller cube files). You can provide 3 numbers (for X,Y,Z) or"// &
" 1 number valid for all components.", &
usage="STRIDE 2 2 2", n_var=-1, default_i_vals=(/2, 2, 2/), type_of_var=integer_t)
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="APPEND", &
description="append the cube files when they already exist", &
default_l_val=.FALSE., lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
CALL section_add_subsection(section, print_key)
CALL section_release(print_key)
! cube files for data generated by the implicit (generalized) Poisson solver
CALL create_implicit_psolver_section(subsection)
CALL section_add_subsection(section, subsection)
CALL section_release(subsection)
! ZMP adding the print section for the v_xc cube
CALL cp_print_key_section_create(print_key, "v_xc_cube", &
description="Controls the printing of a cube file with xc "// &
" potential generated by the ZMP method (for the moment). It is "// &
" valid only for QS with GPW formalism .", &
print_level=high_print_level, filename="")
CALL keyword_create(keyword, name="stride", &
description="The stride (X,Y,Z) used to write the cube file "// &
"(larger values result in smaller cube files). You can provide 3 numbers (for X,Y,Z) or"// &
" 1 number valid for all components.", &
usage="STRIDE 2 2 2", n_var=-1, default_i_vals=(/2, 2, 2/), type_of_var=integer_t)
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="APPEND", &
description="append the cube files when they already exist", &
default_l_val=.FALSE., lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
CALL section_add_subsection(section, print_key)
CALL section_release(print_key)
CALL cp_print_key_section_create(print_key, "efield_cube", &
description="Controls the printing of cube files with electric "// &
" field generated by the total density (electrons+ions). It is "// &
" valid only for QS with GPW formalism .", &
print_level=high_print_level, filename="")
CALL keyword_create(keyword, name="stride", &
description="The stride (X,Y,Z) used to write the cube file "// &
"(larger values result in smaller cube files). You can provide 3 numbers (for X,Y,Z) or"// &
" 1 number valid for all components.", &
usage="STRIDE 2 2 2", n_var=-1, default_i_vals=(/2, 2, 2/), type_of_var=integer_t)
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="APPEND", &
description="append the cube files when they already exist", &
default_l_val=.FALSE., lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
CALL section_add_subsection(section, print_key)
CALL section_release(print_key)
CALL cp_print_key_section_create(print_key, "ELF_CUBE", &
description="Controls printing of cube files with "// &
"the electron localization function (ELF). Note that "// &
"the value of ELF is defined between 0 and 1: Pauli kinetic energy density normalized "// &
" by the kinetic energy density of a uniform el. gas of same density.", &
print_level=high_print_level, filename="")
CALL keyword_create(keyword, name="stride", &
description="The stride (X,Y,Z) used to write the cube file "// &
"(larger values result in smaller cube files). You can provide 3 numbers (for X,Y,Z) or"// &
" 1 number valid for all components.", &
usage="STRIDE 2 2 2", n_var=-1, default_i_vals=(/2, 2, 2/), type_of_var=integer_t)
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="APPEND", &
description="append the cube files when they already exist", &
default_l_val=.FALSE., lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="density_cutoff", &
description=" ", &
usage="density_cutoff 0.0001", &
repeats=.FALSE., &
n_var=1, &
type_of_var=real_t, &
default_r_val=1.0e-10_dp)
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
CALL section_add_subsection(section, print_key)
CALL section_release(print_key)
CALL create_pdos_section(print_key)
CALL section_add_subsection(section, print_key)
CALL section_release(print_key)
CALL create_wannier_section(print_key)
CALL section_add_subsection(section, print_key)
CALL section_release(print_key)
!
!Printing of Moments
CALL create_dipoles_section(print_key, "MOMENTS", high_print_level)
CALL keyword_create( &
keyword=keyword, &
name="MAX_MOMENT", &
description="Maximum moment to be calculated. Values higher than 1 not implemented under periodic boundaries.", &
usage="MAX_MOMENT {integer}", &
repeats=.FALSE., &
n_var=1, &
type_of_var=integer_t, &
default_i_val=1)
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword=keyword, &
name="MAGNETIC", &
description="Calculate also magnetic moments, only implemented without periodic boundaries", &
usage="MAGNETIC yes", &
repeats=.FALSE., &
n_var=1, &
default_l_val=.FALSE., &
lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
CALL section_add_subsection(section, print_key)
CALL section_release(print_key)
! Mulliken population analysis
CALL cp_print_key_section_create(print_key, "MULLIKEN", &
description="Controls the printing of the Mulliken (spin) population analysis", &
print_level=medium_print_level, filename="__STD_OUT__", &
common_iter_levels=1)
CALL keyword_create( &
keyword=keyword, &
name="PRINT_GOP", &
description="Print the gross orbital populations (GOP) in addition to the gross atomic populations (GAP) "// &
"and net charges", &
usage="PRINT_GOP yes", &
repeats=.FALSE., &
n_var=1, &
default_l_val=.FALSE., &
lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
CALL keyword_create( &
keyword=keyword, &
name="PRINT_ALL", &
description="Print all information including the full net AO and overlap population matrix", &
usage="PRINT_ALL yes", &
repeats=.FALSE., &
n_var=1, &
default_l_val=.FALSE., &
lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
CALL section_add_subsection(section, print_key)
CALL section_release(print_key)
! Lowdin population analysis (fairly expensive to compute, so only at high)
CALL cp_print_key_section_create(print_key, "LOWDIN", &
description="Controls the printing of the Lowdin (spin) population analysis", &
print_level=high_print_level, filename="__STD_OUT__", &
common_iter_levels=1)
CALL keyword_create( &
keyword=keyword, &
name="PRINT_GOP", &
description="Print the orbital populations in addition to the atomic populations and net charges", &
usage="PRINT_GOP yes", &
repeats=.FALSE., &
n_var=1, &
default_l_val=.FALSE., &
lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
CALL keyword_create( &
keyword=keyword, &
name="PRINT_ALL", &
description="Print all information including the full symmetrically orthogonalised density matrix", &
usage="PRINT_ALL yes", &
repeats=.FALSE., &
n_var=1, &
default_l_val=.FALSE., &
lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
CALL section_add_subsection(section, print_key)
CALL section_release(print_key)
! Hirshfeld population analysis
CALL cp_print_key_section_create(print_key, "HIRSHFELD", &
description="Controls the printing of the Hirshfeld (spin) population analysis", &
print_level=medium_print_level, filename="__STD_OUT__", &
common_iter_levels=1)
CALL keyword_create(keyword=keyword, name="SELF_CONSISTENT", &
description="Calculate charges from the Hirscheld-I (self_consistent) method."// &
" This scales only the full shape function, not the added charge as in the original scheme.", &
usage="SELF_CONSISTENT yes", repeats=.FALSE., n_var=1, &
default_l_val=.FALSE., lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword=keyword, name="SHAPE_FUNCTION", &
description="Type of shape function used for Hirshfeld partitioning.", &
usage="SHAPE_FUNCTION {Gaussian,Density}", repeats=.FALSE., n_var=1, &
default_i_val=shape_function_gaussian, &
enum_c_vals=s2a("GAUSSIAN", "DENSITY"), &
enum_desc=s2a("Single Gaussian with Colvalent radius", &
"Atomic density expanded in multiple Gaussians"), &
enum_i_vals=(/shape_function_gaussian, shape_function_density/))
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword=keyword, name="REFERENCE_CHARGE", &
description="Charge of atomic partitioning function for Hirshfeld method.", &
usage="REFERENCE_CHARGE {Atomic,Mulliken}", repeats=.FALSE., n_var=1, &
default_i_val=ref_charge_atomic, &
enum_c_vals=s2a("ATOMIC", "MULLIKEN"), &
enum_desc=s2a("Use atomic core charges", "Calculate Mulliken charges"), &
enum_i_vals=(/ref_charge_atomic, ref_charge_mulliken/))
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="USER_RADIUS", &
description="Use user defined radii to generate Gaussians."// &
" These radii are defined by the keyword ATOMIC_RADII", &
usage="USER_RADIUS yes", repeats=.FALSE., n_var=1, &
default_l_val=.FALSE., lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="ATOMIC_RADII", &
description="Defines custom radii to setup the spherical Gaussians.", &
usage="ATOMIC_RADII {real} {real} {real}", repeats=.FALSE., &
unit_str="angstrom", &
type_of_var=real_t, n_var=-1)
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
CALL section_add_subsection(section, print_key)
CALL section_release(print_key)
! MAO (modified atomic orbital) analysis
CALL cp_print_key_section_create(print_key, "MAO_ANALYSIS", &
description="Controls the printing of the MAO (modified atomic orbital) analysis", &
print_level=debug_print_level, filename="__STD_OUT__", &
common_iter_levels=1, &
citations=(/Heinzmann1976, Ehrhardt1985/))
CALL keyword_create(keyword=keyword, name="EPS_FILTER", &
description="Threshold for matrix elements in MAO determination.", &
usage="EPS_FILTER reps", repeats=.FALSE., n_var=1, &
default_r_val=1.e-8_dp, type_of_var=real_t)
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword=keyword, name="REFERENCE_BASIS", &
description="Basis set used to construct MAO's.", &
usage="REFERENCE_BASIS {ORBITAL,PRIMITIVE,EXTERNAL}", repeats=.FALSE., n_var=1, &
default_i_val=mao_basis_orb, &
enum_c_vals=s2a("ORBITAL", "PRIMITIVE", "EXTERNAL"), &
enum_desc=s2a("Use standard orbital basis set", "Construct basis from primitives of the orbital basis", &
"Read external basis (MAO)"), &
enum_i_vals=(/mao_basis_orb, mao_basis_prim, mao_basis_ext/))
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword=keyword, name="PRINT_BASIS", &
description="Print out MAO reference basis.", &
usage="PRINT_BASIS {logical}", repeats=.FALSE., n_var=1, &
default_l_val=.FALSE., lone_keyword_l_val=.TRUE., type_of_var=logical_t)
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword=keyword, name="EPS_GRAD", &
description="Threshold for gradient in MAO optimization.", &
usage="EPS_GRAD reps", repeats=.FALSE., n_var=1, &
default_r_val=1.e-4_dp, type_of_var=real_t)
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword=keyword, name="EPS_FUNCTION", &
description="Threshold for electron defect in MAO optimization.", &
usage="EPS_FUNCTION feps", repeats=.FALSE., n_var=1, &
default_r_val=1.e-3_dp, type_of_var=real_t)
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword=keyword, name="MAX_ITER", &
description="Maximum allowed iterations for MAO optimization.", &
usage="MAX_ITER iter", repeats=.FALSE., n_var=1, &
default_i_val=0, type_of_var=integer_t)
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword=keyword, name="NEGLECT_ABC", &
description="Neglect 3 atom terms in MAO analysis.", &
usage="NEGLECT_ABC {logical}", repeats=.FALSE., n_var=1, &
default_l_val=.TRUE., lone_keyword_l_val=.TRUE., type_of_var=logical_t)
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword=keyword, name="AB_THRESHOLD", &
description="Threshold for printing of AB shared electron numbers.", &
usage="AB_THRESHOLD thr", repeats=.FALSE., n_var=1, &
default_r_val=1.e-2_dp, type_of_var=real_t)
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword=keyword, name="ABC_THRESHOLD", &
description="Threshold for printing of ABC shared electron numbers.", &
usage="ABC_THRESHOLD thr", repeats=.FALSE., n_var=1, &
default_r_val=1.e-5_dp, type_of_var=real_t)
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword=keyword, name="ANALYZE_UNASSIGNED_CHARGE", &
description="Calculate atomic contributions to the unassigned charge.", &
usage="ANALYZE_UNASSIGNED_CHARGE {logical}", repeats=.FALSE., n_var=1, &
default_l_val=.FALSE., lone_keyword_l_val=.TRUE., type_of_var=logical_t)
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
CALL section_add_subsection(section, print_key)
CALL section_release(print_key)
!Minimal localized basis analysis
CALL cp_print_key_section_create(print_key, "MINBAS_ANALYSIS", &
description="Controls the printing of the minimal localized basis analysis", &
print_level=debug_print_level, filename="__STD_OUT__", &
common_iter_levels=1, &
citations=(/Lu2004/))
CALL keyword_create(keyword=keyword, name="EPS_FILTER", &
description="Threshold for matrix elements in basis determination.", &
usage="EPS_FILTER reps", repeats=.FALSE., n_var=1, &
default_r_val=1.e-8_dp, type_of_var=real_t)
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword=keyword, name="FULL_ORTHOGONALIZATION", &
description="Orthogonalize the localized minimal basis.", &
usage="FULL_ORTHOGONALIZATION {logical}", repeats=.FALSE., n_var=1, &
default_l_val=.FALSE., lone_keyword_l_val=.TRUE., type_of_var=logical_t)
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword=keyword, name="BOND_ORDER", &
description="Calculate Mayer Bond Orders.", &
usage="BOND_ORDER {logical}", repeats=.FALSE., n_var=1, &
default_l_val=.FALSE., lone_keyword_l_val=.TRUE., type_of_var=logical_t)
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
NULLIFY (sub_print_key)
CALL cp_print_key_section_create(sub_print_key, "MINBAS_CUBE", &
description="Write the minimal basis on Cube files.", &
print_level=debug_print_level+1, add_last=add_last_numeric, filename="MINBAS")
CALL keyword_create(keyword, name="STRIDE", &
description="The stride (X,Y,Z) used to write the cube file "// &
"(larger values result in smaller cube files). You can provide 3 numbers (for X,Y,Z) or"// &
" 1 number valid for all components.", &
usage="STRIDE 2 2 2", n_var=-1, default_i_vals=(/2, 2, 2/), type_of_var=integer_t)
CALL section_add_keyword(sub_print_key, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="ATOM_LIST", &
description="Indexes of the atoms minimal basis to be printed as cube files"// &
"This keyword can be repeated several times"// &
"(useful if you have to specify many indexes).", &
usage="CUBES_LIST 1 2", &
n_var=-1, type_of_var=integer_t, repeats=.TRUE.)
CALL section_add_keyword(sub_print_key, keyword)
CALL keyword_release(keyword)
CALL section_add_subsection(print_key, sub_print_key)
CALL section_release(sub_print_key)
NULLIFY (sub_print_key)
CALL cp_print_key_section_create(sub_print_key, "MOS_MOLDEN", &
description="Write the minimal basis in Molden file format, for visualisation.", &
print_level=debug_print_level+1, add_last=add_last_numeric, filename="MINBAS")
CALL keyword_create(keyword, name="NDIGITS", &
description="Specifies the number of signficiant digits retained. 3 is OK for visualization.", &
usage="NDIGITS {int}", &
default_i_val=3)
CALL section_add_keyword(sub_print_key, keyword)
CALL keyword_release(keyword)
CALL section_add_subsection(print_key, sub_print_key)
CALL section_release(sub_print_key)
CALL section_add_subsection(section, print_key)
CALL section_release(print_key)
!DOS from density matrix
CALL cp_print_key_section_create(print_key, "ENERGY_WINDOWS", &
description="Controls the printing of the DOS from the density matrix. "// &
"This allows the calculation of the DOS even in density matrix based"// &
"REAL_TIME_PROPAGATION and LS_SCF. "// &
"However, it requires a cubically scaling diagonalization of the Hamiltonian. "// &
"Hartree-Fock NYI, values will be wrong. "// &
"Careful, the orbitals in rtp/emd are not actually eigenstates of the Hamiltonian."// &
"Assumes absence of spin polarization (so far).", &
print_level=high_print_level, common_iter_levels=3, &
each_iter_names=s2a("MD"), each_iter_values=(/100/), &
add_last=add_last_numeric, filename="energy-windows")
CALL keyword_create(keyword, name="N_WINDOWS", &
description="The number of energy windows.", &
usage="N_WINDOWS 200", &
default_i_val=100)
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="EPS_FILTER", &
description="Filtering threshold for sparse matrix operations.", &
usage="EPS_FILTER 1.0E-6", &
default_r_val=1.0E-14_dp)
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="RESTRICT_RANGE", &
description="Restricts the energy windows to states close to the fermi level", &
usage="RESTRICT_RANGE .TRUE.", &
default_l_val=.FALSE., lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="RANGE", &
description="If the RESTRICT_RANGE keyword is set, then all energy widnows will"// &
" be placed in an interval from from the fermi level minus to the fermi level plus this keyword", &
usage="RANGE 1", &
default_r_val=1.0_dp)
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="PRINT_CUBES", &
description="Print the energy windows to cube files", &
usage="DENSITY_PROPAGATION .TRUE.", &
default_l_val=.FALSE., lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="STRIDE", &
description="The stride (X,Y,Z) used to write the energy windows cube files (if enabled) "// &
"(larger values result in smaller cube files). You can provide 3 numbers (for X,Y,Z) or"// &
" 1 number valid for all components.", &
usage="STRIDE 2 2 2", n_var=-1, default_i_vals=(/2, 2, 2/), type_of_var=integer_t)
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
CALL section_add_subsection(section, print_key)
CALL section_release(print_key)
! Hamiltonian in CSR format
CALL cp_print_key_section_create(print_key, "KS_CSR_WRITE", &
description="Write the KS matrix in CSR format into a file.", &
print_level=debug_print_level, filename="")
CALL keyword_create(keyword=keyword, name="Threshold", &
description="Threshold on the absolute value of the elements to be printed out. "// &
"In CP2K all the elements in a (atomic) matrix block are considered non-zero, "// &
"if the block contains at least one non-zero element.", &
usage="THRESHOLD {real}", &
repeats=.FALSE., &
default_r_val=0.0_dp)
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword=keyword, name="Upper_triangular", &
description="Print only the upper triangular part of the matrix. ", &
usage="UPPER_TRIANGULAR {logical}", &
repeats=.FALSE., &
default_l_val=.FALSE., &
lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword=keyword, name="Binary", &
description="Whether or not to generate the file in a binary format. ", &
usage="BINARY {logical}", &
repeats=.FALSE., &
default_l_val=.FALSE., &
lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
CALL section_add_subsection(section, print_key)
CALL section_release(print_key)
! Overlap in CSR format
CALL cp_print_key_section_create(print_key, "S_CSR_WRITE", &
description="Write the overlap matrix in CSR format into a file.", &
print_level=debug_print_level, filename="")
CALL keyword_create(keyword=keyword, name="Threshold", &
description="Threshold on the absolute value of the elements to be printed out. "// &
"In CP2K all the elements in a (atomic) matrix block are considered non-zero, "// &
"if the block contains at least one non-zero element.", &
usage="THRESHOLD {real}", &
repeats=.FALSE., &
default_r_val=0.0_dp)
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword=keyword, name="Upper_triangular", &
description="Print only the upper triangular part of the matrix. ", &
usage="UPPER_TRIANGULAR {logical}", &
repeats=.FALSE., &
default_l_val=.FALSE., &
lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword=keyword, name="Binary", &
description="Whether or not to generate the file in a binary format. ", &
usage="BINARY {logical}", &
repeats=.FALSE., &
default_l_val=.FALSE., &
lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
CALL section_add_subsection(section, print_key)
CALL section_release(print_key)
! interaction adjacency matrix
CALL cp_print_key_section_create(print_key, "ADJMAT_WRITE", &
description="Writes an (upper-triangular) adjacency matrix indicating the "// &
"interaction between atoms (according to overlapping basis functions). The "// &
"columns are: iatom, jatom, ikind, jkind; where iatom and jatom are the atom "// &
"indices (based on the coordinate file), ikind and jkind are the atomic kinds "// &
"(indeces as shown in the ATOMIC KIND INFORMATION section of a CP2K output). ", &
print_level=debug_print_level, filename="")
CALL section_add_subsection(section, print_key)
CALL section_release(print_key)
! Xray diffraction
CALL cp_print_key_section_create( &
print_key_section=print_key, &
name="XRAY_DIFFRACTION_SPECTRUM", &
description="Calculate and print the coherent X-ray "// &
"diffraction spectrum", &
print_level=debug_print_level, &
filename="", &
citations=(/Krack2000, Krack2002/))
CALL keyword_create( &
keyword=keyword, &
name="Q_MAX", &
variants=(/"Q_MAXIMUM"/), &
description="Maximum Q value calculated for the spectrum", &
usage="Q_MAX {real}", &
repeats=.FALSE., &
n_var=1, &
type_of_var=real_t, &
default_r_val=cp_unit_to_cp2k(value=20.0_dp, &
unit_str="angstrom^-1"), &
unit_str="angstrom^-1")
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
CALL section_add_subsection(section, print_key)
CALL section_release(print_key)
CALL cp_print_key_section_create(print_key_section=print_key, &
name="ELECTRIC_FIELD_GRADIENT", &
description="Calculate and print the electric field gradients "// &
"at atomic positions", &
print_level=debug_print_level, &
filename="__STD_OUT__")
CALL keyword_create(keyword=keyword, &
name="INTERPOLATION", &
description="Use interpolation method from real space grid", &
usage="INTERPOLATION {logical}", &
repeats=.FALSE., &
n_var=1, &
default_l_val=.FALSE., lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword=keyword, &
name="GSPACE_SMOOTHING", &
description="Use a G-space smoothing function", &
usage="GSPACE_SMOOTHING cutoff {real}, width {real}", &
repeats=.FALSE., &
n_var=2, default_r_vals=(/-1._dp, -1._dp/), &
type_of_var=real_t)
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword=keyword, &
name="DEBUG", &
description="Print additional debug output", &
usage="DEBUG {logical}", &
repeats=.FALSE., &
n_var=1, &
default_l_val=.FALSE., lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
CALL create_gspace_interp_section(subsection)
CALL section_add_subsection(print_key, subsection)
CALL section_release(subsection)
CALL section_add_subsection(section, print_key)
CALL section_release(print_key)
CALL cp_print_key_section_create(print_key_section=print_key, &
name="BASIS_MOLOPT_QUANTITIES", &
description="Print the two quantities needed in the basis molopt generation:"// &
" total energy and condition number of the overlap matrix (S matrix)", &
print_level=debug_print_level, &
filename="__STD_OUT__")
CALL section_add_subsection(section, print_key)
CALL section_release(print_key)
CALL cp_print_key_section_create(print_key_section=print_key, &
name="HYPERFINE_COUPLING_TENSOR", &
description="Calculate and print the EPR hyperfine coupling tensor"// &
" at atomic positions", &
print_level=debug_print_level, &
filename="__STD_OUT__")
CALL keyword_create(keyword=keyword, &
name="INTERACTION_RADIUS", &
description="Radius of interaction for EPR hyperfine tensor calculation", &
usage="INTERACTION_RADIUS radius {real}", &
repeats=.FALSE., &
n_var=1, default_r_val=10._dp, &
type_of_var=real_t)
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
CALL section_add_subsection(section, print_key)
CALL section_release(print_key)
CALL cp_print_key_section_create(print_key_section=print_key, &
name="OPTIMIZE_LRI_BASIS", &
description="Optimize the exponents of the LRI basis set", &
print_level=low_print_level, &
filename="OPTIMIZED_LRI_BASIS")
CALL section_add_subsection(section, print_key)
CALL section_release(print_key)
CALL cp_print_key_section_create( &
print_key_section=print_key, &
name="PLUS_U", &
description="Controls the printing for the DFT+U methods", &
print_level=high_print_level, &
filename="__STD_OUT__", &
each_iter_names=s2a("QS_SCF"), &
each_iter_values=(/0/), &
citations=(/Dudarev1997, Dudarev1998/))
CALL section_add_subsection(section, print_key)
CALL section_release(print_key)
CALL cp_print_key_section_create( &
print_key_section=print_key, &
name="SCCS", &
description="Controls the printing for the SCCS models", &
print_level=high_print_level, &
filename="__STD_OUT__", &
each_iter_names=s2a("QS_SCF"), &
each_iter_values=(/0/), &
citations=(/Fattebert2002, Andreussi2012/))
NULLIFY (sub_print_key)
CALL cp_print_key_section_create( &
print_key_section=sub_print_key, &
name="DENSITY_GRADIENT", &
description="Controls the printing of the cube files with "// &
"the norm of the density gradient |∇ρ| "// &
"used by the SCCS model.", &
print_level=debug_print_level, &
filename="", &
each_iter_names=s2a("QS_SCF"), &
each_iter_values=(/0/))
CALL keyword_create(keyword, name="STRIDE", &
description="The stride (X,Y,Z) used to write the cube file "// &
"(larger values result in smaller cube files). You can provide 3 "// &
"numbers (for X,Y,Z) or 1 number valid for all components.", &
n_var=-1, &
default_i_vals=(/2, 2, 2/), &
type_of_var=integer_t, &
repeats=.FALSE.)
CALL section_add_keyword(sub_print_key, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="APPEND", &
description="Append the cube files when they already exist", &
default_l_val=.FALSE., &
lone_keyword_l_val=.TRUE., &
repeats=.FALSE.)
CALL section_add_keyword(sub_print_key, keyword)
CALL keyword_release(keyword)
CALL section_add_subsection(print_key, sub_print_key)
CALL section_release(sub_print_key)
CALL cp_print_key_section_create( &
print_key_section=sub_print_key, &
name="DIELECTRIC_FUNCTION", &
description="Controls the printing of the cube files with "// &
"the dielectric function used by the SCCS model. "// &
"This function determines the cavity formed by a solute in "// &
"a solvent and thus it can be used for the visualisaton of the cavity.", &
print_level=debug_print_level, &
filename="", &
each_iter_names=s2a("QS_SCF"), &
each_iter_values=(/0/), &
citations=(/Fattebert2002, Andreussi2012/))
CALL keyword_create(keyword, name="STRIDE", &
description="The stride (X,Y,Z) used to write the cube file "// &
"(larger values result in smaller cube files). You can provide 3 "// &
"numbers (for X,Y,Z) or 1 number valid for all components.", &
n_var=-1, &
default_i_vals=(/2, 2, 2/), &
type_of_var=integer_t, &
repeats=.FALSE.)
CALL section_add_keyword(sub_print_key, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="APPEND", &
description="Append the cube files when they already exist", &
default_l_val=.FALSE., &
lone_keyword_l_val=.TRUE., &
repeats=.FALSE.)
CALL section_add_keyword(sub_print_key, keyword)
CALL keyword_release(keyword)
CALL section_add_subsection(print_key, sub_print_key)
CALL section_release(sub_print_key)
CALL cp_print_key_section_create( &
print_key_section=sub_print_key, &
name="POLARISATION_POTENTIAL", &
description="Controls the printing of the cube files with the "// &
"polarisation potential φ<sup>pol</sup> used by the SCCS model with "// &
"total potential φ<sup>tot</sup> = φ<sup>sol</sup> + φ<sup>pol</sup>", &
print_level=debug_print_level, &
filename="", &
each_iter_names=s2a("QS_SCF"), &
each_iter_values=(/0/), &
citations=(/Fattebert2002, Andreussi2012/))
CALL keyword_create(keyword, name="STRIDE", &
description="The stride (X,Y,Z) used to write the cube file "// &
"(larger values result in smaller cube files). You can provide 3 "// &
"numbers (for X,Y,Z) or 1 number valid for all components.", &
n_var=-1, &
default_i_vals=(/2, 2, 2/), &
type_of_var=integer_t, &
repeats=.FALSE.)
CALL section_add_keyword(sub_print_key, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="APPEND", &
description="Append the cube files when they already exist", &
default_l_val=.FALSE., &
lone_keyword_l_val=.TRUE., &
repeats=.FALSE.)
CALL section_add_keyword(sub_print_key, keyword)
CALL keyword_release(keyword)
CALL section_add_subsection(print_key, sub_print_key)
CALL section_release(sub_print_key)
CALL section_add_subsection(section, print_key)
CALL section_release(print_key)
END SUBROUTINE create_print_dft_section
! **************************************************************************************************
!> \brief ...
!> \param section ...
!> \author JGH
! **************************************************************************************************
SUBROUTINE create_bandstructure_section(section)
TYPE(section_type), POINTER :: section
CHARACTER(len=*), PARAMETER :: routineN = 'create_bandstructure_section', &
routineP = moduleN//':'//routineN
TYPE(keyword_type), POINTER :: keyword
TYPE(section_type), POINTER :: subsection
CPASSERT(.NOT. ASSOCIATED(section))
CALL section_create(section, name="BAND_STRUCTURE", &
description="Specifies the k-points used in band structure calculation.", &
n_keywords=0, n_subsections=0, repeats=.FALSE.)
NULLIFY (keyword)
CALL keyword_create(keyword, name="FILE_NAME", &
description="File name used for band structure", &
usage="FILE_NAME <filename>", default_c_val="", &
type_of_var=char_t, n_var=1)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="ADDED_MOS", &
variants=(/"ADDED_BANDS"/), &
description="Number of MOs/Bands added to the Band Structure calculation.", &
default_i_val=0)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
NULLIFY (subsection)
CALL section_create(subsection, name="KPOINT_SET", &
description="Specifies a k-point line to be calculated.", &
n_keywords=0, n_subsections=0, repeats=.TRUE.)
! keywords
NULLIFY (keyword)
CALL keyword_create(keyword, name="SPECIAL_POINT", &
description="Name and coordinates of a special k-point", &
usage="SPECIAL_POINT GAMMA 0.0 0.0 0.0", n_var=-1, type_of_var=char_t, repeats=.TRUE.)
CALL section_add_keyword(subsection, keyword)
CALL keyword_release(keyword)
!
CALL keyword_create(keyword, name="NPOINTS", &
description="Number of k-points along the line.", &
default_i_val=0)
CALL section_add_keyword(subsection, keyword)
CALL keyword_release(keyword)
!
CALL keyword_create(keyword, name="UNITS", &
description="Special k-points are defined either in units"// &
" of reciprocal lattice vectors or in Cartesian coordinates in uints of 2Pi/len."// &
" B_VECTOR: in multiples of the reciprocal lattice vectors (b)."// &
" CART_ANGSTROM: In units of 2*Pi/Angstrom."// &
" CART_BOHR: In units of 2*Pi/Bohr.", &
usage="UNITS <value>", type_of_var=char_t, default_c_val="B_VECTOR")
CALL section_add_keyword(subsection, keyword)
CALL keyword_release(keyword)
!
CALL section_add_subsection(section, subsection)
CALL section_release(subsection)
END SUBROUTINE create_bandstructure_section
! **************************************************************************************************
!> \brief creates the input section for dealing with homo lumos, including dumping cubes
!> \param print_key ...
! **************************************************************************************************
SUBROUTINE create_mo_cubes_section(print_key)
TYPE(section_type), POINTER :: print_key
CHARACTER(len=*), PARAMETER :: routineN = 'create_mo_cubes_section', &
routineP = moduleN//':'//routineN
TYPE(keyword_type), POINTER :: keyword
NULLIFY (keyword)
CALL cp_print_key_section_create(print_key, "MO_CUBES", &
description="Controls the printing of cubes of the molecular orbitals.", &
print_level=high_print_level, filename="")
CALL keyword_create(keyword, name="stride", &
description="The stride (X,Y,Z) used to write the cube file "// &
"(larger values result in smaller cube files). You can provide 3 numbers (for X,Y,Z) or"// &
" 1 number valid for all components.", &
usage="STRIDE 2 2 2", n_var=-1, default_i_vals=(/2, 2, 2/), type_of_var=integer_t)
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="write_cube", &
description="If the MO cube file should be written. If false, the eigenvalues are still computed."// &
" Can also be useful in combination with STM calculations", &
default_l_val=.TRUE., lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="nlumo", &
description="If the printkey is activated controls the number of lumos"// &
" that are printed and dumped as a cube (-1=all)", &
default_i_val=0)
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
CALL keyword_create( &
keyword, name="nhomo", &
description="If the printkey is activated controls the number of homos that dumped as a cube (-1=all),"// &
" eigenvalues are always all dumped", &
default_i_val=1)
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
CALL keyword_create( &
keyword, name="homo_list", &
description="If the printkey is activated controls the index of homos dumped as a cube,"// &
" eigenvalues are always all dumped. It overrides nhomo.", &
usage="HOMO_LIST {integer} {integer} .. {integer} ", type_of_var=integer_t, &
n_var=-1, repeats=.TRUE.)
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="APPEND", &
description="append the cube files when they already exist", &
default_l_val=.FALSE., lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
END SUBROUTINE create_mo_cubes_section
! **************************************************************************************************
!> \brief ...
!> \param print_key ...
! **************************************************************************************************
SUBROUTINE create_pdos_section(print_key)
TYPE(section_type), POINTER :: print_key
CHARACTER(len=*), PARAMETER :: routineN = 'create_pdos_section', &
routineP = moduleN//':'//routineN
TYPE(keyword_type), POINTER :: keyword
TYPE(section_type), POINTER :: subsection
NULLIFY (subsection)
NULLIFY (keyword)
CALL cp_print_key_section_create(print_key, "PDOS", &
description="Print out the DOS projected per kind and per angular momentum ", &
print_level=debug_print_level, common_iter_levels=1, filename="")
CALL keyword_create(keyword, name="COMPONENTS", &
description="Print out pdos distinguishing all angular momentum components.", &
usage="COMPONENTS", default_l_val=.FALSE., &
lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="APPEND", &
description="Append the pdos obtained at different iterations to the pdos output file."// &
"By defaut the file is overwritten", &
usage="APPEND", default_l_val=.FALSE., &
lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
CALL keyword_create( &
keyword, name="NLUMO", &
description="Number of virtual orbitals to be added to the MO set (-1=all)."//newline// &
"CAUTION: Setting this value to be higher than the number of states present may cause a Cholesky error.", &
usage="NLUMO integer", default_i_val=0)
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="OUT_EACH_MO", &
description="Output on the status of the calculation every OUT_EACH_MO states. If -1 no output", &
usage="OUT_EACH_MO integer", default_i_val=-1)
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
!
CALL section_create(subsection, name="LDOS", &
description="Controls the printing of local PDOS, projected on subsets"// &
" of atoms given through lists", &
n_keywords=4, n_subsections=0, repeats=.TRUE.)
CALL keyword_create(keyword, name="COMPONENTS", &
description="Print out pdos distinguishing all angular momentum components.", &
usage="COMPONENTS", default_l_val=.FALSE., &
lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(subsection, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="LIST", &
description="Specifies a list of indexes of atoms where to project the DOS ", &
usage="LIST {integer} {integer} .. {integer} ", type_of_var=integer_t, &
n_var=-1, repeats=.TRUE.)
CALL section_add_keyword(subsection, keyword)
CALL keyword_release(keyword)
CALL section_add_subsection(print_key, subsection)
CALL section_release(subsection)
CALL section_create(subsection, name="R_LDOS", &
description="Controls the printing of local PDOS, projected on 3D volume in real space,"// &
" the volume is defined in terms of position with respect to atoms in the lists", &
n_keywords=4, n_subsections=0, repeats=.TRUE.)
CALL keyword_create(keyword, name="LIST", &
description="Specifies a list of indexes of atoms used to define the real space volume ", &
usage="LIST {integer} {integer} .. {integer} ", type_of_var=integer_t, &
n_var=-1, repeats=.TRUE.)
CALL section_add_keyword(subsection, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="XRANGE", &
description="range of positions in Cartesian direction x: all grid points within "// &
" this range from at least one atom of the list are considered", &
usage="XRANGE -10.0 10.0", unit_str="angstrom", n_var=2, type_of_var=real_t)
CALL section_add_keyword(subsection, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="YRANGE", &
description="range of positions in Cartesian direction y: all grid points within "// &
" this range from at least one atom of the list are considered", &
usage="YRANGE -10.0 10.0", unit_str="angstrom", n_var=2, type_of_var=real_t)
CALL section_add_keyword(subsection, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="ZRANGE", &
description="range of positions in Cartesian direction z: all grid points within "// &
" this range from at least one atom of the list are considered", &
usage="ZRANGE -10.0 10.0", unit_str="angstrom", n_var=2, type_of_var=real_t)
CALL section_add_keyword(subsection, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="ERANGE", &
description="only project states with the eigenvalues in the given interval. "// &
"Default is all states.", &
usage="ERANGE -1.0 1.0", unit_str="hartree", n_var=2, type_of_var=real_t)
CALL section_add_keyword(subsection, keyword)
CALL keyword_release(keyword)
CALL section_add_subsection(print_key, subsection)
CALL section_release(subsection)
END SUBROUTINE create_pdos_section
! **************************************************************************************************
!> \brief ...
!> \param print_key ...
! **************************************************************************************************
SUBROUTINE create_wannier_section(print_key)
TYPE(section_type), POINTER :: print_key
CHARACTER(len=*), PARAMETER :: routineN = 'create_wannier_section', &
routineP = moduleN//':'//routineN
TYPE(keyword_type), POINTER :: keyword
NULLIFY (keyword)
CALL cp_print_key_section_create(print_key, "WANNIER90", &
description="Interface to Wannier90 code. (EXPERIMENTAL)", &
print_level=debug_print_level, common_iter_levels=1, filename="")
CALL keyword_create(keyword, name="SEED_NAME", &
description="The seedname for the Wannier90 calculation (body of filenames).", &
usage="SEED_NAME filename", default_c_val="wannier90", &
n_var=1, type_of_var=char_t)
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="MP_GRID", &
description="The dimensions of the Monkhorst-Pack k-point grid. ", &
usage="MP_GRID 6 6 6", n_var=-1, default_i_vals=(/10, 10, 10/), type_of_var=integer_t)
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="ADDED_MOS", &
variants=(/"ADDED_BANDS"/), &
description="Number of MOs/Bands added to the Band Structure calculation.", &
default_i_val=0)
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="EXCLUDE_BANDS", &
description="List of Bands excluded in the Wannier calculation.", &
usage="EXCLUDE_BANDS b1 b2 ...", n_var=-1, repeats=.TRUE., &
type_of_var=integer_t)
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="WANNIER_FUNCTIONS", &
description="Number of Wannier functions to be calculated. ", &
usage="WANNIER_FUNCTIONS 6", n_var=1, default_i_val=0, &
repeats=.TRUE., type_of_var=integer_t)
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
END SUBROUTINE create_wannier_section
! **************************************************************************************************
!> \brief ...
!> \param print_key ...
! **************************************************************************************************
SUBROUTINE create_stm_section(print_key)
TYPE(section_type), POINTER :: print_key
CHARACTER(len=*), PARAMETER :: routineN = 'create_stm_section', &
routineP = moduleN//':'//routineN
TYPE(keyword_type), POINTER :: keyword
NULLIFY (keyword)
CALL cp_print_key_section_create(print_key, "STM", &
description="Controls the printing of cubes for the generation of STM images.", &
print_level=debug_print_level, filename="")
CALL keyword_create(keyword, name="stride", &
description="The stride (X,Y,Z) used to write the cube file "// &
"(larger values result in smaller cube files). You can provide 3 numbers (for X,Y,Z) or"// &
" 1 number valid for all components.", &
usage="STRIDE 2 2 2", n_var=-1, default_i_vals=(/2, 2, 2/), type_of_var=integer_t)
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="nlumo", &
description="If the printkey is activated controls the number of additional lumos"// &
" that are computed to be able to reproduce STM images obtained"// &
" from positive bias (imaging unoccupied states)", &
default_i_val=0)
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="BIAS", &
description="Bias energy for scanning tunneling microscopy (STM) image generation."// &
"Orbital densities are summed according to the bias energy."// &
"For negative values, states in the range ]EF+bias,EF] are summed,"// &
"While positive values sum states in the range [EF,EF+bias[."// &
"If postive biases are used, sufficiently many unoccupied stated"// &
" (see ADDED_MOS and NLUMO ) should be computed.", &
n_var=-1, type_of_var=real_t, default_r_vals=(/0.0_dp/), unit_str='eV')
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="TH_TORB", &
description="Tip orbital symmetry in Tersoff-Hamann approximation to compute STM images", &
repeats=.TRUE., &
default_i_val=orb_s, &
usage="TH_TORB s dz2", &
enum_c_vals=s2a("S", "PX", "PY", "PZ", "DXY", "DYZ", "DZX", "DX2", "DY2", "DZ2"), &
enum_i_vals=(/orb_s, orb_px, orb_py, orb_pz, orb_dxy, orb_dyz, orb_dzx, orb_dx2, orb_dy2, orb_dz2/), &
enum_desc=s2a("s orbital", "px orbital", "py orbital", "pz orbital", &
"dxy orbital", "dyz orbital", "dzx orbital", "x^2 orbital", "y^2 orbital", "z^2 orbital"))
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="REF_ENERGY", &
description="By default the reference energy is the Fermi energy. In order to compare"// &
" with STS experiments, where specific energy ranges are addressed, here"// &
" one can set a different reference energy."// &
" The energy range is anyway controlled by the BIAS", &
type_of_var=real_t, default_r_val=0.0_dp, unit_str='eV')
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="APPEND", &
description="append the cube files when they already exist", &
default_l_val=.FALSE., lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
END SUBROUTINE create_stm_section
! **************************************************************************************************
!> \brief ...
!> \param section ...
! **************************************************************************************************
SUBROUTINE create_wfn_mix_section(section)
TYPE(section_type), POINTER :: section
CHARACTER(len=*), PARAMETER :: routineN = 'create_wfn_mix_section', &
routineP = moduleN//':'//routineN
TYPE(keyword_type), POINTER :: keyword
TYPE(section_type), POINTER :: subsection
NULLIFY (subsection)
NULLIFY (keyword)
CPASSERT(.NOT. ASSOCIATED(section))
CALL section_create(section, name="WFN_MIX", &
description="A section that allows manipulation of the MO coeffs,"// &
" e.g. for changing a ground state into an excited state."// &
"Starting from a copy of the original MOs, changes can be made"// &
"by adding linear combinations of HOMO/LUMO of the original MOs to the result MOs", &
n_keywords=1, n_subsections=0, repeats=.FALSE.)
CALL keyword_create(keyword, name="OVERWRITE_MOS", &
description="If the keyword is active molecular orbitals in memory will be replaced by the mixed wfn."// &
" In combination with RTP or EMD no restart will be required to use the mixed wfn.", &
default_l_val=.FALSE., lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL section_create(subsection, name="UPDATE", &
description="update a result MO with with a linear combination of of original MOs."// &
" This section can be repeated to build arbitrary linear combinations using repeatedly y=a*y+b*x.", &
n_keywords=1, n_subsections=0, repeats=.TRUE.)
CALL keyword_create(keyword, name="RESULT_MO_INDEX", &
description="Index of the MO (y) to be modified. Counting down in energy with HOMO=1", &
usage="RESULT_MO_INDEX 1", type_of_var=integer_t, default_i_val=0)
CALL section_add_keyword(subsection, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="RESULT_MARKED_STATE", &
description="Specifies the MO according to "// &
"the marks set in MOLECULAR_STATES. The value corresponds to the repetition "// &
" of MARK_STATES in MOLECULAR_STATES", &
usage="ORIG_MARKED_STATE 1", type_of_var=integer_t, default_i_val=0)
CALL section_add_keyword(subsection, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="RESULT_SPIN_INDEX", &
description="Spin of the MO (y) to be modified.", &
enum_c_vals=s2a("Alpha", "Beta"), &
enum_i_vals=(/1, 2/), & ! direct index in array
default_i_val=1, &
enum_desc=s2a("Majority spin", "Minority spin"))
CALL section_add_keyword(subsection, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="RESULT_SCALE", &
description="Scaling factor of the result variable (a).", &
usage="RESULT_SCALE 0.0", type_of_var=real_t)
CALL section_add_keyword(subsection, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="ORIG_MO_INDEX", &
description="Index of the original MO (x). "// &
"Counting down in energy with HOMO=1 or up from LUMO=1, depending on ORIG_IS_VIRTUAL.", &
usage="ORIG_MO_INDEX 1", type_of_var=integer_t, default_i_val=0)
CALL section_add_keyword(subsection, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="ORIG_MARKED_STATE", &
description="Specifies the MO according to "// &
"the marks set in MOLECULAR_STATES. The value corresponds to the repetition "// &
" of MARK_STATES in MOLECULAR_STATES", &
usage="ORIG_MARKED_STATE 1", type_of_var=integer_t, default_i_val=0)
CALL section_add_keyword(subsection, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="ORIG_SPIN_INDEX", &
description="Spin of the MO (x) to be modified.", &
enum_c_vals=s2a("Alpha", "Beta"), &
enum_i_vals=(/1, 2/), & ! direct index in array
default_i_val=1, &
enum_desc=s2a("Majority spin", "Minority spin"))
CALL section_add_keyword(subsection, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="ORIG_SCALE", &
description="Scaling factor of the result variable (b).", &
usage="ORIG_SCALE 0.0", type_of_var=real_t)
CALL section_add_keyword(subsection, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="ORIG_IS_VIRTUAL", &
description="The original MO (x) is a LUMO.", &
usage="ORIG_IS_VIRTUAL", type_of_var=logical_t)
CALL section_add_keyword(subsection, keyword)
CALL keyword_release(keyword)
CALL section_add_subsection(section, subsection)
CALL section_release(subsection)
END SUBROUTINE create_wfn_mix_section
! **************************************************************************************************
!> \brief creates the input section for the molecular states
!> \param print_key ...
!> \author teo
! **************************************************************************************************
SUBROUTINE create_molecular_states_section(print_key)
TYPE(section_type), POINTER :: print_key
CHARACTER(len=*), PARAMETER :: routineN = 'create_molecular_states_section', &
routineP = moduleN//':'//routineN
TYPE(keyword_type), POINTER :: keyword
TYPE(section_type), POINTER :: print_key2
CPASSERT(.NOT. ASSOCIATED(print_key))
NULLIFY (print_key2, keyword)
CALL cp_print_key_section_create(print_key, "MOLECULAR_STATES", &
description="Controls printing of molecular states ", &
print_level=high_print_level, filename=" ", citations=(/Hunt2003/))
CALL keyword_create( &
keyword, name="CUBE_EVAL_RANGE", &
description="only write cubes if the eigenvalues of the corresponding molecular states lie in the given interval. "// &
"Default is all states.", &
usage="CUBE_EVAL_RANGE -1.0 1.0", unit_str="hartree", n_var=2, type_of_var=real_t)
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="MARK_STATES", &
description="Can be used to mark given molecular states."// &
" Sets a mark to both, occupied and unoccupied states. "// &
"Occupied states are counted beginning with HOMO=1, "// &
"unoccupied states are counted beginning with LUMO=1, "// &
"This is only meaningful in combination with WFN_MIX. "// &
"First integer specifies the molecule, second integer specifies the state.", &
usage="MARK_STATES integer integer", &
n_var=2, default_i_vals=(/-1, -1/), type_of_var=integer_t, repeats=.TRUE.)
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
CALL cp_print_key_section_create(print_key2, "cubes", &
description="Controls the printing of cube files", &
print_level=high_print_level, filename="")
CALL keyword_create(keyword, name="stride", &
description="The stride (X,Y,Z) used to write the cube file "// &
"(larger values result in smaller cube files). You can provide 3 numbers (for X,Y,Z) or"// &
" 1 number valid for all components.", &
usage="STRIDE 2 2 2", n_var=-1, default_i_vals=(/2, 2, 2/), type_of_var=integer_t)
CALL section_add_keyword(print_key2, keyword)
CALL keyword_release(keyword)
CALL section_add_subsection(print_key, print_key2)
CALL section_release(print_key2)
END SUBROUTINE create_molecular_states_section
! **************************************************************************************************
!> \brief ...
!> \param print_key ...
! **************************************************************************************************
SUBROUTINE create_wannier_states_section(print_key)
TYPE(section_type), POINTER :: print_key
CHARACTER(len=*), PARAMETER :: routineN = 'create_wannier_states_section', &
routineP = moduleN//':'//routineN
TYPE(keyword_type), POINTER :: keyword
TYPE(section_type), POINTER :: print_key2
CPASSERT(.NOT. ASSOCIATED(print_key))
NULLIFY (print_key2, keyword)
CALL cp_print_key_section_create(print_key, "WANNIER_STATES", &
description="Controls printing of molecular states ", &
print_level=high_print_level, filename=" ")
CALL keyword_create( &
keyword, name="CUBE_EVAL_RANGE", &
description="only write cubes if the eigenvalues of the corresponding molecular states lie in the given interval. "// &
"Default is all states.", &
usage="CUBE_EVAL_RANGE -1.0 1.0", unit_str="hartree", n_var=2, type_of_var=real_t)
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="MARK_STATES", &
description="Can be used to mark given molecular states."// &
" Sets a mark to both, occupied and unoccupied states. "// &
"Occupied states are counted beginning with HOMO=1, "// &
"unoccupied states are counted beginning with LUMO=1, "// &
"This is only meaningful in combination with WFN_MIX. "// &
"First integer specifies the molecule, second integer specifies the state.", &
usage="MARK_STATES integer integer", &
n_var=2, default_i_vals=(/-1, -1/), type_of_var=integer_t, repeats=.TRUE.)
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
CALL cp_print_key_section_create(print_key2, "cubes", &
description="Controls the printing of cube files", &
print_level=high_print_level, filename="")
CALL keyword_create(keyword, name="stride", &
description="The stride (X,Y,Z) used to write the cube file "// &
"(larger values result in smaller cube files). You can provide 3 numbers (for X,Y,Z) or"// &
" 1 number valid for all components.", &
usage="STRIDE 2 2 2", n_var=-1, default_i_vals=(/2, 2, 2/), type_of_var=integer_t)
CALL section_add_keyword(print_key2, keyword)
CALL keyword_release(keyword)
CALL section_add_subsection(print_key, print_key2)
CALL section_release(print_key2)
END SUBROUTINE create_wannier_states_section
! **************************************************************************************************
!> \brief creates the input section for the qs part
!> \param section the section to create
!> \author teo
! **************************************************************************************************
SUBROUTINE create_qs_section(section)
TYPE(section_type), POINTER :: section
CHARACTER(len=*), PARAMETER :: routineN = 'create_qs_section', &
routineP = moduleN//':'//routineN
TYPE(keyword_type), POINTER :: keyword
TYPE(section_type), POINTER :: subsection
CPASSERT(.NOT. ASSOCIATED(section))
CALL section_create(section, "qs", &
description="parameters needed to set up the Quickstep framework", &
n_keywords=1, n_subsections=0, repeats=.FALSE.)
NULLIFY (keyword, subsection)
! Reals
CALL keyword_create(keyword, name="EPS_DEFAULT", &
description="Try setting all EPS_xxx to values leading to an energy correct up to EPS_DEFAULT", &
usage="EPS_DEFAULT real", default_r_val=1.0E-10_dp)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="EPS_CORE_CHARGE", &
description="Precision for mapping the core charges.Overrides EPS_DEFAULT/100.0 value", &
usage="EPS_CORE_CHARGE real", type_of_var=real_t)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create( &
keyword, name="EPS_GVG_RSPACE", &
variants=(/"EPS_GVG"/), &
description="Sets precision of the realspace KS matrix element integration. Overrides SQRT(EPS_DEFAULT) value", &
usage="EPS_GVG_RSPACE real", type_of_var=real_t)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="EPS_PGF_ORB", &
description="Sets precision of the overlap matrix elements. Overrides SQRT(EPS_DEFAULT) value", &
usage="EPS_PGF_ORB real", type_of_var=real_t)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create( &
keyword, name="EPS_KG_ORB", &
description="Sets precision used in coloring the subsets for the Kim-Gordon method. Overrides SQRT(EPS_DEFAULT) value", &
usage="EPS_KG_ORB 1.0E-8", &
type_of_var=real_t)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="EPS_PPL", &
description="Adjusts the precision for the local part of the pseudo potential. ", &
usage="EPS_PPL real", type_of_var=real_t, default_r_val=1.0E-2_dp)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create( &
keyword, name="EPS_PPNL", &
description="Sets precision of the non-local part of the pseudo potential. Overrides sqrt(EPS_DEFAULT) value", &
usage="EPS_PPNL real", type_of_var=real_t)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="EPS_CPC", &
description="Sets precision of the GAPW projection. Overrides EPS_DEFAULT value", &
usage="EPS_CPC real", type_of_var=real_t)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="EPS_RHO", &
description="Sets precision of the density mapping on the grids.Overrides EPS_DEFAULT value", &
usage="EPS_RHO real", type_of_var=real_t)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="EPS_RHO_RSPACE", &
description="Sets precision of the density mapping in rspace.Overrides EPS_DEFAULT value."// &
".Overrides EPS_RHO value", &
usage="EPS_RHO_RSPACE real", type_of_var=real_t)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="EPS_RHO_GSPACE", &
description="Sets precision of the density mapping in gspace.Overrides EPS_DEFAULT value."// &
".Overrides EPS_RHO value", &
usage="EPS_RHO_GSPACE real", type_of_var=real_t)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="EPS_FILTER_MATRIX", &
description="Sets the threshold for filtering matrix elements.", &
usage="EPS_FILTER_MATRIX 1.0E-6", type_of_var=real_t, default_r_val=0.0E0_dp)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="EPSFIT", &
variants=(/"EPS_FIT"/), &
description="GAPW: precision to give the extention of a hard gaussian ", &
usage="EPSFIT real", default_r_val=1.0E-4_dp)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="EPSISO", &
variants=(/"EPS_ISO"/), &
description="GAPW: precision to determine an isolated projector", &
usage="EPSISO real", default_r_val=1.0E-12_dp)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="EPSSVD", &
variants=(/"EPS_SVD"/), &
description="GAPW: tolerance used in the singular value decomposition of the projector matrix", &
usage="EPS_SVD real", default_r_val=1.0E-8_dp)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="EPSRHO0", &
variants=s2a("EPSVRHO0", "EPS_VRHO0"), &
description="GAPW : precision to determine the range of V(rho0-rho0soft)", &
usage="EPSRHO0 real", default_r_val=1.0E-6_dp)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="ALPHA0_HARD", &
variants=s2a("ALPHA0_H", "ALPHA0"), &
description="GAPW: Exponent for hard compensation charge", &
usage="ALPHA0_HARD real", default_r_val=0.0_dp)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create( &
keyword, name="FORCE_PAW", &
description="Use the GAPW scheme also for atoms with soft basis sets, i.e. "// &
" the local densities are computed even if hard and soft should be equal. "// &
"If this keyword is not set to true, those atoms with soft basis sets are treated by a GPW scheme, i.e. "// &
"the corresponding density contribution goes on the global grid and is expanded in PW. "// &
" This option nullifies the effect of the GPW_TYPE in the atomic KIND", &
usage="FORCE_PAW", &
default_l_val=.FALSE., lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="MAX_RAD_LOCAL", &
description="GAPW : maximum radius of gaussian functions"// &
" included in the generation of projectors", &
usage="MAX_RAD_LOCAL real", default_r_val=25.0_dp)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
! Logicals
CALL keyword_create(keyword, name="LS_SCF", &
description="Perform a linear scaling SCF", &
usage="LS_SCF", lone_keyword_l_val=.TRUE., &
default_l_val=.FALSE.)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="ALMO_SCF", &
description="Perform ALMO SCF", &
usage="ALMO_SCF", lone_keyword_l_val=.TRUE., &
default_l_val=.FALSE.)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="TRANSPORT", &
description="Perform transport calculations (coupling CP2K and OMEN)", &
usage="TRANSPORT", lone_keyword_l_val=.TRUE., &
default_l_val=.FALSE.)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="KG_METHOD", &
description="Use a Kim-Gordon-like scheme.", &
usage="KG_METHOD", lone_keyword_l_val=.TRUE., &
default_l_val=.FALSE., citations=(/Iannuzzi2006, Brelaz1979, Andermatt2016/))
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="MAP_CONSISTENT", &
description="Compute the exact derivative (Hks) of the energy with respect to the density matrix. "// &
"This is slightly more expensive than using an approximate computation, "// &
"but consistent mapping can improve the stability of the SCF procedure, "// &
"especially for a tight EPS_SCF and a less tight EPS_DEFAULT.", &
usage="MAP_CONSISTENT FALSE", &
default_l_val=.TRUE., lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="REF_EMBED_SUBSYS", &
description="A total, reference, system in DFT embedding. ", &
usage="REF_EMBED_SUBSYS FALSE", &
default_l_val=.FALSE., lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="CLUSTER_EMBED_SUBSYS", &
description="A cluster treated with DFT in DFT embedding. ", &
usage="CLUSTER_EMBED_SUBSYS FALSE", &
default_l_val=.FALSE., lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="HIGH_LEVEL_EMBED_SUBSYS", &
description="A cluster treated with a high-level method in DFT embedding. ", &
usage="HIGH_LEVEL_EMBED_SUBSYS FALSE", &
default_l_val=.FALSE., lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="DFET_EMBEDDED", &
description="Calculation with DFT-embedding potential. ", &
usage="DFET_EMBEDDED FALSE", &
default_l_val=.FALSE., lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
! Integers
CALL keyword_create(keyword, name="LMAXN1", &
variants=(/"LMAXRHO1"/), &
description="GAPW : max L number for expansion of the atomic densities in spherical gaussians", &
usage="LMAXN1 integer", &
default_i_val=-1)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="LMAXN0", &
variants=(/"LMAXRHO0"/), &
description="GAPW : max L number for the expansion compensation densities in spherical gaussians", &
usage="LMAXN0 integer", &
default_i_val=2)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="LADDN0", &
description="GAPW : integer added to the max L of the basis set, used to determine the "// &
"maximum value of L for the compensation charge density.", &
usage="LADDN0 integer", &
default_i_val=99)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
! Characters
CALL keyword_create(keyword, name="QUADRATURE", &
description="GAPW: algorithm to construct the atomic radial grids", &
usage="QUADRATURE GC_SIMPLE", &
enum_c_vals=s2a("GC_SIMPLE", "GC_TRANSFORMED", "GC_LOG"), &
enum_i_vals=(/do_gapw_gcs, do_gapw_gct, do_gapw_log/), &
enum_desc=s2a("Gauss-Chebyshev quadrature", &
"Transformed Gauss-Chebyshev quadrature", &
"Logarithmic transformed Gauss-Chebyshev quadrature"), &
default_i_val=do_gapw_log)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="PW_GRID", &
description="What kind of PW_GRID should be employed", &
usage="PW_GRID NS-FULLSPACE", &
enum_c_vals=s2a("SPHERICAL", "NS-FULLSPACE", "NS-HALFSPACE"), &
enum_desc=s2a("- not tested", " tested", " - not tested"), &
enum_i_vals=(/do_pwgrid_spherical, do_pwgrid_ns_fullspace, do_pwgrid_ns_halfspace/), &
default_i_val=do_pwgrid_ns_fullspace)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="PW_GRID_LAYOUT", &
description="Force a particular real-space layout for the plane waves grids. "// &
"Numbers ≤ 0 mean that this dimension is free, incorrect layouts will be ignored. "// &
"The default (/-1,-1/) causes CP2K to select a good value, "// &
"i.e. plane distributed for large grids, more general distribution for small grids.", &
usage="PW_GRID_LAYOUT 4 16", &
repeats=.FALSE., n_var=2, &
default_i_vals=(/-1, -1/))
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="PW_GRID_BLOCKED", &
description="Can be used to set the distribution in g-space for the pw grids and their FFT.", &
usage="PW_GRID_BLOCKED FREE", &
enum_c_vals=s2a("FREE", "TRUE", "FALSE"), &
enum_desc=s2a("CP2K will select an appropriate value", "blocked", "not blocked"), &
enum_i_vals=(/do_pw_grid_blocked_free, do_pw_grid_blocked_true, do_pw_grid_blocked_false/), &
default_i_val=do_pw_grid_blocked_free)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create( &
keyword, name="EXTRAPOLATION", &
variants=s2a("INTERPOLATION", "WF_INTERPOLATION"), &
description="Extrapolation strategy for the wavefunction during e.g. MD."// &
"PS and ASPC are recommended, see also EXTRAPOLATION_ORDER.", &
citations=(/Kolafa2004, VandeVondele2005a/), &
usage="EXTRAPOLATION PS", &
enum_c_vals=s2a("USE_GUESS", "USE_PREV_P", "USE_PREV_RHO_R", "LINEAR_WF", &
"LINEAR_P", "LINEAR_PS", "USE_PREV_WF", "PS", "FROZEN", "ASPC"), &
enum_desc=s2a( &
"Use the method specified with SCF_GUESS, i.e. no extrapolation", &
"Use the previous density matrix", &
"Use the previous density in real space", &
"Linear extrapolation of the wavefunction", &
"Linear extrapolation of the density matrix", &
"Linear extrapolation of the density matrix times the overlap matrix", &
"Use the previous wavefunction", &
"Higher order extrapolation of the density matrix times the overlap matrix", &
"Frozen ...", &
"Always stable predictor corrector, similar to PS, but going for MD stability instead of intial guess accuracy."), &
enum_i_vals=(/ &
wfi_use_guess_method_nr, &
wfi_use_prev_p_method_nr, &
wfi_use_prev_rho_r_method_nr, &
wfi_linear_wf_method_nr, &
wfi_linear_p_method_nr, &
wfi_linear_ps_method_nr, &
wfi_use_prev_wf_method_nr, &
wfi_ps_method_nr, &
wfi_frozen_method_nr, &
wfi_aspc_nr/), &
default_i_val=wfi_aspc_nr)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="EXTRAPOLATION_ORDER", &
description="Order for the PS or ASPC extrapolation (typically 2-4). "// &
"Higher order might bring more accuracy, but comes, "// &
"for large systems, also at some cost. "// &
"In some cases, a high order extrapolation is not stable,"// &
" and the order needs to be reduced.", &
usage="EXTRAPOLATION_ORDER {integer}", default_i_val=3)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="METHOD", &
description="Specifies the electronic structure method that should be employed", &
usage="METHOD GAPW", &
enum_c_vals=s2a("GAPW", "GAPW_XC", "GPW", "LRIGPW", "RIGPW", &
"MNDO", "MNDOD", "AM1", "PM3", "PM6", "PM6-FM", "PDG", "RM1", "PNNL", "DFTB", "OFGPW"), &
enum_desc=s2a("Gaussian and augmented plane waves method", &
"Gaussian and augmented plane waves method only for XC", &
"Gaussian and plane waves method", &
"Local resolution of identity method", &
"Resolution of identity method for HXC terms", &
"MNDO semiempirical", "MNDO-d semiempirical", "AM1 semiempirical", &
"PM3 semiempirical", "PM6 semiempirical", "PM6-FM semiempirical", "PDG semiempirical", &
"RM1 semiempirical", &
"PNNL semiempirical", &
"DFTB Density Functional based Tight-Binding", &
"OFGPW Orbital-free GPW method"), &
enum_i_vals=(/do_method_gapw, do_method_gapw_xc, do_method_gpw, do_method_lrigpw, do_method_rigpw, &
do_method_mndo, do_method_mndod, do_method_am1, do_method_pm3, &
do_method_pm6, do_method_pm6fm, do_method_pdg, do_method_rm1, &
do_method_pnnl, do_method_dftb, do_method_ofgpw/), &
citations=(/Lippert1997, Lippert1999, Krack2000, VandeVondele2005a, &
VandeVondele2006, Dewar1977, Dewar1985, Rocha2006, Stewart1989, Thiel1992, &
Repasky2002, Stewart2007, VanVoorhis2015, Schenter2008/), &
default_i_val=do_method_gpw)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="CORE_PPL", &
description="Specifies the method used to calculate the local pseudopotential contribution.", &
usage="CORE_PPL ANALYTIC", &
enum_c_vals=s2a("ANALYTIC", "GRID"), &
enum_desc=s2a("Analytic integration of integrals", &
"Numerical integration on real space grid. Lumped together with core charge"), &
enum_i_vals=(/do_ppl_analytic, do_ppl_grid/), &
default_i_val=do_ppl_analytic)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="EMBED_RESTART_FILE_NAME", &
description="Root of the file name where to read the embedding "// &
"potential guess.", &
usage="EMBED_RESTART_FILE_NAME <FILENAME>", &
type_of_var=lchar_t)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="EMBED_CUBE_FILE_NAME", &
description="Root of the file name where to read the embedding "// &
"potential (guess) as a cube.", &
usage="EMBED_CUBE_FILE_NAME <FILENAME>", &
type_of_var=lchar_t)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="EMBED_SPIN_CUBE_FILE_NAME", &
description="Root of the file name where to read the spin part "// &
"of the embedding potential (guess) as a cube.", &
usage="EMBED_SPIN_CUBE_FILE_NAME <FILENAME>", &
type_of_var=lchar_t)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL create_distribution_section(subsection)
CALL section_add_subsection(section, subsection)
CALL section_release(subsection)
CALL create_dftb_control_section(subsection)
CALL section_add_subsection(section, subsection)
CALL section_release(subsection)
CALL create_se_control_section(subsection)
CALL section_add_subsection(section, subsection)
CALL section_release(subsection)
CALL create_mulliken_section(subsection)
CALL section_add_subsection(section, subsection)
CALL section_release(subsection)
CALL create_ddapc_restraint_section(subsection, "DDAPC_RESTRAINT")
CALL section_add_subsection(section, subsection)
CALL section_release(subsection)
CALL create_becke_constraint_section(subsection, "BECKE_CONSTRAINT")
CALL section_add_subsection(section, subsection)
CALL section_release(subsection)
CALL create_cdft_control_section(subsection)
CALL section_add_subsection(section, subsection)
CALL section_release(subsection)
CALL create_s2_restraint_section(subsection)
CALL section_add_subsection(section, subsection)
CALL section_release(subsection)
CALL create_lrigpw_section(subsection)
CALL section_add_subsection(section, subsection)
CALL section_release(subsection)
CALL create_optimize_lri_basis_section(subsection)
CALL section_add_subsection(section, subsection)
CALL section_release(subsection)
! Embedding subsections
CALL create_optimize_embed(subsection)
CALL section_add_subsection(section, subsection)
CALL section_release(subsection)
END SUBROUTINE create_qs_section
! **************************************************************************************************
!> \brief ...
!> \param section ...
! **************************************************************************************************
SUBROUTINE create_dftb_control_section(section)
TYPE(section_type), POINTER :: section
CHARACTER(len=*), PARAMETER :: routineN = 'create_dftb_control_section', &
routineP = moduleN//':'//routineN
TYPE(keyword_type), POINTER :: keyword
TYPE(section_type), POINTER :: subsection
CPASSERT(.NOT. ASSOCIATED(section))
CALL section_create(section, "DFTB", &
description="Parameters needed to set up the DFTB methods", &
n_keywords=1, n_subsections=1, repeats=.FALSE., &
citations=(/Porezag1995, Seifert1996, Elstner1998, Zhechkov2005/))
NULLIFY (subsection)
CALL create_dftb_parameter_section(subsection)
CALL section_add_subsection(section, subsection)
CALL section_release(subsection)
NULLIFY (keyword)
CALL keyword_create(keyword, name="self_consistent", &
description="Use self-consistent method", &
citations=(/Elstner1998/), &
usage="SELF_CONSISTENT", default_l_val=.TRUE.)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="orthogonal_basis", &
description="Assume orthogonal basis set", &
usage="ORTHOGONAL_BASIS", default_l_val=.FALSE.)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="do_ewald", &
description="Use Ewald type method instead of direct sum for Coulomb interaction", &
usage="DO_EWALD", default_l_val=.FALSE., lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="dispersion", &
description="Use dispersion correction", &
citations=(/Zhechkov2005/), lone_keyword_l_val=.TRUE., &
usage="DISPERSION", default_l_val=.FALSE.)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="DIAGONAL_DFTB3", &
description="Use a diagonal version of the 3rd order energy correction (DFTB3) ", &
lone_keyword_l_val=.TRUE., &
usage="DIAGONAL_DFTB3", default_l_val=.FALSE.)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="HB_SR_GAMMA", &
description="Uses a modified version for the GAMMA within the SCC-DFTB scheme, "// &
"specifically tuned for hydrogen bonds.", &
citations=(/Hu2007/), lone_keyword_l_val=.TRUE., &
usage="HB_SR_GAMMA", default_l_val=.FALSE.)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="eps_disp", &
description="Define accuracy of dispersion interaction", &
usage="EPS_DISP", default_r_val=0.0001_dp)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
END SUBROUTINE create_dftb_control_section
! **************************************************************************************************
!> \brief ...
!> \param section ...
! **************************************************************************************************
SUBROUTINE create_admm_section(section)
TYPE(section_type), POINTER :: section
CHARACTER(len=*), PARAMETER :: routineN = 'create_admm_section', &
routineP = moduleN//':'//routineN
TYPE(keyword_type), POINTER :: keyword
NULLIFY (keyword)
CPASSERT(.NOT. ASSOCIATED(section))
CALL section_create(section, "AUXILIARY_DENSITY_MATRIX_METHOD", &
description="Parameters needed for the ADMM method.", &
n_keywords=1, n_subsections=1, repeats=.FALSE., &
citations=(/Guidon2010/))
CALL keyword_create( &
keyword=keyword, &
name="ADMM_PURIFICATION_METHOD", &
description="Method that shall be used for wavefunction fitting. Use MO_DIAG for MD.", &
enum_c_vals=s2a("NONE", "CAUCHY", "CAUCHY_SUBSPACE", "MO_DIAG", "MO_NO_DIAG", "MCWEENY", "NONE_DM"), &
enum_i_vals=(/do_admm_purify_none, do_admm_purify_cauchy, do_admm_purify_cauchy_subspace, &
do_admm_purify_mo_diag, do_admm_purify_mo_no_diag, &
do_admm_purify_mcweeny, do_admm_purify_none_dm/), &
enum_desc=s2a("Do not apply any purification", &
"Perform purification via general Cauchy representation", &
"Perform purification via Cauchy representation in occupied subspace", &
"Calculate MO derivatives via Cauchy representation by diagonalization", &
"Calculate MO derivatives via Cauchy representation by inversion", &
"Perform original McWeeny purification via matrix multiplications", &
"Do not apply any purification, works directly with density matrix"), &
default_i_val=do_admm_purify_mo_diag)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create( &
keyword=keyword, &
name="METHOD", &
description="Method that shall be used for wavefunction fitting. Use BASIS_PROJECTION for MD.", &
enum_c_vals=s2a("BASIS_PROJECTION", "BLOCKED_PROJECTION_PURIFY_FULL", "BLOCKED_PROJECTION", &
"CHARGE_CONSTRAINED_PROJECTION"), &
enum_i_vals=(/do_admm_basis_projection, do_admm_blocking_purify_full, do_admm_blocked_projection, &
do_admm_charge_constrained_projection/), &
enum_desc=s2a("Construct auxiliary density matrix from auxiliary basis.", &
"Construct auxiliary density from a blocked Fock matrix,"// &
" but use the original matrix for purification.", &
"Construct auxiliary density from a blocked Fock matrix.", &
"Construct auxiliary density from auxiliary basis enforcing charge constrain."), &
default_i_val=do_admm_basis_projection)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create( &
keyword=keyword, &
name="EXCH_SCALING_MODEL", &
description="Scaling of the exchange correction calculated by the auxiliary density matrix.", &
enum_c_vals=s2a("NONE", "MERLOT"), &
enum_i_vals=(/do_admm_exch_scaling_none, do_admm_exch_scaling_merlot/), &
enum_desc=s2a("No scaling is enabled, refers to methods ADMM1, ADMM2 or ADMMQ.", &
"Exchange scaling according to Merlot (2014)"), &
default_i_val=do_admm_exch_scaling_none)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create( &
keyword=keyword, &
name="EXCH_CORRECTION_FUNC", &
description="Exchange functional which is used for the ADMM correction.", &
enum_c_vals=s2a("DEFAULT", "PBEX", "NONE", "OPTX", "BECKE88X"), &
enum_i_vals=(/do_admm_aux_exch_func_default, do_admm_aux_exch_func_pbex, &
do_admm_aux_exch_func_none, do_admm_aux_exch_func_opt, do_admm_aux_exch_func_bee/), &
enum_desc=s2a("Use PBEX functional for exchange correction, also for truncated and"// &
" short Coulomb interaction.", &
"Use PBEX functional for exchange correction but always normal form.", &
"No correction: X(D)-x(d)-> 0.", &
"Use OPTX functional for exchange correction.", &
"Use Becke88X functional for exchange correction."), &
default_i_val=do_admm_aux_exch_func_default)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, "optx_a1", &
description="OPTX a1 coefficient", &
default_r_val=1.05151_dp)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, "optx_a2", &
description="OPTX a2 coefficient", &
default_r_val=1.43169_dp)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, "optx_gamma", &
description="OPTX gamma coefficient", &
default_r_val=0.006_dp)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="BLOCK_LIST", &
description="Specifies a list of atoms.", &
usage="LIST {integer} {integer} .. {integer}", &
n_var=-1, type_of_var=integer_t, repeats=.TRUE.)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="EPS_FILTER", &
description="Define accuracy of DBCSR operations", &
usage="EPS_FILTER", default_r_val=0.0_dp)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
END SUBROUTINE create_admm_section
! **************************************************************************************************
!> \brief ...
!> \param section ...
! **************************************************************************************************
SUBROUTINE create_dftb_parameter_section(section)
TYPE(section_type), POINTER :: section
CHARACTER(len=*), PARAMETER :: routineN = 'create_dftb_parameter_section', &
routineP = moduleN//':'//routineN
TYPE(keyword_type), POINTER :: keyword
CPASSERT(.NOT. ASSOCIATED(section))
CALL section_create(section, name="PARAMETER", &
description="Information on where to find DFTB parameters", &
n_keywords=1, n_subsections=0, repeats=.FALSE.)
NULLIFY (keyword)
CALL keyword_create(keyword, name="SK_FILE", &
description="Define parameter file for atom pair", &
usage="SK_FILE a1 a2 filename", &
n_var=3, type_of_var=char_t, repeats=.TRUE.)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="PARAM_FILE_PATH", &
description="Specify the directory with the DFTB parameter files. "// &
"Used in combination with the filenames specified in the file "// &
"given in PARAM_FILE_NAME.", usage="PARAM_FILE_PATH pathname", &
n_var=1, type_of_var=char_t, default_c_val="./")
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="PARAM_FILE_NAME", &
description="Specify file that contains the names of "// &
"Slater-Koster tables: A plain text file, each line has the "// &
'format "ATOM1 ATOM2 filename.spl".', &
usage="PARAM_FILE_NAME filename", &
n_var=1, type_of_var=char_t, default_c_val="")
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="DISPERSION_TYPE", &
description="Use dispersion correction of the specified type."// &
" Dispersion correction has to be switched on in the DFTB section.", &
usage="DISPERSION_TYPE (UFF|D3)", &
enum_c_vals=s2a("UFF", "D3"), &
enum_i_vals=(/dispersion_uff, dispersion_d3/), &
enum_desc=s2a("Uses the UFF force field for a pair potential dispersion correction.", &
"Uses the Grimme D3 method (simplified) for a pair potential dispersion correction."), &
default_i_val=dispersion_uff)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="UFF_FORCE_FIELD", &
description="Name of file with UFF parameters that will be used "// &
"for the dispersion correction. Needs to be specified when "// &
"DISPERSION==.TRUE., otherwise cp2k crashes with a Segmentation "// &
"Fault.", usage="UFF_FORCE_FIELD filename", &
n_var=1, type_of_var=char_t, default_c_val="")
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="DISPERSION_PARAMETER_FILE", &
description="Specify file that contains the atomic dispersion "// &
"parameters for the D3 method", &
usage="DISPERSION_PARAMETER_FILE filename", &
n_var=1, type_of_var=char_t, default_c_val="")
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="DISPERSION_RADIUS", &
description="Define radius of dispersion interaction", &
usage="DISPERSION_RADIUS", default_r_val=15._dp)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="COORDINATION_CUTOFF", &
description="Define cutoff for coordination number calculation", &
usage="COORDINATION_CUTOFF", default_r_val=1.e-6_dp)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="D3_SCALING", &
description="Scaling parameters (s6,sr6,s8) for the D3 dispersion method,", &
usage="D3_SCALING 1.0 1.0 1.0", n_var=3, default_r_vals=(/0.0_dp, 0.0_dp, 0.0_dp/))
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="HB_SR_PARAM", &
description="Uses a modified version for the GAMMA within the SCC-DFTB scheme, "// &
"specifically tuned for hydrogen bonds. Specify the exponent used in the exponential.", &
usage="HB_SR_PARAM {real}", default_r_val=4.0_dp)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
END SUBROUTINE create_dftb_parameter_section
! **************************************************************************************************
!> \brief ...
!> \param section ...
! **************************************************************************************************
SUBROUTINE create_se_control_section(section)
TYPE(section_type), POINTER :: section
CHARACTER(len=*), PARAMETER :: routineN = 'create_se_control_section', &
routineP = moduleN//':'//routineN
TYPE(keyword_type), POINTER :: keyword
TYPE(section_type), POINTER :: subsection
NULLIFY (keyword)
CPASSERT(.NOT. ASSOCIATED(section))
CALL section_create(section, "SE", &
description="Parameters needed to set up the Semi-empirical methods", &
n_keywords=8, n_subsections=0, repeats=.FALSE.)
CALL keyword_create(keyword, name="ORTHOGONAL_BASIS", &
description="Assume orthogonal basis set. This flag is overwritten by "// &
"methods with fixed orthogonal/non-orthogonal basis set.", &
usage="ORTHOGONAL_BASIS", default_l_val=.FALSE., lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="STO_NG", &
description="Provides the order of the Slater orbital expansion of Gaussian-Type Orbitals.", &
usage="STO_NG", default_i_val=6)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="ANALYTICAL_GRADIENTS", &
description="Nuclear Gradients are computed analytically or numerically", &
usage="ANALYTICAL_GRADIENTS", default_l_val=.TRUE., lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="DELTA", &
description="Step size in finite difference force calculation", &
usage="DELTA {real} ", default_r_val=1.e-6_dp)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="INTEGRAL_SCREENING", &
description="Specifies the functional form for the ", &
usage="INTEGRAL_SCREENING (KDSO|KDSO-D|SLATER)", &
enum_c_vals=s2a("KDSO", "KDSO-D", "SLATER"), &
enum_i_vals=(/do_se_IS_kdso, do_se_IS_kdso_d, do_se_IS_slater/), &
enum_desc=s2a("Uses the standard NDDO Klopman-Dewar-Sabelli-Ohno equation "// &
"for the screening of the Coulomb interactions.", &
"Uses a modified Klopman-Dewar-Sabelli-Ohno equation, dumping the screening "// &
"parameter for the Coulomb interactions.", &
"Uses an exponential Slater-type function for modelling the Coulomb interactions."), &
default_i_val=do_se_IS_kdso)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="PERIODIC", &
description="Specifies the type of treatment for the electrostatic long-range part "// &
"in semi-empirical calculations.", &
usage="PERIODIC (NONE|EWALD|EWALD_R3|EWALD_GKS)", &
enum_c_vals=s2a("NONE", "EWALD", "EWALD_R3", "EWALD_GKS"), &
enum_i_vals=(/do_se_lr_none, do_se_lr_ewald, do_se_lr_ewald_r3, do_se_lr_ewald_gks/), &
enum_desc=s2a("The long-range part is not explicitly treaten. The interaction "// &
"depends uniquely on the Cutoffs used for the calculation.", &
"Enables the usage of Multipoles Ewald summation schemes. The short-range part "// &
"is tapered according the value of RC_COULOMB.", &
"Enables the usage of Multipoles Ewald summation schemes together with a long-range "// &
"treatment for the 1/R^3 term, deriving from the short-range component. This option "// &
"is active only for K-DSO integral screening type.", &
"Use Ewald directly in Coulomb integral evaluation, works only with Slater screening"), &
default_i_val=do_se_lr_none)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="FORCE_KDSO-D_EXCHANGE", &
description="This keywords forces the usage of the KDSO-D integral screening "// &
"for the Exchange integrals (default is to apply the screening only to the "// &
"Coulomb integrals.", default_l_val=.FALSE., lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="DISPERSION", &
description="Use dispersion correction", &
lone_keyword_l_val=.TRUE., &
usage="DISPERSION", default_l_val=.FALSE.)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="DISPERSION_PARAMETER_FILE", &
description="Specify file that contains the atomic dispersion parameters", &
usage="DISPERSION_PARAMETER_FILE filename", &
n_var=1, type_of_var=char_t, default_c_val="")
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="DISPERSION_RADIUS", &
description="Define radius of dispersion interaction", &
usage="DISPERSION_RADIUS", default_r_val=15._dp)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="COORDINATION_CUTOFF", &
description="Define cutoff for coordination number calculation", &
usage="COORDINATION_CUTOFF", default_r_val=1.e-6_dp)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="D3_SCALING", &
description="Scaling parameters (s6,sr6,s8) for the D3 dispersion method,", &
usage="D3_SCALING 1.0 1.0 1.0", n_var=3, default_r_vals=(/0.0_dp, 0.0_dp, 0.0_dp/))
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
NULLIFY (subsection)
CALL create_coulomb_section(subsection)
CALL section_add_subsection(section, subsection)
CALL section_release(subsection)
CALL create_exchange_section(subsection)
CALL section_add_subsection(section, subsection)
CALL section_release(subsection)
CALL create_screening_section(subsection)
CALL section_add_subsection(section, subsection)
CALL section_release(subsection)
CALL create_lr_corr_section(subsection)
CALL section_add_subsection(section, subsection)
CALL section_release(subsection)
CALL create_neighbor_lists_section(subsection)
CALL section_add_subsection(section, subsection)
CALL section_release(subsection)
CALL create_se_memory_section(subsection)
CALL section_add_subsection(section, subsection)
CALL section_release(subsection)
CALL create_se_print_section(subsection)
CALL section_add_subsection(section, subsection)
CALL section_release(subsection)
CALL create_se_ga_section(subsection)
CALL section_add_subsection(section, subsection)
CALL section_release(subsection)
END SUBROUTINE create_se_control_section
! **************************************************************************************************
!> \brief Create the COULOMB se section
!> \param section the section to create
!> \date 03.2009
!> \author Teodoro Laino [tlaino]
! **************************************************************************************************
SUBROUTINE create_lr_corr_section(section)
TYPE(section_type), POINTER :: section
CHARACTER(len=*), PARAMETER :: routineN = 'create_lr_corr_section', &
routineP = moduleN//':'//routineN
TYPE(keyword_type), POINTER :: keyword
CPASSERT(.NOT. ASSOCIATED(section))
CALL section_create(section, name="LR_CORRECTION", &
description="Setup parameters for the evaluation of the long-range correction term in SE "// &
"calculations.", n_keywords=0, n_subsections=1, repeats=.FALSE.)
NULLIFY (keyword)
CALL keyword_create(keyword, name="CUTOFF", &
description="Atomic Cutoff Radius Cutoff for the evaluation of the long-ranbe correction integrals. ", &
usage="CUTOFF {real} ", unit_str="angstrom", &
default_r_val=cp_unit_to_cp2k(value=6.0_dp, unit_str="angstrom"))
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="RC_TAPER", &
description="Atomic Cutoff Radius Cutoff for Tapering the long-range correction integrals. "// &
"If not specified it assumes the same value specified for the CUTOFF.", &
usage="RC_TAPER {real} ", unit_str="angstrom", type_of_var=real_t)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="RC_RANGE", &
description="Range of cutoff switch function (tapering): 0.5*(1-TANH((r-r0)/RC_RANGE)), "// &
"where r0=2.0*RC_TAPER-20.0*RC_RANGE.", &
usage="RC_RANGE {real} ", unit_str="angstrom", default_r_val=0.0_dp)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
END SUBROUTINE create_lr_corr_section
! **************************************************************************************************
!> \brief Create the COULOMB se section
!> \param section the section to create
!> \date 03.2009
!> \author Teodoro Laino [tlaino]
! **************************************************************************************************
SUBROUTINE create_coulomb_section(section)
TYPE(section_type), POINTER :: section
CHARACTER(len=*), PARAMETER :: routineN = 'create_coulomb_section', &
routineP = moduleN//':'//routineN
TYPE(keyword_type), POINTER :: keyword
CPASSERT(.NOT. ASSOCIATED(section))
CALL section_create(section, name="COULOMB", &
description="Setup parameters for the evaluation of the COULOMB term in SE "// &
"calculations.", n_keywords=0, n_subsections=1, repeats=.FALSE.)
NULLIFY (keyword)
CALL keyword_create( &
keyword, name="CUTOFF", &
description="Atomic Cutoff Radius Cutoff for the evaluation of the Coulomb integrals. "// &
"For non-periodic calculation the default value is exactly the full cell dimension, in order "// &
"to evaluate all pair interactions. Instead, for periodic calculations the default numerical value is used.", &
usage="CUTOFF {real} ", unit_str="angstrom", &
default_r_val=cp_unit_to_cp2k(value=12.0_dp, unit_str="angstrom"))
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="RC_TAPER", &
description="Atomic Cutoff Radius Cutoff for Tapering Coulomb integrals. "// &
"If not specified it assumes the same value specified for the CUTOFF.", &
usage="RC_TAPER {real} ", unit_str="angstrom", type_of_var=real_t)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="RC_RANGE", &
description="Range of cutoff switch function (tapering): 0.5*(1-TANH((r-r0)/RC_RANGE)), "// &
"where r0=2.0*RC_TAPER-20.0*RC_RANGE.", &
usage="RC_RANGE {real} ", unit_str="angstrom", default_r_val=0.0_dp)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
END SUBROUTINE create_coulomb_section
! **************************************************************************************************
!> \brief Create the EXCHANGE se section
!> \param section the section to create
!> \date 03.2009
!> \author Teodoro Laino [tlaino]
! **************************************************************************************************
SUBROUTINE create_exchange_section(section)
TYPE(section_type), POINTER :: section
CHARACTER(len=*), PARAMETER :: routineN = 'create_exchange_section', &
routineP = moduleN//':'//routineN
TYPE(keyword_type), POINTER :: keyword
CPASSERT(.NOT. ASSOCIATED(section))
CALL section_create(section, name="EXCHANGE", &
description="Setup parameters for the evaluation of the EXCHANGE and "// &
" core Hamiltonian terms in SE calculations.", n_keywords=0, n_subsections=1, &
repeats=.FALSE.)
NULLIFY (keyword)
CALL keyword_create(keyword, name="CUTOFF", &
description="Atomic Cutoff Radius Cutoff for the evaluation of the Exchange integrals. "// &
"For non-periodic calculation the default value is exactly the full cell dimension, in order "// &
"to evaluate all pair interactions. Instead, for periodic calculations the default is the "// &
"minimum value between 1/4 of the cell dimension and the value specified in input (either"// &
" explicitly defined or the default numerical value).", &
usage="CUTOFF {real} ", unit_str="angstrom", &
default_r_val=cp_unit_to_cp2k(value=12.0_dp, unit_str="angstrom"))
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="RC_TAPER", &
description="Atomic Cutoff Radius Cutoff for Tapering Exchange integrals. "// &
"If not specified it assumes the same value specified for the CUTOFF.", &
usage="RC_TAPER {real} ", unit_str="angstrom", type_of_var=real_t)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="RC_RANGE", &
description="Range of cutoff switch function (tapering): 0.5*(1-TANH((r-r0)/RC_RANGE)), "// &
"where r0=2.0*RC_TAPER-20.0*RC_RANGE.", &
usage="RC_RANGE {real} ", unit_str="angstrom", default_r_val=0.0_dp)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
END SUBROUTINE create_exchange_section
! **************************************************************************************************
!> \brief Create the SCREENING se section
!> \param section the section to create
!> \date 03.2009
!> \author Teodoro Laino [tlaino]
! **************************************************************************************************
SUBROUTINE create_screening_section(section)
TYPE(section_type), POINTER :: section
CHARACTER(len=*), PARAMETER :: routineN = 'create_screening_section', &
routineP = moduleN//':'//routineN
TYPE(keyword_type), POINTER :: keyword
CPASSERT(.NOT. ASSOCIATED(section))
CALL section_create(section, name="SCREENING", &
description="Setup parameters for the tapering of the Coulomb/Exchange Screening in "// &
"KDSO-D integral scheme,", n_keywords=0, n_subsections=1, repeats=.FALSE.)
NULLIFY (keyword)
CALL keyword_create(keyword, name="RC_TAPER", &
description="Atomic Cutoff Radius Cutoff for Tapering the screening term. ", &
usage="RC_TAPER {real} ", unit_str="angstrom", &
default_r_val=cp_unit_to_cp2k(value=12.0_dp, unit_str="angstrom"))
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="RC_RANGE", &
description="Range of cutoff switch function (tapering): 0.5*(1-TANH((r-r0)/RC_RANGE)), "// &
"where r0=2*RC_TAPER-20*RC_RANGE.", &
usage="RC_RANGE {real} ", unit_str="angstrom", default_r_val=0.0_dp)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
END SUBROUTINE create_screening_section
! **************************************************************************************************
!> \brief Create the print se section
!> \param section the section to create
!> \author teo
! **************************************************************************************************
SUBROUTINE create_se_print_section(section)
TYPE(section_type), POINTER :: section
CHARACTER(len=*), PARAMETER :: routineN = 'create_se_print_section', &
routineP = moduleN//':'//routineN
TYPE(section_type), POINTER :: print_key
CPASSERT(.NOT. ASSOCIATED(section))
CALL section_create(section, name="print", &
description="Section of possible print options in SE code.", &
n_keywords=0, n_subsections=1, repeats=.FALSE.)
NULLIFY (print_key)
CALL cp_print_key_section_create(print_key, "NEIGHBOR_LISTS", &
description="Activates the printing of the neighbor lists used"// &
" for the periodic SE calculations.", &
print_level=high_print_level, filename="", unit_str="angstrom")
CALL section_add_subsection(section, print_key)
CALL section_release(print_key)
CALL cp_print_key_section_create(print_key, "SUBCELL", &
description="Activates the printing of the subcells used for the"// &
"generation of neighbor lists for periodic SE.", &
print_level=high_print_level, filename="__STD_OUT__")
CALL section_add_subsection(section, print_key)
CALL section_release(print_key)
CALL cp_print_key_section_create(print_key, "EWALD_INFO", &
description="Activates the printing of the information for "// &
"Ewald multipole summation in periodic SE.", &
print_level=high_print_level, filename="__STD_OUT__")
CALL section_add_subsection(section, print_key)
CALL section_release(print_key)
END SUBROUTINE create_se_print_section
! **************************************************************************************************
!> \brief creates the input section for use with the GA part of the code
!> \param section the section to create
!> \author Teodoro Laino [tlaino] - University of Zurich - 05.2008
! **************************************************************************************************
SUBROUTINE create_se_ga_section(section)
TYPE(section_type), POINTER :: section
CHARACTER(len=*), PARAMETER :: routineN = 'create_se_ga_section', &
routineP = moduleN//':'//routineN
TYPE(keyword_type), POINTER :: keyword
CPASSERT(.NOT. ASSOCIATED(section))
CALL section_create(section, "GA", &
description="Sets up memory parameters for the storage of the integrals", &
n_keywords=1, n_subsections=0, repeats=.FALSE.)
NULLIFY (keyword)
CALL keyword_create( &
keyword=keyword, &
name="NCELLS", &
description="Defines the number of linked cells for the neighbor list. "// &
"Default value is number of processors", &
usage="NCELLS 10", &
default_i_val=0)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
END SUBROUTINE create_se_ga_section
! **************************************************************************************************
!> \brief creates the input section for the se-memory part integral storage
!> \param section the section to create
!> \author Teodoro Laino [tlaino] - University of Zurich - 05.2008
! **************************************************************************************************
SUBROUTINE create_se_memory_section(section)
TYPE(section_type), POINTER :: section
CHARACTER(len=*), PARAMETER :: routineN = 'create_se_memory_section', &
routineP = moduleN//':'//routineN
TYPE(keyword_type), POINTER :: keyword
CPASSERT(.NOT. ASSOCIATED(section))
CALL section_create(section, "MEMORY", &
description="Sets up memory parameters for the storage of the integrals", &
n_keywords=1, n_subsections=0, repeats=.FALSE.)
NULLIFY (keyword)
CALL keyword_create( &
keyword=keyword, &
name="EPS_STORAGE", &
description="Storage threshold for compression is EPS_STORAGE", &
usage="EPS_STORAGE 1.0E-10", &
default_r_val=1.0E-10_dp)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create( &
keyword=keyword, &
name="MAX_MEMORY", &
description="Defines the maximum amount of memory [MB] used to store precomputed "// &
"(possibly compressed) two-electron two-center integrals", &
usage="MAX_MEMORY 256", &
default_i_val=50)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="COMPRESS", &
description="Enables the compression of the integrals in memory.", &
usage="COMPRESS <LOGICAL>", &
default_l_val=.FALSE., lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
END SUBROUTINE create_se_memory_section
! **************************************************************************************************
!> \brief ...
!> \param section ...
! **************************************************************************************************
SUBROUTINE create_mulliken_section(section)
TYPE(section_type), POINTER :: section
CHARACTER(len=*), PARAMETER :: routineN = 'create_mulliken_section', &
routineP = moduleN//':'//routineN
TYPE(keyword_type), POINTER :: keyword
NULLIFY (keyword)
CPASSERT(.NOT. ASSOCIATED(section))
CALL section_create(section, "MULLIKEN_RESTRAINT", &
description="Use mulliken charges in a restraint (check code for details)", &
n_keywords=7, n_subsections=0, repeats=.FALSE.)
CALL keyword_create(keyword, name="STRENGTH", &
description="force constant of the restraint", &
usage="STRENGTH {real} ", default_r_val=0.1_dp)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="TARGET", &
description="target value of the restraint", &
usage="TARGET {real} ", default_r_val=1._dp)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="ATOMS", &
description="Specifies the list of atoms that is summed in the restraint", &
usage="ATOMS {integer} {integer} .. {integer}", &
n_var=-1, type_of_var=integer_t)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
END SUBROUTINE create_mulliken_section
! **************************************************************************************************
!> \brief ...
!> \param section ...
! **************************************************************************************************
SUBROUTINE create_density_fitting_section(section)
TYPE(section_type), POINTER :: section
CHARACTER(len=*), PARAMETER :: routineN = 'create_density_fitting_section', &
routineP = moduleN//':'//routineN
TYPE(keyword_type), POINTER :: keyword
TYPE(section_type), POINTER :: print_key
NULLIFY (keyword, print_key)
CPASSERT(.NOT. ASSOCIATED(section))
CALL section_create(section, "DENSITY_FITTING", &
description="Setup parameters for density fitting (Bloechl charges or density derived "// &
" atomic point charges (DDAPC) charges)", &
n_keywords=7, n_subsections=0, repeats=.FALSE., &
citations=(/Blochl1995/))
CALL keyword_create(keyword, name="NUM_GAUSS", &
description="Specifies the numbers of gaussian used to fit the QM density for each atomic site.", &
usage="NUM_GAUSS {integer}", &
n_var=1, type_of_var=integer_t, default_i_val=3)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="PFACTOR", &
description="Specifies the progression factor for the gaussian exponent for each atomic site.", &
usage="PFACTOR {real}", &
n_var=1, type_of_var=real_t, default_r_val=1.5_dp)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="MIN_RADIUS", &
description="Specifies the smallest radius of the gaussian used in the fit. All other radius are"// &
" obtained with the progression factor.", &
usage="MIN_RADIUS {real}", &
unit_str="angstrom", n_var=1, type_of_var=real_t, default_r_val=0.5_dp)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="RADII", &
description="Specifies all the radius of the gaussian used in the fit for each atomic site. The use"// &
" of this keyword disables all other keywords of this section.", &
usage="RADII {real} {real} .. {real}", &
unit_str="angstrom", n_var=-1, type_of_var=real_t)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="GCUT", &
description="Cutoff for charge fit in G-space.", &
usage="GCUT {real}", &
n_var=1, type_of_var=real_t, default_r_val=SQRT(6.0_dp))
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL cp_print_key_section_create(print_key, "program_run_info", &
description="Controls the printing of basic information during the run", &
print_level=high_print_level, add_last=add_last_numeric, filename="__STD_OUT__")
CALL keyword_create(keyword, name="CONDITION_NUMBER", &
description="Prints information regarding the condition numbers of the A matrix (to be inverted)", &
usage="ANALYTICAL_GTERM <LOGICAL>", &
default_l_val=.FALSE., lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
CALL section_add_subsection(section, print_key)
CALL section_release(print_key)
END SUBROUTINE create_density_fitting_section
! **************************************************************************************************
!> \brief ...
!> \param section ...
!> \param section_name ...
! **************************************************************************************************
SUBROUTINE create_ddapc_restraint_section(section, section_name)
TYPE(section_type), POINTER :: section
CHARACTER(len=*), INTENT(in) :: section_name
CHARACTER(len=*), PARAMETER :: routineN = 'create_ddapc_restraint_section', &
routineP = moduleN//':'//routineN
TYPE(keyword_type), POINTER :: keyword
TYPE(section_type), POINTER :: print_key
NULLIFY (keyword, print_key)
CPASSERT(.NOT. ASSOCIATED(section))
CALL section_create(section, TRIM(ADJUSTL(section_name)), &
description="Use DDAPC charges in a restraint (check code for details)", &
n_keywords=7, n_subsections=0, repeats=.TRUE.)
CALL keyword_create(keyword, name="TYPE_OF_DENSITY", &
description="Specifies the type of density used for the fitting", &
usage="TYPE_OF_DENSITY (FULL|SPIN)", &
enum_c_vals=s2a("FULL", "SPIN"), &
enum_i_vals=(/do_full_density, do_spin_density/), &
enum_desc=s2a("Full density", "Spin density"), &
default_i_val=do_full_density)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="STRENGTH", &
description="force constant of the restraint", &
usage="STRENGTH {real} ", default_r_val=0.1_dp)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="TARGET", &
description="target value of the restraint", &
usage="TARGET {real} ", default_r_val=1._dp)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="ATOMS", &
description="Specifies the list of atoms that is summed in the restraint", &
usage="ATOMS {integer} {integer} .. {integer}", &
n_var=-1, type_of_var=integer_t)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="COEFF", &
description="Defines the the coefficient of the atom in the atom list (default is one) ", &
usage="COEFF 1.0 -1.0", &
type_of_var=real_t, n_var=-1)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="FUNCTIONAL_FORM", &
description="Specifies the functional form of the term added", &
usage="FUNCTIONAL_FORM RESTRAINT", &
enum_c_vals=s2a("RESTRAINT", "CONSTRAINT"), &
enum_i_vals=(/do_ddapc_restraint, do_ddapc_constraint/), &
enum_desc=s2a("Harmonic potential: s*(q-t)**2", "Constraint form: s*(q-t)"), &
default_i_val=do_ddapc_restraint)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL cp_print_key_section_create(print_key, "program_run_info", &
description="Controls the printing basic info about the method", &
print_level=low_print_level, add_last=add_last_numeric, filename="__STD_OUT__")
CALL section_add_subsection(section, print_key)
CALL section_release(print_key)
END SUBROUTINE create_ddapc_restraint_section
! **************************************************************************************************
!> \brief ...
!> \param section ...
!> \param section_name ...
! **************************************************************************************************
SUBROUTINE create_becke_constraint_section(section, section_name)
TYPE(section_type), POINTER :: section
CHARACTER(len=*), INTENT(in) :: section_name
CHARACTER(len=*), PARAMETER :: routineN = 'create_becke_constraint_section', &
routineP = moduleN//':'//routineN
TYPE(keyword_type), POINTER :: keyword
TYPE(section_type), POINTER :: group_section, print_key
NULLIFY (keyword, print_key, group_section)
CPASSERT(.NOT. ASSOCIATED(section))
CALL section_create(section, TRIM(ADJUSTL(section_name)), &
description="Use the Becke weight population to enforce a charge/spin density constraint. "// &
"The constraint is defined in the section ATOM_GROUP.", &
n_keywords=26, n_subsections=1, repeats=.FALSE., &
citations=(/Becke1988b/))
CALL keyword_create(keyword, name="STRENGTH", &
description="Constraint force constants (Lagrangian multipliers). "// &
"Give one value per constraint group.", &
type_of_var=real_t, n_var=-1, &
default_r_val=0.0_dp)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="TARGET", &
description="Constraint target values. Give one value per constraint group. "// &
"The target value is the desired number of valence electrons, spin moment, or the number of "// &
"alpha or beta electrons on the atoms that define the constraint, suitably multiplied by "// &
"atomic coefficients in case a relative constraint between two sets of atoms is employed. "// &
"Note that core charges are not subtracted from the target value.", &
usage="TARGET {real}", repeats=.FALSE., &
type_of_var=real_t, n_var=-1, &
default_r_val=0.0_dp)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="ADJUST_SIZE", &
description="Adjust Becke cell boundaries with atomic"// &
" radii to generate a heteronuclear cutoff profile. These"// &
" radii are defined with the keyword ATOMIC_RADII.", &
usage="ADJUST_SIZE", &
default_l_val=.FALSE., lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="ATOMIC_RADII", &
description="Defines atomic radii to generate a heteronuclear cutoff profile."// &
" Give one value per element in the same order as they"// &
" appear in the input coordinates.", &
usage="ATOMIC_RADII {real} {real} {real}", repeats=.FALSE., &
unit_str="angstrom", &
type_of_var=real_t, n_var=-1)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="SHOULD_SKIP", &
description="If grid point is farther than GLOBAL_CUTOFF from all constraint atoms, "// &
"move directly to next grid point, thus saving computational resources.", &
usage="SHOULD_SKIP", &
default_l_val=.FALSE., lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="ATOMIC_CHARGES", &
description="Calculate atomic Becke charges (Z = Z_core - Z_becke)."// &
" With fragment based constraints, charges are relative to the fragment"// &
" reference state i.e. Z = Z_becke - Z_frag_reference. Note:"// &
" if the number of atoms is greater than the default"// &
" pw_pool max cache, calculation of atomic charges"// &
" will prompt a warning during deallocation of atomic grids.", &
usage="ATOMIC_CHARGES", &
default_l_val=.FALSE., lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="CAVITY_CONFINE", &
description="Activates Gaussian cavity confinement. The constraint is evaluated only inside "// &
"the cavity. The cavity is formed by summing spherical Gaussians centered on the constraint atoms.", &
usage="CAVITY_CONFINE", &
default_l_val=.FALSE., lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="CAVITY_SHAPE", &
description="Specifies the type of Gaussian cavity used.", &
usage="CAVITY_SHAPE (SINGLE|VDW|COVALENT|USER)", &
enum_c_vals=s2a("DEFAULT", "SINGLE", "VDW", "COVALENT", "USER"), &
enum_i_vals=(/radius_default, radius_single, radius_vdw, radius_covalent, radius_user/), &
enum_desc=s2a("Use covalent radii (in angstrom) to construct Gaussians, but fixed"// &
" 1.0_dp radius for elements with a radius larger than this value.", &
"Single Gaussian for all atom types with radius given by CAVITY_RADIUS.", &
"Use van der Waals radii to construct Gaussians.", &
"Use covalent radii to construct Gaussians.", &
"Use user defined radii (keyword ATOMIC_RADII) to construct Gaussians."), &
default_i_val=radius_default)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="CAVITY_USE_BOHR", &
description="Convert the cavity radius from angstrom to bohr. This results in a larger"// &
" confinement cavity than without unit conversion.", &
usage="CAVITY_USE_BOHR TRUE", &
default_l_val=.FALSE., lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="CAVITY_PRINT", &
description="Print cavity in Gaussian cube file format. Currently, printing options"// &
" are hardcoded.", &
usage="CAVITY_PRINT", &
default_l_val=.FALSE., lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="CAVITY_RADIUS", &
description="Radius parameter controlling the creation of Gaussian cavity confinement.", &
usage="CAVITY_RADIUS <REAL>", &
unit_str="angstrom", &
default_r_val=cp_unit_to_cp2k(3.0_dp, "angstrom"), &
type_of_var=real_t, n_var=1)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="EPS_CAVITY", &
description="Density threshold for cavity creation. Grid points where the Gaussian"// &
" density falls below the threshold are ignored.", &
usage="EPS_CAVITY {real} ", default_r_val=1.0e-6_dp)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="CUTOFF_TYPE", &
description="Specifies the type of cutoff used when building the Becke weight function.", &
usage="CUTOFF_TYPE (GLOBAL|ELEMENT)", &
enum_c_vals=s2a("GLOBAL", "ELEMENT"), &
enum_i_vals=(/becke_cutoff_global, becke_cutoff_element/), &
enum_desc=s2a("Use a single value for all elements. Read from GLOBAL_CUTOFF.", &
"Use a different value for all elements. Values read from ELEMENT_CUTOFF."), &
default_i_val=becke_cutoff_global)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="GLOBAL_CUTOFF", &
description="Parameter used to select which atoms contribute to the"// &
" weight function at each real space grid point.", &
usage="GLOBAL_CUTOFF <REAL>", &
unit_str="angstrom", &
default_r_val=cp_unit_to_cp2k(3.1750632515_dp, "angstrom"), &
type_of_var=real_t, n_var=1)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="ELEMENT_CUTOFF", &
description="Defines element specific cutoffs to decide which atoms contribute to the"// &
" weight function at each real space grid point. Give one value per element in the same"// &
" order as they appear in the coordinates.", &
usage="ELEMENT_CUTOFF {real} {real} {real}", repeats=.FALSE., &
unit_str="angstrom", &
type_of_var=real_t, n_var=-1)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="IN_MEMORY", &
description="Precompute gradients due to Becke constraint during"// &
" initial formation of constraint and store them in memory. Useful"// &
" in combination with confinement, memory intensive otherwise. Does"// &
" nothing if forces are not calculated.", &
usage="IN_MEMORY", &
default_l_val=.FALSE., lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="FRAGMENT_A_FILE_NAME", variants=(/"FRAGMENT_A_FILE"/), &
description="Name of the reference total electron density cube file for fragment A."// &
" May include a path. The reference electron density needs to be outputted"// &
" on the same grid as the full system (same cutoff and cell, output stride 1).", &
usage="FRAGMENT_A_FILE_NAME <FILENAME>", &
default_lc_val="fragment_a.cube")
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="FRAGMENT_B_FILE_NAME", variants=(/"FRAGMENT_B_FILE"/), &
description="Name of the reference total electron density cube file for fragment B."// &
" May include a path. The reference electron density needs to be outputted"// &
" on the same grid as the full system (same cutoff and cell, output stride 1).", &
usage="FRAGMENT_B_FILE_NAME <FILENAME>", &
default_lc_val="fragment_b.cube")
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="FRAGMENT_A_SPIN_FILE", variants=(/"FRAGMENT_A_SPIN_FILE_NAME"/), &
description="Name of the reference spin density cube file for fragment A."// &
" May include a path. The reference spin density needs to be outputted"// &
" on the same grid as the full system (same cutoff and cell, output stride 1).", &
usage="FRAGMENT_A_FILE_NAME <FILENAME>", &
default_lc_val="fragment_a_spin.cube")
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="FRAGMENT_B_SPIN_FILE", variants=(/"FRAGMENT_B_SPIN_FILE_NAME"/), &
description="Name of the reference spin density cube file for fragment B."// &
" May include a path. The reference spin density needs to be outputted"// &
" on the same grid as the full system (same cutoff and cell, output stride 1).", &
usage="FRAGMENT_B_FILE_NAME <FILENAME>", &
default_lc_val="fragment_b_spin.cube")
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="FLIP_FRAGMENT_A", &
description="Logical which determines if the reference spin difference density "// &
"(rho_alpha-rho_beta) for fragment A should be flipped. With default (off) "// &
"value, the fragment is constrained to have more alpha than beta electrons "// &
"if the isolated fragment has unpaired electrons. Useful in conjunction with "// &
"FLIP_FRAGMENT_B.", &
usage="FLIP_FRAGMENT_A", &
default_l_val=.FALSE., lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="FLIP_FRAGMENT_B", &
description="Logical which determines if the reference spin difference density "// &
"(rho_alpha-rho_beta) for fragment B should be flipped. With default (off) "// &
"value, the fragment is constrained to have more alpha than beta electrons "// &
"if the isolated fragment has unpaired electrons. Useful in conjunction with "// &
"FLIP_FRAGMENT_A.", &
usage="FLIP_FRAGMENT_B", &
default_l_val=.FALSE., lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL cp_print_key_section_create(print_key, "PROGRAM_RUN_INFO", &
description="Controls the printing of basic info about the method.", &
print_level=low_print_level, add_last=add_last_numeric, filename="__STD_OUT__")
CALL section_add_subsection(section, print_key)
CALL section_release(print_key)
CALL section_create(group_section, "ATOM_GROUP", &
description="Define a group of atoms for use in a Becke constraint. Each repetition of "// &
"this section creates a new constraint.", &
n_keywords=4, n_subsections=0, repeats=.TRUE.)
CALL keyword_create(keyword, name="ATOMS", &
description="Specifies the list of atoms that are included in the constraint group.", &
usage="ATOMS {integer} {integer} .. {integer}", &
n_var=-1, type_of_var=integer_t)
CALL section_add_keyword(group_section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="COEFF", &
description="Defines coefficients for the atoms in the list of atoms. Accepts value +/-1.0.", &
usage="COEFF 1.0 -1.0", repeats=.TRUE., &
type_of_var=real_t, n_var=-1)
CALL section_add_keyword(group_section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="CONSTRAINT_TYPE ", &
description="Determines what type of constraint to apply. ", &
usage="CONSTRAINT_TYPE (CHARGE|MAGNETIZATION|ALPHA|BETA)", &
enum_c_vals=s2a("CHARGE", "MAGNETIZATION", "ALPHA", "BETA"), &
enum_i_vals=(/cdft_charge_constraint, cdft_magnetization_constraint, &
cdft_alpha_constraint, cdft_beta_constraint/), &
enum_desc=s2a("Total charge density constraint (rho_alpha + rho_beta).", &
"Magnetization density constraint (rho_alpha - rho_beta).", &
"Alpha spin density constraint.", &
"Beta spin density constraint."), &
default_i_val=cdft_charge_constraint)
CALL section_add_keyword(group_section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="FRAGMENT_CONSTRAINT", &
description="Use a fragment based constraint. "// &
"Takes as input the electron densities of two isolated fragments in the "// &
"same geometry that they have in the full system. "// &
"The isolated fragment densities are read from cube files defined in FRAGMENT_{A,B}_FILE. "// &
"For magnetization density constraints, additional files containing the spin difference "// &
"densities must be defined with the keywords FRAGMENT_{A,B}_SPIN_FILE. "// &
"With this keyword active, the target value of the constraint is calculated from the "// &
"the superposition of the isolated fragment densities. Supports only static calculations.", &
usage="FRAGMENT_CONSTRAINT", &
default_l_val=.FALSE., lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(group_section, keyword)
CALL keyword_release(keyword)
CALL section_add_subsection(section, group_section)
CALL section_release(group_section)
CALL section_create(group_section, "DUMMY_ATOMS", &
description="Define an extra group of atoms for which only atomic Becke charges "// &
"should be computed. The section cannot contain any constraint "// &
"atoms that were defined in section ATOM_GROUP.", &
n_keywords=1, n_subsections=0, repeats=.TRUE.)
CALL keyword_create(keyword, name="ATOMS", &
description="Specifies the list of atoms that are included in the DUMMY_ATOMS group.", &
usage="ATOMS {integer} {integer} .. {integer}", &
n_var=-1, type_of_var=integer_t)
CALL section_add_keyword(group_section, keyword)
CALL keyword_release(keyword)
CALL section_add_subsection(section, group_section)
CALL section_release(group_section)
END SUBROUTINE create_becke_constraint_section
! **************************************************************************************************
!> \brief ...
!> \param section ...
! **************************************************************************************************
SUBROUTINE create_cdft_control_section(section)
TYPE(section_type), POINTER :: section
CHARACTER(len=*), PARAMETER :: routineN = 'create_cdft_control_section', &
routineP = moduleN//':'//routineN
TYPE(keyword_type), POINTER :: keyword
TYPE(section_type), POINTER :: subsection
NULLIFY (keyword, subsection)
CPASSERT(.NOT. ASSOCIATED(section))
CALL section_create(section, "CDFT", &
description="Parameters needed to set up a constrained DFT calculation."// &
" The constraint(s) is (are) converged in a separate external SCF loop with settings"// &
" read from the OUTER_SCF section. Supported constraints: Gaussian Hirshfeld (partial)"// &
" and Becke.", n_keywords=8, n_subsections=2, &
repeats=.FALSE., citations=(/Holmberg2017/))
NULLIFY (subsection, keyword)
CALL create_outer_scf_section(subsection)
CALL section_add_subsection(section, subsection)
CALL section_release(subsection)
CALL create_hirshfeld_constraint_section(subsection)
CALL section_add_subsection(section, subsection)
CALL section_release(subsection)
CALL keyword_create(keyword, name="TYPE_OF_CONSTRAINT", &
description="Specifies the type of constraint used.", &
usage="TYPE_OF_CONSTRAINT (NONE|HIRSHFELD|BECKE)", &
enum_c_vals=s2a("NONE", "HIRSHFELD", "BECKE"), &
enum_i_vals=(/outer_scf_none, outer_scf_hirshfeld_constraint, &
outer_scf_becke_constraint/), &
enum_desc=s2a("No constraint (disables section).", &
"Hirshfeld-type constraint defined by constraint atom centered spherical Gaussians"// &
" Partial implementation: no forces or coupling. Requires corresponding section.", &
"Becke constraint. Requires corresponding section in &QS."), &
default_i_val=outer_scf_none)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="REUSE_PRECOND", &
description="Reuse a previously built OT preconditioner between subsequent CDFT SCF iterations "// &
"if the inner OT SCF loop converged in PRECOND_FREQ steps or less. Intended mainly for MD "// &
"simulations with the FULL_ALL preconditioner to speed up the final iterations of the CDFT SCF loop.", &
usage="REUSE_PRECOND yes", repeats=.FALSE., n_var=1, &
default_l_val=.FALSE., lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="PRECOND_FREQ", &
description="See REUSE_PRECOND.", &
usage="PRECOND_FREQ {int}", default_i_val=0)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="MAX_REUSE", &
description="Determines how many times a previously built preconditioner can be reused.", &
usage="MAX_REUSE {int}", default_i_val=0)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="PURGE_HISTORY", &
description="Purge wavefunction and constraint history to improve SCF convergence during MD."// &
"Counts how often the convergence of the first CDFT SCF iteration takes 2 or more outer SCF"// &
" iterations and purges the history if the counter exceeds PURGE_FREQ, and PURGE_OFFSET "// &
" MD steps have passed since the last purge."// &
" The counter is zeroed after each purge.", &
usage="PURGE_HISTORY yes", repeats=.FALSE., n_var=1, &
default_l_val=.FALSE., lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="PURGE_FREQ", &
description="See PURGE_HISTORY.", &
usage="PURGE_FREQ {int} ", default_i_val=1)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="PURGE_OFFSET", &
description="See PURGE_HISTORY.", &
usage="PURGE_OFFSET {int} ", default_i_val=1)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="COUNTER", &
description="A counter to track the total number of energy evaluations. Needed by"// &
" some optimizers to print information. Useful mainly for restarts.", &
usage="COUNTER {int} ", default_i_val=0)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
END SUBROUTINE create_cdft_control_section
! **************************************************************************************************
!> \brief ...
!> \param section ...
! **************************************************************************************************
SUBROUTINE create_hirshfeld_constraint_section(section)
TYPE(section_type), POINTER :: section
CHARACTER(len=*), PARAMETER :: routineN = 'create_hirshfeld_constraint_section', &
routineP = moduleN//':'//routineN
TYPE(keyword_type), POINTER :: keyword
TYPE(section_type), POINTER :: print_key
NULLIFY (keyword, print_key)
CPASSERT(.NOT. ASSOCIATED(section))
CALL section_create(section, "HIRSHFELD_CONSTRAINT", &
description="Parameters for CDFT with Hirshfeld constraint", &
n_keywords=11, n_subsections=0, repeats=.FALSE.)
CALL keyword_create(keyword, name="STRENGTH", &
description="Force constants of the constraints. "// &
"Second value is for combined constraint and is optional.", &
usage="STRENGTH {real} {real}", repeats=.FALSE., &
type_of_var=real_t, n_var=-1, &
default_r_val=0.0_dp)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="TARGET", &
description="Target values of the constraints. "// &
"Second value is for combined constraint and is optional.", &
usage="TARGET {real}", repeats=.FALSE., &
type_of_var=real_t, n_var=-1, &
default_r_val=0.0_dp)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="ATOMS", &
description="Specifies the list of atoms that are included in the constraint", &
usage="ATOMS {integer} {integer} .. {integer}", &
n_var=-1, type_of_var=integer_t)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="COEFF", &
description="Defines coefficients for atoms included in the constraint (default is one)"// &
" Use +1.0 for donor atoms and -1.0 for acceptor atoms.", &
usage="COEFF 1.0 -1.0", repeats=.TRUE., &
type_of_var=real_t, n_var=-1)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="SELF_CONSISTENT", &
description="Calculate charges from the Hirsheld-I (self_consistent) method."// &
" This scales only the full shape function, not the added charge as in the original scheme. NYI.", &
usage="SELF_CONSISTENT yes", repeats=.FALSE., n_var=1, &
default_l_val=.FALSE., lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="SHAPE_FUNCTION", &
description="Type of shape function used for Hirshfeld partitioning.", &
usage="SHAPE_FUNCTION {Gaussian,Density}", repeats=.FALSE., n_var=1, &
default_i_val=shape_function_gaussian, &
enum_c_vals=s2a("GAUSSIAN", "DENSITY"), &
enum_desc=s2a("Single Gaussian with Colvalent radius", &
"Atomic density expanded in multiple Gaussians (NYI)"), &
enum_i_vals=(/shape_function_gaussian, shape_function_density/))
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="REFERENCE_CHARGE", &
description="Charge of atomic partitioning function for Hirshfeld method.", &
usage="REFERENCE_CHARGE {Atomic,Mulliken}", repeats=.FALSE., n_var=1, &
default_i_val=ref_charge_atomic, &
enum_c_vals=s2a("ATOMIC", "MULLIKEN"), &
enum_desc=s2a("Use atomic core charges", "Calculate Mulliken charges (NYI)"), &
enum_i_vals=(/ref_charge_atomic, ref_charge_mulliken/))
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="USER_RADIUS", &
description="Use user defined covalent radii for single Gaussian Hirshfeld partitioning."// &
" These radii are defined by the keyword ATOMIC_RADII", &
usage="USER_RADIUS yes", repeats=.FALSE., n_var=1, &
default_l_val=.FALSE., lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="ATOMIC_RADII", &
description="Defines custom radii to setup the spherical Gaussians.", &
usage="ATOMIC_RADII {real} {real} {real}", repeats=.FALSE., &
unit_str="angstrom", &
type_of_var=real_t, n_var=-1)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL cp_print_key_section_create(print_key, "PROGRAM_RUN_INFO", &
description="Controls the printing of basic info about the method", &
print_level=low_print_level, add_last=add_last_numeric, filename="__STD_OUT__")
CALL section_add_subsection(section, print_key)
CALL section_release(print_key)
END SUBROUTINE create_hirshfeld_constraint_section
! **************************************************************************************************
!> \brief ...
!> \param section ...
! **************************************************************************************************
SUBROUTINE create_s2_restraint_section(section)
TYPE(section_type), POINTER :: section
CHARACTER(len=*), PARAMETER :: routineN = 'create_s2_restraint_section', &
routineP = moduleN//':'//routineN
TYPE(keyword_type), POINTER :: keyword
NULLIFY (keyword)
CPASSERT(.NOT. ASSOCIATED(section))
CALL section_create(section, "S2_RESTRAINT", &
description="Use S2 in a re/constraint (OT only)", &
n_keywords=7, n_subsections=0, repeats=.FALSE.)
CALL keyword_create(keyword, name="STRENGTH", &
description="force constant of the restraint", &
usage="STRENGTH {real} ", default_r_val=0.1_dp)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="TARGET", &
description="target value of the restraint", &
usage="TARGET {real} ", default_r_val=1._dp)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="FUNCTIONAL_FORM", &
description="Specifies the functional form of the term added", &
usage="FUNCTIONAL_FORM RESTRAINT", &
enum_c_vals=s2a("RESTRAINT", "CONSTRAINT"), &
enum_i_vals=(/do_s2_restraint, do_s2_constraint/), &
enum_desc=s2a("Harmonic potential: s*(q-t)**2", "Constraint form: s*(q-t)"), &
default_i_val=do_s2_restraint)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
END SUBROUTINE create_s2_restraint_section
! **************************************************************************************************
!> \brief creates the input section for the tddfpt part
!> \param section the section to create
!> \author teo
! **************************************************************************************************
SUBROUTINE create_tddfpt_section(section)
TYPE(section_type), POINTER :: section
CHARACTER(len=*), PARAMETER :: routineN = 'create_tddfpt_section', &
routineP = moduleN//':'//routineN
TYPE(keyword_type), POINTER :: keyword
TYPE(section_type), POINTER :: subsection
CPASSERT(.NOT. ASSOCIATED(section))
CALL section_create(section, "tddfpt", &
description="parameters needed to set up the Time Dependent Density Functional PT", &
n_keywords=5, n_subsections=1, repeats=.FALSE., &
citations=(/Iannuzzi2005/))
NULLIFY (subsection, keyword)
! Integer
CALL keyword_create(keyword, name="MAX_KV", &
variants=s2a("MAX_VECTORS"), &
description=" maximal number of Krylov space vectors", &
usage="MAX_KV someInteger>0", &
n_var=1, type_of_var=integer_t, &
default_i_val=60)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="RESTARTS", &
variants=s2a("N_RESTARTS"), &
description=" maximal number subspace search restarts", &
usage="RESTARTS someInteger>0", &
n_var=1, type_of_var=integer_t, &
default_i_val=5)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="NEV", &
variants=s2a("N_EV", "EV"), &
description=" number of excitations to calculate", &
usage="NEV someInteger>0", &
n_var=1, type_of_var=integer_t, &
default_i_val=1)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="NLUMO", &
description=" number of additional unoccupied orbitals ", &
usage="NLUMO 10", &
n_var=1, type_of_var=integer_t, &
default_i_val=5)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="NREORTHO", &
variants=s2a("N_REORTHO", "REORTHO", "REORTHOGONALITAZIONS"), &
description=" number of reorthogonalization steps", &
usage="NREORTHO someInteger>0", &
n_var=1, type_of_var=integer_t, &
default_i_val=2)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
! Logical
CALL keyword_create(keyword, name="KERNEL", &
variants=s2a("DO_KERNEL"), &
description="compute the kernel (debug purpose only)", &
usage="KERNEL logical_value", &
default_l_val=.TRUE., lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="LSD_SINGLETS", &
description="compute singlets using lsd vxc kernel", &
usage="LSD_SINGLETS logical_value", &
default_l_val=.FALSE., lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="INVERT_S", &
variants=s2a("INVERT_OVERLAP"), &
description="use the inverse of the overlap matrix", &
usage="INVERT_S logical_value", &
default_l_val=.TRUE., lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="PRECONDITIONER", &
variants=s2a("PRECOND"), &
description="use the preconditioner (only for Davidson)", &
usage="PRECONDITIONER logical_value", &
default_l_val=.TRUE., lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
! Character
CALL keyword_create(keyword, name="RES_ETYPE", &
variants=s2a("RESTRICTED_EXCITATIONS_TYPE", "RES_E_TYPE"), &
description="(singlets/triplets) for restricted calculation", &
usage="RES_ETYPE T", &
enum_c_vals=s2a("S", "SINGLET", "SINGLETS", "T", "TRIPLET", "TRIPLETS"), &
enum_i_vals=(/tddfpt_singlet, tddfpt_singlet, tddfpt_singlet, &
tddfpt_triplet, tddfpt_triplet, tddfpt_triplet/), &
default_i_val=tddfpt_singlet)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="DIAG_METHOD", &
variants=s2a("DIAGONALIZATION_METHOD", "METHOD"), &
description="Diagonalization method used in tddfpt", &
usage="DIAG_METHOD DAVIDSON", &
enum_c_vals=s2a("DAVIDSON", "LANCZOS"), &
enum_i_vals=(/tddfpt_davidson, tddfpt_lanczos/), &
default_i_val=tddfpt_davidson)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="OE_CORR", &
variants=s2a("ORBITAL_EIGENVALUES_CORRECTION"), &
description="Which type of orbital eigenvalue correction to use\n"// &
"(to yield better HOMO-LUMO energies)", &
usage="OE_CORR SAOP", &
enum_c_vals=s2a("NONE", "LB", "LB_ALPHA", "LB94", "GLLB", "GLB", "SAOP", "SIC"), &
enum_i_vals=(/oe_none, oe_lb, oe_lb, oe_lb, oe_gllb, oe_gllb, oe_saop, oe_sic/), &
default_i_val=oe_none)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
! Real
CALL keyword_create(keyword, name="CONVERGENCE", &
variants=s2a("CONV"), &
description="The convergence of the eigenvalues", &
usage="CONVERGENCE 1.0E-6 ", &
n_var=1, type_of_var=real_t, &
default_r_val=1.0e-5_dp)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL create_xc_section(subsection)
CALL section_add_subsection(section, subsection)
CALL section_release(subsection)
CALL create_sic_section(subsection)
CALL section_add_subsection(section, subsection)
CALL section_release(subsection)
END SUBROUTINE create_tddfpt_section
! **************************************************************************************************
!> \brief creates the input section for the relativistic part
!> \param section the section to create
!> \author jens
! **************************************************************************************************
SUBROUTINE create_relativistic_section(section)
TYPE(section_type), POINTER :: section
CHARACTER(len=*), PARAMETER :: routineN = 'create_relativistic_section', &
routineP = moduleN//':'//routineN
TYPE(keyword_type), POINTER :: keyword
CPASSERT(.NOT. ASSOCIATED(section))
CALL section_create(section, "relativistic", &
description="parameters needed and setup for relativistic calculations", &
n_keywords=5, n_subsections=0, repeats=.FALSE.)
NULLIFY (keyword)
CALL keyword_create(keyword, name="method", &
description="type of relativistic correction used", &
usage="method (NONE|DKH|ZORA)", default_i_val=rel_none, &
enum_c_vals=s2a("NONE", "DKH", "ZORA"), &
enum_i_vals=(/rel_none, rel_dkh, rel_zora/), &
enum_desc=s2a("Use no relativistic correction", &
"Use Douglas-Kroll-Hess method", &
"Use ZORA method"))
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="DKH_order", &
description="The order of the DKH transformation ", &
usage="DKH_order 2", default_i_val=2)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="ZORA_type", &
description="Type of ZORA method to be used", &
usage="ZORA_type scMP", default_i_val=rel_zora_full, &
enum_c_vals=s2a("FULL", "MP", "scMP"), &
enum_desc=s2a("Full ZORA method (not implemented)", &
"ZORA with atomic model potential", &
"Scaled ZORA with atomic model potential"), &
enum_i_vals=(/rel_zora_full, rel_zora_mp, rel_sczora_mp/))
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="transformation", &
description="Type of DKH transformation", &
usage="transformation (FULL|MOLECULE|ATOM)", default_i_val=rel_trans_atom, &
enum_c_vals=s2a("FULL", "MOLECULE", "ATOM"), &
enum_i_vals=(/rel_trans_full, rel_trans_molecule, rel_trans_atom/), &
enum_desc=s2a("Use full matrix transformation", &
"Use transformation blocked by molecule", &
"Use atomic blocks"))
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="z_cutoff", &
description="The minimal atomic number considered for atom transformation", &
usage="z_cutoff 50", default_i_val=1)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="potential", &
description="External potential used in DKH transformation, full 1/r or erfc(r)/r", &
usage="POTENTIAL {FULL,ERFC}", default_i_val=rel_pot_erfc, &
enum_c_vals=s2a("FULL", "ERFC"), &
enum_i_vals=(/rel_pot_full, rel_pot_erfc/))
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
END SUBROUTINE create_relativistic_section
! **************************************************************************************************
!> \brief creates the structure of the section with the DFT SCF parameters
!> \param section will contain the SCF section
!> \author fawzi
! **************************************************************************************************
SUBROUTINE create_scf_section(section)
TYPE(section_type), POINTER :: section
CHARACTER(len=*), PARAMETER :: routineN = 'create_scf_section', &
routineP = moduleN//':'//routineN
TYPE(keyword_type), POINTER :: keyword
TYPE(section_type), POINTER :: print_key, subsection
NULLIFY (print_key)
CPASSERT(.NOT. ASSOCIATED(section))
CALL section_create(section, "scf", &
description="Parameters needed to perform an SCF run.", &
n_keywords=18, n_subsections=7, repeats=.FALSE.)
NULLIFY (subsection)
CALL create_ot_section(subsection)
CALL section_add_subsection(section, subsection)
CALL section_release(subsection)
CALL create_diagonalization_section(subsection)
CALL section_add_subsection(section, subsection)
CALL section_release(subsection)
CALL create_outer_scf_section(subsection)
CALL section_add_subsection(section, subsection)
CALL section_release(subsection)
CALL create_smear_section(subsection)
CALL section_add_subsection(section, subsection)
CALL section_release(subsection)
CALL create_mixing_section(subsection)
CALL section_add_subsection(section, subsection)
CALL section_release(subsection)
CALL create_mom_section(subsection)
CALL section_add_subsection(section, subsection)
CALL section_release(subsection)
NULLIFY (keyword)
CALL keyword_create(keyword, name="MAX_ITER_LUMO", &
variants=(/"MAX_ITER_LUMOS"/), &
description="The maximum number of iteration for the lumo computation", &
usage="MAX_ITER_LUMO 100", default_i_val=299)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="EPS_LUMO", &
variants=(/"EPS_LUMOS"/), &
description="target accuracy of the computation of the lumo energy", &
usage="EPS_LUMO 1.e-6", default_r_val=1.0e-5_dp)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="MAX_SCF", &
description="Maximum number of SCF iteration to be performed for one optimization", &
usage="MAX_SCF 200", default_i_val=50)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="MAX_SCF_HISTORY", variants=(/"MAX_SCF_HIST"/), &
description="Maximum number of SCF iterations after the history pipeline is filled", &
usage="MAX_SCF_HISTORY 1", default_i_val=0, lone_keyword_i_val=1)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="MAX_DIIS", &
variants=(/"MAX_DIIS_BUFFER_SIZE"/), &
description="Maximum number of DIIS vectors to be used", &
usage="MAX_DIIS 3", default_i_val=4)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="LEVEL_SHIFT", &
variants=(/"LSHIFT"/), &
description="Use level shifting to improve convergence", &
usage="LEVEL_SHIFT 0.1", default_r_val=0._dp)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="EPS_SCF", &
description="Target accuracy for the SCF convergence.", &
usage="EPS_SCF 1.e-6", default_r_val=1.e-5_dp)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="EPS_SCF_HISTORY", variants=(/"EPS_SCF_HIST"/), &
description="Target accuracy for the SCF convergence after the history pipeline is filled.", &
usage="EPS_SCF_HISTORY 1.e-5", default_r_val=0.0_dp, lone_keyword_r_val=1.0e-5_dp)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="CHOLESKY", &
description="If the cholesky method should be used for computing "// &
"the inverse of S, and in this case calling which Lapack routines", &
usage="CHOLESKY REDUCE", default_i_val=cholesky_restore, &
enum_c_vals=s2a("OFF", "REDUCE", "RESTORE", "INVERSE", "INVERSE_DBCSR"), &
enum_desc=s2a("The cholesky algorithm is not used", "Reduce is called", &
"Reduce is replaced by two restore", &
"Restore uses operator multiply by inverse of the triangular matrix", &
"Like inverse, but matrix stored as dbcsr, sparce matrix algebra used when possible"), &
enum_i_vals=(/cholesky_off, cholesky_reduce, cholesky_restore, cholesky_inverse, cholesky_dbcsr/))
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="EPS_EIGVAL", &
description="Throw away linear combinations of basis functions with a small eigenvalue in S", &
usage="EPS_EIGVAL 1.0", default_r_val=1.0e-5_dp)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="EPS_DIIS", &
description="Threshold on the convergence to start using DIAG/DIIS", &
usage="EPS_DIIS 5.0e-2", default_r_val=0.1_dp)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create( &
keyword, name="SCF_GUESS", &
description="Change the initial guess for the wavefunction.", &
usage="SCF_GUESS RESTART", default_i_val=atomic_guess, &
enum_c_vals=s2a("ATOMIC", "RESTART", "RANDOM", "CORE", &
"HISTORY_RESTART", "MOPAC", "SPARSE", "NONE"), &
enum_desc=s2a("Generate an atomic density using the atomic code", &
"Use the RESTART file as an initial guess (and ATOMIC if not present).", &
"Use random wavefunction coefficients.", &
"Diagonalize the core hamiltonian for an initial guess.", &
"Extrapolated from previous RESTART files.", &
"Use same guess as MOPAC for semi-empirical methods or a simple diagonal density matrix for other methods", &
"Generate a sparse wavefunction using the atomic code (for OT based methods)", &
"Skip initial guess (only for NON-SCC DFTB)."), &
enum_i_vals=(/atomic_guess, restart_guess, random_guess, core_guess, &
history_guess, mopac_guess, sparse_guess, no_guess/))
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="NROW_BLOCK", &
description="sets the number of rows in a scalapack block", &
usage="NROW_BLOCK 31", default_i_val=32)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="NCOL_BLOCK", &
description="Sets the number of columns in a scalapack block", &
usage="NCOL_BLOCK 31", default_i_val=32)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="ADDED_MOS", &
description="Number of additional MOS added for each spin", &
usage="ADDED_MOS", default_i_val=0, n_var=-1)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword=keyword, &
name="ROKS_SCHEME", &
description="Selects the ROKS scheme when ROKS is applied.", &
usage="ROKS_SCHEME HIGH-SPIN", &
repeats=.FALSE., &
n_var=1, &
enum_c_vals=s2a("GENERAL", "HIGH-SPIN"), &
enum_i_vals=(/general_roks, high_spin_roks/), &
default_i_val=high_spin_roks)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword=keyword, &
name="ROKS_F", &
variants=(/"F_ROKS"/), &
description="Allows to define the parameter f for the "// &
"general ROKS scheme.", &
usage="ROKS_PARAMETER 1/2", &
repeats=.FALSE., &
n_var=1, &
type_of_var=real_t, &
default_r_val=0.5_dp)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword=keyword, &
name="ROKS_PARAMETERS", &
variants=(/"ROKS_PARAMETER"/), &
description="Allows to define all parameters for the high-spin "// &
"ROKS scheme explicitly. "// &
"The full set of 6 parameters has to be specified "// &
"in the order acc, bcc, aoo, boo, avv, bvv", &
usage="ROKS_PARAMETERS 1/2 1/2 1/2 1/2 1/2 1/2", &
repeats=.FALSE., &
n_var=6, &
type_of_var=real_t, &
default_r_vals=(/-0.5_dp, 1.5_dp, 0.5_dp, 0.5_dp, 1.5_dp, -0.5_dp/))
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL section_create(subsection, "PRINT", "Printing of information during the SCF.", &
repeats=.FALSE.)
CALL cp_print_key_section_create(print_key, "RESTART", &
description="Controls the dumping of the MO restart file during SCF."// &
"By default keeps a short history of three restarts."// &
"See also RESTART_HISTORY", &
print_level=low_print_level, common_iter_levels=3, &
each_iter_names=s2a("QS_SCF"), each_iter_values=(/20/), &
add_last=add_last_numeric, filename="RESTART")
CALL keyword_create(keyword, name="BACKUP_COPIES", &
description="Specifies the maximum index of backup copies.", &
usage="BACKUP_COPIES {int}", &
default_i_val=3)
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
CALL section_add_subsection(subsection, print_key)
CALL section_release(print_key)
CALL cp_print_key_section_create( &
print_key, "RESTART_HISTORY", &
description="Dumps unique MO restart files during the run keeping all of them.", &
print_level=low_print_level, common_iter_levels=0, &
each_iter_names=s2a("__ROOT__", "MD", "GEO_OPT", "ROT_OPT", "NEB", "METADYNAMICS", "QS_SCF"), &
each_iter_values=(/500, 500, 500, 500, 500, 500, 500/), &
filename="RESTART")
CALL keyword_create(keyword, name="BACKUP_COPIES", &
description="Specifies the maximum index of backup copies.", &
usage="BACKUP_COPIES {int}", &
default_i_val=3)
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
CALL section_add_subsection(subsection, print_key)
CALL section_release(print_key)
CALL cp_print_key_section_create(print_key, "iteration_info", &
description="Controls the printing of basic iteration information during the SCF.", &
print_level=low_print_level, add_last=add_last_numeric, filename="__STD_OUT__")
CALL keyword_create(keyword, name="time_cumul", &
description="If the printkey is activated switches the printing of timings"// &
" to cumulative (over the SCF).", &
default_l_val=.FALSE., lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
CALL section_add_subsection(subsection, print_key)
CALL section_release(print_key)
CALL cp_print_key_section_create(print_key, "program_run_info", &
description="Controls the printing of basic information during the SCF.", &
print_level=low_print_level, add_last=add_last_numeric, filename="__STD_OUT__")
CALL section_add_subsection(subsection, print_key)
CALL section_release(print_key)
CALL cp_print_key_section_create(print_key, "MO_ORTHONORMALITY", &
description="Controls the printing relative to the orthonormality of MOs (CT S C).", &
print_level=high_print_level, add_last=add_last_numeric, filename="__STD_OUT__")
CALL section_add_subsection(subsection, print_key)
CALL section_release(print_key)
CALL cp_print_key_section_create(print_key, "MO_MAGNITUDE", &
description="Prints the min/max eigenvalues of the overlap of the MOs without S (CT C).", &
print_level=high_print_level, add_last=add_last_numeric, filename="__STD_OUT__")
CALL section_add_subsection(subsection, print_key)
CALL section_release(print_key)
CALL cp_print_key_section_create(print_key, "detailed_energy", &
description="Controls the printing of detailed energy information.", &
print_level=high_print_level, add_last=add_last_numeric, filename="__STD_OUT__")
CALL section_add_subsection(subsection, print_key)
CALL section_release(print_key)
CALL cp_print_key_section_create(print_key, "diis_info", &
description="Controls the printing of DIIS information.", &
print_level=high_print_level, add_last=add_last_numeric, filename="__STD_OUT__")
CALL section_add_subsection(subsection, print_key)
CALL section_release(print_key)
CALL cp_print_key_section_create(print_key, "total_densities", &
description="Controls the printing of total densities.", &
print_level=high_print_level, add_last=add_last_numeric, filename="__STD_OUT__")
CALL section_add_subsection(subsection, print_key)
CALL section_release(print_key)
CALL cp_print_key_section_create(print_key, "Lanczos", &
description="Controls the printing of information on Lanczos refinement iterations.", &
print_level=high_print_level, add_last=add_last_numeric, filename="__STD_OUT__")
CALL section_add_subsection(subsection, print_key)
CALL section_release(print_key)
CALL cp_print_key_section_create( &
print_key, "DIAG_SUB_SCF", &
description="Controls the printing of information on subspace diagonalization internal loop. ", &
print_level=high_print_level, add_last=add_last_numeric, filename="__STD_OUT__")
CALL section_add_subsection(subsection, print_key)
CALL section_release(print_key)
CALL cp_print_key_section_create(print_key, "Davidson", &
description="Controls the printing of information on Davidson iterations.", &
print_level=high_print_level, add_last=add_last_numeric, filename="__STD_OUT__")
CALL section_add_subsection(subsection, print_key)
CALL section_release(print_key)
CALL cp_print_key_section_create(print_key, "FILTER_MATRIX", &
description="Controls the printing of information on Filter Matrix method.", &
print_level=high_print_level, add_last=add_last_numeric, filename="__STD_OUT__")
CALL section_add_subsection(subsection, print_key)
CALL section_release(print_key)
CALL keyword_create(keyword, name="DM_RESTART_WRITE", &
description="Write the density matrix into a binary file at the end of the SCF.", &
usage="DM_RESTART_WRITE", default_l_val=.FALSE., lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(subsection, keyword)
CALL keyword_release(keyword)
CALL cp_print_key_section_create(print_key, "MOS_MOLDEN", &
description="Write the molecular orbitals in Molden file format, for visualisation.", &
print_level=debug_print_level+1, add_last=add_last_numeric, filename="MOS")
CALL keyword_create(keyword, name="NDIGITS", &
description="Specifies the number of signficiant digits retained. 3 is OK for visualization.", &
usage="NDIGITS {int}", &
default_i_val=3)
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
CALL section_add_subsection(subsection, print_key)
CALL section_release(print_key)
CALL section_add_subsection(section, subsection)
CALL section_release(subsection)
END SUBROUTINE create_scf_section
! **************************************************************************************************
!> \brief creates the KG section
!> \param section ...
!> \author Martin Haeufel [2012.07]
! **************************************************************************************************
SUBROUTINE create_kg_section(section)
TYPE(section_type), POINTER :: section
CHARACTER(len=*), PARAMETER :: routineN = 'create_kg_section', &
routineP = moduleN//':'//routineN
TYPE(keyword_type), POINTER :: keyword
TYPE(section_type), POINTER :: print_key, subsection, subsubsection
CPASSERT(.NOT. ASSOCIATED(section))
CALL section_create(section, "KG_METHOD", &
description="Specifies the parameters for a Kim-Gordon-like partitioning"// &
" into molecular subunits", &
n_keywords=0, n_subsections=1, repeats=.FALSE., &
citations=(/Iannuzzi2006, Brelaz1979, Andermatt2016/))
NULLIFY (keyword, subsection, print_key)
! add a XC section
CALL create_xc_section(subsection)
CALL section_add_subsection(section, subsection)
CALL section_release(subsection)
! add LRI section
CALL create_lrigpw_section(subsection)
CALL section_add_subsection(section, subsection)
CALL section_release(subsection)
CALL keyword_create(keyword, name="COLORING_METHOD", &
description="Which algorithm to use for coloring.", &
usage="COLORING_METHOD GREEDY", &
default_i_val=kg_color_dsatur, &
enum_c_vals=s2a("DSATUR", "GREEDY"), &
enum_desc=s2a("Maximum degree of saturation, relatively accurate", &
"Greedy, fast coloring, less accurate"), &
enum_i_vals=(/kg_color_dsatur, kg_color_greedy/))
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="TNADD_METHOD", &
description="Algorithm to use for the calculation of the nonadditive kinetic energy.", &
usage="TNADD_METHOD ATOMIC", &
default_i_val=kg_tnadd_embed, &
enum_c_vals=s2a("EMBEDDING", "RI_EMBEDDING", "ATOMIC", "NONE"), &
enum_desc=s2a("Use full embedding potential (see Iannuzzi et al)", &
"Use full embedding potential with RI density fitting", &
"Use sum of atomic model potentials", &
"Do not use kinetic energy embedding"), &
enum_i_vals=(/kg_tnadd_embed, kg_tnadd_embed_ri, kg_tnadd_atomic, kg_tnadd_none/))
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL section_create(subsection, name="PRINT", &
description="Print section", &
n_keywords=0, n_subsections=1, repeats=.FALSE.)
CALL cp_print_key_section_create(print_key, "NEIGHBOR_LISTS", &
description="Controls the printing of the neighbor lists.", &
print_level=low_print_level, filename="__STD_OUT__", unit_str="angstrom")
CALL keyword_create(keyword=keyword, &
name="SAB_ORB_FULL", &
description="Activates the printing of the full orbital "// &
"orbital neighbor lists.", &
default_l_val=.FALSE., &
lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword=keyword, &
name="SAB_ORB_MOLECULAR", &
description="Activates the printing of the orbital "// &
"orbital neighbor lists for molecular subsets.", &
default_l_val=.FALSE., &
lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword=keyword, &
name="SAC_KIN", &
description="Activates the printing of the orbital "// &
"atomic potential neighbor list.", &
default_l_val=.FALSE., &
lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
CALL section_add_subsection(subsection, print_key)
CALL section_release(print_key)
CALL section_add_subsection(section, subsection)
CALL section_release(subsection)
!!!!!!!!!!!!!!! ENERGY_CORRECTION SECTION !!!!!!!!!!!!!!!!!!!
NULLIFY (keyword, subsection, print_key)
CALL section_create(subsection, name="ENERGY_CORRECTION", &
description="Sets the various options for the Energy Correction", &
n_keywords=0, n_subsections=1, repeats=.FALSE.)
CALL keyword_create(keyword, name="_SECTION_PARAMETERS_", &
description="Controls the activation of the energy_correction", &
usage="&ENERGY_CORRECTION T", &
default_l_val=.FALSE., &
lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(subsection, keyword)
CALL keyword_release(keyword)
! add a special XC section
NULLIFY (subsubsection)
CALL create_xc_section(subsubsection)
CALL section_add_subsection(subsection, subsubsection)
CALL section_release(subsubsection)
CALL keyword_create(keyword, name="ENERGY_FUNCTIONAL", &
description="Functional used in energy correction", &
usage="ENERGY_FUNCTIONAL HARRIS", &
default_i_val=kg_ec_functional_harris, &
enum_c_vals=s2a("HARRIS"), &
enum_desc=s2a("Harris functional"), &
enum_i_vals=(/kg_ec_functional_harris/))
CALL section_add_keyword(subsection, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="HARRIS_BASIS", &
description="Specifies the type of basis to be used for the KG energy correction."// &
"Options are: (1) the default orbital basis (ORBITAL);"// &
"(2) the primitive functions of the default orbital basis (PRIMITIVE);"// &
"(3) the basis set labeled in Kind section (HARRIS)", &
usage="HARRIS_BASIS ORBITAL", &
type_of_var=char_t, default_c_val="ORBITAL", n_var=-1)
CALL section_add_keyword(subsection, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="MAO", &
description="Use modified atomic orbitals (MAO) to solve Harris equation", &
usage="MAO T", default_l_val=.FALSE., lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(subsection, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="MAO_MAX_ITER", &
description="Maximum iterations in MAO optimization. ", &
usage="MAO_MAX_ITER 100 ", default_i_val=0)
CALL section_add_keyword(subsection, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="MAO_EPS_GRAD", &
description="Threshold used for MAO iterations. ", &
usage="MAO_EPS_GRAD 1.0E-4 ", default_r_val=1.0E-5_dp)
CALL section_add_keyword(subsection, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="ALGORITHM", &
description="Algorithm used to solve KS equation", &
usage="ALGORITHM DIAGONALIZATION", &
default_i_val=kg_ec_diagonalization, &
enum_c_vals=s2a("DIAGONALIZATION"), &
enum_desc=s2a("Diagonalization of KS matrix."), &
enum_i_vals=(/kg_ec_diagonalization/))
CALL section_add_keyword(subsection, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="FACTORIZATION", &
description="Algorithm used to calculate factorization of overlap matrix", &
usage="FACTORIZATION CHOLESKY", &
default_i_val=kg_cholesky, &
enum_c_vals=s2a("CHOLESKY"), &
enum_desc=s2a("Cholesky factorization of overlap matrix"), &
enum_i_vals=(/kg_cholesky/))
CALL section_add_keyword(subsection, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="EPS_DEFAULT", &
description="Threshold used for accuracy estimates within energy correction algorithms. ", &
usage="EPS_DEFAULT 1.0E-6 ", default_r_val=1.0E-12_dp)
CALL section_add_keyword(subsection, keyword)
CALL keyword_release(keyword)
CALL section_add_subsection(section, subsection)
CALL section_release(subsection)
END SUBROUTINE create_kg_section
! **************************************************************************************************
!> \brief creates the structure of the section with SCF parameters
!> controlling an other loop
!> \param section will contain the SCF section
!> \author Joost VandeVondele [2006.03]
! **************************************************************************************************
SUBROUTINE create_outer_scf_section(section)
TYPE(section_type), POINTER :: section
CHARACTER(len=*), PARAMETER :: routineN = 'create_outer_scf_section', &
routineP = moduleN//':'//routineN
TYPE(keyword_type), POINTER :: keyword
TYPE(section_type), POINTER :: subsection
CPASSERT(.NOT. ASSOCIATED(section))
CALL section_create(section, "OUTER_SCF", &
description="parameters controlling the outer SCF loop", &
n_keywords=13, n_subsections=1, repeats=.FALSE.)
NULLIFY (keyword)
CALL keyword_create(keyword, name="_SECTION_PARAMETERS_", &
description="controls the activation of the outer SCF loop", &
usage="&OUTER_SCF ON", default_l_val=.FALSE., lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
! add CDFT_OPT section
NULLIFY (subsection)
CALL create_cdft_opt_section(subsection)
CALL section_add_subsection(section, subsection)
CALL section_release(subsection)
CALL keyword_create(keyword, name="TYPE", &
description="Specifies which kind of outer SCF should be employed", &
usage="TYPE DDAPC_CONSTRAINT ", &
default_i_val=outer_scf_none, &
enum_c_vals=s2a("DDAPC_CONSTRAINT", "S2_CONSTRAINT", "BECKE_CONSTRAINT", &
"BASIS_CENTER_OPT", "CDFT_CONSTRAINT", "NONE"), &
enum_desc=s2a("Enforce a constraint on the DDAPC, requires the corresponding section", &
"Enforce a constraint on the S2, requires the corresponding section", &
"Enforce a constraint on the Becke weight population, "// &
"requires the corresponding section", &
"Optimize positions of basis functions, if atom types FLOATING_BASIS_CENTER "// &
" are defined", &
"Enforce a constraint on a generic CDFT weight population, "// &
"requires the corresponding section"// &
" which determines the type of weight used "// &
"(currently only Gaussian Hirshfeld supported)", &
"Do nothing in the outer loop, useful for resetting the inner loop,"), &
enum_i_vals=(/outer_scf_ddapc_constraint, outer_scf_s2_constraint, &
outer_scf_becke_constraint, outer_scf_basis_center_opt, &
outer_scf_cdft_constraint, outer_scf_none/))
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="OPTIMIZER", &
description="Method used to bring the outer loop to a stationary point", &
usage="OPTIMIZER SD", &
default_i_val=outer_scf_optimizer_none, &
enum_c_vals=s2a("SD", "DIIS", "NONE", "BISECT", "BROYDEN", "NEWTON", "SECANT", "NEWTON_LS"), &
enum_desc=s2a("Takes steps in the direction of the gradient, multiplied by step_size", &
"Uses a Direct Inversion in the Iterative Subspace method", &
"Do nothing, useful only with the none type", &
"Bisection of the gradient, useful for difficult one dimensional cases", &
"Broyden's method. Variant defined in BROYDEN_TYPE.", &
"Newton's method. Only compatible with CDFT constraints.", &
"Secant method. Only for one dimensional cases. See Broyden for "// &
"multidimensional cases.", &
"Newton's method with backtracking line search to find the optimal step size. "// &
"Only compatible with CDFT constraints. Starts from the regular Newton solution "// &
"and successively reduces the step size until the L2 norm of the CDFT gradient "// &
"decreases or MAX_LS steps is reached. Potentially very expensive because "// &
"each iteration performs a full SCF calculation."), &
enum_i_vals=(/outer_scf_optimizer_sd, outer_scf_optimizer_diis, outer_scf_optimizer_none, &
outer_scf_optimizer_bisect, outer_scf_optimizer_broyden, &
outer_scf_optimizer_newton, outer_scf_optimizer_secant, &
outer_scf_optimizer_newton_ls/))
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="BISECT_TRUST_COUNT", &
description="Maximum number of times the same point will be used in bisection,"// &
" a small number guards against the effect of wrongly converged states.", &
usage="BISECT_TRUST_COUNT 5", default_i_val=10)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="EPS_SCF", &
description="The target gradient of the outer SCF variables. "// &
"Notice that the EPS_SCF of the inner loop also determines "// &
"the value that can be reached in the outer loop, "// &
"typically EPS_SCF of the outer loop must be smaller "// &
"than EPS_SCF of the inner loop.", &
usage="EPS_SCF 1.0E-6 ", default_r_val=1.0E-5_dp)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="DIIS_BUFFER_LENGTH", &
description="Maximum number of DIIS vectors used ", &
usage="DIIS_BUFFER_LENGTH 5", default_i_val=3)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="EXTRAPOLATION_ORDER", &
description="Number of past states used in the extrapolation of the variables during e.g. MD", &
usage="EXTRAPOLATION_ORDER 5", default_i_val=3)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="MAX_SCF", &
description="The maximum number of outer loops ", &
usage="MAX_SCF 20", default_i_val=50)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="STEP_SIZE", &
description="The initial step_size used in the optimizer (currently steepest descent). "// &
"Note that in cases where a sadle point is sought for (constrained DFT),"// &
" this can be negative. For Newton and Broyden optimizers, use a value less/higher than "// &
"the default 1.0 (in absolute value, the sign is not significant) to active an under/overrelaxed "// &
"optimizer.", &
usage="STEP_SIZE -1.0", default_r_val=0.5_dp)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
END SUBROUTINE create_outer_scf_section
! **************************************************************************************************
!> \brief Create the BSSE section for counterpoise correction
!> \param section the section to create
!> \author teo
! **************************************************************************************************
SUBROUTINE create_bsse_section(section)
TYPE(section_type), POINTER :: section
CHARACTER(len=*), PARAMETER :: routineN = 'create_bsse_section', &
routineP = moduleN//':'//routineN
TYPE(keyword_type), POINTER :: keyword
TYPE(section_type), POINTER :: subsection
CPASSERT(.NOT. ASSOCIATED(section))
CALL section_create(section, name="BSSE", &
description="This section is used to set up the BSSE calculation. "// &
"It also requires that for each atomic kind X a kind X_ghost is present, "// &
"with the GHOST keyword specified, in addition to the other required fields.", &
n_keywords=3, n_subsections=1, repeats=.FALSE.)
NULLIFY (keyword, subsection)
! FRAGMENT SECTION
CALL section_create(subsection, name="FRAGMENT", &
description="Specify the atom number belonging to this fragment.", &
n_keywords=2, n_subsections=0, repeats=.TRUE.)
CALL keyword_create(keyword, name="LIST", &
description="Specifies a list of atoms.", &
usage="LIST {integer} {integer} .. {integer}", &
repeats=.TRUE., n_var=-1, type_of_var=integer_t)
CALL section_add_keyword(subsection, keyword)
CALL keyword_release(keyword)
CALL section_add_subsection(section, subsection)
CALL section_release(subsection)
! CONFIGURATION SECTION
CALL section_create(subsection, name="CONFIGURATION", &
description="Specify additional parameters for the combinatorial configurations.", &
n_keywords=2, n_subsections=0, repeats=.TRUE.)
CALL keyword_create(keyword, name="GLB_CONF", &
description="Specifies the global configuration using 1 or 0.", &
usage="GLB_CONF {integer} {integer} .. {integer}", &
n_var=-1, type_of_var=integer_t)
CALL section_add_keyword(subsection, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="SUB_CONF", &
description="Specifies the subconfiguration using 1 or 0 belonging to the global configuration.", &
usage="SUB_CONF {integer} {integer} .. {integer}", &
n_var=-1, type_of_var=integer_t)
CALL section_add_keyword(subsection, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword=keyword, &
name="MULTIPLICITY", &
variants=(/"MULTIP"/), &
description="Specify for each fragment the multiplicity. Two times the total spin plus one. "// &
"Specify 3 for a triplet, 4 for a quartet,and so on. Default is 1 (singlet) for an "// &
"even number and 2 (doublet) for an odd number of electrons.", &
usage="MULTIPLICITY 3", &
default_i_val=0) ! this default value is just a flag to get the above
CALL section_add_keyword(subsection, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="CHARGE", &
description="The total charge for each fragment.", &
usage="CHARGE -1", &
default_i_val=0)
CALL section_add_keyword(subsection, keyword)
CALL keyword_release(keyword)
CALL section_add_subsection(section, subsection)
CALL section_release(subsection)
CALL section_create(subsection, name="FRAGMENT_ENERGIES", &
description="This section contains the energies of the fragments already"// &
" computed. It is useful as a summary and specifically for restarting BSSE runs.", &
n_keywords=2, n_subsections=0, repeats=.TRUE.)
CALL keyword_create(keyword, name="_DEFAULT_KEYWORD_", &
description="The energy computed for each fragment", repeats=.TRUE., &
usage="{REAL}", type_of_var=real_t)
CALL section_add_keyword(subsection, keyword)
CALL keyword_release(keyword)
CALL section_add_subsection(section, subsection)
CALL section_release(subsection)
CALL create_print_bsse_section(subsection)
CALL section_add_subsection(section, subsection)
CALL section_release(subsection)
END SUBROUTINE create_bsse_section
! **************************************************************************************************
!> \brief Create the print bsse section
!> \param section the section to create
!> \author teo
! **************************************************************************************************
SUBROUTINE create_print_bsse_section(section)
TYPE(section_type), POINTER :: section
CHARACTER(len=*), PARAMETER :: routineN = 'create_print_bsse_section', &
routineP = moduleN//':'//routineN
TYPE(section_type), POINTER :: print_key
CPASSERT(.NOT. ASSOCIATED(section))
CALL section_create(section, name="print", &
description="Section of possible print options in BSSE code.", &
n_keywords=0, n_subsections=1, repeats=.FALSE.)
NULLIFY (print_key)
CALL cp_print_key_section_create(print_key, "PROGRAM_RUN_INFO", &
description="Controls the printing of information regarding the run.", &
print_level=low_print_level, filename="__STD_OUT__")
CALL section_add_subsection(section, print_key)
CALL section_release(print_key)
CALL cp_print_key_section_create(print_key, "RESTART", &
description="Controls the dumping of the restart file during BSSE runs."// &
"By default the restart is updated after each configuration calculation is "// &
" completed.", &
print_level=silent_print_level, common_iter_levels=0, &
add_last=add_last_numeric, filename="")
CALL section_add_subsection(section, print_key)
CALL section_release(print_key)
END SUBROUTINE create_print_bsse_section
! **************************************************************************************************
!> \brief creates the interpolation section for the periodic QM/MM
!> \param section ...
!> \author tlaino
! **************************************************************************************************
SUBROUTINE create_gspace_interp_section(section)
TYPE(section_type), POINTER :: section
CHARACTER(len=*), PARAMETER :: routineN = 'create_gspace_interp_section', &
routineP = moduleN//':'//routineN
TYPE(keyword_type), POINTER :: keyword
TYPE(section_type), POINTER :: print_key
CPASSERT(.NOT. ASSOCIATED(section))
CALL section_create(section, name="interpolator", &
description="controls the interpolation for the G-space term", &
n_keywords=5, n_subsections=0, repeats=.FALSE.)
NULLIFY (keyword, print_key)
CALL keyword_create(keyword, name="aint_precond", &
description="the approximate inverse to use to get the starting point"// &
" for the linear solver of the spline3 methods", &
usage="kind spline3", &
default_i_val=precond_spl3_aint, &
enum_c_vals=s2a("copy", "spl3_nopbc_aint1", "spl3_nopbc_precond1", &
"spl3_nopbc_aint2", "spl3_nopbc_precond2", "spl3_nopbc_precond3"), &
enum_i_vals=(/no_precond, precond_spl3_aint, precond_spl3_1, &
precond_spl3_aint2, precond_spl3_2, precond_spl3_3/))
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="precond", &
description="The preconditioner used"// &
" for the linear solver of the spline3 methods", &
usage="kind spline3", &
default_i_val=precond_spl3_3, &
enum_c_vals=s2a("copy", "spl3_nopbc_aint1", "spl3_nopbc_precond1", &
"spl3_nopbc_aint2", "spl3_nopbc_precond2", "spl3_nopbc_precond3"), &
enum_i_vals=(/no_precond, precond_spl3_aint, precond_spl3_1, &
precond_spl3_aint2, precond_spl3_2, precond_spl3_3/))
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="eps_x", &
description="accuracy on the solution for spline3 the interpolators", &
usage="eps_x 1.e-15", default_r_val=1.e-10_dp)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="eps_r", &
description="accuracy on the residual for spline3 the interpolators", &
usage="eps_r 1.e-15", default_r_val=1.e-10_dp)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="max_iter", &
variants=(/'maxiter'/), &
description="the maximum number of iterations", &
usage="max_iter 200", default_i_val=100)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
NULLIFY (print_key)
CALL cp_print_key_section_create(print_key, "conv_info", &
description="if convergence information about the linear solver"// &
" of the spline methods should be printed", &
print_level=medium_print_level, each_iter_names=s2a("SPLINE_FIND_COEFFS"), &
each_iter_values=(/10/), filename="__STD_OUT__", &
add_last=add_last_numeric)
CALL section_add_subsection(section, print_key)
CALL section_release(print_key)
END SUBROUTINE create_gspace_interp_section
! **************************************************************************************************
!> \brief input section for optional parameters for LRIGPW
!> LRI: local resolution of identity
!> \param section the section to create
!> \author Dorothea Golze [02.2015]
! **************************************************************************************************
SUBROUTINE create_lrigpw_section(section)
TYPE(section_type), POINTER :: section
CHARACTER(len=*), PARAMETER :: routineN = 'create_lrigpw_section', &
routineP = moduleN//':'//routineN
TYPE(keyword_type), POINTER :: keyword
CPASSERT(.NOT. ASSOCIATED(section))
CALL section_create(section, name="LRIGPW", &
description="This section specifies optional parameters for LRIGPW.", &
n_keywords=3, n_subsections=0, repeats=.FALSE., citations=(/Golze2017b/))
NULLIFY (keyword)
CALL keyword_create(keyword, name="LRI_OVERLAP_MATRIX", &
description="Specifies whether to calculate the inverse or the "// &
"pseudoinverse of the overlap matrix of the auxiliary "// &
"basis set. Calculating the pseudoinverse is necessary "// &
"for very large auxiliary basis sets, but more expensive. "// &
"Using the pseudoinverse, consistent forces are not "// &
"guaranteed yet.", &
usage="LRI_OVERLAP_MATRIX INVERSE", &
enum_c_vals=s2a("INVERSE", "PSEUDO_INVERSE_SVD", "PSEUDO_INVERSE_DIAG", &
"AUTOSELECT"), &
enum_desc=s2a("Calculate inverse of the overlap matrix.", &
"Calculate the pseuodinverse of the overlap matrix "// &
"using singular value decomposition.", &
"Calculate the pseudoinverse of the overlap matrix "// &
"by prior diagonalization.", &
"Choose automatically for each pair whether to "// &
"calculate the inverse or pseudoinverse based on the "// &
"condition number of the overlap matrix for each pair. "// &
"Calculating the pseudoinverse is much more expensive."), &
enum_i_vals=(/do_lri_inv, do_lri_pseudoinv_svd, &
do_lri_pseudoinv_diag, do_lri_inv_auto/), &
default_i_val=do_lri_inv)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="MAX_CONDITION_NUM", &
description="If AUTOSELECT is chosen for LRI_OVERLAP_MATRIX, this "// &
"keyword specifies that the pseudoinverse is calculated "// &
"only if the LOG of the condition number of the lri "// &
"overlap matrix is larger than the given value.", &
usage="MAX_CONDITION_NUM 20.0", default_r_val=20.0_dp)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="EPS_O3_INT", &
description="Threshold for ABA and ABB integrals in LRI. "// &
"This is used for screening in the KS and "// &
"force calculations (tensor contractions).", &
usage="EPS_O3_INT 1.e-10", default_r_val=1.0e-14_dp)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="DEBUG_LRI_INTEGRALS", &
description="Debug the integrals needed for LRIGPW.", &
usage="DEBUG_LRI_INTEGRALS TRUE", &
default_l_val=.FALSE., lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="EXACT_1C_TERMS", &
description="Don't use LRI for one center densities.", &
usage="EXACT_1C_TERMS TRUE", &
default_l_val=.FALSE., lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="PPL_RI", &
description="Use LRI/RI for local pseudopotential.", &
usage="PPL_RI TRUE", &
default_l_val=.FALSE., lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="RI_STATISTIC", &
description="Print statistical information on the RI calculation.", &
usage="RI_STATISTIC TRUE", &
default_l_val=.FALSE., lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="DISTANT_PAIR_APPROXIMATION", &
description="Calculate distant pairs using an independent atom approximation.", &
usage="DISTANT_PAIR_APPROXIMATION TRUE", &
default_l_val=.FALSE., lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="DISTANT_PAIR_METHOD", &
description="Method used to separate pair density for distant pairs."// &
"Options: EW (equal weights); AW (atomic weights); SW (set weights); "// &
"LW (shell function weights)", &
usage="DISTANT_PAIR_METHOD {method}", &
default_c_val="LW")
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="DISTANT_PAIR_RADII", &
description="Inner and outer radii used in distant "// &
"pair separation. Smooth interpolation between inner and outer "// &
"radius is used.", &
usage="DISTANT_PAIR_RADII r_inner {real} r_outer {real} ", &
n_var=2, default_r_vals=(/8._dp, 12._dp/), unit_str='bohr', &
type_of_var=real_t)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="SHG_LRI_INTEGRALS", &
description="Uses the SHG (solid harmonic Gaussian) integral "// &
"scheme instead of Obara-Saika", &
usage="SHG_LRI_INTEGRALS TRUE", &
default_l_val=.TRUE., lone_keyword_l_val=.TRUE., &
citations=(/Golze2017a/))
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="RI_SINV", &
description="Approximation to be used for the inverse of the "// &
"RI overlap matrix. INVF, INVS: exact inverse, apply directly "// &
"for solver (F:full matrix, S:sparsematrix). AINV approximate inverse, use with PCG. "// &
"NONE: no approximation used with CG solver.", &
usage="RI_SINV NONE", default_c_val="INVF")
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
END SUBROUTINE create_lrigpw_section
! **************************************************************************************************
!> \brief input section for optimization of the auxililary basis for LRIGPW
!> \param section the section to create
!> \author Dorothea Golze [05.2014]
! **************************************************************************************************
SUBROUTINE create_optimize_lri_basis_section(section)
TYPE(section_type), POINTER :: section
CHARACTER(len=*), PARAMETER :: routineN = 'create_optimize_lri_basis_section', &
routineP = moduleN//':'//routineN
TYPE(keyword_type), POINTER :: keyword
TYPE(section_type), POINTER :: subsection
CPASSERT(.NOT. ASSOCIATED(section))
CALL section_create(section, name="OPTIMIZE_LRI_BASIS", &
description="This section specifies the parameters for optimizing "// &
"the lri auxiliary basis sets for LRIGPW. The Powell optimizer is used.", &
n_keywords=1, n_subsections=0, repeats=.FALSE.)
NULLIFY (keyword, subsection)
CALL keyword_create(keyword, name="ACCURACY", &
description="Target accuracy for the objective function (RHOEND)", &
usage="ACCURACY 5.0E-4", default_r_val=1.0E-5_dp)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="MAX_FUN", &
description="Maximum number of function evaluations", &
usage="MAX_FUN 200", default_i_val=4000)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="STEP_SIZE", &
description="Initial step size for search algorithm (RHOBEG)", &
usage="STEP_SIZE 1.0E-1", default_r_val=5.0E-2_dp)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="CONDITION_WEIGHT", &
description="This keyword allows to give different weight "// &
"factors to the condition number (LOG(cond) is used).", &
usage="CONDITION_WEIGHT 1.0E-4", default_r_val=1.0E-6_dp)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="USE_CONDITION_NUMBER", &
description="Determines whether condition number should be part "// &
"of optimization or not", &
usage="USE_CONDITION_NUMBER", &
default_l_val=.FALSE., lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="GEOMETRIC_SEQUENCE", &
description="Exponents are assumed to be a geometric squence. "// &
"Only the minimal and maximal exponents of one set are optimized and "// &
"the other exponents are obtained by geometric progression.", &
usage="GEOMETRIC_SEQUENCE", &
default_l_val=.FALSE., lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="DEGREES_OF_FREEDOM", &
description="Specifies the degrees of freedom in the basis "// &
"optimization.", &
usage="DEGREES_OF_FREEDOM ALL", &
enum_c_vals=s2a("ALL", "COEFFICIENTS", "EXPONENTS"), &
enum_desc=s2a("Set all parameters in the basis to be variable.", &
"Set all coefficients in the basis set to be variable.", &
"Set all exponents in the basis to be variable."), &
enum_i_vals=(/do_lri_opt_all, do_lri_opt_coeff, do_lri_opt_exps/), &
default_i_val=do_lri_opt_exps)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL create_constrain_exponents_section(subsection)
CALL section_add_subsection(section, subsection)
CALL section_release(subsection)
END SUBROUTINE create_optimize_lri_basis_section
! **************************************************************************************************
!> \brief Input for DFT embedding
!> \param section ...
!> \author Vladimir Rybkin [08.2017]
! **************************************************************************************************
SUBROUTINE create_optimize_embed(section)
TYPE(section_type), POINTER :: section
CHARACTER(len=*), PARAMETER :: routineN = 'create_optimize_embed', &
routineP = moduleN//':'//routineN
TYPE(keyword_type), POINTER :: keyword
CPASSERT(.NOT. ASSOCIATED(section))
CALL section_create(section, name="OPT_EMBED", &
description="This section specifies optional parameters for DFT embedding potential optimization.", &
n_keywords=15, n_subsections=3, repeats=.FALSE.)
NULLIFY (keyword)
CALL keyword_create(keyword, name="REG_LAMBDA", &
description="Parameter for Yang's regularization "// &
"involving kinetic matrix.", &
usage="REG_LAMBDA 0.0001", default_r_val=0.0001_dp)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="N_ITER", &
description="Maximum number of iterations "// &
"in the optimization procedure.", &
usage="N_ITER 75", default_i_val=50)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="TRUST_RAD", &
description="Maximum number of iterations "// &
"in the optimization procedure.", &
usage="TRUST_RAD 0.5", default_r_val=0.5_dp)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="DENS_CONV_MAX", &
description="Convergence criterion for "// &
"the maximum electron density difference.", &
usage="DENS_CONV_MAX 0.01", default_r_val=0.01_dp)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="DENS_CONV_INT", &
description="Convergence criterion for "// &
"the integrated electron density difference.", &
usage="DENS_CONV_INT 0.1", default_r_val=0.1_dp)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="SPIN_DENS_CONV_MAX", &
description="Convergence criterion for "// &
"the maximum electron density difference.", &
usage="DENS_CONV_MAX 0.01", default_r_val=0.01_dp)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="SPIN_DENS_CONV_INT", &
description="Convergence criterion for "// &
"the integrated electron density difference.", &
usage="DENS_CONV_INT 0.1", default_r_val=0.1_dp)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="OPTIMIZER", &
description="Optimize embedding potential.", &
usage="OPTIMIZER LEVEL_SHIFT", &
default_i_val=embed_steep_desc, &
enum_c_vals=s2a("STEEPEST_DESCENT", "QUASI_NEWTON", "LEVEL_SHIFT"), &
enum_desc=s2a("Steepest descent.", "Quasi-Newton.", "Level shift."), &
enum_i_vals=(/embed_steep_desc, embed_quasi_newton, embed_level_shift/))
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="GRID_OPT", &
description="Optimize embedding potential on the grid. ", &
usage="GRID_OPT .TRUE.", &
default_l_val=.FALSE.)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="ADD_CONST_POT", &
description="Apply level shift in the "// &
"optimization of the embedding potential.", &
usage="ADD_CONST_POT .FALSE.", default_l_val=.FALSE.)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="READ_EMBED_POT", &
description="Read the embedding potential "// &
"restart vector as a guess.", &
usage="READ_EMBED_POT .FALSE.", default_l_val=.FALSE.)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="READ_EMBED_POT_CUBE", &
description="Read the embedding potential "// &
"(restart) from the cube file.", &
usage="READ_EMBED_POT_CUBE .FALSE.", default_l_val=.FALSE.)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="EMBED_RESTART_FILE_NAME", &
description="Root of the file name where to read the embedding "// &
"potential guess.", &
usage="EMBED_RESTART_FILE_NAME <FILENAME>", &
type_of_var=lchar_t)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="EMBED_CUBE_FILE_NAME", &
description="Root of the file name where to read the embedding "// &
"potential (guess) as a cube.", &
usage="EMBED_CUBE_FILE_NAME <FILENAME>", &
type_of_var=lchar_t)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="EMBED_SPIN_CUBE_FILE_NAME", &
description="Root of the file name where to read the spin part "// &
"of the embedding potential (guess) as a cube.", &
usage="EMBED_SPIN_CUBE_FILE_NAME <FILENAME>", &
type_of_var=lchar_t)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL create_print_embed_diff(section)
CALL create_print_embed_pot_cube(section)
CALL create_print_embed_restart_vec(section)
END SUBROUTINE create_optimize_embed
! **************************************************************************************************
!> \brief ...
!> \param section ...
! **************************************************************************************************
SUBROUTINE create_print_embed_diff(section)
TYPE(section_type), POINTER :: section
CHARACTER(len=*), PARAMETER :: routineN = 'create_print_embed_diff', &
routineP = moduleN//':'//routineN
TYPE(keyword_type), POINTER :: keyword
TYPE(section_type), POINTER :: print_key
NULLIFY (print_key, keyword)
CALL cp_print_key_section_create(print_key, "EMBED_DENS_DIFF", &
description="Controls the printing of cube files with "// &
" embedding densisty differences", &
print_level=high_print_level, add_last=add_last_numeric, filename="")
CALL keyword_create(keyword, name="stride", &
description="The stride (X,Y,Z) used to write the cube file "// &
"(larger values result in smaller cube files). You can provide 3 numbers (for X,Y,Z) or"// &
" 1 number valid for all components.", &
usage="STRIDE 2 2 2", n_var=-1, default_i_vals=(/2, 2, 2/), type_of_var=integer_t)
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
CALL section_add_subsection(section, print_key)
CALL section_release(print_key)
END SUBROUTINE create_print_embed_diff
! **************************************************************************************************
!> \brief ...
!> \param section ...
! **************************************************************************************************
SUBROUTINE create_print_embed_pot_cube(section)
TYPE(section_type), POINTER :: section
CHARACTER(len=*), PARAMETER :: routineN = 'create_print_embed_pot_cube', &
routineP = moduleN//':'//routineN
TYPE(keyword_type), POINTER :: keyword
TYPE(section_type), POINTER :: print_key
NULLIFY (print_key, keyword)
CALL cp_print_key_section_create(print_key, "EMBED_POT_CUBE", &
description="Controls the printing of cube files with "// &
"with embedding potential", &
print_level=high_print_level, add_last=add_last_numeric, filename="")
CALL keyword_create(keyword, name="stride", &
description="The stride (X,Y,Z) used to write the cube file "// &
"(larger values result in smaller cube files). You can provide 3 numbers (for X,Y,Z) or"// &
" 1 number valid for all components.", &
usage="STRIDE 2 2 2", n_var=-1, default_i_vals=(/2, 2, 2/), type_of_var=integer_t)
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
CALL section_add_subsection(section, print_key)
CALL section_release(print_key)
END SUBROUTINE create_print_embed_pot_cube
! **************************************************************************************************
!> \brief ...
!> \param section ...
! **************************************************************************************************
SUBROUTINE create_print_embed_restart_vec(section)
TYPE(section_type), POINTER :: section
CHARACTER(len=*), PARAMETER :: routineN = 'create_print_embed_restart_vec', &
routineP = moduleN//':'//routineN
TYPE(section_type), POINTER :: print_key
NULLIFY (print_key)
CALL cp_print_key_section_create(print_key, "EMBED_POT_VECTOR", &
description="Controls the printing of cube files with "// &
"with embedding potential", &
print_level=silent_print_level, add_last=add_last_numeric, filename="")
CALL section_add_subsection(section, print_key)
CALL section_release(print_key)
END SUBROUTINE create_print_embed_restart_vec
! **************************************************************************************************
!> \brief input section for optional parameters for RIGPW
!> \param section the section to create
!> \author JGH [06.2017]
! **************************************************************************************************
SUBROUTINE create_rigpw_section(section)
TYPE(section_type), POINTER :: section
CHARACTER(len=*), PARAMETER :: routineN = 'create_rigpw_section', &
routineP = moduleN//':'//routineN
CPASSERT(.NOT. ASSOCIATED(section))
CALL section_create(section, name="RIGPW", &
description="This section specifies optional parameters for RIGPW.", &
n_keywords=1, n_subsections=0, repeats=.FALSE.)
! CALL keyword_create(keyword, name="RI_OVERLAP_MATRIX", &
! description="Specifies whether to calculate the inverse or the "// &
! "pseudoinverse of the overlap matrix of the auxiliary "// &
! "basis set. Calculating the pseudoinverse is necessary "// &
! "for very large auxiliary basis sets, but more expensive. "// &
! "Using the pseudoinverse, consistent forces are not "// &
! "guaranteed yet.", &
! usage="RI_OVERLAP_MATRIX INVERSE", &
! enum_c_vals=s2a("INVERSE", "PSEUDO_INVERSE_SVD", "PSEUDO_INVERSE_DIAG", &
! "AUTOSELECT"), &
! enum_desc=s2a("Calculate inverse of the overlap matrix.", &
! "Calculate the pseuodinverse of the overlap matrix "// &
! "using singular value decomposition.", &
! "Calculate the pseudoinverse of the overlap matrix "// &
! "by prior diagonalization.", &
! "Choose automatically for each pair whether to "// &
! "calculate the inverse or pseudoinverse based on the "// &
! "condition number of the overlap matrix for each pair. "// &
! "Calculating the pseudoinverse is much more expensive."), &
! enum_i_vals=(/do_lri_inv, do_lri_pseudoinv_svd, &
! do_lri_pseudoinv_diag, do_lri_inv_auto/), &
! default_i_val=do_lri_inv)
! CALL section_add_keyword(section, keyword)
! CALL keyword_release(keyword)
END SUBROUTINE create_rigpw_section
! **************************************************************************************************
!> \brief input section for constraints for auxiliary basis set optimization
!> \param section the section to create
!> \author Dorothea Golze [11.2014]
! **************************************************************************************************
SUBROUTINE create_constrain_exponents_section(section)
TYPE(section_type), POINTER :: section
CHARACTER(len=*), PARAMETER :: routineN = 'create_constrain_exponents_section', &
routineP = moduleN//':'//routineN
TYPE(keyword_type), POINTER :: keyword
CALL section_create(section, name="CONSTRAIN_EXPONENTS", &
description="specifies constraints for the exponents of the "// &
"lri auxiliary basis sets in the optimization.", &
n_keywords=1, n_subsections=0, repeats=.FALSE.)
NULLIFY (keyword)
CALL keyword_create(keyword, name="SCALE", &
description="Defines the upper and lower boundaries as "// &
"(1+scale)*exp and (1-scale)*exp. Fermi-like constraint "// &
"function", &
usage="SCALE 0.3", default_r_val=0.3_dp)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="FERMI_EXP", &
description="Exponent in the fermi-like constraint function. ", &
usage="FERMI_EXP 2.63", default_r_val=2.63391_dp)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
END SUBROUTINE create_constrain_exponents_section
! **************************************************************************************************
!> \brief creates the multigrid
!> \param section input section to create
!> \param create_subsections indicates whether or not subsections INTERPOLATOR and RS_GRID
!> should be created
!> \author fawzi
! **************************************************************************************************
SUBROUTINE create_mgrid_section(section, create_subsections)
TYPE(section_type), POINTER :: section
LOGICAL, INTENT(in) :: create_subsections
CHARACTER(len=*), PARAMETER :: routineN = 'create_mgrid_section', &
routineP = moduleN//':'//routineN
TYPE(keyword_type), POINTER :: keyword
TYPE(section_type), POINTER :: subsection
CPASSERT(.NOT. ASSOCIATED(section))
CALL section_create(section, name="mgrid", &
description="multigrid information", &
n_keywords=5, n_subsections=1, repeats=.FALSE.)
NULLIFY (keyword)
CALL keyword_create(keyword, name="NGRIDS", &
description="The number of multigrids to use", &
usage="ngrids 1", default_i_val=4)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword=keyword, name="cutoff", &
description="The cutoff of the finest grid level. Default value for "// &
"SE or DFTB calculation is 1.0 [Ry].", &
usage="cutoff 300", default_r_val=cp_unit_to_cp2k(value=280.0_dp, &
unit_str="Ry"), n_var=1, unit_str="Ry")
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="progression_factor", &
description="Factor used to find the cutoff of the multigrids that"// &
" where not given explicitly", &
usage="progression_factor <integer>", default_r_val=3._dp)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="commensurate", &
description="If the grids should be commensurate. If true overrides "// &
"the progression factor and the cutoffs of the sub grids", &
usage="commensurate", default_l_val=.FALSE., &
lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="realspace", &
description="If both rho and rho_gspace are needed ", &
usage="realspace", default_l_val=.FALSE., &
lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="REL_CUTOFF", &
variants=(/"RELATIVE_CUTOFF"/), &
description="Determines the grid at which a Gaussian is mapped,"// &
" giving the cutoff used for a gaussian with alpha=1."// &
" A value 50+-10Ry might be required for highly accurate results, "// &
" Or for simulations with a variable cell."// &
" Versions prior to 2.3 used a default of 30Ry.", &
usage="RELATIVE_CUTOFF real", default_r_val=20.0_dp, &
unit_str="Ry")
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="MULTIGRID_SET", &
description="Activate a manual setting of the multigrids", &
usage="MULTIGRID_SET", default_l_val=.FALSE.)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword &
, name="SKIP_LOAD_BALANCE_DISTRIBUTED" &
, description="Skips load balancing on distributed multigrids. " &
//"Memory usage is O(p) so may be used " &
//"for all but the very largest runs." &
, usage="SKIP_LOAD_BALANCE_DISTRIBUTED" &
, default_l_val=.FALSE. &
, lone_keyword_l_val=.TRUE. &
)
! CALL keyword_create(keyword, name="SKIP_LOAD_BALANCE_DISTRIBUTED",&
! description="Skip load balancing on distributed multigrids, which might be memory intensive."//&
! "If not explicitly specified, runs using more than 1024 MPI tasks will default to .TRUE.",&
! usage="SKIP_LOAD_BALANCE_DISTRIBUTED", default_l_val=.FALSE., lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="MULTIGRID_CUTOFF", &
variants=(/"CUTOFF_LIST"/), &
description="List of cutoff values to set up multigrids manually", &
usage="MULTIGRID_CUTOFF 200.0 100.0 ", n_var=-1, type_of_var=real_t)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
IF (create_subsections) THEN
NULLIFY (subsection)
CALL create_rsgrid_section(subsection)
CALL section_add_subsection(section, subsection)
CALL section_release(subsection)
NULLIFY (subsection)
CALL create_interp_section(subsection)
CALL section_add_subsection(section, subsection)
CALL section_release(subsection)
END IF
END SUBROUTINE create_mgrid_section
! **************************************************************************************************
!> \brief creates the interpolation section
!> \param section ...
!> \author tlaino
! **************************************************************************************************
SUBROUTINE create_interp_section(section)
TYPE(section_type), POINTER :: section
CHARACTER(len=*), PARAMETER :: routineN = 'create_interp_section', &
routineP = moduleN//':'//routineN
TYPE(keyword_type), POINTER :: keyword
TYPE(section_type), POINTER :: print_key
CPASSERT(.NOT. ASSOCIATED(section))
CALL section_create(section, name="interpolator", &
description="kind of interpolation used between the multigrids", &
n_keywords=5, n_subsections=0, repeats=.FALSE.)
NULLIFY (keyword, print_key)
CALL keyword_create(keyword, name="kind", &
description="the interpolator to use", &
usage="kind spline3", &
default_i_val=pw_interp, &
enum_c_vals=s2a("pw", "spline3_nopbc", "spline3"), &
enum_i_vals=(/pw_interp, &
spline3_nopbc_interp, spline3_pbc_interp/))
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="safe_computation", &
description="if a non unrolled calculation is to be performed in parallel", &
usage="safe_computation OFF", &
default_l_val=.FALSE., &
lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="aint_precond", &
description="the approximate inverse to use to get the starting point"// &
" for the linear solver of the spline3 methods", &
usage="aint_precond copy", &
default_i_val=precond_spl3_aint, &
enum_c_vals=s2a("copy", "spl3_nopbc_aint1", "spl3_nopbc_aint2", &
"spl3_nopbc_precond1", "spl3_nopbc_precond2", "spl3_nopbc_precond3"), &
enum_i_vals=(/no_precond, precond_spl3_aint, precond_spl3_aint2, &
precond_spl3_1, precond_spl3_2, precond_spl3_3/))
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="precond", &
description="The preconditioner used"// &
" for the linear solver of the spline3 methods", &
usage="PRECOND copy", &
default_i_val=precond_spl3_3, &
enum_c_vals=s2a("copy", "spl3_nopbc_aint1", "spl3_nopbc_aint2", &
"spl3_nopbc_precond1", "spl3_nopbc_precond2", "spl3_nopbc_precond3"), &
enum_i_vals=(/no_precond, precond_spl3_aint, precond_spl3_aint2, &
precond_spl3_1, precond_spl3_2, precond_spl3_3/))
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="eps_x", &
description="accuracy on the solution for spline3 the interpolators", &
usage="eps_x 1.e-15", default_r_val=1.e-10_dp)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="eps_r", &
description="accuracy on the residual for spline3 the interpolators", &
usage="eps_r 1.e-15", default_r_val=1.e-10_dp)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="max_iter", &
variants=(/'maxiter'/), &
description="the maximum number of iterations", &
usage="max_iter 200", default_i_val=100)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
NULLIFY (print_key)
CALL cp_print_key_section_create(print_key, "conv_info", &
description="if convergence information about the linear solver"// &
" of the spline methods should be printed", &
print_level=medium_print_level, each_iter_names=s2a("SPLINE_FIND_COEFFS"), &
each_iter_values=(/10/), filename="__STD_OUT__", &
add_last=add_last_numeric)
CALL section_add_subsection(section, print_key)
CALL section_release(print_key)
END SUBROUTINE create_interp_section
! **************************************************************************************************
!> \brief creates the sic (self interaction correction) section
!> \param section ...
!> \author fawzi
! **************************************************************************************************
SUBROUTINE create_sic_section(section)
TYPE(section_type), POINTER :: section
CHARACTER(len=*), PARAMETER :: routineN = 'create_sic_section', &
routineP = moduleN//':'//routineN
TYPE(keyword_type), POINTER :: keyword
CPASSERT(.NOT. ASSOCIATED(section))
CALL section_create(section, "sic", &
description="parameters for the self interaction correction", &
n_keywords=6, n_subsections=0, repeats=.FALSE., &
citations=(/VandeVondele2005b, Perdew1981, Avezac2005/))
NULLIFY (keyword)
CALL keyword_create(keyword, name="SIC_SCALING_A", &
description="Scaling of the coulomb term in sic [experimental]", &
usage="SIC_SCALING_A 0.5", &
citations=(/VandeVondele2005b/), &
default_r_val=1.0_dp)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="SIC_SCALING_B", &
description="Scaling of the xc term in sic [experimental]", &
usage="SIC_SCALING_B 0.5", &
citations=(/VandeVondele2005b/), &
default_r_val=1.0_dp)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="SIC_METHOD", &
description="Method used to remove the self interaction", &
usage="SIC_METHOD MAURI_US", &
default_i_val=sic_none, &
enum_c_vals=s2a("NONE", "MAURI_US", "MAURI_SPZ", "AD", "EXPLICIT_ORBITALS"), &
enum_i_vals=(/sic_none, sic_mauri_us, sic_mauri_spz, sic_ad, sic_eo/), &
enum_desc=s2a("Do not apply a sic correction", &
"Employ a (scaled) correction proposed by Mauri and co-workers"// &
" on the spin density / doublet unpaired orbital", &
"Employ a (scaled) Perdew-Zunger expression"// &
" on the spin density / doublet unpaired orbital", &
"The average density correction", &
"(scaled) Perdew-Zunger correction explicitly on a set of orbitals."), &
citations=(/VandeVondele2005b, Perdew1981, Avezac2005/))
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="ORBITAL_SET", &
description="Type of orbitals treated with the SIC", &
usage="ORBITAL_SET ALL", &
default_i_val=sic_list_unpaired, &
enum_c_vals=s2a("UNPAIRED", "ALL"), &
enum_desc=s2a("correction for the unpaired orbitals only, requires a restricted open shell calculation", &
"correction for all orbitals, requires a LSD or ROKS calculation"), &
enum_i_vals=(/sic_list_unpaired, sic_list_all/))
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
END SUBROUTINE create_sic_section
! **************************************************************************************************
!> \brief creates the low spin roks section
!> \param section ...
!> \author Joost VandeVondele
! **************************************************************************************************
SUBROUTINE create_low_spin_roks_section(section)
TYPE(section_type), POINTER :: section
CHARACTER(len=*), PARAMETER :: routineN = 'create_low_spin_roks_section', &
routineP = moduleN//':'//routineN
TYPE(keyword_type), POINTER :: keyword
CPASSERT(.NOT. ASSOCIATED(section))
CALL section_create(section, "LOW_SPIN_ROKS", &
description="Specify the details of the low spin ROKS method."// &
"In particular, one can specify various terms added to the energy of the high spin roks configuration"// &
" with a energy scaling factor, and a prescription of the spin state.", &
n_keywords=6, n_subsections=0, repeats=.FALSE.)
NULLIFY (keyword)
CALL keyword_create(keyword, name="ENERGY_SCALING", &
description="The scaling factors for each term added to the total energy."// &
"This list should contain one number for each term added to the total energy.", &
usage="ENERGY_SCALING 1.0 -1.0 ", &
n_var=-1, type_of_var=real_t, repeats=.FALSE.)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create( &
keyword, name="SPIN_CONFIGURATION", &
description="for each singly occupied orbital, specify if this should be an alpha (=1) or a beta (=2) orbital"// &
"This keyword should be repeated, each repetition corresponding to an additional term.", &
usage="SPIN_CONFIGURATION 1 2", &
n_var=-1, type_of_var=integer_t, repeats=.TRUE.)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
END SUBROUTINE create_low_spin_roks_section
! **************************************************************************************************
!> \brief Creates the section for applying an electrostatic external potential
!> \param section ...
!> \date 12.2009
!> \author teo
! **************************************************************************************************
SUBROUTINE create_ext_pot_section(section)
TYPE(section_type), POINTER :: section
CHARACTER(len=*), PARAMETER :: routineN = 'create_ext_pot_section', &
routineP = moduleN//':'//routineN
TYPE(keyword_type), POINTER :: keyword
CPASSERT(.NOT. ASSOCIATED(section))
CALL section_create(section, name="EXTERNAL_POTENTIAL", &
description="Section controlling the presence of an electrostatic "// &
"external potential dependent on the atomic positions (X,Y,Z). "// &
"As the external potential is currently applied via a grid, "// &
"it only works with DFT based methods (GPW/GAPW) that already use "// &
"a grid based approach to solve the Poisson equation.", &
n_keywords=7, n_subsections=0, repeats=.FALSE.)
NULLIFY (keyword)
CALL keyword_create(keyword, name="FUNCTION", &
description="Specifies the functional form in mathematical notation. Variables must be the atomic "// &
"coordinates (X,Y,Z) of the grid.", usage="FUNCTION X^2+Y^2+Z^2+LOG(ABS(X+Y))", &
type_of_var=lchar_t, n_var=1)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="PARAMETERS", &
description="Defines the parameters of the functional form", &
usage="PARAMETERS a b D", type_of_var=char_t, &
n_var=-1, repeats=.TRUE.)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="VALUES", &
description="Defines the values of parameter of the functional form", &
usage="VALUES ", type_of_var=real_t, &
n_var=-1, repeats=.TRUE., unit_str="internal_cp2k")
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="UNITS", &
description="Optionally, allows to define valid CP2K unit strings for each parameter value. "// &
"It is assumed that the corresponding parameter value is specified in this unit.", &
usage="UNITS angstrom eV*angstrom^-1 angstrom^1 K", type_of_var=char_t, &
n_var=-1, repeats=.TRUE.)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="STATIC", &
description="Specifies the external potential as STATIC or time dependent. At the moment "// &
"only static potentials are implemented.", &
usage="STATIC T", default_l_val=.TRUE., lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="DX", &
description="Parameter used for computing the derivative with the Ridders' method.", &
usage="DX <REAL>", default_r_val=0.1_dp, unit_str="bohr")
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="ERROR_LIMIT", &
description="Checks that the error in computing the derivative is not larger than "// &
"the value set; in case error is larger a warning message is printed.", &
usage="ERROR_LIMIT <REAL>", default_r_val=1.0E-12_dp)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
!keyword for reading the external potential from cube file
CALL keyword_create(keyword, name="READ_FROM_CUBE", &
description="Switch for reading the external potential from file pot.cube. The values "// &
"of the potential must be on the grid points of the realspace grid.", &
usage="READ_FROM_CUBE T", default_l_val=.FALSE., lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
!keyword for scaling the external potential that is read from file by a constant factor
CALL keyword_create(keyword, name="SCALING_FACTOR", &
description="A factor for scaling the the external potential that is read from file."// &
"The value of the potential at each grid point is multiplied by this factor.", &
usage="SCALING_FACTOR <REAL>", default_r_val=1.0_dp)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
END SUBROUTINE create_ext_pot_section
! **************************************************************************************************
!> \brief ZMP Creates the section for reading user supplied external density
!> \param section ...
!> \date 03.2011
!> \author D. Varsano [daniele.varsano@nano.cnr.it]
! **************************************************************************************************
SUBROUTINE create_ext_den_section(section)
TYPE(section_type), POINTER :: section
CHARACTER(len=*), PARAMETER :: routineN = 'create_ext_den_section', &
routineP = moduleN//':'//routineN
TYPE(keyword_type), POINTER :: keyword
CPASSERT(.NOT. ASSOCIATED(section))
CALL section_create(section, name="EXTERNAL_DENSITY", &
description="Section for the use of the ZMP technique on external densities.", &
n_keywords=4, n_subsections=0, repeats=.FALSE., &
citations=(/Zhao1994, Tozer1996/))
NULLIFY (keyword)
CALL keyword_create(keyword, name="FILE_DENSITY", &
description="Specifies the filename containing the target density in *.cube format."// &
"In the MGRID section it must be imposed NGRID 1, as it works with only"// &
"one grid. The number of points in each direction, and the spacing must"// &
"be previously defined choosing the plane waves cut-off in section MGRID"// &
"keyword CUTOFF, and the cube dimention in section SUBSYS / CELL / keyword ABC", &
usage="DENSITY_FILE_NAME <FILENAME>", &
type_of_var=char_t, default_c_val="RHO_O.dat", n_var=-1)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="LAMBDA", &
description="Lagrange multiplier defined in the constraint ZMP method. When starting, use"// &
"small values when starting from scratch (around 5,10). Then gradually increase"// &
"the values depending, restarting from the previous calculation with the smaller"// &
"value. To choose the progressive values of LAMBDA look at the convergence of the"// &
" eigenvalues.", &
usage="DX <REAL>", default_r_val=10.0_dp)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="ZMP_CONSTRAINT", &
description="Specify which kind of constraint to solve the ZMP equation. The COULOMB default"// &
"option is more stable.", &
usage="ZMP_CONSTRAINT <CHAR>", &
enum_c_vals=s2a("COULOMB", "DIFF", "NONE"), &
enum_i_vals=(/use_coulomb, use_diff, use_no/), &
enum_desc=s2a("Coulomb constraint, integral of [rho_0(r)-rho(r)]/|r-r'|", &
"Simple constraint, [rho_0(r)-rho(r)]", &
"No constrain imposed"), &
default_i_val=use_coulomb)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="FERMI_AMALDI", &
description="Add the Fermi-Amaldi contribution to the Hartree potential."// &
"It leads to a more stable convergence.", &
usage="FERMI_AMALDI <LOGICAL>", &
repeats=.FALSE., &
n_var=1, &
default_l_val=.TRUE., lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
END SUBROUTINE create_ext_den_section
! **************************************************************************************************
!> \brief ZMP Creates the section for creating the external v_xc
!> \param section ...
!> \date 03.2011
!> \author D. Varsano [daniele.varsano@nano.cnr.it]
! **************************************************************************************************
SUBROUTINE create_ext_vxc_section(section)
TYPE(section_type), POINTER :: section
CHARACTER(len=*), PARAMETER :: routineN = 'create_ext_vxc_section', &
routineP = moduleN//':'//routineN
TYPE(keyword_type), POINTER :: keyword
CPASSERT(.NOT. ASSOCIATED(section))
CALL section_create(section, name="EXTERNAL_VXC", &
description="SCF convergence with external v_xc calculated through previous ZMP"// &
"calculation", &
n_keywords=1, n_subsections=0, repeats=.FALSE.)
NULLIFY (keyword)
CALL keyword_create(keyword, name="FILE_VXC", &
description="The *.cube filename containing the v_xc potential. This works only"// &
"with NGRID 1 imposed in the MGRID section. The number of points in each"// &
"direction, and the spacing must equal to those previously used in the ZMP"// &
"calculation and defined through the plane wave cut-off and the cube dimension"// &
"respectively set in section MGRID / keyword CUTOFF, and in section SUBSYS /"// &
"CELL / keyword ABC", &
usage="FILE_VXC <FILENAME>", &
type_of_var=char_t, default_c_val="VXC_O.dat", n_var=-1)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
END SUBROUTINE create_ext_vxc_section
! **************************************************************************************************
!> \brief makes the orbital transformation section
!> \param section ...
!> \par History
!> 11.2004 created [Joost VandeVondele]
! **************************************************************************************************
SUBROUTINE create_ot_section(section)
TYPE(section_type), POINTER :: section
CHARACTER(len=*), PARAMETER :: routineN = 'create_ot_section', &
routineP = moduleN//':'//routineN
TYPE(keyword_type), POINTER :: keyword
CPASSERT(.NOT. ASSOCIATED(section))
CALL section_create(section, "OT", &
description="Sets the various options for the orbital transformation (OT) method. "// &
"Default settings already provide an efficient, yet robust method. "// &
"Most systems benefit from using the FULL_ALL preconditioner "// &
"combined with a small value (0.001) of ENERGY_GAP. "// &
"Well-behaved systems might benefit from using a DIIS minimizer. "// &
"<u>Advantages:</u> "// &
"It's fast, because no expensive diagonalisation is performed. "// &
"If preconditioned correctly, method guaranteed to find minimum. "// &
"<u>Disadvantages:</u> "// &
"Sensitive to preconditioning. A good preconditioner can be expensive. "// &
"No smearing, or advanced SCF mixing possible: POOR convergence for metalic systems.", &
n_keywords=27, n_subsections=0, repeats=.FALSE., &
citations=(/VandeVondele2003, Weber2008/))
NULLIFY (keyword)
CALL keyword_create(keyword, name="_SECTION_PARAMETERS_", &
description="controls the activation of the ot method", &
usage="&OT T", &
default_l_val=.FALSE., &
lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="ALGORITHM", &
description="Algorithm to be used for OT", &
usage="ALGORITHM STRICT", &
default_i_val=ot_algo_taylor_or_diag, &
enum_c_vals=s2a("STRICT", "IRAC"), &
enum_desc=s2a("Strict orthogonality: Taylor or diagonalization based algorithm.", &
"Orbital Transformation based Iterative Refinement "// &
"of the Approximative Congruence transformation (OT/IR)."), &
enum_i_vals=(/ot_algo_taylor_or_diag, ot_algo_irac/), &
citations=(/VandeVondele2003, VandeVondele2005a, Weber2008/))
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="IRAC_DEGREE", &
description="The refinement polynomial degree (2, 3 or 4).", &
usage="IRAC_DEGREE 4", &
default_i_val=4)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="MAX_IRAC", &
description="Maximum allowed refinement iteration.", &
usage="MAX_IRAC 5", &
default_i_val=50)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="ORTHO_IRAC", &
description="The orthogonality method.", &
usage="ORTHO_IRAC POLY", &
default_i_val=ot_chol_irac, &
enum_c_vals=s2a("CHOL", "POLY", "LWDN"), &
enum_desc=s2a("Cholesky.", "Polynomial.", "Loewdin."), &
enum_i_vals=(/ot_chol_irac, ot_poly_irac, ot_lwdn_irac/))
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="EPS_IRAC_FILTER_MATRIX", &
description="Sets the threshold for filtering the matrices.", &
usage="EPS_IRAC_FILTER_MATRIX 1.0E-5", &
default_r_val=0.0_dp)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="EPS_IRAC", &
description="Targeted accuracy during the refinement iteration.", &
usage="EPS_IRAC 1.0E-5", &
default_r_val=1.0E-10_dp)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="EPS_IRAC_QUICK_EXIT", &
description="Only one extra refinement iteration is "// &
"done when the norm is below this value.", &
usage="EPS_IRAC_QUICK_EXIT 1.0E-2", &
default_r_val=1.0E-5_dp)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="EPS_IRAC_SWITCH", &
description="The algorithm switches to the polynomial "// &
"refinement when the norm is below this value.", &
usage="EPS_IRAC_SWITCH 1.0E-3", &
default_r_val=1.0E-2_dp)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="ON_THE_FLY_LOC", &
description="On the fly localization of the molecular orbitals. "// &
"Can only be used with OT/IRAC.", &
usage="ON_THE_FLY_LOC T", &
default_l_val=.FALSE.)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create( &
keyword, name="MINIMIZER", &
description="Minimizer to be used with the OT method", &
usage="MINIMIZER DIIS", &
default_i_val=ot_mini_cg, &
enum_c_vals=s2a("SD", "CG", "DIIS", "BROYDEN"), &
enum_desc=s2a("Steepest descent: not recommended", "Conjugate Gradients: most reliable, use for difficult systems."// &
" The total energy should decrease at every OT CG step if the line search is appropriate.", &
"Direct inversion in the iterative subspace: less reliable than CG, but sometimes about 50% faster", &
"Broyden mixing approximating the inverse Hessian"), &
enum_i_vals=(/ot_mini_sd, ot_mini_cg, ot_mini_diis, ot_mini_broyden/))
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="SAFE_DIIS", &
variants=(/"SAFER_DIIS"/), &
description="Reject DIIS steps if they point away from the"// &
" minimum, do SD in that case.", &
usage="SAFE_DIIS ON", default_l_val=.TRUE.)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="N_HISTORY_VEC", &
variants=s2a("NDIIS", "N_DIIS", "N_BROYDEN"), &
description="Number of history vectors to be used with DIIS or BROYDEN", &
usage="N_DIIS 4", &
default_i_val=7)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="BROYDEN_BETA", &
description="Underrelaxation for the broyden mixer", &
usage="BROYDEN_BETA 0.9", &
default_r_val=0.9_dp)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="BROYDEN_GAMMA", &
description="Backtracking parameter", &
usage="BROYDEN_GAMMA 0.5", &
default_r_val=0.5_dp)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="BROYDEN_SIGMA", &
description="Curvature of energy functional.", &
usage="BROYDEN_SIGMA 0.25", &
default_r_val=0.25_dp)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="BROYDEN_ETA", &
description="Dampening of estimated energy curvature.", &
usage="BROYDEN_ETA 0.7", &
default_r_val=0.7_dp)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="BROYDEN_OMEGA", &
description="Growth limit of curvature.", &
usage="BROYDEN_OMEGA 1.1", &
default_r_val=1.1_dp)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="BROYDEN_SIGMA_DECREASE", &
description="Reduction of curvature on bad approximation.", &
usage="BROYDEN_SIGMA_DECREASE 0.7", &
default_r_val=0.7_dp)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="BROYDEN_SIGMA_MIN", &
description="Minimum adaptive curvature.", &
usage="BROYDEN_SIGMA_MIN 0.05", &
default_r_val=0.05_dp)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="BROYDEN_FORGET_HISTORY", &
description="Forget history on bad approximation", &
usage="BROYDEN_FORGET_HISTORY OFF", default_l_val=.FALSE., &
lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="BROYDEN_ADAPTIVE_SIGMA", &
description="Enable adaptive curvature estimation", &
usage="BROYDEN_ADAPTIVE_SIGMA ON", default_l_val=.TRUE., &
lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="BROYDEN_ENABLE_FLIP", &
description="Ensure positive definite update", &
usage="BROYDEN_ENABLE_FLIP ON", default_l_val=.TRUE., &
lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="LINESEARCH", &
variants=(/"LINE_SEARCH"/), &
description="1D line search algorithm to be used with the OT minimizer,"// &
" in increasing order of robustness and cost. MINIMIZER CG combined with"// &
" LINESEARCH GOLD should always find an electronic minimum. "// &
" Whereas the 2PNT minimizer is almost always OK, 3PNT might be needed for systems"// &
" in which successive OT CG steps do not decrease the total energy.", &
usage="LINESEARCH GOLD", &
default_i_val=ls_2pnt, &
enum_c_vals=s2a("NONE", "2PNT", "3PNT", "GOLD"), &
enum_desc=s2a("take fixed lenght steps", "extrapolate based on 2 points", &
"... or on 3 points", "perform 1D golden section search of the minimum (very expensive)"), &
enum_i_vals=(/ls_none, ls_2pnt, ls_3pnt, ls_gold/))
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create( &
keyword, name="STEPSIZE", &
description="Initial stepsize used for the line search, sometimes this parameter can be reduced to stablize DIIS"// &
" or to improve the CG behavior in the first few steps."// &
" The optimal value depends on the quality of the preconditioner."// &
" A negative values leaves the choice to CP2K depending on the preconditioner.", &
usage="STEPSIZE 0.4", &
default_r_val=-1.0_dp)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="GOLD_TARGET", &
description="Target relative uncertainty in the location of the minimum for LINESEARCH GOLD", &
usage="GOLD_TARGET 0.1", &
default_r_val=0.01_dp)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create( &
keyword, name="PRECONDITIONER", &
description="Type of preconditioner to be used with all minimization schemes. "// &
"They differ in effectiveness, cost of construction, cost of application. "// &
"Properly preconditioned minimization can be orders of magnitude faster than doing nothing.", &
usage="PRECONDITIONER FULL_ALL", &
default_i_val=ot_precond_full_kinetic, &
enum_c_vals=s2a("FULL_ALL", "FULL_SINGLE_INVERSE", "FULL_SINGLE", "FULL_KINETIC", "FULL_S_INVERSE", &
"NONE"), &
enum_desc=s2a("Most effective state selective preconditioner based on diagonalization, "// &
"requires the ENERGY_GAP parameter to be an underestimate of the HOMO-LUMO gap. "// &
"This preconditioner is recommended for almost all systems, except very large systems where "// &
"make_preconditioner would dominate the total computational cost.", &
"Based on H-eS cholesky inversion, similar to FULL_SINGLE in preconditioning efficiency "// &
"but cheaper to construct, "// &
"might be somewhat less robust. Recommended for large systems.", &
"Based on H-eS diagonalisation, not as good as FULL_ALL, but somewhat cheaper to apply. ", &
"Cholesky inversion of S and T, fast construction, robust, and relatively good, "// &
"use for very large systems.", &
"Cholesky inversion of S, not as good as FULL_KINETIC, yet equally expensive.", &
"skip preconditioning"), &
enum_i_vals=(/ot_precond_full_all, ot_precond_full_single_inverse, ot_precond_full_single, &
ot_precond_full_kinetic, ot_precond_s_inverse, ot_precond_none/), &
citations=(/VandeVondele2003, Weber2008, Schiffmann2015/))
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="CHOLESKY", &
description="If FULL_ALL the cholesky decomposition of the S matrix is used. "// &
"Options on the algorithm to be used.", &
usage="CHOLESKY REDUCE", default_i_val=cholesky_reduce, &
enum_c_vals=s2a("OFF", "REDUCE", "RESTORE", "INVERSE", "INVERSE_DBCSR"), &
enum_desc=s2a("The cholesky algorithm is not used", "Reduce is called", &
"Reduce is replaced by two restore", &
"Restore uses operator multiply by inverse of the triangular matrix", &
"Like inverse, but matrix stored as dbcsr, sparce matrix algebra used when possible"), &
enum_i_vals=(/cholesky_off, cholesky_reduce, cholesky_restore, cholesky_inverse, cholesky_dbcsr/))
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create( &
keyword, name="PRECOND_SOLVER", &
description="How the preconditioner is applied to the residual.", &
usage="PRECOND_SOLVER DIRECT", &
default_i_val=ot_precond_solver_default, &
enum_c_vals=s2a("DEFAULT", "DIRECT", "INVERSE_CHOLESKY", "INVERSE_UPDATE"), &
enum_desc=s2a("the default", "Cholesky decomposition followed by triangular solve "// &
"(works for FULL_KINETIC/SINGLE_INVERSE/S_INVERSE)", &
"Cholesky decomposition followed by explicit inversion "// &
"(works for FULL_KINETIC/SINGLE_INVERSE/S_INVERSE)", &
"Performs a Hotelling update of the inverse if a previous preconditioner is present. "// &
"Mainly useful for GPU accelerated systems (works for FULL_KINETIC/SINGLE_INVERSE/S_INVERSE)"), &
enum_i_vals=(/ot_precond_solver_default, &
ot_precond_solver_direct, &
ot_precond_solver_inv_chol, &
ot_precond_solver_update/))
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create( &
keyword, name="ENERGY_GAP", &
description="Should be an estimate for the energy gap [a.u.] (HOMO-LUMO) and is used in preconditioning, "// &
"especially effective with the FULL_ALL preconditioner, in which case it should be an underestimate "// &
"of the gap (can be a small number, e.g. 0.002)."// &
" FULL_SINGLE_INVERSE takes it as lower bound (values below 0.05 can cause stability issues)."// &
" In general, heigher values will tame the preconditioner in case of poor initial guesses."// &
" A negative value will leave the choice to CP2K depending on type of preconditioner.", &
usage="ENERGY_GAP 0.001", &
default_r_val=-1.0_dp)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create( &
keyword, name="EPS_TAYLOR", &
variants=(/"EPSTAYLOR"/), &
description="Target accuracy of the taylor expansion for the matrix functions, should normally be kept as is.", &
usage="EPS_TAYLOR 1.0E-15", &
default_r_val=1.0E-16_dp)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create( &
keyword, name="MAX_TAYLOR", &
description="Maximum order of the Taylor expansion before diagonalisation is prefered, for large parallel runs"// &
" a slightly higher order could sometimes result in a small speedup.", &
usage="MAX_TAYLOR 5", &
default_i_val=4)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="ROTATION", &
description="Introduce additional variables so that rotations of the occupied"// &
" subspace are allowed as well, only needed for cases where the energy is not invariant under "// &
" a rotation of the occupied subspace such as non-singlet restricted calculations "// &
" or fractional occupations.", &
usage="ROTATION", lone_keyword_l_val=.TRUE., &
default_l_val=.FALSE.)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="ENERGIES", &
description="Optimize orbital energies for use in Fermi-Dirac smearing "// &
"(requires ROTATION and FD smearing to be active).", &
usage="ENERGIES", lone_keyword_l_val=.TRUE., &
default_l_val=.FALSE.)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="OCCUPATION_PRECONDITIONER", &
description="Preconditioner with the occupation numbers (FD smearing)", &
usage="OCCUPATION_PRECONDITIONER", lone_keyword_l_val=.TRUE., &
default_l_val=.FALSE.)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="NONDIAG_ENERGY", &
description="Add a non-diagonal energy penalty (FD smearing)", &
usage="NONDIAG_ENERGY", lone_keyword_l_val=.TRUE., &
default_l_val=.FALSE.)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="NONDIAG_ENERGY_STRENGTH", &
description="The prefactor for the non-diagonal energy penalty (FD smearing)", &
usage="NONDIAG_ENERGY_STRENGTH", default_r_val=1.0_dp)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
END SUBROUTINE create_ot_section
! **************************************************************************************************
!> \brief creates the diagonalization section
!> \param section ...
!> \par History
!> 10.2008 created [JGH]
! **************************************************************************************************
SUBROUTINE create_diagonalization_section(section)
TYPE(section_type), POINTER :: section
CHARACTER(len=*), PARAMETER :: routineN = 'create_diagonalization_section', &
routineP = moduleN//':'//routineN
TYPE(keyword_type), POINTER :: keyword
TYPE(section_type), POINTER :: subsection
CPASSERT(.NOT. ASSOCIATED(section))
CALL section_create(section, "DIAGONALIZATION", &
description="Set up type and parameters for Kohn-Sham matrix diagonalization.", &
n_keywords=0, n_subsections=1, repeats=.FALSE.)
NULLIFY (keyword)
CALL keyword_create(keyword, name="_SECTION_PARAMETERS_", &
description="controls the activation of the diagonalization method", &
usage="&DIAGONALIZATION T", &
default_l_val=.FALSE., &
lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="ALGORITHM", &
description="Algorithm to be used for diagonalization", &
usage="ALGORITHM STANDARD", &
default_i_val=diag_standard, &
enum_c_vals=s2a("STANDARD", "OT", "LANCZOS", "DAVIDSON", "FILTER_MATRIX"), &
enum_desc=s2a("Standard diagonalization: LAPACK methods or Jacobi.", &
"Iterative diagonalization using OT method", &
"Block Krylov-space approach to self-consistent diagonalisation", &
"Preconditioned blocked Davidson", &
"Filter matrix diagonalization"), &
enum_i_vals=(/diag_standard, diag_ot, diag_block_krylov, diag_block_davidson, &
diag_filter_matrix/))
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="JACOBI_THRESHOLD", &
description="Controls the accuracy of the pseudo-diagonalization method using Jacobi rotations", &
usage="JACOBI_THRESHOLD 1.0E-6", &
default_r_val=1.0E-7_dp, &
citations=(/Stewart1982/))
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="EPS_JACOBI", &
description="Below this threshold value for the SCF convergence the pseudo-diagonalization "// &
"method using Jacobi rotations is activated. This method is much faster than a "// &
"real diagonalization and it is even speeding up while achieving full convergence."// &
"However, it needs a pre-converged wavefunction obtained by at least one real "// &
"diagonalization which is further optimized while keeping the original eigenvalue "// &
"spectrum. The MO eigenvalues are NOT updated. The method might be useful to speed "// &
"up calculations for large systems e.g. using a semi-empirical method.", &
usage="EPS_JACOBI 1.0E-5", &
default_r_val=0.0_dp, &
citations=(/Stewart1982/))
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="EPS_ADAPT", &
description="Required accuracy in iterative diagonalization as compared to current SCF convergence", &
usage="EPS_ADAPT 0.01", &
default_r_val=0._dp)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="MAX_ITER", &
description="Maximum number of iterations in iterative diagonalization", &
usage="MAX_ITER 20", &
default_i_val=2)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="EPS_ITER", &
description="Required accuracy in iterative diagonalization", &
usage="EPS_ITER 1.e-8", &
default_r_val=1.e-8_dp)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
NULLIFY (subsection)
CALL create_ot_section(subsection)
CALL section_add_subsection(section, subsection)
CALL section_release(subsection)
NULLIFY (subsection)
CALL create_krylov_section(subsection)
CALL section_add_subsection(section, subsection)
CALL section_release(subsection)
NULLIFY (subsection)
CALL create_diag_subspace_section(subsection)
CALL section_add_subsection(section, subsection)
CALL section_release(subsection)
NULLIFY (subsection)
CALL create_davidson_section(subsection)
CALL section_add_subsection(section, subsection)
CALL section_release(subsection)
NULLIFY (subsection)
CALL create_filtermatrix_section(subsection)
CALL section_add_subsection(section, subsection)
CALL section_release(subsection)
END SUBROUTINE create_diagonalization_section
! **************************************************************************************************
!> \brief ...
!> \param section ...
! **************************************************************************************************
SUBROUTINE create_davidson_section(section)
TYPE(section_type), POINTER :: section
CHARACTER(len=*), PARAMETER :: routineN = 'create_davidson_section', &
routineP = moduleN//':'//routineN
TYPE(keyword_type), POINTER :: keyword
CPASSERT(.NOT. ASSOCIATED(section))
CALL section_create(section, "DAVIDSON", &
description=" ", &
n_keywords=2, n_subsections=0, repeats=.FALSE.)
NULLIFY (keyword)
CALL keyword_create( &
keyword, name="PRECONDITIONER", &
description="Type of preconditioner to be used with all minimization schemes. ", &
usage="PRECONDITIONER FULL_ALL", &
default_i_val=ot_precond_full_all, &
enum_c_vals=s2a("FULL_ALL", "FULL_SINGLE_INVERSE", "NONE"), &
enum_desc=s2a("Most effective state selective preconditioner based on diagonalization ", &
"Based on H-eS cholesky inversion, similar to FULL_SINGLE in preconditioning efficiency "// &
"but cheaper to construct, might be somewhat less robust. Recommended for large systems.", &
"skip preconditioning"), &
enum_i_vals=(/ot_precond_full_all, ot_precond_full_single_inverse, ot_precond_none/), &
citations=(/VandeVondele2003/))
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="PRECOND_SOLVER", &
description="How the preconditioner is applied to the residual.", &
usage="PRECOND_SOLVER DIRECT", &
default_i_val=ot_precond_solver_default, &
enum_c_vals=s2a("DEFAULT", "DIRECT", "INVERSE_CHOLESKY"), &
enum_desc=s2a("the default", "Cholesky decomposition followed by triangular solve "// &
"(works for FULL_KINETIC/SINGLE_INVERSE/S_INVERSE)", &
"Cholesky decomposition followed by explicit inversion "// &
"(works for FULL_KINETIC/SINGLE_INVERSE/S_INVERSE)"), &
enum_i_vals=(/ot_precond_solver_default, &
ot_precond_solver_direct, &
ot_precond_solver_inv_chol/))
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create( &
keyword, name="ENERGY_GAP", &
description="Should be an estimate for the energy gap [a.u.] (HOMO-LUMO) and is used in preconditioning, "// &
"especially effective with the FULL_ALL preconditioner, in which case it should be an underestimate "// &
"of the gap (0.001 doing normally fine). For the other preconditioners, making this value larger (0.2)"// &
" will tame the preconditioner in case of poor initial guesses.", &
usage="ENERGY_GAP 0.001", &
default_r_val=0.2_dp)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="NEW_PREC_EACH", &
description="Number of SCF iterations after which a new Preconditioner is computed", &
usage="NEW_PREC_EACH 10", default_i_val=20)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="FIRST_PREC", &
description="First SCF iteration at which a Preconditioner is employed", &
usage="FIRST_PREC 1", default_i_val=1)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="CONV_MOS_PERCENT", &
description="Minimal percent of MOS that have to converge within the Davidson loop"// &
" before the SCF iteration is completed and a new Hamiltonian is computed", &
usage="CONV_MOS_PERCENT 0.8", default_r_val=0.5_dp)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="SPARSE_MOS", &
description="Use MOS as sparse matrix and avoid as much as possible multiplications with full matrices", &
usage="SPARSE_MOS", default_l_val=.TRUE., &
lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
END SUBROUTINE create_davidson_section
! **************************************************************************************************
!> \brief ...
!> \param section ...
! **************************************************************************************************
SUBROUTINE create_krylov_section(section)
TYPE(section_type), POINTER :: section
CHARACTER(len=*), PARAMETER :: routineN = 'create_krylov_section', &
routineP = moduleN//':'//routineN
TYPE(keyword_type), POINTER :: keyword
CPASSERT(.NOT. ASSOCIATED(section))
CALL section_create(section, "KRYLOV", &
description=" ", &
n_keywords=2, n_subsections=0, repeats=.FALSE.)
NULLIFY (keyword)
CALL keyword_create(keyword, name="NKRYLOV", &
description="Dimension of the Krylov space used for the Lanczos refinement", &
usage="NKRYLOV 20", &
default_i_val=4)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="NBLOCK", &
description="Size of the block of vectors refined simultaneously by the Lanczos procedure", &
usage="NBLOCK 1", &
default_i_val=32)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="EPS_KRYLOV", &
description="Convergence criterion for the MOs", &
usage="EPS_KRYLOV 0.00001", &
default_r_val=0.0000001_dp)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="EPS_STD_DIAG", &
description="Level of convergence to be reached before starting the Lanczos procedure."// &
" Above this threshold a standard diagonalization method is used. "// &
" If negative Lanczos is started at the first iteration", &
usage="EPS_STD_DIAG 0.001", &
default_r_val=-1.0_dp)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="CHECK_MOS_CONV", &
description="This requires to check the convergence of MOS also when standard "// &
"diagonalization steps are performed, if the block krylov approach is active.", &
usage="CHECK_MOS_CONV T", &
default_l_val=.FALSE., &
lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
END SUBROUTINE create_krylov_section
! **************************************************************************************************
!> \brief ...
!> \param section ...
! **************************************************************************************************
SUBROUTINE create_diag_subspace_section(section)
TYPE(section_type), POINTER :: section
CHARACTER(len=*), PARAMETER :: routineN = 'create_diag_subspace_section', &
routineP = moduleN//':'//routineN
TYPE(keyword_type), POINTER :: keyword
TYPE(section_type), POINTER :: subsection
CPASSERT(.NOT. ASSOCIATED(section))
CALL section_create(section, "DIAG_SUB_SCF", &
description="Activation of self-consistenf subspace refinement by diagonalization "// &
"of H by adjusting the occupation but keeping the MOS unchanged.", &
n_keywords=2, n_subsections=1, repeats=.FALSE.)
NULLIFY (keyword, subsection)
CALL keyword_create(keyword, name="_SECTION_PARAMETERS_", &
description="controls the activation of inner SCF loop to refine occupations in MOS subspace", &
usage="&DIAG_SUB_SCF T", &
default_l_val=.FALSE., &
lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="MAX_ITER", &
description="Maximum number of iterations for the SCF inner loop", &
usage="MAX_ITER 20", &
default_i_val=2)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="EPS_ENE", &
description="Required energy accuracy for convergence of subspace diagonalization", &
usage="EPS_ENE 1.e-8", &
default_r_val=1.e-4_dp)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="EPS_ADAPT_SCF", &
description="Required density matrix accuracy as compared to current SCF convergence", &
usage="EPS_ADAPT_SCF 1.e-1", &
default_r_val=1._dp)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create( &
keyword, name="EPS_SKIP_SUB_DIAG", &
description="Level of convergence to be reached before starting the internal loop of subspace rotations."// &
" Above this threshold only the outer diagonalization method is used. "// &
" If negative the subspace rotation is started at the first iteration", &
usage="EPS_SKIP_SUB_DIAG 0.001", &
default_r_val=-1.0_dp)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL create_mixing_section(subsection)
CALL section_add_subsection(section, subsection)
CALL section_release(subsection)
END SUBROUTINE create_diag_subspace_section
! **************************************************************************************************
!> \brief makes the input section for core-level spectroscopy simulations
!> \param section ...
!> \par History
!> 03.2005 created [MI]
! **************************************************************************************************
SUBROUTINE create_xas_section(section)
TYPE(section_type), POINTER :: section
CHARACTER(len=*), PARAMETER :: routineN = 'create_xas_section', &
routineP = moduleN//':'//routineN
TYPE(keyword_type), POINTER :: keyword
TYPE(section_type), POINTER :: print_key, subsection
CPASSERT(.NOT. ASSOCIATED(section))
CALL section_create(section, "xas", &
description="Sets the method of choice to calculate core-level excitation spectra. "// &
"The occupied states from which we calculate the "// &
"excitation should be specified. "// &
"Localization of the orbitals may be useful.", &
n_keywords=10, n_subsections=1, repeats=.FALSE., &
citations=(/Iannuzzi2007/))
NULLIFY (keyword, subsection, print_key)
CALL keyword_create(keyword, name="_SECTION_PARAMETERS_", &
description="controls the activation of core-level spectroscopy simulations", &
usage="&XAS T", &
default_l_val=.FALSE., &
lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="METHOD", &
variants=(/"XAS_METHOD"/), &
description="Method to be used to calculate core-level excitation spectra", &
usage="METHOD TP_HH", &
default_i_val=xas_none, &
enum_c_vals=s2a("NONE", "TP_HH", "TP_FH", "TP_VAL", "TP_XHH", "TP_XFH", "DSCF", "TP_FLEX"), &
enum_desc=s2a( &
"No core electron spectroscopy", "Transition potential half-hole", &
"Transition potential full-hole", "Hole in homo for X-ray emission only ", &
"Transition potential excited half-hole", &
"Transition potential excited full-hole ", &
"DSCF calculations to compute the first (core)excited state", &
"Transition potential with generalized core occupation and total number of electrons"), &
enum_i_vals=(/xas_none, xas_tp_hh, xas_tp_fh, xes_tp_val, xas_tp_xhh, &
xas_tp_xfh, xas_dscf, xas_tp_flex/))
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="XAS_CORE", &
description="Occupation of the core state in XAS calculation by TP_FLEX.", &
usage="XAS_CORE 0.5", &
default_r_val=0.5_dp)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="XAS_TOT_EL", &
description="Total number of electrons for spin channel alpha, in XAS calculation by TP_FLEX."// &
"If it is a negative value, the number of electrons is set to GS number of electrons "// &
"minus the amount subtracted from the core state", &
usage="XAS_TOT_EL 10", &
default_r_val=-1._dp)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="XES_CORE", &
description="Occupation of the core state in XES calculation by TP_VAL. "// &
"The HOMO is emptied by the same amount.", &
usage="XES_CORE 0.5", &
default_r_val=1._dp)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="XES_EMPTY_HOMO", &
description="Set the occupation of the HOMO in XES calculation by TP_VAL. "// &
"The HOMO can be emptied or not, if the core is still full.", &
usage="XES_EMPTY_HOMO", &
default_l_val=.FALSE., &
lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="DIPOLE_FORM", &
variants=(/"DIP_FORM"/), &
description="Type of integral to get the oscillator strengths "// &
"in the diipole approximation", &
usage="DIPOLE_FORM string", &
default_i_val=xas_dip_vel, &
enum_c_vals=s2a("LENGTH", "VELOCITY"), &
enum_desc=s2a("Length form ⟨ i | e r | j ⟩", &
"Velocity form ⟨ i | d/dr | j ⟩"), &
enum_i_vals=(/xas_dip_len, xas_dip_vel/))
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
! replace the specialized keyword with standard scf section
! scf_env is added to xas_env
NULLIFY (subsection)
CALL create_scf_section(subsection)
CALL section_add_subsection(section, subsection)
CALL section_release(subsection)
CALL keyword_create(keyword, name="STATE_TYPE", &
variants=(/"TYPE"/), &
description="Type of the orbitals that are excited for the xas spectra calculation", &
usage="STATE_TYPE 1S", &
default_i_val=xas_1s_type, &
enum_c_vals=s2a("1S", "2S", "2P"), &
enum_desc=s2a("1s orbitals", "2s orbitals", "2p orbitals"), &
enum_i_vals=(/xas_1s_type, xas_2s_type, xas_2p_type/))
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="STATE_SEARCH", &
description="# of states where to look for the one to be excited", &
usage="STATE_SEARCH 1", &
default_i_val=-1)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="SPIN_CHANNEL", &
description="# Spin channel of the excited orbital", &
usage="SPIN_CHANNEL 1", &
default_i_val=1)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="ATOMS_LIST", &
variants=(/"AT_LIST"/), &
description="Indexes of the atoms to be excited. "// &
"This keyword can be repeated several times"// &
"(useful if you have to specify many indexes).", &
usage="ATOMS_LIST {integer} {integer} .. {integer} ", &
n_var=-1, type_of_var=integer_t, repeats=.TRUE.)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="ADDED_MOS", &
description="Number of additional MOS added spin up only", &
usage="ADDED_MOS {integer}", default_i_val=-1)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="MAX_ITER_ADDED", &
description="maximum number of iteration in calculation of added orbitals", &
usage="MAX_ITER_ADDED 100", default_i_val=2999)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="EPS_ADDED", &
description="target accuracy incalculation of the added orbitals", &
usage="EPS_ADDED 1.e-6", default_r_val=1.0e-5_dp)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="NGAUSS", &
description="Number of gto's for the expansion of the STO "// &
"of the type given by STATE_TYPE", &
usage="NGAUSS {integer}", default_i_val=3)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="RESTART", &
description="Restart the excited state if the restart file exists", &
usage="RESTART", &
default_l_val=.FALSE., lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="WFN_RESTART_FILE_NAME", &
variants=(/"RESTART_FILE_NAME"/), &
description="Root of the file names where to read the MOS from "// &
"which to restart the calculation of the core level excited states", &
usage="WFN_RESTART_FILE_NAME <FILENAME>", &
type_of_var=lchar_t)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL create_localize_section(subsection)
CALL section_add_subsection(section, subsection)
CALL section_release(subsection)
CALL section_create(subsection, "PRINT", &
"printing of information during the core-level spectroscopy simulation", &
repeats=.FALSE.)
! Add printing of wannier infos
CALL print_wanniers(subsection)
CALL cp_print_key_section_create(print_key, "iteration_info", &
description="Controls the printing of basic iteration information during the XAS SCF.", &
print_level=low_print_level, filename="__STD_OUT__")
CALL keyword_create(keyword, name="time_cumul", &
description="If the printkey is activated switches the printing of timings"// &
" to cumulative (over the SCF).", &
default_l_val=.FALSE., lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
CALL section_add_subsection(subsection, print_key)
CALL section_release(print_key)
CALL cp_print_key_section_create(print_key, "program_run_info", &
description="Controls the printing of basic iteration information in CLS", &
print_level=low_print_level, add_last=add_last_numeric, filename="__STD_OUT__")
CALL section_add_subsection(subsection, print_key)
CALL section_release(print_key)
CALL cp_print_key_section_create(print_key, "XES_SPECTRUM", &
description="Controls the dumping of the CLS output files containing the emission spectra", &
print_level=low_print_level, common_iter_levels=3, filename="")
CALL section_add_subsection(subsection, print_key)
CALL section_release(print_key)
CALL cp_print_key_section_create( &
print_key, "XAS_SPECTRUM", &
description="Controls the dumping of the CLS output files containing the absorption spectra", &
print_level=low_print_level, common_iter_levels=3, filename="")
CALL section_add_subsection(subsection, print_key)
CALL section_release(print_key)
CALL create_pdos_section(print_key)
CALL section_add_subsection(subsection, print_key)
CALL section_release(print_key)
CALL cp_print_key_section_create(print_key, "RESTART", &
description="Controls the dumping of MO restart file during the SCF."// &
"of a Core-Level-Spectroscopy calculation. For each new excited atom,"// &
"one different restart file is dumped. These restart files should be"// &
"employed only to restart the same type of CLS calculation, "// &
"i.e. with the same core potential.", &
print_level=low_print_level, common_iter_levels=3, each_iter_names=s2a("XAS_SCF"), &
add_last=add_last_numeric, each_iter_values=(/3/), filename="")
CALL section_add_subsection(subsection, print_key)
CALL section_release(print_key)
CALL cp_print_key_section_create(print_key, "CLS_FUNCTION_CUBES", &
description="Controls the printing of the relaxed orbitals ", &
print_level=high_print_level, common_iter_levels=3, add_last=add_last_numeric, filename="")
CALL keyword_create(keyword, name="stride", &
description="The stride (X,Y,Z) used to write the cube file "// &
"(larger values result in smaller cube files). You can provide 3 numbers (for X,Y,Z) or"// &
" 1 number valid for all components.", &
usage="STRIDE 2 2 2", n_var=-1, default_i_vals=(/2, 2, 2/), type_of_var=integer_t)
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="CUBES_LU_BOUNDS", &
variants=(/"CUBES_LU"/), &
description="The lower and upper index of the states to be printed as cube", &
usage="CUBES_LU_BOUNDS integer integer", &
n_var=2, default_i_vals=(/0, -2/), type_of_var=integer_t)
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="CUBES_LIST", &
description="Indexes of the states to be printed as cube files"// &
"This keyword can be repeated several times"// &
"(useful if you have to specify many indexes).", &
usage="CUBES_LIST 1 2", &
n_var=-1, type_of_var=integer_t, repeats=.TRUE.)
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="APPEND", &
description="append the cube files when they already exist", &
default_l_val=.FALSE., lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
CALL section_add_subsection(subsection, print_key)
CALL section_release(print_key)
CALL section_add_subsection(section, subsection)
CALL section_release(subsection)
END SUBROUTINE create_xas_section
! **************************************************************************************************
!> \brief Create CP2K input section for the smearing of occupation numbers
!> \param section ...
!> \date 27.08.2008
!> \author Matthias Krack (MK)
!> \version 1.0
! **************************************************************************************************
SUBROUTINE create_smear_section(section)
TYPE(section_type), POINTER :: section
CHARACTER(LEN=*), PARAMETER :: routineN = 'create_smear_section', &
routineP = moduleN//':'//routineN
TYPE(keyword_type), POINTER :: keyword
CPASSERT(.NOT. ASSOCIATED(section))
CALL section_create(section, &
name="SMEAR", &
description="Define the smearing of the MO occupation numbers", &
n_keywords=6, &
n_subsections=0, &
repeats=.FALSE.)
NULLIFY (keyword)
CALL keyword_create(keyword, &
name="_SECTION_PARAMETERS_", &
description="Controls the activation of smearing", &
usage="&SMEAR ON", &
default_l_val=.FALSE., &
lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, &
name="METHOD", &
description="Smearing method to be applied", &
usage="METHOD Fermi_Dirac", &
default_i_val=smear_energy_window, &
enum_c_vals=s2a("FERMI_DIRAC", "ENERGY_WINDOW", "LIST"), &
enum_i_vals=(/smear_fermi_dirac, smear_energy_window, smear_list/), &
enum_desc=s2a("Fermi-Dirac distribution defined by the keyword ELECTRONIC_TEMPERATURE", &
"Energy window defined by the keyword WINDOW_SIZE", &
"Use a fixed list of occupations"))
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, &
name="LIST", &
description="A list of fractional occupations to use. Must match the number of states "// &
"and sum up to the correct number of electrons", &
repeats=.FALSE., &
n_var=-1, &
type_of_var=real_t, &
usage="LIST 2.0 0.6666 0.6666 0.66666 0.0 0.0")
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, &
name="ELECTRONIC_TEMPERATURE", &
variants=s2a("ELEC_TEMP", "TELEC"), &
description="Electronic temperature in the case of Fermi-Dirac smearing", &
repeats=.FALSE., &
n_var=1, &
type_of_var=real_t, &
default_r_val=cp_unit_to_cp2k(value=300.0_dp, unit_str="K"), &
unit_str="K", &
usage="ELECTRONIC_TEMPERATURE [K] 300")
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, &
name="EPS_FERMI_DIRAC", &
description="Accuracy checks on occupation numbers use this as a tolerance", &
repeats=.FALSE., &
n_var=1, &
type_of_var=real_t, &
default_r_val=1.0E-10_dp, &
usage="EPS_FERMI_DIRAC 1.0E-6")
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, &
name="WINDOW_SIZE", &
description="Size of the energy window centred at the Fermi level", &
repeats=.FALSE., &
n_var=1, &
type_of_var=real_t, &
default_r_val=0.0_dp, &
unit_str="au_e", &
usage="WINDOW_SIZE [eV] 0.3")
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="FIXED_MAGNETIC_MOMENT", &
description="Imposed difference between the numbers of electrons of spin up "// &
"and spin down: m = n(up) - n(down). A negative value (default) allows "// &
"for a change of the magnetic moment. -1 specifically keeps an integer "// &
"number of spin up and spin down electrons.", &
repeats=.FALSE., &
n_var=1, &
type_of_var=real_t, &
default_r_val=-100.0_dp, &
usage="FIXED_MAGNETIC_MOMENT 1.5")
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
END SUBROUTINE create_smear_section
! **************************************************************************************************
!> \brief ...
!> \param section ...
! **************************************************************************************************
SUBROUTINE create_rtp_section(section)
TYPE(section_type), POINTER :: section
CHARACTER(len=*), PARAMETER :: routineN = 'create_rtp_section', &
routineP = moduleN//':'//routineN
TYPE(keyword_type), POINTER :: keyword
TYPE(section_type), POINTER :: print_key, print_section
NULLIFY (keyword)
CPASSERT(.NOT. ASSOCIATED(section))
CALL section_create(section, "REAL_TIME_PROPAGATION", &
description="Parameters needed to set up the real time propagation"// &
" for the electron dynamics. This currently works only in the NVE ensemble.", &
n_keywords=4, n_subsections=4, repeats=.FALSE., &
citations=(/Kunert2003, Andermatt2016/))
CALL keyword_create(keyword, name="MAX_ITER", &
description="Maximal number of iterations for the self consistent propagator loop.", &
usage="MAX_ITER 10", &
default_i_val=10)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="EPS_ITER", &
description="Convergence criterion for the self consistent propagator loop.", &
usage="EPS_ITER 1.0E-5", &
default_r_val=1.0E-7_dp)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="ASPC_ORDER", &
description="Speciefies how many steps will be used for extrapolation. "// &
"One will be always used which is means X(t+dt)=X(t)", &
usage="ASPC_ORDER 3", &
default_i_val=3)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="MAT_EXP", &
description="Which method should be used to calculate the exponential"// &
" in the propagator. It is recommended to use BCH when employing density_propagation "// &
"and ARNOLDI otherwise.", &
usage="MAT_EXP TAYLOR", default_i_val=do_arnoldi, &
enum_c_vals=s2a("TAYLOR", "PADE", "ARNOLDI", "BCH"), &
enum_i_vals=(/do_taylor, do_pade, do_arnoldi, do_bch/), &
enum_desc=s2a("exponential is evaluated using scaling and squaring in combination"// &
" with a taylor expansion of the exponential.", &
"uses scaling and squaring together with the pade approximation", &
"uses arnoldi subspace algorithm to compute exp(H)*MO directly, can't be used in "// &
"combination with Crank Nicholson or density propagation", &
"Uses a Baker-Campbell-Hausdorff expansion to propagate the density matrix,"// &
" only works for density propagation"))
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="DENSITY_PROPAGATION", &
description="The density matrix is propagated instead of the molecular orbitals. "// &
"This can allow a linear scaling simulation. The density matrix is filtered with "// &
"the threshold based on the EPS_FILTER keyword from the LS_SCF section", &
usage="DENSITY_PROPAGATION .TRUE.", &
default_l_val=.FALSE., lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="SC_CHECK_START", &
description="Speciefies how many iteration steps will be done without "// &
"a check for self consistency. Can save some time in big calculations.", &
usage="SC_CHECK_START 3", &
default_i_val=0)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="EXP_ACCURACY", &
description="Accuracy for the taylor and pade approximation. "// &
"This is only an upper bound bound since the norm used for the guess "// &
"is an upper bound for the needed one.", &
usage="EXP_ACCURACY 1.0E-6", &
default_r_val=1.0E-9_dp)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="PROPAGATOR", &
description="Which propagator should be used for the orbitals", &
usage="PROPAGATOR ETRS", default_i_val=do_etrs, &
enum_c_vals=s2a("ETRS", "CN", "EM"), &
enum_i_vals=(/do_etrs, do_cn, do_em/), &
enum_desc=s2a("enforced time reversible symmetry", &
"Crank Nicholson propagator", &
"Exponential midpoint propagator"))
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="INITIAL_WFN", &
description="Controls the initial WFN used for propagation.", &
usage="INITIAL_WFN SCF_WFN", default_i_val=use_scf_wfn, &
enum_c_vals=s2a("SCF_WFN", "RESTART_WFN", "RT_RESTART"), &
enum_i_vals=(/use_scf_wfn, use_restart_wfn, use_rt_restart/), &
enum_desc=s2a("An SCF run is performed to get the initial state.", &
"A wavefunction from a previous SCF is propagated. Especially useful,"// &
" if electronic constraints or restraints are used in the previous calculation, "// &
"since these do not work in the rtp scheme.", &
"use the wavefunction of a real time propagation/ehrenfest run"))
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="APPLY_DELTA_PULSE", &
description="Applies a delta kick to the initial wfn (only RTP for now - the EMD "// &
" case is not yet implemented).", &
usage="APPLY_DELTA_PULSE", &
default_l_val=.FALSE., lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="PERIODIC", &
description="Apply a delta-kick that is compatible with periodic boundary conditions"// &
" for any value of DELTA_PULSE_SCALE. Uses perturbation theory for the preparation of"// &
" the initial wfn. Note that the pulse is only applied when INITIAL_WFN is set to SCF_WFN,"// &
" and not for restarts (RT_RESTART).", &
usage="PERIODIC", &
default_l_val=.TRUE., lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="DELTA_PULSE_DIRECTION", &
description="Direction of the applied electric field. The k vector is given as"// &
" 2*Pi*[i,j,k]*inv(h_mat), which for PERIODIC .FALSE. yields exp(ikr) periodic with"// &
" the unit cell, only if DELTA_PULSE_SCALE is set to unity. For an orthorhombic cell"// &
" [1,0,0] yields [2*Pi/L_x,0,0]. For small cells, this results in a very large kick.", &
usage="DELTA_PULSE_DIRECTION 1 1 1", n_var=3, default_i_vals=(/1, 0, 0/), &
type_of_var=integer_t)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="DELTA_PULSE_SCALE", &
description="Scale the k vector, which for PERIODIC .FALSE. results in exp(ikr) no"// &
" longer being periodic with the unit cell. The norm of k is the strength of the"// &
" applied electric field in atomic units.", &
usage="DELTA_PULSE_SCALE 0.01 ", n_var=1, default_r_val=0.001_dp)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="HFX_BALANCE_IN_CORE", &
description="If HFX is used, this keyword forces a redistribution/recalculation"// &
" of the integrals, balanced with respect to the in core steps.", &
usage="HFX_BALANCE_IN_CORE", &
default_l_val=.FALSE., lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="MCWEENY_MAX_ITER", &
description="Determines the maximum amount of McWeeny steps used after each converged"// &
" step in density propagation", &
usage="MCWEENY_MAX_ITER 2", default_i_val=1)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create( &
keyword, name="ACCURACY_REFINEMENT", &
description="If using density propagation some parts should be calculated with a higher accuracy than the rest"// &
" to reduce numerical noise. This factor determines by how much the filtering threshold is"// &
" reduced for these calculations.", &
usage="ACCURACY_REFINEMENT", default_i_val=100)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="MCWEENY_EPS", &
description="Threshold after which McWeeny is terminated", &
usage="MCWEENY_EPS 0.00001", &
default_r_val=0.0_dp)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
NULLIFY (print_section)
CALL section_create(print_section, name="PRINT", &
description="Section of possible print options for an RTP runs", &
repeats=.FALSE.)
NULLIFY (print_key)
CALL cp_print_key_section_create(print_key, "PROGRAM_RUN_INFO", &
description="Controls the printing within real time propagation and Eherenfest dynamics", &
print_level=low_print_level, filename="__STD_OUT__")
CALL section_add_subsection(print_section, print_key)
CALL section_release(print_key)
CALL cp_print_key_section_create(print_key, "RESTART", &
description="Controls the dumping of the MO restart file during rtp. "// &
"By default keeps a short history of three restarts."// &
"See also RESTART_HISTORY. In density propagation this controls the printing of P.", &
print_level=low_print_level, common_iter_levels=3, &
each_iter_names=s2a("MD"), each_iter_values=(/20/), &
add_last=add_last_numeric, filename="RESTART")
CALL keyword_create(keyword, name="BACKUP_COPIES", &
description="Specifies the maximum index of backup copies.", &
usage="BACKUP_COPIES {int}", &
default_i_val=3)
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
CALL section_add_subsection(print_section, print_key)
CALL section_release(print_key)
CALL cp_print_key_section_create(print_key, "RESTART_HISTORY", &
description="Dumps unique MO restart files during the run keeping all of them. "// &
"In density propagation it dumps the density matrix instead", &
print_level=low_print_level, common_iter_levels=0, &
each_iter_names=s2a("MD"), &
each_iter_values=(/500/), &
filename="RESTART")
CALL keyword_create(keyword, name="BACKUP_COPIES", &
description="Specifies the maximum index of backup copies.", &
usage="BACKUP_COPIES {int}", &
default_i_val=3)
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
CALL section_add_subsection(print_section, print_key)
CALL section_release(print_key)
CALL cp_print_key_section_create(print_key, "CURRENT", &
description="Print the current during an EMD simulation to cube files.", &
print_level=high_print_level, common_iter_levels=0, &
each_iter_names=s2a("MD"), &
each_iter_values=(/20/), &
filename="current")
CALL keyword_create(keyword, name="BACKUP_COPIES", &
description="Specifies the maximum index of backup copies.", &
usage="BACKUP_COPIES {int}", &
default_i_val=1)
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="STRIDE", &
description="The stride (X,Y,Z) used to write the cube file "// &
"(larger values result in smaller cube files). You can provide 3 numbers (for X,Y,Z) or"// &
" 1 number valid for all components.", &
usage="STRIDE 2 2 2", n_var=-1, default_i_vals=(/2, 2, 2/), type_of_var=integer_t)
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
CALL section_add_subsection(print_section, print_key)
CALL section_release(print_key)
CALL section_add_subsection(section, print_section)
CALL section_release(print_section)
END SUBROUTINE create_rtp_section
! **************************************************************************************************
!> \brief Create CP2K input section for the SCCS model
!> \param section ...
!> \par History:
!> - Creation (10.10.2013,MK)
!> \author Matthias Krack (MK)
!> \version 1.0
! **************************************************************************************************
SUBROUTINE create_sccs_section(section)
TYPE(section_type), POINTER :: section
CHARACTER(LEN=*), PARAMETER :: routineN = 'create_sccs_section', &
routineP = moduleN//':'//routineN
TYPE(keyword_type), POINTER :: keyword
TYPE(section_type), POINTER :: subsection
CPASSERT(.NOT. ASSOCIATED(section))
CALL section_create(section, &
name="SCCS", &
description="Define the parameters for self-consistent continuum solvation (SCCS) model", &
citations=(/Fattebert2002, Andreussi2012/), &
n_keywords=8, &
n_subsections=2, &
repeats=.FALSE.)
NULLIFY (keyword)
CALL keyword_create(keyword, &
name="_SECTION_PARAMETERS_", &
description="Controls the activation of the SCCS section", &
usage="&SCCS ON", &
default_l_val=.FALSE., &
lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, &
name="ALPHA", &
description="Solvent specific tunable parameter for the calculation of "// &
"the repulsion term <i>G<sup>rep</sup> = α S</i> "// &
"where <i>S</i> is the (quantum) surface of the cavity", &
repeats=.FALSE., &
n_var=1, &
type_of_var=real_t, &
default_r_val=0.0_dp, &
unit_str="mN/m")
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, &
name="BETA", &
description="Solvent specific tunable parameter for the calculation of "// &
"the dispersion term <i>G<sup>dis</sup> = β V</i> "// &
"where <i>V</i> is the (quantum) volume of the cavity", &
repeats=.FALSE., &
n_var=1, &
type_of_var=real_t, &
default_r_val=0.0_dp, &
unit_str="GPa")
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, &
name="DELTA_RHO", &
description="Numerical increment for the calculation of the (quantum) "// &
"surface of the solute cavity", &
repeats=.FALSE., &
n_var=1, &
type_of_var=real_t, &
default_r_val=2.0E-5_dp)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, &
name="DERIVATIVE_METHOD", &
description="Method for the calculation of the numerical derivatives on the real-space grids", &
usage="DERIVATIVE_METHOD cd5", &
repeats=.FALSE., &
n_var=1, &
default_i_val=sccs_derivative_fft, &
enum_c_vals=s2a("FFT", "CD3", "CD5", "CD7"), &
enum_i_vals=(/sccs_derivative_fft, &
sccs_derivative_cd3, &
sccs_derivative_cd5, &
sccs_derivative_cd7/), &
enum_desc=s2a("Fast Fourier transformation", &
"3-point stencil central differences", &
"5-point stencil central differences", &
"7-point stencil central differences"))
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, &
name="DIELECTRIC_CONSTANT", &
variants=(/"EPSILON_SOLVENT"/), &
description="Dielectric constant of the solvent", &
repeats=.FALSE., &
n_var=1, &
type_of_var=real_t, &
default_r_val=80.0_dp, &
usage="DIELECTRIC_CONSTANT 78.36")
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, &
name="EPS_SCCS", &
variants=s2a("EPS_ITER", "TAU_POL"), &
description="Tolerance for the convergence of the polarisation density, "// &
"i.e. requested accuracy for the SCCS iteration cycle", &
repeats=.FALSE., &
n_var=1, &
type_of_var=real_t, &
default_r_val=1.0E-6_dp, &
usage="EPS_ITER 1.0E-7")
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, &
name="EPS_SCF", &
description="The SCCS iteration cycle is activated only if the SCF iteration cycle "// &
"is converged to this threshold value", &
repeats=.FALSE., &
n_var=1, &
type_of_var=real_t, &
default_r_val=0.5_dp, &
usage="EPS_SCF 1.0E-2")
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, &
name="GAMMA", &
variants=s2a("SURFACE_TENSION"), &
description="Surface tension of the solvent used for the calculation of "// &
"the cavitation term <i>G<sup>cav</sup> = γ S</i> "// &
"where <i>S</i> is the (quantum) surface of the cavity", &
repeats=.FALSE., &
n_var=1, &
type_of_var=real_t, &
default_r_val=0.0_dp, &
unit_str="mN/m")
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, &
name="MAX_ITER", &
description="Maximum number of SCCS iteration steps performed to converge "// &
"within the given tolerance", &
repeats=.FALSE., &
n_var=1, &
type_of_var=integer_t, &
default_i_val=100, &
usage="MAX_ITER 50")
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, &
name="METHOD", &
description="Method used for the smoothing of the dielectric function", &
usage="METHOD Fattebert-Gygi", &
default_i_val=sccs_andreussi, &
enum_c_vals=s2a("ANDREUSSI", "FATTEBERT-GYGI"), &
enum_i_vals=(/sccs_andreussi, sccs_fattebert_gygi/), &
enum_desc=s2a("Smoothing function proposed by Andreussi et al.", &
"Smoothing function proposed by Fattebert and Gygi"))
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, &
name="MIXING", &
variants=(/"ETA"/), &
description="Mixing parameter (Hartree damping) employed during the iteration procedure", &
repeats=.FALSE., &
n_var=1, &
type_of_var=real_t, &
default_r_val=0.6_dp, &
usage="MIXING 0.2")
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
NULLIFY (subsection)
CALL section_create(subsection, &
name="ANDREUSSI", &
description="Define the parameters of the dielectric smoothing function proposed by "// &
"Andreussi et al.", &
citations=(/Andreussi2012/), &
n_keywords=2, &
n_subsections=0, &
repeats=.FALSE.)
CALL keyword_create(keyword, &
name="RHO_MAX", &
description="Maximum density value used for the smoothing of the dielectric function", &
repeats=.FALSE., &
n_var=1, &
type_of_var=real_t, &
default_r_val=0.0035_dp, &
usage="RHO_MAX 0.01")
CALL section_add_keyword(subsection, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, &
name="RHO_MIN", &
description="Minimum density value used for the smoothing of the dielectric function", &
repeats=.FALSE., &
n_var=1, &
type_of_var=real_t, &
default_r_val=0.0001_dp, &
usage="RHO_MIN 0.0003")
CALL section_add_keyword(subsection, keyword)
CALL keyword_release(keyword)
CALL section_add_subsection(section, subsection)
CALL section_release(subsection)
CALL section_create(subsection, &
name="FATTEBERT-GYGI", &
description="Define the parameters of the dielectric smoothing function proposed by "// &
"Fattebert and Gygi", &
citations=(/Fattebert2002/), &
n_keywords=2, &
n_subsections=0, &
repeats=.FALSE.)
CALL keyword_create(keyword, &
name="BETA", &
description="Parameter β changes the width of the interface solute-solvent", &
repeats=.FALSE., &
n_var=1, &
type_of_var=real_t, &
default_r_val=1.7_dp, &
usage="BETA 1.3")
CALL section_add_keyword(subsection, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, &
name="RHO_ZERO", &
variants=(/"RHO0"/), &
description="Parameter ρ<sub>0</sub> defines the critical density in the middle "// &
"of the interface solute-solvent", &
repeats=.FALSE., &
n_var=1, &
type_of_var=real_t, &
default_r_val=0.0006_dp, &
usage="RHO_ZERO 0.0004")
CALL section_add_keyword(subsection, keyword)
CALL keyword_release(keyword)
CALL section_add_subsection(section, subsection)
CALL section_release(subsection)
END SUBROUTINE create_sccs_section
! **************************************************************************************************
!> \brief Create CP2K input section for the calculation of an active space Hamiltonian
!> \param section ...
!> \par History:
!> - Creation 06.04.2016
!> \author JHU
! **************************************************************************************************
SUBROUTINE create_active_space_section(section)
TYPE(section_type), POINTER :: section
CHARACTER(LEN=*), PARAMETER :: routineN = 'create_active_space_section', &
routineP = moduleN//':'//routineN
TYPE(keyword_type), POINTER :: keyword
TYPE(section_type), POINTER :: print_key, subsection
CPASSERT(.NOT. ASSOCIATED(section))
CALL section_create(section, name="ACTIVE_SPACE", &
description="Define parameters and method to calculate an electronic active space", &
n_keywords=1, n_subsections=0, repeats=.FALSE.)
NULLIFY (keyword, subsection, print_key)
CALL keyword_create(keyword, &
name="_SECTION_PARAMETERS_", &
description="Controls the activation of the ACTIVE_SPACE section", &
usage="&ACTIVE_SPACE ON", &
default_l_val=.FALSE., &
lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="MODEL", &
description="Model used to calculate active space interaction Hamiltonian.", &
usage="MODEL HARTREE-FOCK", &
default_i_val=hf_model, &
enum_c_vals=s2a("HARTREE-FOCK", "RSDFT", "DMFT"), &
enum_i_vals=(/hf_model, rsdft_model, dmft_model/), &
enum_desc=s2a("Hartree-Fock model for interaction Hamiltonian", &
"Range-separated DFT model for interaction Hamiltonian", &
"DMFT model Hamiltonian"))
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="ACTIVE_ELECTRONS", &
description="The number of active electrons in the CAS space", &
usage="ACTIVE_ELECTRONS 4", n_var=1, default_i_val=-1, type_of_var=integer_t)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="INACTIVE_ELECTRONS", &
description="The number of inactive electrons in the CAS space", &
usage="INACTIVE_ELECTRONS 2 {2}", n_var=-1, default_i_vals=(/-1, -1/), &
type_of_var=integer_t)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="ACTIVE_ORBITALS", &
description="The number of active orbitals defining the CAS space.", &
usage="ACTIVE_ORBITALS 2 {2}", n_var=-1, default_i_vals=(/-1, -1/), &
type_of_var=integer_t)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="INACTIVE_ORBITALS", &
description="The number of nactive orbitals.", &
usage="INACTIVE_ORBITALS 2 {2}", n_var=-1, default_i_vals=(/-1, -1/), &
type_of_var=integer_t)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="ISOLATED_SYSTEM", &
description="System is treated without any periodic boundary conditions.", &
default_l_val=.FALSE., lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL cp_print_key_section_create(print_key, "FCIDUMP", &
description="Controls the writing of a file in FCIDUMP format.", &
print_level=high_print_level, filename="")
CALL section_add_subsection(section, print_key)
CALL section_release(print_key)
CALL keyword_create(keyword, name="ORBITAL_SELECTION", &
description="Method used to select active space orbitals.", &
usage="ORBITAL_SELECTION CANONICAL", &
default_i_val=casci_canonical, &
enum_c_vals=s2a("CANONICAL", "WANNIER_PROJECTION", "MAO"), &
enum_i_vals=(/casci_canonical, wannier_projection, mao_projection/), &
enum_desc=s2a("Select orbitals using energy ordering of canoncial orbitals", &
"Select orbitals from projected Wannier functions", &
"Select orbitals from modified atomic orbitals"))
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="SUBSPACE_ATOM", &
description="Number of atom that defines the subspace to be projected on.", &
usage="SUBSPACE_ATOM x", default_i_val=-1, &
type_of_var=integer_t)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="SUBSPACE_SHELL", &
description="Shell definition for subsapce.", &
usage="SUBSPACE_SHELL 3d4s", default_c_val="X", &
type_of_var=char_t)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL create_print_orb_section(subsection)
CALL section_add_subsection(section, subsection)
CALL section_release(subsection)
CALL create_eri_section(subsection)
CALL section_add_subsection(section, subsection)
CALL section_release(subsection)
CALL create_eri_gpw(subsection)
CALL section_add_subsection(section, subsection)
CALL section_release(subsection)
CALL create_localize_section(subsection)
CALL section_add_subsection(section, subsection)
CALL section_release(subsection)
END SUBROUTINE create_active_space_section
! **************************************************************************************************
!> \brief ...
!> \param section ...
! **************************************************************************************************
SUBROUTINE create_print_orb_section(section)
TYPE(section_type), POINTER :: section
CHARACTER(len=*), PARAMETER :: routineN = 'create_print_orb_section', &
routineP = moduleN//':'//routineN
TYPE(keyword_type), POINTER :: keyword
CPASSERT(.NOT. ASSOCIATED(section))
CALL section_create(section, "PRINT_ORBITAL_CUBES", &
description="Controls printing of active orbital cube files.", &
n_keywords=5, n_subsections=0, repeats=.FALSE.)
NULLIFY (keyword)
CALL keyword_create(keyword, name="FILENAME", &
description="Body of Filename for the cube files.", &
usage="FILENAME {name}", default_c_val="ActiveOrbital", &
type_of_var=char_t)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="ALIST", &
description="List of alpha orbitals to be printed. -1 defaults to all values", &
usage="ALIST {1 2 3 ...}", n_var=-1, default_i_vals=(/-1/), &
lone_keyword_i_val=-1, type_of_var=integer_t)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="BLIST", &
description="List of beta orbitals to be printed. -1 defaults to all values", &
usage="ALIST {1 2 3 ...}", n_var=-1, default_i_vals=(/-1/), &
lone_keyword_i_val=-1, type_of_var=integer_t)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="STRIDE", &
description="The stride (X,Y,Z) used to write the cube file"// &
"(larger values result in smaller cube files)."// &
" You can provide 3 numbers (for X,Y,Z) or 1 number valid for all components", &
usage="STRIDE {2 2 2}", n_var=-1, default_i_vals=(/2, 2, 2/), &
type_of_var=integer_t)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
END SUBROUTINE create_print_orb_section
! **************************************************************************************************
!> \brief ...
!> \param section ...
! **************************************************************************************************
SUBROUTINE create_eri_section(section)
TYPE(section_type), POINTER :: section
CHARACTER(len=*), PARAMETER :: routineN = 'create_eri_section', &
routineP = moduleN//':'//routineN
TYPE(keyword_type), POINTER :: keyword
CPASSERT(.NOT. ASSOCIATED(section))
CALL section_create(section, "ERI", &
description="Parameters for the electron repulsion integrals.", &
n_keywords=5, n_subsections=0, repeats=.FALSE.)
NULLIFY (keyword)
CALL keyword_create(keyword, name="METHOD", &
description="Method used in ERI calculation.", &
usage="METHOD FULL_GPW", &
enum_c_vals=s2a("FULL_GPW", "GPW_HALF_TRANSFORM"), &
enum_i_vals=(/eri_method_full_gpw, eri_method_gpw_ht/), &
enum_desc=s2a("Use the GPW approach with MOs", &
"Use the GPW approach for half-transformed MO ERIs"), &
default_i_val=eri_method_gpw_ht)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="OPERATOR", &
description="Operator used in ERI calculation.", &
usage="OPERATOR <1/R>", &
enum_c_vals=s2a("<1/R>", "<EXP(-A*R)/R>", "<ERF(A*R)/R>", &
"<ERFC(A*R)/R>", "<EXP(-A*R2)/R>"), &
enum_i_vals=(/eri_operator_coulomb, eri_operator_yukawa, &
eri_operator_erf, eri_operator_erfc, eri_operator_gaussian/), &
enum_desc=s2a("Coulomb operator", &
"Yukawa potential operator", &
"Error function potential operator", &
"Complementary error function potential operator", &
"Gaussian potential operator"), &
default_i_val=eri_operator_coulomb)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="OPERATOR_PARAMETER", &
description="Range parameter for ERI operator.", &
usage="OPERATOR_PARAMETER 4.0", type_of_var=real_t, &
default_r_val=8.0_dp)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="PERIODICITY", &
description="Periodicity used for operators in ERI calclulation.", &
usage="PERIODICITY {1 1 1}", n_var=-1, default_i_vals=(/1, 1, 1/), &
type_of_var=integer_t)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="CUTOFF_RADIUS", &
description="Radius of operator interactions in non-periodic cases.", &
usage="CUTOFF_RADIUS 20", type_of_var=real_t, &
default_r_val=-1.0_dp)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create( &
keyword, name="EPS_INTEGRAL", &
description="Accuracy of ERIs that will be stored.", &
usage="EPS_FILTER 1.0E-10 ", type_of_var=real_t, &
default_r_val=1.0E-12_dp)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
END SUBROUTINE create_eri_section
! **************************************************************************************************
!> \brief ...
!> \param section ...
! **************************************************************************************************
SUBROUTINE create_eri_gpw(section)
TYPE(section_type), POINTER :: section
CHARACTER(len=*), PARAMETER :: routineN = 'create_eri_gpw', routineP = moduleN//':'//routineN
TYPE(keyword_type), POINTER :: keyword
CPASSERT(.NOT. ASSOCIATED(section))
CALL section_create(section, "ERI_GPW", &
description="Parameters for the GPW approach to electron repulsion integrals.", &
n_keywords=5, n_subsections=0, repeats=.FALSE.)
NULLIFY (keyword)
CALL keyword_create(keyword, name="EPS_GRID", &
description="Determines a threshold for the GPW based integration", &
usage="EPS_GRID 1.0E-9 ", type_of_var=real_t, &
default_r_val=1.0E-8_dp)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="CUTOFF", &
description="The cutoff of the finest grid level in the GPW integration.", &
usage="CUTOFF 300", type_of_var=real_t, &
default_r_val=300.0_dp)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="REL_CUTOFF", &
variants=(/"RELATIVE_CUTOFF"/), &
description="Determines the grid at which a Gaussian is mapped.", &
usage="REL_CUTOFF 50", type_of_var=real_t, &
default_r_val=50.0_dp)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="STORE_WFN", &
variants=(/"STORE_WAVEFUNCTION"/), &
description="Strore wavefunction in real space representation for integration.", &
usage="STORE_WFN T", type_of_var=logical_t, &
default_l_val=.TRUE., lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="PRINT_LEVEL", &
variants=(/"IOLEVEL"/), &
description="How much output is written by the individual groups.", &
usage="PRINT_LEVEL HIGH", &
default_i_val=silent_print_level, enum_c_vals= &
s2a("SILENT", "LOW", "MEDIUM", "HIGH", "DEBUG"), &
enum_desc=s2a("Almost no output", &
"Little output", "Quite some output", "Lots of output", &
"Everything is written out, useful for debugging purposes only"), &
enum_i_vals=(/silent_print_level, low_print_level, medium_print_level, &
high_print_level, debug_print_level/))
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
END SUBROUTINE create_eri_gpw
! **************************************************************************************************
!> \brief Creates the section for cube files related to the implicit Poisson solver.
!> \param section the section to be created
!> \par History
!> 03.2016 refactored from create_print_dft_section [Hossein Bani-Hashemian]
!> \author Mohammad Hossein Bani-Hashemian
! **************************************************************************************************
SUBROUTINE create_implicit_psolver_section(section)
TYPE(section_type), POINTER :: section
CHARACTER(len=*), PARAMETER :: routineN = 'create_implicit_psolver_section', &
routineP = moduleN//':'//routineN
TYPE(keyword_type), POINTER :: keyword
TYPE(section_type), POINTER :: print_key
CPASSERT(.NOT. ASSOCIATED(section))
CALL section_create(section, name="IMPLICIT_PSOLVER", &
description="Controls printing of cube files for data from the implicit "// &
"(generalized) Poisson solver.", &
citations=(/BaniHashemian2016/), &
n_keywords=0, n_subsections=3, repeats=.FALSE.)
NULLIFY (keyword, print_key)
! dielectric constant function
CALL cp_print_key_section_create(print_key, "DIELECTRIC_CUBE", &
description="Controls the printing of a cube file with dielectric constant from "// &
"the implicit (generalized) Poisson solver.", &
print_level=high_print_level, filename="")
CALL keyword_create(keyword, name="stride", &
description="The stride (X,Y,Z) used to write the cube file "// &
"(larger values result in smaller cube files). You can provide 3 numbers (for X,Y,Z) or"// &
" 1 number valid for all components.", &
usage="STRIDE 2 2 2", n_var=-1, default_i_vals=(/2, 2, 2/), type_of_var=integer_t)
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="APPEND", &
description="append the cube files when they already exist", &
default_l_val=.FALSE., lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
CALL section_add_subsection(section, print_key)
CALL section_release(print_key)
! dirichlet type constraints
CALL cp_print_key_section_create( &
print_key, "DIRICHLET_BC_CUBE", &
description="Controls the printing of cube files with unit step functions (constraints) "// &
"representing Dirichlet-type (boundary) regions defined in the implicit (generalized) Poisson "// &
"solver section. The regions remain unchanged throughout the calculations. If the Dirichlet "// &
" regions are relatively large and/or the number of partitions is quite high, in order to save memory,"// &
" generate the cube files in early steps and perform the rest of the calculations with this keyword"// &
" switched off.", &
print_level=high_print_level, filename="")
CALL keyword_create(keyword, name="TILE_CUBES", &
description="Print tiles that tessellate the Dirichlet regions into cube files. If TRUE, "// &
"generates cube files as many as the total number of tiles.", &
usage="TILE_CUBES <logical>", &
default_l_val=.FALSE., lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="stride", &
description="The stride (X,Y,Z) used to write the cube file "// &
"(larger values result in smaller cube files). You can provide 3 numbers (for X,Y,Z) or"// &
" 1 number valid for all components.", &
usage="STRIDE 2 2 2", n_var=-1, default_i_vals=(/2, 2, 2/), type_of_var=integer_t)
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="APPEND", &
description="append the cube files when they already exist", &
default_l_val=.FALSE., lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
CALL section_add_subsection(section, print_key)
CALL section_release(print_key)
! charge introduced by Lagrange multipliers
CALL cp_print_key_section_create(print_key, "DIRICHLET_CSTR_CHARGE_CUBE", &
description="Controls the printing of cube files with penalty charges induced to "// &
"Dirichlet regions by Lagrange multipliers (implicit Poisson solver).", &
print_level=high_print_level, filename="")
CALL keyword_create(keyword, name="stride", &
description="The stride (X,Y,Z) used to write the cube file "// &
"(larger values result in smaller cube files). You can provide 3 numbers (for X,Y,Z) or"// &
" 1 number valid for all components.", &
usage="STRIDE 2 2 2", n_var=-1, default_i_vals=(/2, 2, 2/), type_of_var=integer_t)
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="APPEND", &
description="append the cube files when they already exist", &
default_l_val=.FALSE., lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(print_key, keyword)
CALL keyword_release(keyword)
CALL section_add_subsection(section, print_key)
CALL section_release(print_key)
END SUBROUTINE create_implicit_psolver_section
! **************************************************************************************************
!> \brief creates the input section for parameters related to CDFT specific optimizers
!> \param section the section to be created
!> \par History
!> 03.2018 separated from create_outer_scf_section [Nico Holmberg]
!> \author Nico Holmberg
! **************************************************************************************************
SUBROUTINE create_cdft_opt_section(section)
TYPE(section_type), POINTER :: section
CHARACTER(len=*), PARAMETER :: routineN = 'create_cdft_opt_section', &
routineP = moduleN//':'//routineN
TYPE(keyword_type), POINTER :: keyword
CPASSERT(.NOT. ASSOCIATED(section))
CALL section_create(section, "CDFT_OPT", &
description="Parameters controlling optimization methods that are compatible "// &
"only with CDFT based constraints (i.e. CDFT SCF is active). Specifically, "// &
"the control parameters for the Broyden and Newton optimizers are defined in this "// &
"section.", &
n_keywords=10, n_subsections=0, repeats=.FALSE.)
NULLIFY (keyword)
CALL keyword_create(keyword, name="BROYDEN_TYPE", &
description="Specifies the Broyden optimizer variant to use.", &
usage="BROYDEN_TYPE BT1", &
default_i_val=broyden_type_1, &
enum_c_vals=s2a("BT1", "BT1_EXPLICIT", "BT2", "BT2_EXPLICIT", &
"BT1_LS", "BT1_EXPLICIT_LS", "BT2_LS", "BT2_EXPLICIT_LS"), &
enum_desc=s2a("Broyden's first method, also known as the good method. The initial Jacobian"// &
" is built from MD history if available. Otherwise switches to SD for one"// &
" SCF iteration until a Jacobian can be built from the SCF history.", &
"Same as BT1, but computes the explicit Jacobian with finite differences. "// &
"Requires a CDFT SCF procedure to be active.", &
"Same as BT1, but uses Broyden's second method, also known as the bad method.", &
"Same as BT1_EXPLICIT, but using Broyden's second method.", &
"Same as BT1, but uses backtracking line search for optimizing the step size "// &
"(see optimizer NEWTON_LS).", &
"Same as BT1_EXPLICIT, but uses backtracking line search for optimizing the step size.", &
"Same as BT2, but uses backtracking line search for optimizing the step size.", &
"Same as BT2_EXPLICIT, but uses backtracking line search for optimizing the step size."), &
enum_i_vals=(/broyden_type_1, broyden_type_1_explicit, broyden_type_2, &
broyden_type_2_explicit, broyden_type_1_ls, broyden_type_1_explicit_ls, &
broyden_type_2_ls, broyden_type_2_explicit_ls/))
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="JACOBIAN_TYPE", &
description="Finite difference method used to calculate the inverse Jacobian "// &
"needed by some optimizers. Compatible only with CDFT constraints.", &
usage="JACOBIAN_TYPE FD1", &
default_i_val=jacobian_fd1, &
enum_c_vals=s2a("FD1", "FD1_BACKWARD", "FD2", "FD2_BACKWARD", "FD1_CENTRAL"), &
enum_desc=s2a("First order forward difference (one extra energy evaluation per constraint).", &
"First order backward difference (one extra energy evaluation per constraint).", &
"Second order forward difference (two extra energy evaluations per constraint).", &
"Second order backward difference (two extra energy evaluations per constraint).", &
"First order central difference (two extra energy evaluations per constraint)."), &
enum_i_vals=(/jacobian_fd1, jacobian_fd1_backward, jacobian_fd2, &
jacobian_fd2_backward, jacobian_fd1_central/))
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="JACOBIAN_STEP", &
description="Step size to use in the calculation of the inverse Jacobian with finite differences. "// &
"Expects one value for all constraints, or one value per constraint.", &
usage="JACOBIAN_STEP 5.0E-3 ", n_var=-1, default_r_val=5.0E-3_dp)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="JACOBIAN_FREQ", &
description="Defines parameters that control how often the explicit Jacobian is built, "// &
"which is needed by some optimizers. Expects two values. The first value "// &
"determines how many consecutive CDFT SCF iterations should skip a rebuild,"// &
" whereas the latter how many MD steps. The values can be zero (meaning never "// &
" rebuild) or positive. Both values cannot be zero.", &
usage="JACOBIAN_FREQ 1 1", n_var=2, &
default_i_vals=(/1, 1/), type_of_var=integer_t)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="JACOBIAN_RESTART", &
description="Restart the inverse Jacobian using the vector defined with keyword JACOBIAN_VECTOR.", &
usage="JACOBIAN_RESTART TRUE", &
default_l_val=.FALSE., lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="JACOBIAN_VECTOR", &
description="Defines the inverse Jacobian matrix. Useful for restarting calculations. "// &
"Expects n^2 values where n is the total number of constraints. "// &
"The matrix should be given in row major order.", &
usage="JACOBIAN_VECTOR 1.0 0.0", n_var=-1, type_of_var=real_t)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="MAX_LS", &
description="The maximum number of backtracking line search steps to perform.", &
usage="MAX_LS 5", default_i_val=5)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="FACTOR_LS", &
description="Control parameter for backtracking line search. The step size is reduced by "// &
"this factor on every line search iteration. Value must be between 0 and 1 (exclusive).", &
usage="FACTOR_LS 0.5", default_r_val=0.5_dp)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
CALL keyword_create(keyword, name="CONTINUE_LS", &
description="Continue backtracking line search until MAX_LS steps are reached or the "// &
"norm of the CDFT gradient no longer decreases. Default (false) behavior exits the "// &
"line search procedure on the first step that the gradient decreases.", &
usage="CONTINUE_LS TRUE", &
default_l_val=.FALSE., lone_keyword_l_val=.TRUE.)
CALL section_add_keyword(section, keyword)
CALL keyword_release(keyword)
END SUBROUTINE create_cdft_opt_section
END MODULE input_cp2k_dft
|