From ea6d8cbe23761f51490b068e0599642ba3526bc5 Mon Sep 17 00:00:00 2001
From: pscrozi
Date: Thu, 3 May 2012 15:29:09 +0000
Subject: [PATCH] Adding kspace_modify diff option to select the PPPM
differentiation method.
git-svn-id: svn://svn.icms.temple.edu/lammps-ro/trunk@8040 f3b2605a-c512-4ea7-a41b-209d697bcdaa
---
doc/kspace_modify.html | 13 +++++++++++--
doc/kspace_modify.txt | 15 ++++++++++++---
2 files changed, 23 insertions(+), 5 deletions(-)
diff --git a/doc/kspace_modify.html b/doc/kspace_modify.html
index 266a54b480..9809870e63 100644
--- a/doc/kspace_modify.html
+++ b/doc/kspace_modify.html
@@ -17,7 +17,7 @@
- one or more keyword/value pairs may be listed
-
- keyword = mesh or order or gewald or slab
+
- keyword = mesh or order or gewald or slab or compute or diff
mesh value = x y z
x,y,z = PPPM FFT grid size in each dimension
@@ -30,6 +30,7 @@
volfactor = ratio of the total extended volume used in the
2d approximation compared with the volume of the simulation domain
compute value = yes or no
+ diff value = ik or ad
@@ -111,6 +112,14 @@ defining a kspace_style, but a Kspace-compatib
pair_style requires a kspace_style to be defined.
This keyword gives you that option.
+The diff keyword specifies the differentiation scheme used by the
+PPPM method to compute forces on particles given electrostatic
+potentials on the PPPM mesh. The ik approach is the default that
+performs differentiation in kspace, but requires 3 FFTs to transfer
+the computed fields back to real space. The analytic differentiation,
+or ad approach requires only 1 FFT, but requires a somewhat bigger
+PPPM mesh to achieve the same accuracy as the ik approach.
+
Restrictions: none
Related commands:
@@ -120,7 +129,7 @@ This keyword gives you that option.
Default:
The option defaults are mesh = 0 0 0, order = 5, force = -1.0, gewald
-= 0.0, slab = 1.0, and compute = yes.
+= 0.0, slab = 1.0, compute = yes, and diff = ik.
diff --git a/doc/kspace_modify.txt b/doc/kspace_modify.txt
index b679c67e5e..3b4d08945c 100644
--- a/doc/kspace_modify.txt
+++ b/doc/kspace_modify.txt
@@ -13,7 +13,7 @@ kspace_modify command :h3
kspace_modify keyword value ... :pre
one or more keyword/value pairs may be listed :ulb,l
-keyword = {mesh} or {order} or {gewald} or {slab} :l
+keyword = {mesh} or {order} or {gewald} or {slab} or {compute} or {diff} :l
{mesh} value = x y z
x,y,z = PPPM FFT grid size in each dimension
{order} value = N
@@ -24,7 +24,8 @@ keyword = {mesh} or {order} or {gewald} or {slab} :l
{slab} value = volfactor
volfactor = ratio of the total extended volume used in the
2d approximation compared with the volume of the simulation domain
- {compute} value = {yes} or {no} :pre
+ {compute} value = {yes} or {no}
+ {diff} value = {ik} or {ad} :pre
:ule
[Examples:]
@@ -105,6 +106,14 @@ defining a "kspace_style"_kspace_style.html, but a Kspace-compatible
"pair_style"_pair_style.html requires a kspace_style to be defined.
This keyword gives you that option.
+The {diff} keyword specifies the differentiation scheme used by the
+PPPM method to compute forces on particles given electrostatic
+potentials on the PPPM mesh. The ik approach is the default that
+performs differentiation in kspace, but requires 3 FFTs to transfer
+the computed fields back to real space. The analytic differentiation,
+or ad approach requires only 1 FFT, but requires a somewhat bigger
+PPPM mesh to achieve the same accuracy as the ik approach.
+
[Restrictions:] none
[Related commands:]
@@ -114,7 +123,7 @@ This keyword gives you that option.
[Default:]
The option defaults are mesh = 0 0 0, order = 5, force = -1.0, gewald
-= 0.0, slab = 1.0, and compute = yes.
+= 0.0, slab = 1.0, compute = yes, and diff = ik.
:line