deepks_basic.h

Go to the documentation of this file.

#ifndef DEEPKS_BASIC_H
#define DEEPKS_BASIC_H
 
#ifdef __MLALGO
#include "deepks_param.h"
#include "source_cell/unitcell.h"
 
#include <torch/script.h>
#include <torch/torch.h>
 
namespace DeePKS_domain
{
//------------------------
// deepks_basic.cpp
//------------------------
 
// The file contains 2 subroutines:
// 1. load_model : loads model for applying V_delta
// 2. cal_gevdm : d(des)/d(pdm), calculated using torch::autograd::grad
// 3. cal_edelta_gedm : calculates E_delta and d(E_delta)/d(pdm)
//       this is the term V(D) that enters the expression V_delta = |alpha>V(D)<alpha|
//       caculated using torch::autograd::grad
// 4. check_gedm : prints gedm for checking
// 5. cal_edelta_gedm_equiv : calculates E_delta and d(E_delta)/d(pdm) for equivariant version
// 6. prepare_atom : prepares atom tensor for output as deepks_out_labels = 2
// 7. prepare_box : prepares box tensor for output as deepks_out_labels = 2
 
// load the trained neural network models
void load_model(const std::string& model_file, torch::jit::script::Module& model);
 
// calculate gevdm
void cal_gevdm(const int nat,
               const DeePKS_Param& deepks_param,
               const std::vector<torch::Tensor>& pdm,
               std::vector<torch::Tensor>& gevdm);
 
void cal_edelta_gedm(const int nat,
                     const DeePKS_Param& deepks_param,
                     const std::vector<torch::Tensor>& descriptor,
                     const std::vector<torch::Tensor>& pdm,
                     torch::jit::script::Module& model_deepks,
                     double** gedm,
                     double& E_delta);
void check_gedm(const DeePKS_Param& deepks_param, double** gedm);
void cal_edelta_gedm_equiv(const int nat,
                           const DeePKS_Param& deepks_param,
                           const std::vector<torch::Tensor>& descriptor,
                           torch::jit::script::Module& model_deepks,
                           double** gedm,
                           double& E_delta,
                           const int rank);
 
void prepare_atom(const UnitCell& ucell, torch::Tensor& atom_out);
void prepare_box(const UnitCell& ucell, torch::Tensor& box_out);
} // namespace DeePKS_domain
#endif
#endif