Skip to content

Commit 7cc357b

Browse files
author
abacus_fixer
committed
update format
1 parent da6f23e commit 7cc357b

5 files changed

Lines changed: 33 additions & 27 deletions

File tree

source/source_cell/module_symmetry/symmetry.h

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -160,8 +160,12 @@ class Symmetry : public Symmetry_Basic
160160
*
161161
* @param rhogtot charge density in reciprocal space
162162
* @param ixyz2ipw index mapping from real to reciprocal space
163-
* @param nx, ny, nz grid dimensions
164-
* @param fftnx, fftny, fftnz FFT grid dimensions
163+
* @param nx grid dimension in x
164+
* @param ny grid dimension in y
165+
* @param nz grid dimension in z
166+
* @param fftnx FFT grid dimension in x
167+
* @param fftny FFT grid dimension in y
168+
* @param fftnz FFT grid dimension in z
165169
* @param gamma_only_pw whether to use gamma-only PW
166170
*/
167171
void rhog_symmetry(std::complex<double> *rhogtot, int* ixyz2ipw, const int &nx,

source/source_cell/module_symmetry/symmetry_basic.h

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,9 @@ class Symmetry_Basic
118118
*
119119
* @param gmatrix rotation matrix
120120
* @param gtrans translation vector
121-
* @param i,j,k indices
121+
* @param i index in x
122+
* @param j index in y
123+
* @param k index in z
122124
*/
123125
void rotate(
124126
ModuleBase::Matrix3 &gmatrix, ModuleBase::Vector3<double> &gtrans,

source/source_cell/parallel_kpoints.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ class Parallel_Kpoints
9898
std::vector<ModuleBase::Vector3<double>>& vec_global) const;
9999
#endif
100100

101-
///<K-point information>
101+
/// K-point information
102102
std::vector<int> nks_pool; ///< number of k-points in each pool (without spin)
103103
std::vector<int> startk_pool; ///< the first k-point in each pool (without spin)
104104
std::vector<int> whichpool; ///< whichpool[k]: the pool which k belongs to, dim: nkstot_np

source/source_cell/pseudo.h

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ class pseudo
2020
pseudo();
2121
~pseudo();
2222

23-
///<PP_HEADER>
23+
/// PP_HEADER
2424
bool has_so = false; ///< if .true. includes spin-orbit
2525
int nv = 0; ///< UPF file version number
2626
std::string psd; ///< Element label
@@ -47,37 +47,37 @@ class pseudo
4747
std::vector<double> jchi = {}; ///< jchi(nwfc), added by zhengdy-soc
4848
std::vector<int> nn = {};
4949

50-
///<PP_LOCAL> Local pseudopotentials
50+
/// PP_LOCAL - Local pseudopotentials
5151
std::vector<double> vloc_at = {}; ///< [mesh], local potential( = pseudopot_upf.vloc )
5252

53-
///<PP_MESH>
53+
/// PP_MESH
5454
std::vector<double> r = {}; ///< radial logaritmic mesh, r[0:mesh-1]
5555
std::vector<double> rab = {}; ///< derivative of the radial mesh, rab[0:mesh-1]
5656

57-
///<PP_NLCC>
57+
/// PP_NLCC
5858
std::vector<double> rho_atc = {}; ///< radial core charge density, rho_atc[0:mesh-1]
5959

60-
///<PP_RHOATOM>
60+
/// PP_RHOATOM
6161
std::vector<double> rho_at = {}; ///< radial atomic charge density, rho_at[0:mesh-1]
6262

63-
///<PP_PSWFC>
63+
/// PP_PSWFC
6464
ModuleBase::matrix chi; ///< radial atomic orbitals, chi(nchi, mesh)
6565

66-
///<PP_OTHER>
66+
/// PP_OTHER
6767
int msh = 0; ///< number of points up to rcut
6868
double rcut = 0.0; ///< cut-off radius
6969

70-
///<PP_BETA>
70+
/// PP_BETA
7171
std::vector<int> lll = {}; ///< lll(nbeta), angular momentum of the beta function
7272

73-
///<PP_DIJ>
73+
/// PP_DIJ
7474
ModuleBase::matrix dion; ///< dion(nbeta,nbeta)
7575
ModuleBase::matrix betar; ///< (nbeta, mesh), radial beta_{mu} functions
7676

77-
///<PP_OTHER>
77+
/// PP_OTHER
7878
int nh = 0; ///< number of beta functions per atomic type
7979

80-
///<USPP> Ultrasoft pseudopotential
80+
/// USPP - Ultrasoft pseudopotential
8181
ModuleBase::realArray qfuncl; ///< qfuncl(2*lmax+1,nbeta*(nbeta+1)/2,mesh) Q_{mu,nu}(|r|) function for |r|> r_L
8282
ModuleBase::matrix qqq; ///< qqq(nbeta,nbeta) q_{mu,nu}
8383
/**

source/source_cell/read_pp.h

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -20,15 +20,15 @@
2020
class Pseudopot_upf
2121
{
2222
public:
23-
///<PP_INFO>
24-
///<PP_HEADER>
25-
///<PP_MESH>
26-
///<PP_NLCC>
27-
///<PP_LOCAL>
28-
///<PP_NONLOCAL>
29-
///<PP_PSWFC>
30-
///<PP_PSRHOATOM>
31-
///<addinfo>
23+
/// PP_INFO
24+
/// PP_HEADER
25+
/// PP_MESH
26+
/// PP_NLCC
27+
/// PP_LOCAL
28+
/// PP_NONLOCAL
29+
/// PP_PSWFC
30+
/// PP_PSRHOATOM
31+
/// addinfo
3232

3333
/**
3434
* @brief Default constructor.
@@ -52,7 +52,7 @@ class Pseudopot_upf
5252
bool q_with_l; ///< if .true. qfunc is pseudized in
5353
int nqf; ///< number of Q coefficients
5454

55-
///<Dynamic arrays>
55+
/// Dynamic arrays
5656
bool coulomb_potential = false; ///< coulomb potential : z/r
5757
ModuleBase::matrix chi; ///< chi(nwfc,mesh) atomic wavefcts
5858
std::vector<int> kbeta = {}; ///< kbeta(nbeta):number of mesh points for projector i (must be .le. mesh )
@@ -69,7 +69,7 @@ class Pseudopot_upf
6969

7070
int nd; ///< nl_5 // Number of nonzero Dij
7171

72-
///<VWR format>
72+
/// VWR format
7373
int spd_loc; ///< s,p,d local component
7474
int iTB_s; ///< TB s orbital index
7575
int iTB_p; ///< TB p orbital index
@@ -263,7 +263,7 @@ class Pseudopot_upf
263263
*/
264264
void read_pseudo_so(std::ifstream& ifs, Atom_pseudo& pp);
265265

266-
///<UPF201 format>
266+
/// UPF201 format
267267
/**
268268
* @brief Read UPF201 format pseudopotential.
269269
*

0 commit comments

Comments
 (0)