From 56b53f9ae93c09dd158df939fb19c3eaed67afa3 Mon Sep 17 00:00:00 2001
From: sjplimp Examples:
Description:
region values = region-ID of region to apply rescaling to
+
region values = region-ID
+ region-ID = ID of region to apply rescaling to
+ partial values = xflag yflag zflag
+ xflag,yflag,zflag = 0/1 if the velocity component should not or should be rescaled
fix 3 flow temp/rescale 100 1.0 1.1 0.02 0.5
-fix 3 boundary temp/rescale 1 1.0 1.5 0.05 1.0 region edge
+fix 3 boundary temp/rescale 1 1.0 1.5 0.05 1.0 region edge
+fix 3 boundary temp/rescale 1 1.0 1.5 0.05 1.0 partial 0 1 1
The keyword partial rescales only the specified velocity components. +A compute of style temp/partial is used to compute the current +temperature of just those components (see below). +
+The region and partial keywords cannot currently be used together. +
A temp/rescale fix does not update the coordinates of its atoms. It is normally used with a fix of style nve that does that. A temp/rescale fix should not normally be used on atoms that also have @@ -58,16 +68,19 @@ their temperature controlled by another fix - e.g. a nvt or langevin fix.
This fix computes a temperature each timestep. To do this, the fix -creates its own compute of style "temp" or "temp/region", as if one of -these commands had been issued: +creates its own compute of style "temp" or "temp/region" or +"temp/partial", as if one of these commands had been issued:
compute fix-ID_temp group-ID temp compute fix-ID_temp group-ID temp/region region-ID +compute fix-ID_temp group-ID temp/partial xflag yflag zflag-
Which is used depends on whether a region was specified with the fix. -See the compute temp and compute -temp/region commands for details. Note that -the ID of the new compute is the fix-ID with underscore + "temp" +
Which is used depends on whether the region or partial keywords +were specified with the fix. See the compute +temp, compute +temp/region, and compute +temp/partial commands for details. Note +that the ID of the new compute is the fix-ID with underscore + "temp" appended and the group for the new compute is the same as the fix group.
diff --git a/doc/fix_temp_rescale.txt b/doc/fix_temp_rescale.txt index 0b294cb474..d56eea6968 100644 --- a/doc/fix_temp_rescale.txt +++ b/doc/fix_temp_rescale.txt @@ -19,13 +19,17 @@ Tstart,Tstop = desired temperature at start/end of run (temperature units) window = only rescale if temperature is outside this window (temperature units) fraction = rescale to target temperature by this fraction zero or more keyword/value pairs may be appended -keyword = {region} :ul - {region} values = region-ID of region to apply rescaling to :pre +keyword = {region} or {partial} :ul + {region} values = region-ID + region-ID = ID of region to apply rescaling to + {partial} values = xflag yflag zflag + xflag,yflag,zflag = 0/1 if the velocity component should not or should be rescaled :pre [Examples:] fix 3 flow temp/rescale 100 1.0 1.1 0.02 0.5 -fix 3 boundary temp/rescale 1 1.0 1.5 0.05 1.0 region edge :pre +fix 3 boundary temp/rescale 1 1.0 1.5 0.05 1.0 region edge +fix 3 boundary temp/rescale 1 1.0 1.5 0.05 1.0 partial 0 1 1 :pre [Description:] @@ -47,6 +51,12 @@ The keyword {region} applies the fix only to atoms that are in the specified geometric region (and in the fix group). Since atoms can enter/leave a region, this test is performed each timestep. +The keyword {partial} rescales only the specified velocity components. +A compute of style temp/partial is used to compute the current +temperature of just those components (see below). + +The {region} and {partial} keywords cannot currently be used together. + A temp/rescale fix does not update the coordinates of its atoms. It is normally used with a fix of style {nve} that does that. A temp/rescale fix should not normally be used on atoms that also have @@ -54,16 +64,19 @@ their temperature controlled by another fix - e.g. a "nvt"_fix_nvt.html or "langevin"_fix_langevin.html fix. This fix computes a temperature each timestep. To do this, the fix -creates its own compute of style "temp" or "temp/region", as if one of -these commands had been issued: +creates its own compute of style "temp" or "temp/region" or +"temp/partial", as if one of these commands had been issued: compute fix-ID_temp group-ID temp -compute fix-ID_temp group-ID temp/region region-ID :pre +compute fix-ID_temp group-ID temp/region region-ID +compute fix-ID_temp group-ID temp/partial xflag yflag zflag :pre -Which is used depends on whether a region was specified with the fix. -See the "compute temp"_compute_temp.html and "compute -temp/region"_compute_temp_region.html commands for details. Note that -the ID of the new compute is the fix-ID with underscore + "temp" +Which is used depends on whether the {region} or {partial} keywords +were specified with the fix. See the "compute +temp"_compute_temp.html, "compute +temp/region"_compute_temp_region.html, and "compute +temp/partial"_compute_temp_partial.html commands for details. Note +that the ID of the new compute is the fix-ID with underscore + "temp" appended and the group for the new compute is the same as the fix group.