Files
lammps/src/QEQ/fix_qeq_fire.cpp

334 lines
8.7 KiB
C++

/* ----------------------------------------------------------------------
LAMMPS - Large-scale Atomic/Molecular Massively Parallel Simulator
https://www.lammps.org/, Sandia National Laboratories
LAMMPS development team: developers@lammps.org
Copyright (2003) Sandia Corporation. Under the terms of Contract
DE-AC04-94AL85000 with Sandia Corporation, the U.S. Government retains
certain rights in this software. This software is distributed under
the GNU General Public License.
See the README file in the top-level LAMMPS directory.
------------------------------------------------------------------------- */
/* ----------------------------------------------------------------------
Contributing author: Ray Shan (Sandia)
------------------------------------------------------------------------- */
#include "fix_qeq_fire.h"
#include "atom.h"
#include "comm.h"
#include "error.h"
#include "force.h"
#include "kspace.h"
#include "neigh_list.h"
#include "neighbor.h"
#include "pair_comb.h"
#include "pair_comb3.h"
#include "update.h"
#include <cmath>
#include <cstring>
using namespace LAMMPS_NS;
using namespace FixConst;
#define DELAYSTEP 0
#define DT_GROW 1.1
#define DT_SHRINK 0.5
#define ALPHA0 0.8
#define ALPHA_SHRINK 0.10
#define TMAX 10.0
/* ---------------------------------------------------------------------- */
FixQEqFire::FixQEqFire(LAMMPS *lmp, int narg, char **arg) :
FixQEq(lmp, narg, arg), comb(nullptr), comb3(nullptr)
{
qdamp = 0.20;
qstep = 0.20;
int iarg = 8;
while (iarg < narg) {
if (strcmp(arg[iarg], "qdamp") == 0) {
if (iarg + 2 > narg) utils::missing_cmd_args(FLERR, "fix qeq/fire qdamp", error);
qdamp = utils::numeric(FLERR, arg[iarg + 1], false, lmp);
iarg += 2;
} else if (strcmp(arg[iarg], "qstep") == 0) {
if (iarg + 2 > narg) utils::missing_cmd_args(FLERR, "fix qeq/fire qstep", error);
qstep = utils::numeric(FLERR, arg[iarg + 1], false, lmp);
iarg += 2;
} else if (strcmp(arg[iarg], "warn") == 0) {
if (iarg + 2 > narg) utils::missing_cmd_args(FLERR, "fix qeq/fire warn", error);
maxwarn = utils::logical(FLERR, arg[iarg + 1], false, lmp);
iarg += 2;
} else
error->all(FLERR, "Unknown fix qeq/fire keyword: {}", arg[iarg]);
}
}
/* ---------------------------------------------------------------------- */
void FixQEqFire::init()
{
FixQEq::init();
neighbor->add_request(this);
if (tolerance < 1e-4)
if (comm->me == 0)
error->warning(FLERR, "Fix qeq/fire tolerance {} may be too small for damped fires",
tolerance);
comb3 = dynamic_cast<PairComb3 *>(force->pair_match("^comb3", 0));
if (!comb3) comb = dynamic_cast<PairComb *>(force->pair_match("^comb", 0));
}
/* ---------------------------------------------------------------------- */
void FixQEqFire::pre_force(int /*vflag*/)
{
int inum, *ilist;
int i, ii, iloop;
double *q = atom->q;
double vmax, vdotf, vdotfall, vdotv, vdotvall, fdotf, fdotfall;
double scale1, scale2;
double dtvone, dtv;
double enegtot, enegchk;
double alpha = qdamp;
double dt, dtmax;
double enegchkall;
bigint ntimestep = update->ntimestep;
bigint last_negative = 0;
if (ntimestep % nevery) return;
if (atom->nmax > nmax) reallocate_storage();
inum = list->inum;
ilist = list->ilist;
for (ii = 0; ii < inum; ii++) {
i = ilist[ii];
qv[i] = 0.0;
}
dt = qstep;
dtmax = TMAX * dt;
for (iloop = 0; iloop < maxiter; iloop++) {
pack_flag = 1;
comm->forward_comm(this);
if (comb) {
comb->yasu_char(qf, igroup);
enegtot = comb->enegtot / ngroup;
} else if (comb3) {
comb3->combqeq(qf, igroup);
enegtot = comb3->enegtot / ngroup;
} else {
enegtot = compute_eneg();
enegtot /= ngroup;
}
for (ii = 0; ii < inum; ii++) {
i = ilist[ii];
qf[i] -= enegtot; // Enforce adiabatic
}
// FIRE minimization algorithm
// vdotfall = v dot f = qv dot qf
vdotf = 0.0;
for (ii = 0; ii < inum; ii++) {
i = ilist[ii];
vdotf += (qv[i] * qf[i]);
}
MPI_Allreduce(&vdotf, &vdotfall, 1, MPI_DOUBLE, MPI_SUM, world);
if (vdotfall > 0.0) {
vdotv = fdotf = 0.0;
for (ii = 0; ii < inum; ii++) {
i = ilist[ii];
vdotv += qv[i] * qv[i];
fdotf += qf[i] * qf[i];
}
MPI_Allreduce(&vdotv, &vdotvall, 1, MPI_DOUBLE, MPI_SUM, world);
MPI_Allreduce(&fdotf, &fdotfall, 1, MPI_DOUBLE, MPI_SUM, world);
scale1 = 1.0 - alpha;
if (fdotfall == 0.0)
scale2 = 0.0;
else
scale2 = alpha * sqrt(vdotvall / fdotfall);
for (ii = 0; ii < inum; ii++) {
i = ilist[ii];
qv[i] = scale1 * qv[i] + scale2 * qf[i];
}
if (ntimestep - last_negative > DELAYSTEP) {
dt = MIN(dt * DT_GROW, dtmax);
alpha *= ALPHA_SHRINK;
}
} else {
last_negative = ntimestep;
dt *= DT_SHRINK;
alpha = ALPHA0;
for (ii = 0; ii < inum; ii++) {
i = ilist[ii];
qv[i] = 0.0;
}
}
// limit timestep so no charges change more than dmax
dtvone = dt;
double dmax = 0.1;
for (ii = 0; ii < inum; ii++) {
i = ilist[ii];
vmax = MAX(fabs(qv[i]), 0);
if (dtvone * vmax > dmax) dtvone = dmax / vmax;
}
MPI_Allreduce(&dtvone, &dtv, 1, MPI_DOUBLE, MPI_MIN, world);
//dtv = dt;
// Euler integration step
enegchk = 0.0;
for (ii = 0; ii < inum; ii++) {
i = ilist[ii];
q[i] -= dtv * qv[i];
qv[i] += dtv * qf[i];
enegchk += fabs(qf[i]);
}
MPI_Allreduce(&enegchk, &enegchkall, 1, MPI_DOUBLE, MPI_SUM, world);
enegchk = enegchkall / ngroup;
if (enegchk < tolerance) break;
}
matvecs = iloop;
if ((comm->me == 0) && maxwarn && (iloop >= maxiter))
error->warning(FLERR, "Charges did not converge at step {}: {}", update->ntimestep, enegchk);
if (force->kspace) force->kspace->qsum_qsq();
}
/* ---------------------------------------------------------------------- */
double FixQEqFire::compute_eneg()
{
int i, j, ii, jj, inum, jnum, itype;
int *ilist, *jlist, *numneigh, **firstneigh;
double eneg, enegtot;
double r, rsq, delr[3], rinv;
int *type = atom->type;
int *mask = atom->mask;
double *q = atom->q;
double **x = atom->x;
inum = list->inum;
ilist = list->ilist;
numneigh = list->numneigh;
firstneigh = list->firstneigh;
for (ii = 0; ii < inum; ii++) {
i = ilist[ii];
if (mask[i] & groupbit) qf[i] = 0.0;
}
// communicating charge force to all nodes, first forward then reverse
pack_flag = 2;
comm->forward_comm(this);
for (ii = 0; ii < inum; ii++) {
i = ilist[ii];
itype = type[i];
if (mask[i] & groupbit) {
qf[i] += chi[itype] + eta[itype] * q[i];
jlist = firstneigh[i];
jnum = numneigh[i];
for (jj = 0; jj < jnum; jj++) {
j = jlist[jj];
j &= NEIGHMASK;
delr[0] = x[i][0] - x[j][0];
delr[1] = x[i][1] - x[j][1];
delr[2] = x[i][2] - x[j][2];
rsq = delr[0] * delr[0] + delr[1] * delr[1] + delr[2] * delr[2];
if (rsq > cutoff_sq) continue;
r = sqrt(rsq);
rinv = 1.0 / r;
qf[i] += q[j] * rinv;
qf[j] += q[i] * rinv;
}
}
}
pack_flag = 2;
comm->reverse_comm(this);
// sum charge force on each node and return it
eneg = enegtot = 0.0;
for (ii = 0; ii < inum; ii++) {
i = ilist[ii];
if (mask[i] & groupbit) eneg += qf[i];
}
MPI_Allreduce(&eneg, &enegtot, 1, MPI_DOUBLE, MPI_SUM, world);
return enegtot;
}
/* ---------------------------------------------------------------------- */
int FixQEqFire::pack_forward_comm(int n, int *list, double *buf, int /*pbc_flag*/, int * /*pbc*/)
{
int m = 0;
if (pack_flag == 1)
for (m = 0; m < n; m++) buf[m] = atom->q[list[m]];
else if (pack_flag == 2)
for (m = 0; m < n; m++) buf[m] = qf[list[m]];
return m;
}
/* ---------------------------------------------------------------------- */
void FixQEqFire::unpack_forward_comm(int n, int first, double *buf)
{
int i, m;
if (pack_flag == 1)
for (m = 0, i = first; m < n; m++, i++) atom->q[i] = buf[m];
else if (pack_flag == 2)
for (m = 0, i = first; m < n; m++, i++) qf[i] = buf[m];
}
/* ---------------------------------------------------------------------- */
int FixQEqFire::pack_reverse_comm(int n, int first, double *buf)
{
int i, m;
for (m = 0, i = first; m < n; m++, i++) buf[m] = qf[i];
return m;
}
/* ---------------------------------------------------------------------- */
void FixQEqFire::unpack_reverse_comm(int n, int *list, double *buf)
{
int m;
for (m = 0; m < n; m++) qf[list[m]] += buf[m];
}
/* ---------------------------------------------------------------------- */