Page MenuHomec4science

fix_tune_kspace.cpp
No OneTemporary

File Metadata

Created
Fri, Jun 7, 17:25

fix_tune_kspace.cpp

/* ----------------------------------------------------------------------
LAMMPS - Large-scale Atomic/Molecular Massively Parallel Simulator
http://lammps.sandia.gov, Sandia National Laboratories
Steve Plimpton, sjplimp@sandia.gov
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: Paul Crozier (SNL)
------------------------------------------------------------------------- */
#include "string.h"
#include "stdlib.h"
#include "fix_tune_kspace.h"
#include "update.h"
#include "domain.h"
#include "atom.h"
#include "comm.h"
#include "force.h"
#include "kspace.h"
#include "pair.h"
#include "error.h"
#include "memory.h"
#include "timer.h"
#include "neighbor.h"
#include "modify.h"
#include "compute.h"
#include <iostream>
#include <cmath>
#include <limits>
#define SWAP(a,b) {temp=(a);(a)=(b);(b)=temp;}
#define SIGN(a,b) ((b) >= 0.0 ? fabs(a) : -fabs(a))
#define GOLD 1.618034
using namespace std;
using namespace LAMMPS_NS;
using namespace FixConst;
/* ---------------------------------------------------------------------- */
FixTuneKspace::FixTuneKspace(LAMMPS *lmp, int narg, char **arg) :
Fix(lmp, narg, arg)
{
if (narg < 3) error->all(FLERR,"Illegal fix tune/kspace command");
box_change = 1;
global_freq = 1;
firststep = 0;
niter = 0;
niter_adjust_rcut = 0;
keep_bracketing = true;
first_brent_pass = true;
converged = false;
need_fd2_brent = false;
ewald_time = pppm_time = msm_time = 0.0;
// parse arguments
nevery = force->inumeric(FLERR,arg[3]);
// set up reneighboring
force_reneighbor = 1;
next_reneighbor = update->ntimestep + 1;
}
/* ---------------------------------------------------------------------- */
FixTuneKspace::~FixTuneKspace()
{
}
/* ---------------------------------------------------------------------- */
int FixTuneKspace::setmask()
{
int mask = 0;
mask |= PRE_EXCHANGE;
mask |= PRE_NEIGHBOR;
return mask;
}
/* ---------------------------------------------------------------------- */
void FixTuneKspace::init()
{
if (!force->kspace) error->all(FLERR,"Cannot use fix tune/kspace without kspace");
if (!force->pair) error->all(FLERR,"Cannot use fix tune/kspace without a pair style");
double old_acc = force->kspace->accuracy/force->kspace->two_charge_force;
char old_acc_str[12];
sprintf(old_acc_str,"%g",old_acc);
strcpy(new_acc_str,old_acc_str);
int itmp;
double *p_cutoff = (double *) force->pair->extract("cut_coul",itmp);
pair_cut_coul = *p_cutoff;
}
/* ----------------------------------------------------------------------
perform dynamic kspace parameter optimization
------------------------------------------------------------------------- */
void FixTuneKspace::pre_exchange()
{
if (!nevery) return;
if (!force->kspace) return;
if (!force->pair) return;
if (next_reneighbor != update->ntimestep) return;
next_reneighbor = update->ntimestep + nevery;
double time = get_timing_info();
if (strcmp(force->kspace_style,"ewald") == 0) ewald_time = time;
if (strcmp(force->kspace_style,"pppm") == 0) pppm_time = time;
if (strcmp(force->kspace_style,"msm") == 0) msm_time = time;
niter++;
if (niter == 1) {
// test Ewald
store_old_kspace_settings();
strcpy(new_kspace_style,"ewald");
sprintf(new_pair_style,"%s/long",base_pair_style);
update_pair_style(new_pair_style,pair_cut_coul);
update_kspace_style(new_kspace_style,new_acc_str);
} else if (niter == 2) {
// test PPPM
store_old_kspace_settings();
strcpy(new_kspace_style,"pppm");
sprintf(new_pair_style,"%s/long",base_pair_style);
update_pair_style(new_pair_style,pair_cut_coul);
update_kspace_style(new_kspace_style,new_acc_str);
} else if (niter == 3) {
// test MSM
store_old_kspace_settings();
strcpy(new_kspace_style,"msm");
sprintf(new_pair_style,"%s/msm",base_pair_style);
update_pair_style(new_pair_style,pair_cut_coul);
update_kspace_style(new_kspace_style,new_acc_str);
} else if (niter == 4) {
store_old_kspace_settings();
cout << "ewald_time = " << ewald_time << endl;
cout << "pppm_time = " << pppm_time << endl;
cout << "msm_time = " << msm_time << endl;
// switch to fastest one
strcpy(new_kspace_style,"ewald");
sprintf(new_pair_style,"%s/long",base_pair_style);
if (pppm_time < ewald_time && pppm_time < msm_time)
strcpy(new_kspace_style,"pppm");
else if (msm_time < pppm_time && msm_time < ewald_time) {
strcpy(new_kspace_style,"msm");
sprintf(new_pair_style,"%s/msm",base_pair_style);
}
update_pair_style(new_pair_style,pair_cut_coul);
update_kspace_style(new_kspace_style,new_acc_str);
} else {
adjust_rcut(time);
}
last_spcpu = timer->elapsed(TIME_LOOP);
}
/* ----------------------------------------------------------------------
figure out CPU time per timestep since last time checked
------------------------------------------------------------------------- */
double FixTuneKspace::get_timing_info()
{
double dvalue;
double new_cpu;
int new_step = update->ntimestep;
if (firststep == 0) {
new_cpu = 0.0;
dvalue = 0.0;
firststep = 1;
} else {
new_cpu = timer->elapsed(TIME_LOOP);
double cpu_diff = new_cpu - last_spcpu;
int step_diff = new_step - last_step;
if (step_diff > 0.0) dvalue = cpu_diff/step_diff;
else dvalue = 0.0;
}
last_step = new_step;
last_spcpu = new_cpu;
return dvalue;
}
/* ----------------------------------------------------------------------
store old kspace settings: style, accuracy, order, etc
------------------------------------------------------------------------- */
void FixTuneKspace::store_old_kspace_settings()
{
int n = strlen(force->kspace_style) + 1;
char *old_kspace_style = new char[n];
strcpy(old_kspace_style,force->kspace_style);
strcpy(new_kspace_style,old_kspace_style);
double old_acc = force->kspace->accuracy_relative;
char old_acc_str[12];
sprintf(old_acc_str,"%g",old_acc);
strcpy(new_pair_style,force->pair_style);
strcpy(base_pair_style,force->pair_style);
char *trunc;
if ((trunc = strstr(base_pair_style, "/long")) != NULL) *trunc = '\0';
if ((trunc = strstr(base_pair_style, "/msm" )) != NULL) *trunc = '\0';
old_differentiation_flag = force->kspace->differentiation_flag;
old_slabflag = force->kspace->slabflag;
old_slab_volfactor = force->kspace->slab_volfactor;
}
/* ----------------------------------------------------------------------
update the pair style if necessary, preserving the settings
------------------------------------------------------------------------- */
void FixTuneKspace::update_pair_style(char *new_pair_style, double pair_cut_coul)
{
int itmp;
double *p_cutoff = (double *) force->pair->extract("cut_coul",itmp);
*p_cutoff = pair_cut_coul;
// check to see if we need to change pair styles
if (strcmp(new_pair_style,force->pair_style) == 0) return;
// create a temporary file to store current pair settings
FILE *p_pair_settings_file;
p_pair_settings_file = tmpfile();
force->pair->write_restart(p_pair_settings_file);
rewind(p_pair_settings_file);
cout << "Creating new pair style: " << new_pair_style << endl;
// delete old pair style and create new one
force->create_pair(new_pair_style,lmp->suffix);
// restore current pair settings from temporary file
force->pair->read_restart(p_pair_settings_file);
double *pcutoff = (double *) force->pair->extract("cut_coul",itmp);
double current_cutoff = *pcutoff;
cout << "Coulomb cutoff for real space: " << current_cutoff << endl;
// close temporary file
fclose(p_pair_settings_file);
}
/* ----------------------------------------------------------------------
update the kspace style if necessary
------------------------------------------------------------------------- */
void FixTuneKspace::update_kspace_style(char *new_kspace_style, char *new_acc_str)
{
// create kspace style char string
int narg = 2;
char **arg;
arg = NULL;
int maxarg = 100;
arg = (char **) memory->srealloc(arg,maxarg*sizeof(char *),"tune/kspace:arg");
int n = 12;
arg[0] = new char[n];
strcpy(arg[0],new_kspace_style);
arg[1] = new char[n];
strcpy(arg[1],new_acc_str);
// delete old kspace style and create new one
force->create_kspace(narg,arg,lmp->suffix);
force->kspace->differentiation_flag = old_differentiation_flag;
force->kspace->slabflag = old_slabflag;
force->kspace->slab_volfactor = old_slab_volfactor;
// initialize new kspace style, pair style, molecular styles
force->init();
// set up grid
force->kspace->setup_grid();
// Re-init neighbor list. Probably only needed when redefining the pair style. Should happen after pair->init() to get pair style neighbor list request registered
neighbor->init();
// Re-init computes to update pointers to virials, etc.
for (int i = 0; i < modify->ncompute; i++) modify->compute[i]->init();
memory->sfree(arg);
}
/* ----------------------------------------------------------------------
find the optimal real space coulomb cutoff
------------------------------------------------------------------------- */
void FixTuneKspace::adjust_rcut(double time)
{
if (strcmp(force->kspace_style,"msm") == 0) return;
if (converged) return;
double temp;
const double TINY = 1.0e-20;
// get the current cutoff
int itmp;
double *p_cutoff = (double *) force->pair->extract("cut_coul",itmp);
double current_cutoff = *p_cutoff;
cout << "Old Coulomb cutoff for real space: " << current_cutoff << endl;
// use Brent's method from Numerical Recipes to find optimal real space cutoff
// first time through, get ax_brent and fa_brent, and adjust cutoff
if (keep_bracketing) {
if (niter_adjust_rcut == 0) {
pair_cut_coul /= 2;
} else if (niter_adjust_rcut == 1) {
ax_brent = current_cutoff;
fa_brent = time;
pair_cut_coul *= 2;
// second time through, get bx_brent and fb_brent, and adjust cutoff
} else if (niter_adjust_rcut == 2) {
bx_brent = current_cutoff;
fb_brent = time;
if (fb_brent > fa_brent) {
SWAP(ax_brent,bx_brent);
SWAP(fb_brent,fa_brent);
pair_cut_coul /= 4;
} else {
pair_cut_coul *= 2;
}
// third time through, get cx_brent and fc_brent, and adjust cutoff if needed
} else if (niter_adjust_rcut == 3) {
cx_brent = current_cutoff;
fc_brent = time;
if (fc_brent > fb_brent) keep_bracketing = false;
else {
double r = (bx_brent - ax_brent)*(fb_brent - fc_brent);
double q = (bx_brent - cx_brent)*(fb_brent - fa_brent);
dx_brent = bx_brent - ((bx_brent - cx_brent)*q - (bx_brent - ax_brent)*r)/
(2.0*SIGN(MAX(fabs(q - r),TINY),q - r));
pair_cut_coul = dx_brent;
}
// after third time through, bracket the minimum, and adjust cutoff
} else if (niter_adjust_rcut > 3) {
dx_brent = current_cutoff;
if (need_fd2_brent) fd2_brent = time;
else fd_brent = time;
mnbrak();
pair_cut_coul = dx_brent;
}
}
if (!keep_bracketing) {
dx_brent = current_cutoff;
fd_brent = time;
if (first_brent_pass) brent0();
else brent2();
brent1();
pair_cut_coul = dx_brent;
}
niter_adjust_rcut++;
if (pair_cut_coul <= 0.0) pair_cut_coul = fabs(MIN(ax_brent,MIN(bx_brent,(MIN(cx_brent,dx_brent))))/2.0) + TINY;
if (pair_cut_coul != pair_cut_coul)
error->all(FLERR,"Bad real space Coulomb cutoff in fix tune/kspace");
// change the cutoff to pair_cut_coul
*p_cutoff = pair_cut_coul;
// report the new cutoff
double *new_cutoff = (double *) force->pair->extract("cut_coul",itmp);
current_cutoff = *new_cutoff;
cout << "Adjusted Coulomb cutoff for real space: " << current_cutoff << endl;
store_old_kspace_settings();
update_pair_style(new_pair_style,pair_cut_coul);
update_kspace_style(new_kspace_style,new_acc_str);
}
/* ----------------------------------------------------------------------
bracket a minimum using parabolic extrapolation
------------------------------------------------------------------------- */
void FixTuneKspace::mnbrak()
{
const double GLIMIT = 100.0, TINY = 1.0e-20;
double temp,r,q;
r = (bx_brent - ax_brent)*(fb_brent - fc_brent);
q = (bx_brent - cx_brent)*(fb_brent - fa_brent);
dx_brent = bx_brent - ((bx_brent - cx_brent)*q - (bx_brent - ax_brent)*r)/
(2.0*SIGN(MAX(fabs(q - r),TINY),q - r));
dxlim = bx_brent + GLIMIT*(cx_brent - bx_brent);
if ((bx_brent - dx_brent)*(dx_brent - cx_brent) > 0.0) {
if (fd_brent < fc_brent) {
ax_brent = bx_brent;
bx_brent = dx_brent;
fa_brent = fb_brent;
fb_brent = fd_brent;
keep_bracketing = false;
return;
} else if (fd_brent > fb_brent) {
cx_brent = dx_brent;
fc_brent = fd_brent;
keep_bracketing = false;
return;
}
dx_brent = cx_brent + GOLD*(cx_brent - bx_brent);
if (need_fd2_brent) {
fd_brent = fd2_brent;
need_fd2_brent = false;
} else {
need_fd2_brent = true;
return;
}
} else if ((cx_brent - dx_brent)*(dx_brent - dxlim) > 0.0) {
if (fd_brent < fc_brent) {
if (need_fd2_brent) {
need_fd2_brent = false;
} else {
need_fd2_brent = true;
dx_brent += GOLD*(dx_brent - cx_brent);
return;
}
shft3(bx_brent,cx_brent,dx_brent,dx_brent + GOLD*(dx_brent - cx_brent));
shft3(fb_brent,fc_brent,fd_brent,fd2_brent);
}
} else if ((dx_brent - dxlim)*(dxlim - cx_brent) >= 0.0) {
dx_brent = dxlim;
if (need_fd2_brent) {
fd_brent = fd2_brent;
need_fd2_brent = false;
} else {
need_fd2_brent = true;
return;
}
} else {
dx_brent = cx_brent + GOLD*(cx_brent - bx_brent);
if (need_fd2_brent) {
fd_brent = fd2_brent;
need_fd2_brent = false;
} else {
need_fd2_brent = true;
return;
}
}
shft3(ax_brent,bx_brent,cx_brent,dx_brent);
shft3(fa_brent,fb_brent,fc_brent,fd_brent);
}
/* ----------------------------------------------------------------------
Brent's method from Numerical Recipes
------------------------------------------------------------------------- */
void FixTuneKspace::brent0()
{
a_brent=(ax_brent < cx_brent ? ax_brent : cx_brent);
b_brent=(ax_brent > cx_brent ? ax_brent : cx_brent);
x_brent=w_brent=v_brent=bx_brent;
fw_brent=fv_brent=fx_brent=fb_brent;
}
/* ----------------------------------------------------------------------
Brent's method from Numerical Recipes
------------------------------------------------------------------------- */
void FixTuneKspace::brent1()
{
const int ITMAX=100;
const double CGOLD=0.3819660;
const double ZEPS=numeric_limits<double>::epsilon()*1.0e-3;
double d=0.0,etemp;
double p,q,r,tol1,tol2,xm;
double e=0.0;
double tol=0.001;
xm=0.5*(a_brent+b_brent);
tol2=2.0*(tol1=tol*fabs(x_brent)+ZEPS);
if (fabs(x_brent-xm) <= (tol2-0.5*(b_brent-a_brent))) {
converged = true;
dx_brent = x_brent;
return;
}
if (fabs(e) > tol1) {
r=(x_brent-w_brent)*(fx_brent-fv_brent);
q=(x_brent-v_brent)*(fx_brent-fw_brent);
p=(x_brent-v_brent)*q-(x_brent-w_brent)*r;
q=2.0*(q-r);
if (q > 0.0) p = -p;
q=fabs(q);
etemp=e;
e=d;
if (fabs(p) >= fabs(0.5*q*etemp) || p <= q*(a_brent-x_brent) || p >= q*(b_brent-x_brent))
d=CGOLD*(e=(x_brent >= xm ? a_brent-x_brent : b_brent-x_brent));
else {
d=p/q;
dx_brent=x_brent+d;
if (dx_brent-a_brent < tol2 || b_brent-dx_brent < tol2)
d=SIGN(tol1,xm-x_brent);
}
} else {
d=CGOLD*(e=(x_brent >= xm ? a_brent-x_brent : b_brent-x_brent));
}
dx_brent=(fabs(d) >= tol1 ? x_brent+d : x_brent+SIGN(tol1,d));
first_brent_pass = false;
return;
}
/* ----------------------------------------------------------------------
Brent's method from Numerical Recipes
------------------------------------------------------------------------- */
void FixTuneKspace::brent2()
{
if (fd_brent <= fx_brent) {
if (dx_brent >= x_brent) a_brent=x_brent; else b_brent=x_brent;
shft3(v_brent,w_brent,x_brent,dx_brent);
shft3(fv_brent,fw_brent,fx_brent,fd_brent);
} else {
if (dx_brent < x_brent) a_brent=dx_brent; else b_brent=dx_brent;
if (fd_brent <= fw_brent || w_brent == x_brent) {
v_brent=w_brent;
w_brent=dx_brent;
fv_brent=fw_brent;
fw_brent=fd_brent;
} else if (fd_brent <= fv_brent || v_brent == x_brent || v_brent == w_brent) {
v_brent=dx_brent;
fv_brent=fd_brent;
}
}
}

Event Timeline