git-svn-id: svn://svn.icms.temple.edu/lammps-ro/trunk@4029 f3b2605a-c512-4ea7-a41b-209d697bcdaa

This commit is contained in:
sjplimp 2010-04-23 14:24:18 +00:00
parent 7dbb6d500e
commit 00eca36fe5
7 changed files with 223 additions and 27 deletions

View File

@ -38,7 +38,7 @@ tar xvf lammps*.tar
<P>This will create a LAMMPS directory containing two files and several
sub-directories:
</P>
<DIV ALIGN=center><TABLE WIDTH="0%" BORDER=1 >
<DIV ALIGN=center><TABLE BORDER=1 >
<TR><TD >README</TD><TD > text file</TD></TR>
<TR><TD >LICENSE</TD><TD > the GNU General Public License (GPL)</TD></TR>
<TR><TD >bench</TD><TD > benchmark problems</TD></TR>
@ -350,7 +350,7 @@ package".
</P>
<P>The current list of standard packages is as follows:
</P>
<DIV ALIGN=center><TABLE WIDTH="0%" BORDER=1 >
<DIV ALIGN=center><TABLE BORDER=1 >
<TR><TD >asphere </TD><TD > aspherical particles and force fields</TD></TR>
<TR><TD >class2 </TD><TD > class 2 force fields</TD></TR>
<TR><TD >colloid </TD><TD > colloidal particle force fields</TD></TR>
@ -762,7 +762,7 @@ output is performed.
<P>Specify a variable that will be defined for substitution purposes when
the input script is read. "Name" is the variable name which can be a
single character (referenced as $x in the input script) or a full
string (referenced as $\<I>abc\</I>). The value can be any string. Using
string (referenced as ${abc}). The value can be any string. Using
this command-line option is equivalent to putting the line "variable
name index value" at the beginning of the input script. Defining an
index variable as a command-line argument overrides any setting for

View File

