cosineRamp

cosineRamp

Works with all licenses.

Function for an initial ramp.

cosineRamp Parameters

direction (float vector)

Direction of the ramp (unit vector \({\bf \hat{u}}\) of gradient).

startPosition (float)

Value of \({\bf \hat{u}}\cdot {\bf x}\) at which the ramp starts.

endPosition (float)

Value of \({\bf \hat{u}}\cdot {\bf x}\) at which the ramp ends.

startAmplitude (float)

Amplitude for \({\bf \hat{u}}\cdot {\bf x}<startPosition\).

endAmplitude (float)

Amplitude for \({\bf \hat{u}}\cdot {\bf x}>endPosition\).

Example cosineRamp Block

<STFunc component0>
   kind = cosineRamp
   direction = [1. 0. 0.]
   startPosition = 0.0
   endPosition   = 0.1
   startAmplitude = 0.
   endAmplitude   = 1.0e17
 </STFunc>