forked from deepmodeling/abacus-develop
-
Notifications
You must be signed in to change notification settings - Fork 2
Expand file tree
/
Copy pathpy_esolver_lcao.cpp
More file actions
1011 lines (870 loc) · 30.7 KB
/
py_esolver_lcao.cpp
File metadata and controls
1011 lines (870 loc) · 30.7 KB
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
/**
* @file py_esolver_lcao.cpp
* @brief Python bindings for ESolver_KS_LCAO
*
* This file provides pybind11 bindings for the LCAO ESolver,
* enabling Python-controlled SCF workflows with breakpoint support.
*/
#include <pybind11/pybind11.h>
#include <pybind11/numpy.h>
#include <pybind11/stl.h>
#include <pybind11/complex.h>
#include <pybind11/functional.h>
#include "py_esolver_lcao.hpp"
// ABACUS headers for actual implementation
#include "source_estate/module_charge/charge.h"
#include "source_estate/fp_energy.h"
#include "source_estate/elecstate.h"
#include "source_estate/module_dm/density_matrix.h"
#include "source_lcao/hamilt_lcao.h"
#include "source_lcao/module_hcontainer/hcontainer.h"
#include "source_basis/module_ao/parallel_orbitals.h"
#include <complex>
#include <stdexcept>
#include <iostream>
namespace py = pybind11;
using namespace pybind11::literals;
namespace py_esolver
{
// ============================================================================
// PyChargeAccessor Implementation
// ============================================================================
void PyChargeAccessor::set_from_charge(const Charge* chr)
{
if (chr == nullptr)
{
chr_ptr_ = nullptr;
rho_ptr_ = nullptr;
nspin_ = 0;
nrxx_ = 0;
ngmc_ = 0;
return;
}
chr_ptr_ = chr;
rho_ptr_ = nullptr; // Use chr_ptr_ instead
nspin_ = chr->nspin;
nrxx_ = chr->nrxx;
ngmc_ = chr->ngmc;
}
void PyChargeAccessor::set_data(const double* rho_ptr, int nspin, int nrxx)
{
chr_ptr_ = nullptr; // Not using Charge object
rho_ptr_ = rho_ptr;
nspin_ = nspin;
nrxx_ = nrxx;
ngmc_ = 0;
}
py::array_t<double> PyChargeAccessor::get_rho() const
{
if (!is_valid())
{
throw std::runtime_error("Charge data not available. Run SCF first.");
}
// Create numpy array with shape (nspin, nrxx)
std::vector<ssize_t> shape = {static_cast<ssize_t>(nspin_), static_cast<ssize_t>(nrxx_)};
auto result = py::array_t<double>(shape);
auto buf = result.request();
double* ptr = static_cast<double*>(buf.ptr);
// Copy data from either chr_ptr_ or rho_ptr_
if (chr_ptr_ != nullptr && chr_ptr_->rho != nullptr)
{
// Copy from Charge object (rho is double** with shape [nspin][nrxx])
for (int is = 0; is < nspin_; ++is)
{
if (chr_ptr_->rho[is] != nullptr)
{
std::copy(chr_ptr_->rho[is], chr_ptr_->rho[is] + nrxx_, ptr + is * nrxx_);
}
}
}
else if (rho_ptr_ != nullptr)
{
// Copy from flat array (legacy mode)
std::copy(rho_ptr_, rho_ptr_ + nspin_ * nrxx_, ptr);
}
else
{
throw std::runtime_error("No valid charge data source.");
}
return result;
}
py::array_t<std::complex<double>> PyChargeAccessor::get_rhog() const
{
if (chr_ptr_ == nullptr || chr_ptr_->rhog == nullptr)
{
throw std::runtime_error("Reciprocal-space charge density not available.");
}
// Create numpy array with shape (nspin, ngmc)
std::vector<ssize_t> shape = {static_cast<ssize_t>(nspin_), static_cast<ssize_t>(ngmc_)};
auto result = py::array_t<std::complex<double>>(shape);
auto buf = result.request();
std::complex<double>* ptr = static_cast<std::complex<double>*>(buf.ptr);
// Copy from Charge object (rhog is complex** with shape [nspin][ngmc])
for (int is = 0; is < nspin_; ++is)
{
if (chr_ptr_->rhog[is] != nullptr)
{
std::copy(chr_ptr_->rhog[is], chr_ptr_->rhog[is] + ngmc_, ptr + is * ngmc_);
}
}
return result;
}
py::array_t<double> PyChargeAccessor::get_rho_core() const
{
if (chr_ptr_ == nullptr || chr_ptr_->rho_core == nullptr)
{
throw std::runtime_error("Core charge density not available.");
}
// Create numpy array with shape (nrxx,)
std::vector<ssize_t> shape = {static_cast<ssize_t>(nrxx_)};
auto result = py::array_t<double>(shape);
auto buf = result.request();
double* ptr = static_cast<double*>(buf.ptr);
std::copy(chr_ptr_->rho_core, chr_ptr_->rho_core + nrxx_, ptr);
return result;
}
// ============================================================================
// PyEnergyAccessor Implementation
// ============================================================================
void PyEnergyAccessor::set_from_fenergy(const elecstate::fenergy* f_en)
{
if (f_en == nullptr)
{
etot_ = 0.0;
eband_ = 0.0;
hartree_energy_ = 0.0;
etxc_ = 0.0;
ewald_energy_ = 0.0;
demet_ = 0.0;
exx_ = 0.0;
evdw_ = 0.0;
return;
}
etot_ = f_en->etot;
eband_ = f_en->eband;
hartree_energy_ = f_en->hartree_energy;
etxc_ = f_en->etxc;
ewald_energy_ = f_en->ewald_energy;
demet_ = f_en->demet;
exx_ = f_en->exx;
evdw_ = f_en->evdw;
}
void PyEnergyAccessor::set_energies(double etot, double eband, double hartree,
double etxc, double ewald, double demet,
double exx, double evdw)
{
etot_ = etot;
eband_ = eband;
hartree_energy_ = hartree;
etxc_ = etxc;
ewald_energy_ = ewald;
demet_ = demet;
exx_ = exx;
evdw_ = evdw;
}
py::dict PyEnergyAccessor::get_all_energies() const
{
py::dict result;
result["etot"] = etot_;
result["eband"] = eband_;
result["hartree_energy"] = hartree_energy_;
result["etxc"] = etxc_;
result["ewald_energy"] = ewald_energy_;
result["demet"] = demet_;
result["exx"] = exx_;
result["evdw"] = evdw_;
return result;
}
// ============================================================================
// PyHamiltonianAccessor Implementation (template)
// ============================================================================
template <typename TK, typename TR>
void PyHamiltonianAccessor<TK, TR>::set_from_hamilt(hamilt::HamiltLCAO<TK, TR>* hamilt_lcao, int nks, const Parallel_Orbitals* pv)
{
hamilt_ptr_ = hamilt_lcao;
pv_ = pv;
nks_ = nks;
if (hamilt_lcao == nullptr)
{
nbasis_ = 0;
nloc_ = 0;
nrow_ = 0;
ncol_ = 0;
return;
}
// Get dimensions from Parallel_Orbitals if available
if (pv != nullptr)
{
nrow_ = pv->get_row_size();
ncol_ = pv->get_col_size();
nloc_ = nrow_ * ncol_;
nbasis_ = pv->get_global_row_size();
}
// Initialize pointer arrays for compatibility mode
hk_ptrs_.resize(nks, nullptr);
sk_ptrs_.resize(nks, nullptr);
matrix_dims_.resize(nks, {nrow_, ncol_});
}
template <typename TK, typename TR>
void PyHamiltonianAccessor<TK, TR>::set_dimensions(int nbasis, int nks)
{
nbasis_ = nbasis;
nks_ = nks;
hk_ptrs_.resize(nks, nullptr);
sk_ptrs_.resize(nks, nullptr);
matrix_dims_.resize(nks, {0, 0});
}
template <typename TK, typename TR>
void PyHamiltonianAccessor<TK, TR>::set_Hk_data(int ik, const TK* data, int nrow, int ncol)
{
if (ik >= 0 && ik < nks_)
{
hk_ptrs_[ik] = data;
matrix_dims_[ik] = {nrow, ncol};
}
}
template <typename TK, typename TR>
void PyHamiltonianAccessor<TK, TR>::set_Sk_data(int ik, const TK* data, int nrow, int ncol)
{
if (ik >= 0 && ik < nks_)
{
sk_ptrs_[ik] = data;
matrix_dims_[ik] = {nrow, ncol};
}
}
template <typename TK, typename TR>
py::array_t<TK> PyHamiltonianAccessor<TK, TR>::get_Hk(int ik) const
{
if (!is_valid() || ik < 0 || ik >= nks_)
{
throw std::runtime_error("Invalid k-point index or Hamiltonian not available.");
}
if (hk_ptrs_[ik] == nullptr)
{
throw std::runtime_error("H(k) data not set for this k-point.");
}
auto [nrow, ncol] = matrix_dims_[ik];
std::vector<ssize_t> shape = {nrow, ncol};
auto result = py::array_t<TK>(shape);
auto buf = result.request();
TK* ptr = static_cast<TK*>(buf.ptr);
std::copy(hk_ptrs_[ik], hk_ptrs_[ik] + nrow * ncol, ptr);
return result;
}
template <typename TK, typename TR>
py::array_t<TK> PyHamiltonianAccessor<TK, TR>::get_Sk(int ik) const
{
if (!is_valid() || ik < 0 || ik >= nks_)
{
throw std::runtime_error("Invalid k-point index or overlap matrix not available.");
}
if (sk_ptrs_[ik] == nullptr)
{
throw std::runtime_error("S(k) data not set for this k-point.");
}
auto [nrow, ncol] = matrix_dims_[ik];
std::vector<ssize_t> shape = {nrow, ncol};
auto result = py::array_t<TK>(shape);
auto buf = result.request();
TK* ptr = static_cast<TK*>(buf.ptr);
std::copy(sk_ptrs_[ik], sk_ptrs_[ik] + nrow * ncol, ptr);
return result;
}
template <typename TK, typename TR>
py::dict PyHamiltonianAccessor<TK, TR>::get_HR() const
{
// Placeholder: will be implemented when full ABACUS integration is available
py::dict result;
return result;
}
template <typename TK, typename TR>
py::dict PyHamiltonianAccessor<TK, TR>::get_SR() const
{
// Placeholder: will be implemented when full ABACUS integration is available
py::dict result;
return result;
}
// Explicit template instantiations
template class PyHamiltonianAccessor<double, double>;
template class PyHamiltonianAccessor<std::complex<double>, double>;
// ============================================================================
// PyDensityMatrixAccessor Implementation (template)
// ============================================================================
template <typename TK, typename TR>
void PyDensityMatrixAccessor<TK, TR>::set_from_dm(elecstate::DensityMatrix<TK, TR>* dm)
{
dm_ptr_ = dm;
if (dm == nullptr)
{
nks_ = 0;
nrow_ = 0;
ncol_ = 0;
return;
}
nks_ = dm->get_DMK_nks();
nrow_ = dm->get_DMK_nrow();
ncol_ = dm->get_DMK_ncol();
// Initialize pointer arrays for compatibility mode
dmk_ptrs_.resize(nks_, nullptr);
}
template <typename TK, typename TR>
void PyDensityMatrixAccessor<TK, TR>::set_dimensions(int nks, int nrow, int ncol)
{
nks_ = nks;
nrow_ = nrow;
ncol_ = ncol;
dmk_ptrs_.resize(nks, nullptr);
}
template <typename TK, typename TR>
void PyDensityMatrixAccessor<TK, TR>::set_DMK_data(int ik, const TK* data)
{
if (ik >= 0 && ik < nks_)
{
dmk_ptrs_[ik] = data;
}
}
template <typename TK, typename TR>
py::array_t<TK> PyDensityMatrixAccessor<TK, TR>::get_DMK(int ik) const
{
if (!is_valid() || ik < 0 || ik >= nks_)
{
throw std::runtime_error("Invalid k-point index or density matrix not available.");
}
if (dmk_ptrs_[ik] == nullptr)
{
throw std::runtime_error("DM(k) data not set for this k-point.");
}
std::vector<ssize_t> shape = {static_cast<ssize_t>(nrow_), static_cast<ssize_t>(ncol_)};
auto result = py::array_t<TK>(shape);
auto buf = result.request();
TK* ptr = static_cast<TK*>(buf.ptr);
std::copy(dmk_ptrs_[ik], dmk_ptrs_[ik] + nrow_ * ncol_, ptr);
return result;
}
template <typename TK, typename TR>
std::vector<py::array_t<TK>> PyDensityMatrixAccessor<TK, TR>::get_DMK_all() const
{
std::vector<py::array_t<TK>> result;
for (int ik = 0; ik < nks_; ++ik)
{
result.push_back(get_DMK(ik));
}
return result;
}
template <typename TK, typename TR>
py::dict PyDensityMatrixAccessor<TK, TR>::get_DMR() const
{
// Placeholder: will be implemented when full ABACUS integration is available
py::dict result;
return result;
}
// Explicit template instantiations
template class PyDensityMatrixAccessor<double, double>;
template class PyDensityMatrixAccessor<std::complex<double>, double>;
// ============================================================================
// PyESolverLCAO Implementation (template)
// ============================================================================
template <typename TK, typename TR>
PyESolverLCAO<TK, TR>::PyESolverLCAO()
{
// Constructor - initialization deferred to initialize()
}
template <typename TK, typename TR>
PyESolverLCAO<TK, TR>::~PyESolverLCAO()
{
// Destructor - cleanup will be implemented in Phase 3
}
template <typename TK, typename TR>
void PyESolverLCAO<TK, TR>::initialize(const std::string& input_dir, int mpi_comm_handle)
{
// Placeholder: will be implemented in Phase 3
// This will:
// 1. Convert mpi_comm_handle to MPI_Comm via MPI_Comm_f2c()
// (if mpi_comm_handle >= 0, otherwise use MPI_COMM_WORLD)
// 2. Use the resulting communicator for MPI_Comm_size/rank
// 3. Pass base_comm to Parallel_Global::init_pools(), split_diag_world(), split_grid_world()
// 4. Read INPUT file from input_dir
// 5. Initialize UnitCell
// 6. Create ESolver_KS_LCAO instance
initialized_ = true;
std::cout << "[PyESolverLCAO] Initialized with input directory: " << input_dir
<< ", mpi_comm_handle: " << mpi_comm_handle << std::endl;
}
template <typename TK, typename TR>
void PyESolverLCAO<TK, TR>::before_all_runners()
{
if (!initialized_)
{
throw std::runtime_error("ESolver not initialized. Call initialize() first.");
}
// Placeholder: will call esolver_->before_all_runners() in Phase 3
std::cout << "[PyESolverLCAO] before_all_runners called" << std::endl;
}
template <typename TK, typename TR>
void PyESolverLCAO<TK, TR>::before_scf(int istep)
{
if (!initialized_)
{
throw std::runtime_error("ESolver not initialized. Call initialize() first.");
}
istep_ = istep;
scf_started_ = true;
conv_esolver_ = false;
niter_ = 0;
// Placeholder: will call esolver_->before_scf() in Phase 3
std::cout << "[PyESolverLCAO] before_scf called for step " << istep << std::endl;
}
template <typename TK, typename TR>
void PyESolverLCAO<TK, TR>::run_scf_iteration(int iter)
{
if (!scf_started_)
{
throw std::runtime_error("SCF not started. Call before_scf() first.");
}
niter_ = iter;
// Placeholder: will implement actual SCF iteration in Phase 3
// 1. iter_init()
// 2. hamilt2rho()
// 3. iter_finish()
std::cout << "[PyESolverLCAO] SCF iteration " << iter << std::endl;
}
template <typename TK, typename TR>
void PyESolverLCAO<TK, TR>::run_scf(int max_iter)
{
before_scf(istep_);
for (int iter = 1; iter <= max_iter; ++iter)
{
run_scf_iteration(iter);
if (conv_esolver_)
{
break;
}
}
}
template <typename TK, typename TR>
void PyESolverLCAO<TK, TR>::after_scf(int istep)
{
if (!scf_started_)
{
throw std::runtime_error("SCF not started. Call before_scf() first.");
}
// Placeholder: will call esolver_->after_scf() in Phase 3
std::cout << "[PyESolverLCAO] after_scf called for step " << istep << std::endl;
scf_started_ = false;
}
template <typename TK, typename TR>
PyChargeAccessor PyESolverLCAO<TK, TR>::get_charge() const
{
PyChargeAccessor accessor;
// Note: esolver_ connection will be implemented when full ABACUS integration is available
// For now, return empty accessor
return accessor;
}
template <typename TK, typename TR>
PyEnergyAccessor PyESolverLCAO<TK, TR>::get_energy() const
{
PyEnergyAccessor accessor;
// Note: esolver_ connection will be implemented when full ABACUS integration is available
// For now, return empty accessor
return accessor;
}
template <typename TK, typename TR>
PyHamiltonianAccessor<TK, TR> PyESolverLCAO<TK, TR>::get_hamiltonian() const
{
PyHamiltonianAccessor<TK, TR> accessor;
// Note: esolver_ connection will be implemented when full ABACUS integration is available
// For now, return empty accessor
return accessor;
}
template <typename TK, typename TR>
PyDensityMatrixAccessor<TK, TR> PyESolverLCAO<TK, TR>::get_density_matrix() const
{
PyDensityMatrixAccessor<TK, TR> accessor;
// Note: esolver_ connection will be implemented when full ABACUS integration is available
// For now, return empty accessor
return accessor;
}
template <typename TK, typename TR>
py::array_t<TK> PyESolverLCAO<TK, TR>::get_psi(int ik) const
{
// Note: Will return wave function coefficients when full ABACUS integration is available
return py::array_t<TK>();
}
template <typename TK, typename TR>
py::array_t<double> PyESolverLCAO<TK, TR>::get_eigenvalues(int ik) const
{
// Note: Will return eigenvalues when full ABACUS integration is available
return py::array_t<double>();
}
template <typename TK, typename TR>
py::array_t<double> PyESolverLCAO<TK, TR>::get_occupations(int ik) const
{
// Note: Will return occupation numbers when full ABACUS integration is available
return py::array_t<double>();
}
template <typename TK, typename TR>
int PyESolverLCAO<TK, TR>::get_nks() const
{
// Note: Will return actual nks when full ABACUS integration is available
return 0;
}
template <typename TK, typename TR>
py::array_t<double> PyESolverLCAO<TK, TR>::get_kvec_d(int ik) const
{
std::vector<ssize_t> shape = {3};
auto result = py::array_t<double>(shape);
auto buf = result.request();
double* ptr = static_cast<double*>(buf.ptr);
ptr[0] = ptr[1] = ptr[2] = 0.0;
return result;
}
template <typename TK, typename TR>
py::array_t<double> PyESolverLCAO<TK, TR>::get_wk() const
{
// Note: Will return k-point weights when full ABACUS integration is available
return py::array_t<double>();
}
template <typename TK, typename TR>
int PyESolverLCAO<TK, TR>::get_nbasis() const
{
// Note: Will return actual nbasis when full ABACUS integration is available
return 0;
}
template <typename TK, typename TR>
int PyESolverLCAO<TK, TR>::get_nbands() const
{
// Note: Will return actual nbands when full ABACUS integration is available
return 0;
}
template <typename TK, typename TR>
int PyESolverLCAO<TK, TR>::get_nspin() const
{
// Note: Will return actual nspin when full ABACUS integration is available
return 1;
}
template <typename TK, typename TR>
int PyESolverLCAO<TK, TR>::get_nat() const
{
// Note: Will return actual nat when full ABACUS integration is available
return 0;
}
// Explicit template instantiations
template class PyESolverLCAO<double, double>;
template class PyESolverLCAO<std::complex<double>, double>;
} // namespace py_esolver
// ============================================================================
// Pybind11 Module Definition
// ============================================================================
void bind_charge_accessor(py::module& m)
{
py::class_<py_esolver::PyChargeAccessor>(m, "ChargeAccessor",
R"pbdoc(
Accessor for charge density data.
Provides access to real-space charge density (rho) and related quantities.
)pbdoc")
.def(py::init<>())
.def("get_rho", &py_esolver::PyChargeAccessor::get_rho,
R"pbdoc(
Get real-space charge density as numpy array.
Returns
-------
numpy.ndarray
Charge density with shape (nspin, nrxx)
)pbdoc")
.def("get_rhog", &py_esolver::PyChargeAccessor::get_rhog,
R"pbdoc(
Get reciprocal-space charge density as numpy array.
Returns
-------
numpy.ndarray
Charge density in G-space with shape (nspin, ngmc)
)pbdoc")
.def("get_rho_core", &py_esolver::PyChargeAccessor::get_rho_core,
R"pbdoc(
Get core charge density as numpy array.
Returns
-------
numpy.ndarray
Core charge density with shape (nrxx,)
)pbdoc")
.def_property_readonly("nspin", &py_esolver::PyChargeAccessor::get_nspin,
"Number of spin channels")
.def_property_readonly("nrxx", &py_esolver::PyChargeAccessor::get_nrxx,
"Number of real-space grid points")
.def_property_readonly("ngmc", &py_esolver::PyChargeAccessor::get_ngmc,
"Number of G-vectors for charge density")
.def("is_valid", &py_esolver::PyChargeAccessor::is_valid,
"Check if charge data is available");
}
void bind_energy_accessor(py::module& m)
{
py::class_<py_esolver::PyEnergyAccessor>(m, "EnergyAccessor",
R"pbdoc(
Accessor for energy data.
Provides access to various energy components from the calculation.
All energies are in Rydberg units.
)pbdoc")
.def(py::init<>())
.def_property_readonly("etot", &py_esolver::PyEnergyAccessor::get_etot,
"Total energy (Ry)")
.def_property_readonly("eband", &py_esolver::PyEnergyAccessor::get_eband,
"Band energy (Ry)")
.def_property_readonly("hartree_energy", &py_esolver::PyEnergyAccessor::get_hartree_energy,
"Hartree energy (Ry)")
.def_property_readonly("etxc", &py_esolver::PyEnergyAccessor::get_etxc,
"Exchange-correlation energy (Ry)")
.def_property_readonly("ewald_energy", &py_esolver::PyEnergyAccessor::get_ewald_energy,
"Ewald energy (Ry)")
.def_property_readonly("demet", &py_esolver::PyEnergyAccessor::get_demet,
"-TS term for metals (Ry)")
.def_property_readonly("exx", &py_esolver::PyEnergyAccessor::get_exx,
"Exact exchange energy (Ry)")
.def_property_readonly("evdw", &py_esolver::PyEnergyAccessor::get_evdw,
"van der Waals energy (Ry)")
.def("get_all_energies", &py_esolver::PyEnergyAccessor::get_all_energies,
"Get all energies as a dictionary");
}
template <typename TK>
void bind_hamiltonian_accessor(py::module& m, const std::string& suffix)
{
using HamiltAccessor = py_esolver::PyHamiltonianAccessor<TK>;
std::string class_name = "HamiltonianAccessor" + suffix;
py::class_<HamiltAccessor>(m, class_name.c_str(),
R"pbdoc(
Accessor for Hamiltonian matrix data.
Provides access to H(k), S(k), H(R), and S(R) matrices.
)pbdoc")
.def(py::init<>())
.def_property_readonly("nbasis", &HamiltAccessor::get_nbasis,
"Number of basis functions")
.def_property_readonly("nks", &HamiltAccessor::get_nks,
"Number of k-points")
.def("get_Hk", &HamiltAccessor::get_Hk,
R"pbdoc(
Get H(k) matrix for specific k-point.
Parameters
----------
ik : int
K-point index
Returns
-------
numpy.ndarray
Hamiltonian matrix at k-point ik
)pbdoc", "ik"_a)
.def("get_Sk", &HamiltAccessor::get_Sk,
R"pbdoc(
Get S(k) overlap matrix for specific k-point.
Parameters
----------
ik : int
K-point index
Returns
-------
numpy.ndarray
Overlap matrix at k-point ik
)pbdoc", "ik"_a)
.def("get_HR", &HamiltAccessor::get_HR,
"Get H(R) in sparse format")
.def("get_SR", &HamiltAccessor::get_SR,
"Get S(R) in sparse format")
.def("is_valid", &HamiltAccessor::is_valid,
"Check if Hamiltonian data is available");
}
template <typename TK>
void bind_density_matrix_accessor(py::module& m, const std::string& suffix)
{
using DMAccessor = py_esolver::PyDensityMatrixAccessor<TK>;
std::string class_name = "DensityMatrixAccessor" + suffix;
py::class_<DMAccessor>(m, class_name.c_str(),
R"pbdoc(
Accessor for density matrix data.
Provides access to DM(k) and DM(R) matrices.
)pbdoc")
.def(py::init<>())
.def_property_readonly("nks", &DMAccessor::get_nks,
"Number of k-points")
.def_property_readonly("nrow", &DMAccessor::get_nrow,
"Number of rows in density matrix")
.def_property_readonly("ncol", &DMAccessor::get_ncol,
"Number of columns in density matrix")
.def("get_DMK", &DMAccessor::get_DMK,
R"pbdoc(
Get DM(k) for specific k-point.
Parameters
----------
ik : int
K-point index
Returns
-------
numpy.ndarray
Density matrix at k-point ik
)pbdoc", "ik"_a)
.def("get_DMK_all", &DMAccessor::get_DMK_all,
"Get all DM(k) matrices as a list")
.def("get_DMR", &DMAccessor::get_DMR,
"Get DM(R) in sparse format")
.def("is_valid", &DMAccessor::is_valid,
"Check if density matrix data is available");
}
template <typename TK, typename TR>
void bind_esolver_lcao(py::module& m, const std::string& suffix)
{
using ESolver = py_esolver::PyESolverLCAO<TK, TR>;
std::string class_name = "ESolverLCAO" + suffix;
py::class_<ESolver>(m, class_name.c_str(),
R"pbdoc(
Python wrapper for ESolver_KS_LCAO.
This class provides a Python interface for LCAO calculations
with support for breakpoints and state inspection during SCF.
Example
-------
>>> esolver = ESolverLCAO_gamma()
>>> esolver.initialize("./")
>>> esolver.before_all_runners()
>>> esolver.before_scf(0)
>>> for iter in range(1, 101):
... esolver.run_scf_iteration(iter)
... energy = esolver.get_energy()
... print(f"Iter {iter}: E = {energy.etot}")
... if esolver.is_converged():
... break
>>> # Breakpoint before after_scf - inspect state here
>>> charge = esolver.get_charge()
>>> hamiltonian = esolver.get_hamiltonian()
>>> esolver.after_scf(0)
)pbdoc")
.def(py::init<>())
// Initialization
.def("initialize", &ESolver::initialize,
R"pbdoc(
Initialize ESolver from INPUT file.
Parameters
----------
input_dir : str
Directory containing INPUT, STRU, and other input files
mpi_comm_handle : int, optional
Fortran MPI communicator handle from mpi4py comm.py2f().
Use -1 (default) to use MPI_COMM_WORLD.
)pbdoc", "input_dir"_a, "mpi_comm_handle"_a = -1)
.def("before_all_runners", &ESolver::before_all_runners,
"Initialize calculation environment")
// SCF Control
.def("before_scf", &ESolver::before_scf,
R"pbdoc(
Prepare for SCF calculation.
Parameters
----------
istep : int, optional
Ion step index (default: 0)
)pbdoc", "istep"_a = 0)
.def("run_scf_iteration", &ESolver::run_scf_iteration,
R"pbdoc(
Run a single SCF iteration.
Parameters
----------
iter : int
Iteration number (1-based)
)pbdoc", "iter"_a)
.def("run_scf", &ESolver::run_scf,
R"pbdoc(
Run complete SCF loop.
Parameters
----------
max_iter : int, optional
Maximum number of iterations (default: 100)
)pbdoc", "max_iter"_a = 100)
.def("after_scf", &ESolver::after_scf,
R"pbdoc(
Finalize SCF calculation.
Parameters
----------
istep : int, optional
Ion step index (default: 0)
)pbdoc", "istep"_a = 0)
// Status
.def("is_converged", &ESolver::is_converged,
"Check if SCF is converged")
.def_property_readonly("niter", &ESolver::get_niter,
"Current iteration number")
.def_property_readonly("drho", &ESolver::get_drho,
"Charge density difference")
.def_property_readonly("istep", &ESolver::get_istep,
"Current ion step")
// Data Accessors
.def("get_charge", &ESolver::get_charge,
"Get charge density accessor")
.def("get_energy", &ESolver::get_energy,
"Get energy accessor")
.def("get_hamiltonian", &ESolver::get_hamiltonian,
"Get Hamiltonian accessor")
.def("get_density_matrix", &ESolver::get_density_matrix,
"Get density matrix accessor")
// Wave functions
.def("get_psi", &ESolver::get_psi,
"Get wave function coefficients for k-point ik", "ik"_a)
.def("get_eigenvalues", &ESolver::get_eigenvalues,
"Get eigenvalues for k-point ik", "ik"_a)
.def("get_occupations", &ESolver::get_occupations,
"Get occupation numbers for k-point ik", "ik"_a)
// K-points
.def_property_readonly("nks", &ESolver::get_nks,
"Number of k-points")
.def("get_kvec_d", &ESolver::get_kvec_d,
"Get k-vector in direct coordinates", "ik"_a)
.def("get_wk", &ESolver::get_wk,
"Get k-point weights")
// System info
.def_property_readonly("nbasis", &ESolver::get_nbasis,
"Number of basis functions")
.def_property_readonly("nbands", &ESolver::get_nbands,
"Number of bands")
.def_property_readonly("nspin", &ESolver::get_nspin,
"Number of spin channels")
.def_property_readonly("nat", &ESolver::get_nat,
"Number of atoms");
}
PYBIND11_MODULE(_esolver_pack, m)
{
m.doc() = R"pbdoc(
PyABACUS ESolver Module
-----------------------
This module provides Python bindings for ABACUS ESolver_KS_LCAO,
enabling Python-controlled SCF workflows with breakpoint support.
Main Classes
------------
ESolverLCAO_gamma : ESolver for gamma-only calculations
ESolverLCAO_multi_k : ESolver for multi-k calculations
Accessor Classes
----------------
ChargeAccessor : Access charge density data
EnergyAccessor : Access energy components
HamiltonianAccessor_gamma/multi_k : Access Hamiltonian matrices
DensityMatrixAccessor_gamma/multi_k : Access density matrices
Example
-------
>>> from pyabacus.esolver import ESolverLCAO_gamma
>>> esolver = ESolverLCAO_gamma()
>>> esolver.initialize("./")
>>> esolver.before_all_runners()
>>> esolver.before_scf(0)
>>> # Run SCF with breakpoint support
>>> for iter in range(1, 101):
... esolver.run_scf_iteration(iter)
... if esolver.is_converged():
... break
>>> # Inspect state before after_scf
>>> charge = esolver.get_charge()
>>> energy = esolver.get_energy()
>>> esolver.after_scf(0)
)pbdoc";
// Bind accessor classes