votca 2026-dev
Loading...
Searching...
No Matches
staticsite.h
Go to the documentation of this file.
1
2/*
3 * Copyright 2009-2020 The VOTCA Development Team
4 * (http://www.votca.org)
5 *
6 * Licensed under the Apache License, Version 2.0 (the "License")
7 *
8 * You may not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
10 *
11 * http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS,
15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16nn * See the License for the specific language governing permissions and
17 * limitations under the License.
18 *
19 */
20
21#pragma once
22#ifndef VOTCA_XTP_STATICSITE_H
23#define VOTCA_XTP_STATICSITE_H
24
25// Local VOTCA includes
26#include "eigen.h"
27#include "qmatom.h"
28
29namespace votca {
30namespace xtp {
31
38
39 public:
40 struct data {
42 char* element;
43 double posX;
44 double posY;
45 double posZ;
46
48
49 double Q00;
50 double Q11c;
51 double Q11s;
52 double Q10;
53 double Q20;
54 double Q21c;
55 double Q21s;
56 double Q22c;
57 double Q22s;
58 };
59 StaticSite(Index id, std::string element, Eigen::Vector3d pos)
60 : id_(id), element_(element), pos_(pos) {};
61
62 StaticSite(Index id, std::string element)
63 : StaticSite(id, element, Eigen::Vector3d::Zero()) {};
64
65 StaticSite(const data& d) { ReadData(d); }
66
67 StaticSite(const QMAtom& atom, double charge)
68 : StaticSite(atom.getId(), atom.getElement(), atom.getPos()) {
69 setCharge(charge);
70 }
71 virtual ~StaticSite() = default;
72
73 protected:
74 StaticSite() = default;
75
76 public:
77 Index getId() const { return id_; }
78 Index getRank() const { return rank_; }
79 const std::string& getElement() const { return element_; }
80 const Eigen::Vector3d& getPos() const { return pos_; }
81
82 // Used by SegmentMapper::map() to renumber copied sites while keeping
83 // their multipole data. Named setID() like QMAtom::setID() for use in
84 // generic template code.
85 void setID(Index id) { id_ = id; }
86
87 void setMultipole(const Vector9d& multipole, Index rank) {
88 Q_ = multipole;
89 rank_ = rank;
90 }
91 // sets rank to 0 as well
92 void setCharge(double q) {
93 Q_(0) = q;
94 rank_ = 0;
95 }
96
97 // reset dipole and rank if necessary
98 void setStaticDipole(const Eigen::Vector3d& dipole) {
99 Q_.segment<3>(1) = dipole;
100 if (rank_ == 0) rank_ = 1;
101 }
102
103 void setPos(const Eigen::Vector3d& position) { pos_ = position; }
104
105 // COORDINATES TRANSFORMATION
106 void Translate(const Eigen::VectorXd& shift);
107 virtual void Rotate(const Eigen::Matrix3d& R, const Eigen::Vector3d& refPos);
108
109 // MULTIPOLES DEFINITION
110 double getCharge() const { return Q_(0); }
111 const Vector9d& Q() const {
112 return Q_;
113 } // Q00,Q11c,Q11s,Q10,Q20, Q21c, Q21s, Q22c, Q22s,...[NOT following Stone
114 // order for dipoles]
115
116 virtual Eigen::Vector3d getDipole() const { return Q_.segment<3>(1); }
117 virtual Eigen::Vector3d getStaticDipole() const { return Q_.segment<3>(1); };
118 virtual Eigen::Vector3d getInducedDipole() const {
119 return Eigen::Vector3d::Zero();
120 };
121
122 Eigen::Matrix3d CalculateCartesianMultipole() const;
123
124 static Eigen::VectorXd CalculateSphericalMultipole(
125 const Eigen::Matrix3d& quad_cart);
126
127 std::string WriteMpsLine(std::string unit = "bohr") const;
128
129 static void SetupCptTable(CptTable& table);
130
131 void WriteData(data& d) const;
132 void ReadData(const data& d);
133 virtual void setpolarization(const Eigen::Matrix3d&) { return; }
134
135 virtual std::string identify() const { return "staticsite"; }
136
137 friend std::ostream& operator<<(std::ostream& out, const StaticSite& site) {
138 out << site.getId() << " " << site.getElement() << " " << site.getRank();
139 out << " " << site.getPos().transpose() << "\n";
140 return out;
141 }
142
143 protected:
144 virtual std::string writepolarization() const;
145
146 Index id_ = -1;
147 std::string element_ = "";
148 Eigen::Vector3d pos_ = Eigen::Vector3d::Zero();
150
151 Vector9d Q_ = Vector9d::Zero(); // Q00,Q11c,Q11s,Q10,Q20,Q21c,Q21s,Q22c,Q22s
152};
153} // namespace xtp
154} // namespace votca
155
156#endif // VOTCA_XTP_STATICSITE_H
container for QM atoms
Definition qmatom.h:37
void setMultipole(const Vector9d &multipole, Index rank)
Definition staticsite.h:87
virtual Eigen::Vector3d getInducedDipole() const
Definition staticsite.h:118
static Eigen::VectorXd CalculateSphericalMultipole(const Eigen::Matrix3d &quad_cart)
Definition staticsite.cc:54
Eigen::Matrix3d CalculateCartesianMultipole() const
Definition staticsite.cc:37
virtual Eigen::Vector3d getStaticDipole() const
Definition staticsite.h:117
static void SetupCptTable(CptTable &table)
virtual Eigen::Vector3d getDipole() const
Definition staticsite.h:116
const std::string & getElement() const
Definition staticsite.h:79
std::string WriteMpsLine(std::string unit="bohr") const
virtual void setpolarization(const Eigen::Matrix3d &)
Definition staticsite.h:133
void setID(Index id)
Definition staticsite.h:85
StaticSite(Index id, std::string element)
Definition staticsite.h:62
Index getId() const
Definition staticsite.h:77
const Eigen::Vector3d & getPos() const
Definition staticsite.h:80
void setPos(const Eigen::Vector3d &position)
Definition staticsite.h:103
StaticSite(Index id, std::string element, Eigen::Vector3d pos)
Definition staticsite.h:59
double getCharge() const
Definition staticsite.h:110
void setStaticDipole(const Eigen::Vector3d &dipole)
Definition staticsite.h:98
StaticSite(const QMAtom &atom, double charge)
Definition staticsite.h:67
virtual ~StaticSite()=default
virtual std::string identify() const
Definition staticsite.h:135
StaticSite(const data &d)
Definition staticsite.h:65
void WriteData(data &d) const
virtual std::string writepolarization() const
Definition staticsite.cc:88
friend std::ostream & operator<<(std::ostream &out, const StaticSite &site)
Definition staticsite.h:137
void ReadData(const data &d)
void setCharge(double q)
Definition staticsite.h:92
void Translate(const Eigen::VectorXd &shift)
Definition staticsite.cc:83
Index getRank() const
Definition staticsite.h:78
const Vector9d & Q() const
Definition staticsite.h:111
virtual void Rotate(const Eigen::Matrix3d &R, const Eigen::Vector3d &refPos)
Definition staticsite.cc:66
Eigen::Vector3d pos_
Definition staticsite.h:148
Provides a means for comparing floating point numbers.
Definition basebead.h:33
Eigen::Index Index
Definition types.h:26
Eigen::Matrix< double, 9, 1 > Vector9d
Definition eigen.h:37