Skip to content

Commit 6e42e67

Browse files
committed
update docs and remove the parameter wannier_card
1 parent 274048d commit 6e42e67

File tree

4 files changed

+16
-8
lines changed

4 files changed

+16
-8
lines changed

docs/advanced/input_files/input-main.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@
3131
- [read\_file\_dir](#read_file_dir)
3232
- [restart\_load](#restart_load)
3333
- [wannier\_card](#wannier_card)
34+
- [spillage\_outdir](#spillage_outdir)
3435
- [Plane Wave](#plane-wave-related-variables)
3536
- [ecutwfc](#ecutwfc)
3637
- [ecutrho](#ecutrho)
@@ -172,6 +173,7 @@
172173
- [out\_wfc_re_im](#out_wfc_re_im)
173174
- [if\_separate\_k](#if_separate_k)
174175
- [out\_elf](#out_elf)
176+
- [out\_spillage](#out_spillage)
175177
- [Density of States](#density-of-states)
176178
- [dos\_edelta\_ev](#dos_edelta_ev)
177179
- [dos\_sigma](#dos_sigma)
@@ -780,6 +782,13 @@ These variables are used to control parameters related to input files.
780782
- **Description**: The name of the input file related to Wannier90.
781783
- **Default**: "none"
782784

785+
### spillage_outdir
786+
787+
- **Type**: String
788+
- **Availability**: Used only for plane wave basis set.
789+
- **Description**: The directory to save the spillage files.
790+
- **Default**: "./"
791+
783792
[back to top](#full-list-of-input-keywords)
784793

785794
## Plane wave related variables
@@ -2026,6 +2035,13 @@ These variables are used to control the output of properties.
20262035
In molecular dynamics calculations, the output frequency is controlled by [out_interval](#out_interval).
20272036
- **Default**: 0 3
20282037

2038+
### out_spillage
2039+
2040+
- **Type**: Integer
2041+
- **Availability**: Only for Kohn-Sham DFT with plane-wave basis.
2042+
- **Description**: This output is only intentively needed by the ABACUS numerical atomic orbital generation workflow. This parameter is used to control whether to output the overlap integrals between truncated spherical Bessel functions (TSBFs) and plane-wave basis expanded wavefunctions (named as `OVERLAP_Q`), and between TSBFs (named as `OVERLAP_Sq`), also their first order derivatives. The output files are named starting with `orb_matrix`. A value of `2` would enable the output.
2043+
- **Default**: 0
2044+
20292045
[back to top](#full-list-of-input-keywords)
20302046

20312047
## Density of states

source/source_io/module_parameter/input_parameter.h

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,6 @@ struct Input_para
5959
std::string orbital_dir = ""; ///< directory of orbital file
6060
std::string read_file_dir = "auto"; ///< directory of files for reading
6161
bool restart_load = false;
62-
std::string wannier_card = "none"; ///< input card for wannier functions.
6362
int mem_saver = 0; ///< 1: save psi when nscf calculation.
6463
int diago_proc = 0; ///< the number of procs used to diag. mohan add 2012-01-13
6564
int nbspline = -1; ///< the order of B-spline basis(>=0) if it is -1 (default)

source/source_io/read_input_item_system.cpp

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -695,12 +695,6 @@ void ReadInput::item_system()
695695
read_sync_bool(input.restart_load);
696696
this->add_item(item);
697697
}
698-
{
699-
Input_Item item("wannier_card");
700-
item.annotation = "input card for wannier functions";
701-
read_sync_string(input.wannier_card);
702-
this->add_item(item);
703-
}
704698
{
705699
Input_Item item("mem_saver");
706700
item.annotation = "Only for nscf calculations. if set to 1, then a "

source/source_io/test/read_input_ptest.cpp

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,6 @@ TEST_F(InputParaTest, ParaRead)
4141
EXPECT_EQ(param.inp.pseudo_dir, "../../PP_ORB/");
4242
EXPECT_EQ(param.inp.orbital_dir, "../../PP_ORB/");
4343
EXPECT_EQ(param.inp.read_file_dir, "OUT.autotest/");
44-
EXPECT_EQ(param.inp.wannier_card, "none");
4544
EXPECT_EQ(param.inp.latname, "none");
4645
EXPECT_EQ(param.inp.calculation, "scf");
4746
EXPECT_EQ(param.inp.esolver_type, "ksdft");

0 commit comments

Comments
 (0)