Skip to content

Commit 06f8591

Browse files
committedAug 19, 2024
add some documentation
1 parent 451b192 commit 06f8591

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed
 

‎src/qmoperators/one_electron/ZoraOperator.h

+14
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,22 @@ namespace mrchem {
3131

3232
class QMPotential;
3333

34+
/**
35+
* @class ZoraOperator
36+
* @brief Implements chi = kappa - 1 relativistic dampening function. This has to be done in order to
37+
* avoid numerical instabilities in the ZORA operator. Whenever this operator is applied, the + 1 has to be added to chi i
38+
* in order to get the kappa operator. kappa * phi = chi * phi + phi
39+
* This has to be done manually.
40+
*/
3441
class ZoraOperator final : public RankZeroOperator {
3542
public:
43+
/**
44+
* @brief Constructor for the ZoraOperator that contains the chi = kappa - 1 function.
45+
* @param vz The potential used to calculate the kappa function.
46+
* @param c Speed of light.
47+
* @param proj_prec The precision of the MW projection.
48+
* @param inverse If true, the inverse of the chi function is calculated.
49+
*/
3650
ZoraOperator(QMPotential &vz, double c, double proj_prec, bool inverse = false);
3751
};
3852

0 commit comments

Comments
 (0)
Please sign in to comment.