File: density_description_file.h

package info (click to toggle)
ergo 3.8.2-1.1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 17,568 kB
  • sloc: cpp: 94,763; ansic: 17,785; sh: 10,701; makefile: 1,403; yacc: 127; lex: 116; awk: 23
file content (93 lines) | stat: -rw-r--r-- 3,084 bytes parent folder | download
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
/* Ergo, version 3.8.2, a program for linear scaling electronic structure
 * calculations.
 * Copyright (C) 2023 Elias Rudberg, Emanuel H. Rubensson, Pawel Salek,
 * and Anastasia Kruchinina.
 * 
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 * 
 * Primary academic reference:
 * Ergo: An open-source program for linear-scaling electronic structure
 * calculations,
 * Elias Rudberg, Emanuel H. Rubensson, Pawel Salek, and Anastasia
 * Kruchinina,
 * SoftwareX 7, 107 (2018),
 * <http://dx.doi.org/10.1016/j.softx.2018.03.005>
 * 
 * For further information about Ergo, see <http://www.ergoscf.org>.
 */

/** @file density_description_file.h

    @brief An interface file for writing and reading density matrices
    to/from a file, including basis set information.

    @author: Elias Rudberg <em>responsible</em>
*/

#ifndef DENSITY_DESC_FILE
#define  DENSITY_DESC_FILE 1

#include "basisinfo.h"


int ddf_writeShellListAndDensityMatricesToFile(const BasisInfoStruct & basisInfo,
					       int noOfDensityMatrices,
					       ergo_real** densityMatrixList,
					       const char* fileName);

typedef struct
{
  long nvalues;
  int* rowind;
  int* colind;
  ergo_real* values;
} matrix_description_struct;

/** Writes basisInfo and sparse matrices in a format that can be later
    read by ddf_load_density.
*/

int ddf_writeShellListAndDensityMatricesToFile_sparse(const BasisInfoStruct & basisInfo,
						      int noOfDensityMatrices,
						      matrix_description_struct* densityMatrixList,
						      const char* fileName);


/** Function opens fileName, fills in basisInfo (which has
   to be allocated and nullified), allocates densityMatrixList and
   reads density matrix or at most two matrices and puts it/them in
   densityMatrixList.
*/
int ddf_load_density(const char *densityFileName,
		     int noOfDensityMatrices,
		     const IntegralInfo& integralInfo,
		     BasisInfoStruct **basisInfo,
		     ergo_real **densityMatrixList);

/** Function opens fileName, fills in basisInfo (which has
   to be allocated and nullified), allocates densityMatrixList and
   reads density matrix or at most two matrices and puts it/them in
   densityMatrixList.
*/
int ddf_load_density_sparse(const char *densityFileName,
			    const IntegralInfo& integralInfo,
			    BasisInfoStruct **basisInfo,
			    int *noOfDensitiesRead,
			    int** rowindList,
			    int** colindList,
			    ergo_real** valuesList,
			    long* nvaluesList);


#endif /*  DENSITY_DESC_FILE */