diff --git a/doc/variable.html b/doc/variable.html index bf438fdab6..866eb08219 100644 --- a/doc/variable.html +++ b/doc/variable.html @@ -443,12 +443,12 @@ will generate the sequence of output timesteps:

1000,1100,1200, ... ,1900,2000 
 
-

The vdisplace(x,y) function takes 2 arguments: x = coord0 and y = -velocity, and uses the elapsed time to change the coordinate value by -a linear displacement due to the applied velocity over the course of a -run, according to this formula: +

The vdisplace(x,y) function takes 2 arguments: x = value0 and y = +velocity, and uses the elapsed time to change the value by a linear +displacement due to the applied velocity over the course of a run, +according to this formula:

-
value = coord0 + velocity*(timestep-startstep)*dt 
+
value = value0 + velocity*(timestep-startstep)*dt 
 

where dt = the timestep size.

@@ -459,13 +459,12 @@ the start keyword of the run command. See the timestep-startstep.

The swiggle(x,y,z) and cwiggle(x,y,z) functions each take 3 arguments: -x = coord0, y = amplitude, z = period. They use the elapsed time to -oscillate the coordinate value by a sin() or cos() function over the -course of a run, according to one of these formulas, where -omega = 2 PI / period: +x = value0, y = amplitude, z = period. They use the elapsed time to +oscillate the value by a sin() or cos() function over the course of a +run, according to one of these formulas, where omega = 2 PI / period:

-
value = coord0 + Amplitude * sin(omega*(timestep-startstep)*dt)
-value = coord0 + Amplitude * (1 - cos(omega*(timestep-startstep)*dt)) 
+
value = value0 + Amplitude * sin(omega*(timestep-startstep)*dt)
+value = value0 + Amplitude * (1 - cos(omega*(timestep-startstep)*dt)) 
 

where dt = the timestep size.

diff --git a/doc/variable.txt b/doc/variable.txt index 2bfdf1a536..8d10d8f4dd 100644 --- a/doc/variable.txt +++ b/doc/variable.txt @@ -443,12 +443,12 @@ will generate the sequence of output timesteps: 1000,1100,1200, ... ,1900,2000 :pre -The vdisplace(x,y) function takes 2 arguments: x = coord0 and y = -velocity, and uses the elapsed time to change the coordinate value by -a linear displacement due to the applied velocity over the course of a -run, according to this formula: +The vdisplace(x,y) function takes 2 arguments: x = value0 and y = +velocity, and uses the elapsed time to change the value by a linear +displacement due to the applied velocity over the course of a run, +according to this formula: -value = coord0 + velocity*(timestep-startstep)*dt :pre +value = value0 + velocity*(timestep-startstep)*dt :pre where dt = the timestep size. @@ -459,13 +459,12 @@ the {start} keyword of the "run"_run.html command. See the timestep-startstep. The swiggle(x,y,z) and cwiggle(x,y,z) functions each take 3 arguments: -x = coord0, y = amplitude, z = period. They use the elapsed time to -oscillate the coordinate value by a sin() or cos() function over the -course of a run, according to one of these formulas, where -omega = 2 PI / period: +x = value0, y = amplitude, z = period. They use the elapsed time to +oscillate the value by a sin() or cos() function over the course of a +run, according to one of these formulas, where omega = 2 PI / period: -value = coord0 + Amplitude * sin(omega*(timestep-startstep)*dt) -value = coord0 + Amplitude * (1 - cos(omega*(timestep-startstep)*dt)) :pre +value = value0 + Amplitude * sin(omega*(timestep-startstep)*dt) +value = value0 + Amplitude * (1 - cos(omega*(timestep-startstep)*dt)) :pre where dt = the timestep size.