@ -21,18 +21,24 @@
<LI>fx,fy,fz = force component values (force units)
<LI>any of fx,fy,fz can be a variable (see below)
<LI>zero or more keyword/value pairs may be appended to args
<LI>keyword = <I>region</I>
<PRE> <I>region</I> value = region-ID
region-ID = ID of region atoms must be in to have added force
region-ID = ID of region atoms must be in to have added force
<I>energy</I> value = variable-ID
variable-ID = ID of variable that calculates the potential energy of each atom in the added force field
</PRE>
</UL>
<P><B>Examples:</B>
</P>
<PRE>fix kick flow addforce 1.0 0.0 0.0
<PRE>fix kick flow addforce 1.0 0.0 0.0
fix kick flow addforce 1.0 0.0 v_oscillate
fix ff boundary addforce 0.0 0.0 v_push energy espace
</PRE>
<P><B>Description:</B>
</P>
@ -41,10 +47,60 @@ the group. This command can be used to give an additional push to
atoms in a simulation, such as for a simulation of Poiseuille flow in
a channel.
</P>
<P>Any of the 3 quantities defining the force components can be
specified as an equal-style or atom-style <A HREF = "variable">variable</A>, namely
<I>fx</I>, <I>fy</I>, <I>fz</I>. If the value is a variable, it should be specified
as v_ID, where ID is the variable ID. In this case, the variable will
be evaluated each timestep, and its value used to determine the
force component.
</P>
<P>Equal-style variables can specify formulas with various mathematical
functions, and include <A HREF = "thermo_style.html">thermo_style</A> command
keywords for the simulation box parameters and timestep and elapsed
time. Thus it is easy to specify a time-dependent force field.
</P>
<P>Atom-style variables can specify the same formulas as equal-style
variables but can also include per-atom values, such as atom
coordinates. Thus it is easy to specify a spatially-dependent force
field with optional time-dependence as well.
</P>
<P>If the <I>region</I> keyword is used, the atom must also be in the
specified geometric <A HREF = "region.html">region</A> in order to have force added
to it.
</P>
<P>Adding a force to atoms implies a change in their potential energy as
they move due to the applied force field. For dynamics via the "run"
command, this energy can be optionally added to the system's potential
energy for thermodynamic output (see below). For energy minimization
via the "minimize" command, this energy must be added to the system's
potential energy to formulate a self-consistent minimization problem
(see below).
</P>
<P>The <I>energy</I> keyword is not allowed if the added force is a constant
vector F = (fx,fy,fz), with all components defined as numeric
constants and not as variables. This is because LAMMPS can compute
the energy for each atom directly as E = -x dot F = -(x*fx + y*fy +
z*fz), so that -Grad(E) = F.
</P>
<P>The <I>energy</I> keyword is optional if the added force is defined with
one or more variables, and if you are performing dynamics via the
<A HREF = "run.html">run</A> command. If the keyword is not used, LAMMPS will set
the energy to 0.0, which is typically fine for dynamics.
</P>
<P>The <I>energy</I> keyword is required if the added force is defined with
one or more variables, and you are performing energy minimization via
the "minimize" command. The keyword specifies the ID of an atom-style
<A HREF = "variable.html">variable</A> which is used to compute the energy of each
atom as function of its position. Unlike variables used for <I>fx</I>,
<I>fy</I>, <I>fz</I>, the energy variable is specified by ID only, without a
"v_" prefix.
</P>
<P>Note that when the <I>energy</I> keyword is used during an energy
minimization, you must insure that the formula defined for the
atom-style <A HREF = "variable.html">variable</A> is consistent with the force
variable formulas, i.e. that -Grad(E) = F. If you don't, the
minimization will not converge properly.
</P>
<P><B>Restart, fix_modify, output, run start/stop, minimize info:</B>
</P>
<P>No information about this fix is written to <A HREF = "restart.html">binary restart
@ -70,7 +126,10 @@ scalar and vector values calculated by this fix are "extensive".
the <A HREF = "run.html">run</A> command.
</P>
<P>The forces due to this fix are imposed during an energy minimization,
invoked by the <A HREF = "minimize.html">minimize</A> command.
invoked by the <A HREF = "minimize.html">minimize</A> command. You should not
specify force components with a variable that has time-dependence for
use with a minimizer, since the minimizer increments the timestep as
the iteration count during the minimization.
</P>
<P>IMPORTANT NOTE: If you want the fictitious potential energy associated
with the added forces to be included in the total potential energy of

View File

