File: grid_interface.h

package info (click to toggle)
ergo 3.8.2-1.1
  • links: PTS, VCS
  • area: main
  • in suites: 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 (64 lines) | stat: -rw-r--r-- 2,533 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
/* 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>.
 */

/* -*-mode:c; c-style:bsd; c-basic-offset:4;indent-tabs-mode:nil; -*- */
/** @file grid_interface.h Grid Generator interface. */

#if !defined(_GRID_INTERFACE_H_)
#define _GRID_INTERFACE_H_ 1

#include "realtype.h"
typedef ergo_real real;

/** GridGenMolInfo is an abstract class providing information about
 * the molecule so that the grid generator can fetch atom positions
 * and charges, and shell extents. We prefer to provide virtual
 * functions than just store data in order to reduce storage and need
 * no destructor. This abstract interface also allows to share the
 * code between different programs. */
class GridGenMolInfo {
 public:
    int    noOfAtoms;
    int    noOfBasisFuncs;
    int    noOfShells;

    GridGenMolInfo(int a, int b, int s)
      : noOfAtoms(a), noOfBasisFuncs(b), noOfShells(s) {}

    virtual void getAtom(int icent, int *cnt, real (*coor)[3],
                         int *charge, int *mult) const = 0;
    virtual void setShellRadii(real *shellRadii) const = 0;
    virtual void getBlocks(const real *center, real cellsz,
                           const real *rshell,
                           int *nblcnt, int (*iblcks)[2]) const = 0;
    virtual void getExps(int *maxl, int **nucbas, real (**aa)[2]) const = 0;
    virtual ~GridGenMolInfo() {};
};

#endif /* _GRID_INTERFACE_H_ */