JDFTx  1.2.0
VDWCoupling.h
1 /*-------------------------------------------------------------------
2 Copyright 2012 Ravishankar Sundararaman, Kendra Letchworth Weaver
3 
4 This file is part of JDFTx.
5 
6 JDFTx is free software: you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation, either version 3 of the License, or
9 (at your option) any later version.
10 
11 JDFTx is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
15 
16 You should have received a copy of the GNU General Public License
17 along with JDFTx. If not, see <http://www.gnu.org/licenses/>.
18 -------------------------------------------------------------------*/
19 
20 
21 #ifndef JDFTX_ELECTRONIC_VDWCOUPLING_H
22 #define JDFTX_ELECTRONIC_VDWCOUPLING_H
23 
24 #include <fluid/Fmix.h>
25 #include <fluid/Molecule.h>
26 #include <fluid/FluidMixture.h>
27 #include <electronic/common.h>
28 #include <electronic/VanDerWaals.h>
29 
31 class VDWCoupling : public Fmix
32 {
33 public:
34  VDWCoupling(FluidMixture* fluidMixture, const std::vector< std::vector< vector3<> > >& atpos, const std::shared_ptr<VanDerWaals>& vdW, double vdwScale);
35 
37  double energyAndGrad(const ScalarFieldTildeArray& Ntilde, ScalarFieldTildeArray* Phi_Ntilde=0, IonicGradient* forces=0) const;
38 
39  //Interface to fluid side (virtual functions from Fmix):
40  double computeUniform(const std::vector<double>& N, std::vector<double>& Phi_N) const;
41  double compute(const ScalarFieldTildeArray& Ntilde, ScalarFieldTildeArray& Phi_Ntilde) const;
42  string getName() const;
43 
44 private:
45  const std::vector< std::vector< vector3<> > >& atpos;
46  const std::shared_ptr<VanDerWaals>& vdW;
47  double vdwScale;
48  std::vector<int> atomicNumber;
49 };
50 
51 #endif // JDFTX_ELECTRONIC_VDWCOUPLING_H
double computeUniform(const std::vector< double > &N, std::vector< double > &Phi_N) const
Mixture of fluids that provides the total free energy functional for minimization Constructing Fex an...
Definition: FluidMixture.h:32
string getName() const
A string identifier for this mixing functional (used in EnergyComponent label)
Abstract base class for mixing functionals: interactions between fluids (beyond hard sphere and scale...
Definition: Fmix.h:29
double compute(const ScalarFieldTildeArray &Ntilde, ScalarFieldTildeArray &Phi_Ntilde) const
double energyAndGrad(const ScalarFieldTildeArray &Ntilde, ScalarFieldTildeArray *Phi_Ntilde=0, IonicGradient *forces=0) const
Main energy and gradients function.
Van der Waals coupling between atoms from electronic DFT and fluid density fields.
Definition: VDWCoupling.h:31
Object to hold all the forces.
Definition: IonicMinimizer.h:31
std::vector< ScalarFieldTilde > ScalarFieldTildeArray
dynamic size collection of reciprocal space scalar fields
Definition: ScalarFieldArray.h:33