@ -15,15 +15,20 @@ fix ID group-ID addforce fx fy fz keyword value ... :pre
ID, group-ID are documented in "fix"_fix.html command :ulb,l
addforce = style name of this fix command :l
fx,fy,fz = force component values (force units) :l
any of fx,fy,fz can be a variable (see below) :l
zero or more keyword/value pairs may be appended to args :l
keyword = {region} :l
{region} value = region-ID
region-ID = ID of region atoms must be in to have added force :pre
region-ID = ID of region atoms must be in to have added force
{energy} value = variable-ID
variable-ID = ID of variable that calculates the potential energy of each atom in the added force field :pre
:ule
[Examples:]
fix kick flow addforce 1.0 0.0 0.0 :pre
fix kick flow addforce 1.0 0.0 0.0
fix kick flow addforce 1.0 0.0 v_oscillate
fix ff boundary addforce 0.0 0.0 v_push energy espace :pre
[Description:]
@ -32,10 +37,62 @@ the group. This command can be used to give an additional push to
atoms in a simulation, such as for a simulation of Poiseuille flow in
a channel.
Any of the 3 quantities defining the force components can be
specified as an equal-style or atom-style "variable"_variable, namely
{fx}, {fy}, {fz}. If the value is a variable, it should be specified
as v_ID, where ID is the variable ID. In this case, the variable will
be evaluated each timestep, and its value used to determine the
force component.
Equal-style variables can specify formulas with various mathematical
functions, and include "thermo_style"_thermo_style.html command
keywords for the simulation box parameters and timestep and elapsed
time. Thus it is easy to specify a time-dependent force field.
Atom-style variables can specify the same formulas as equal-style
variables but can also include per-atom values, such as atom
coordinates. Thus it is easy to specify a spatially-dependent force
field with optional time-dependence as well.
If the {region} keyword is used, the atom must also be in the
specified geometric "region"_region.html in order to have force added
to it.
Adding a force to atoms implies a change in their potential energy as
they move due to the applied force field. For dynamics via the "run"
command, this energy can be optionally added to the system's potential
energy for thermodynamic output (see below). For energy minimization
via the "minimize" command, this energy must be added to the system's
potential energy to formulate a self-consistent minimization problem
(see below).
The {energy} keyword is not allowed if the added force is a constant
vector F = (fx,fy,fz), with all components defined as numeric
constants and not as variables. This is because LAMMPS can compute
the energy for each atom directly as E = -x dot F = -(x*fx + y*fy +
z*fz), so that -Grad(E) = F.
The {energy} keyword is optional if the added force is defined with
one or more variables, and if you are performing dynamics via the
"run"_run.html command. If the keyword is not used, LAMMPS will set
the energy to 0.0, which is typically fine for dynamics.
The {energy} keyword is required if the added force is defined with
one or more variables, and you are performing energy minimization via
the "minimize" command. The keyword specifies the ID of an atom-style
"variable"_variable.html which is used to compute the energy of each
atom as function of its position. Unlike variables used for {fx},
{fy}, {fz}, the energy variable is specified by ID only, without a
"v_" prefix.
Note that when the {energy} keyword is used during an energy
minimization, you must insure that the formula defined for the
atom-style "variable"_variable.html is consistent with the force
variable formulas, i.e. that -Grad(E) = F. For example, if the force
were a spring-like F = kx, then the energy formula should be E =
-0.5kx^2. If you don't do this correctly, the minimization will not
converge properly.
[Restart, fix_modify, output, run start/stop, minimize info:]
No information about this fix is written to "binary restart
@ -61,7 +118,10 @@ No parameter of this fix can be used with the {start/stop} keywords of
the "run"_run.html command.
The forces due to this fix are imposed during an energy minimization,
invoked by the "minimize"_minimize.html command.
invoked by the "minimize"_minimize.html command. You should not
specify force components with a variable that has time-dependence for
use with a minimizer, since the minimizer increments the timestep as
the iteration count during the minimization.
IMPORTANT NOTE: If you want the fictitious potential energy associated
with the added forces to be included in the total potential energy of

View File

@ -21,6 +21,8 @@
<LI>fx,fy,fz = force component values (force units)
<LI>any of fx,fy,fz can be a variable (see below)
<LI>zero or more keyword/value pairs may be appended to args
<LI>keyword = <I>region</I>
@ -33,7 +35,8 @@
<P><B>Examples:</B>
</P>
<PRE>fix pressdown topwall aveforce 0.0 -1.0 0.0
fix 2 bottomwall aveforce NULL -1.0 0.0 region top
fix 2 bottomwall aveforce NULL -1.0 0.0 region top
fix 2 bottomwall aveforce NULL -1.0 v_oscillate region top
</PRE>
<P><B>Description:</B>
</P>
@ -47,10 +50,21 @@ component. The actual force on each atom is then set to the average
value plus the component specified in this command. This means each
atom in the group receives the same force.
</P>
<P>If any of the arguments is specified as NULL then the forces in that
dimension are not changed. Note that this is not the same as
specifying a 0.0 value, since that sets all forces to the same average
value without adding in any additional force.
<P>Any of the fx,fy,fz values can be specified as NULL which means the
force in that dimension is not changed. Note that this is not the
same as specifying a 0.0 value, since that sets all forces to the same
average value without adding in any additional force.
</P>
<P>Any of the 3 quantities defining the force components can be specified
as an equal-style <A HREF = "variable">variable</A>, namely <I>fx</I>, <I>fy</I>, <I>fz</I>. If
the value is a variable, it should be specified as v_ID, where ID is
the variable ID. In this case, the variable will be evaluated each
timestep, and its value used to determine the average force.
</P>
<P>Equal-style variables can specify formulas with various mathematical
functions, and include <A HREF = "thermo_style.html">thermo_style</A> command
keywords for the simulation box parameters and timestep and elapsed
time. Thus it is easy to specify a time-dependent average force.
</P>
<P>If the <I>region</I> keyword is used, the atom must also be in the
specified geometric <A HREF = "region.html">region</A> in order to have force added
@ -72,7 +86,10 @@ fix are "extensive".
the <A HREF = "run.html">run</A> command.
</P>
<P>The forces due to this fix are imposed during an energy minimization,
invoked by the <A HREF = "minimize.html">minimize</A> command.
invoked by the <A HREF = "minimize.html">minimize</A> command. You should not
specify force components with a variable that has time-dependence for
use with a minimizer, since the minimizer increments the timestep as
the iteration count during the minimization.
</P>
<P><B>Restrictions:</B> none
</P>

View File

@ -15,6 +15,7 @@ fix ID group-ID aveforce fx fy fz keyword value ... :pre
ID, group-ID are documented in "fix"_fix.html command :ulb,l
aveforce = style name of this fix command :l
fx,fy,fz = force component values (force units) :l
any of fx,fy,fz can be a variable (see below) :l
zero or more keyword/value pairs may be appended to args :l
keyword = {region} :l
{region} value = region-ID
@ -24,7 +25,8 @@ keyword = {region} :l
[Examples:]
fix pressdown topwall aveforce 0.0 -1.0 0.0
fix 2 bottomwall aveforce NULL -1.0 0.0 region top :pre
fix 2 bottomwall aveforce NULL -1.0 0.0 region top
fix 2 bottomwall aveforce NULL -1.0 v_oscillate region top :pre
[Description:]
@ -38,10 +40,21 @@ component. The actual force on each atom is then set to the average
value plus the component specified in this command. This means each
atom in the group receives the same force.
If any of the arguments is specified as NULL then the forces in that
dimension are not changed. Note that this is not the same as
specifying a 0.0 value, since that sets all forces to the same average
value without adding in any additional force.
Any of the fx,fy,fz values can be specified as NULL which means the
force in that dimension is not changed. Note that this is not the
same as specifying a 0.0 value, since that sets all forces to the same
average value without adding in any additional force.
Any of the 3 quantities defining the force components can be specified
as an equal-style "variable"_variable, namely {fx}, {fy}, {fz}. If
the value is a variable, it should be specified as v_ID, where ID is
the variable ID. In this case, the variable will be evaluated each
timestep, and its value used to determine the average force.
Equal-style variables can specify formulas with various mathematical
functions, and include "thermo_style"_thermo_style.html command
keywords for the simulation box parameters and timestep and elapsed
time. Thus it is easy to specify a time-dependent average force.
If the {region} keyword is used, the atom must also be in the
specified geometric "region"_region.html in order to have force added
@ -63,7 +76,10 @@ No parameter of this fix can be used with the {start/stop} keywords of
the "run"_run.html command.
The forces due to this fix are imposed during an energy minimization,
invoked by the "minimize"_minimize.html command.
invoked by the "minimize"_minimize.html command. You should not
specify force components with a variable that has time-dependence for
use with a minimizer, since the minimizer increments the timestep as
the iteration count during the minimization.
[Restrictions:] none

View File

@ -17,12 +17,14 @@
</PRE>
<UL><LI>ID, group-ID are documented in <A HREF = "fix.html">fix</A> command
<LI>setforce = style name of this fix command
<LI>fx,fy,fz = force component values
<LI>fx,fy,fz = force component values
<LI>any of fx,fy,fz can be a variable (see below)
</UL>
<P><B>Examples:</B>
</P>
<PRE>fix freeze indenter setforce 0.0 0.0 0.0
fix 2 edge setforce NULL 0.0 0.0
fix 2 edge setforce NULL 0.0 0.0
fix 2 edge setforce NULL 0.0 v_oscillate
</PRE>
<P><B>Description:</B>
</P>
@ -35,6 +37,23 @@ force, assuming their initial velocity zero.
<P>Any of the fx,fy,fz values can be specified as NULL which means do not
alter the force component in that dimension.
</P>
<P>Any of the 3 quantities defining the force components can be
specified as an equal-style or atom-style <A HREF = "variable">variable</A>, namely
<I>fx</I>, <I>fy</I>, <I>fz</I>. If the value is a variable, it should be specified
as v_ID, where ID is the variable ID. In this case, the variable will
be evaluated each timestep, and its value used to determine the
force component.
</P>
<P>Equal-style variables can specify formulas with various mathematical
functions, and include <A HREF = "thermo_style.html">thermo_style</A> command
keywords for the simulation box parameters and timestep and elapsed
time. Thus it is easy to specify a time-dependent force field.
</P>
<P>Atom-style variables can specify the same formulas as equal-style
variables but can also include per-atom values, such as atom
coordinates. Thus it is easy to specify a spatially-dependent force
field with optional time-dependence as well.
</P>
<P><B>Restart, fix_modify, output, run start/stop, minimize info:</B>
</P>
<P>No information about this fix is written to <A HREF = "restart.html">binary restart
@ -51,7 +70,10 @@ fix are "extensive".
the <A HREF = "run.html">run</A> command.
</P>
<P>The forces due to this fix are imposed during an energy minimization,
invoked by the <A HREF = "minimize.html">minimize</A> command.
invoked by the <A HREF = "minimize.html">minimize</A> command. You should not
specify force components with a variable that has time-dependence for
use with a minimizer, since the minimizer increments the timestep as
the iteration count during the minimization.
</P>
<P><B>Restrictions:</B> none
</P>

View File

@ -14,12 +14,14 @@ fix ID group-ID setforce fx fy fz :pre
ID, group-ID are documented in "fix"_fix.html command
setforce = style name of this fix command
fx,fy,fz = force component values :ul
fx,fy,fz = force component values
any of fx,fy,fz can be a variable (see below) :ul
[Examples:]
fix freeze indenter setforce 0.0 0.0 0.0
fix 2 edge setforce NULL 0.0 0.0 :pre
fix 2 edge setforce NULL 0.0 0.0
fix 2 edge setforce NULL 0.0 v_oscillate :pre
[Description:]
@ -32,6 +34,23 @@ force, assuming their initial velocity zero.
Any of the fx,fy,fz values can be specified as NULL which means do not
alter the force component in that dimension.
Any of the 3 quantities defining the force components can be
specified as an equal-style or atom-style "variable"_variable, namely
{fx}, {fy}, {fz}. If the value is a variable, it should be specified
as v_ID, where ID is the variable ID. In this case, the variable will
be evaluated each timestep, and its value used to determine the
force component.
Equal-style variables can specify formulas with various mathematical
functions, and include "thermo_style"_thermo_style.html command
keywords for the simulation box parameters and timestep and elapsed
time. Thus it is easy to specify a time-dependent force field.
Atom-style variables can specify the same formulas as equal-style
variables but can also include per-atom values, such as atom
coordinates. Thus it is easy to specify a spatially-dependent force
field with optional time-dependence as well.
[Restart, fix_modify, output, run start/stop, minimize info:]
No information about this fix is written to "binary restart
@ -48,7 +67,10 @@ No parameter of this fix can be used with the {start/stop} keywords of
the "run"_run.html command.
The forces due to this fix are imposed during an energy minimization,
invoked by the "minimize"_minimize.html command.
invoked by the "minimize"_minimize.html command. You should not
specify force components with a variable that has time-dependence for
use with a minimizer, since the minimizer increments the timestep as
the iteration count during the minimization.
[Restrictions:] none