PropertyRamp Custom Task - Revision history

Nairnj: /* Calculate Property Change During the Ramp */

2024-05-02T22:47:32Z

Calculate Property Change During the Ramp

← Older revision		Revision as of 22:47, 2 May 2024
Line 85:		Line 85:

	* <tt>(delta)</tt> - the final property change to apply to all particles (or the magnitude of the change after the ramp is done). The ramp will [[#Incremental Changes on Particles\|apply this change incrementally]] by the chosen ramp style during the duration of the ramp. Once the ramp is done, no more changes will be made.		* <tt>(delta)</tt> - the final property change to apply to all particles (or the magnitude of the change after the ramp is done). The ramp will [[#Incremental Changes on Particles\|apply this change incrementally]] by the chosen ramp style during the duration of the ramp. Once the ramp is done, no more changes will be made.
	* <tt>(function)</tt> - [[User Defined Functions\|user-defined function]] of time (in [[ConsistentUnits Command#Legacy and Consistent Units\|alt time units]]) and particle position (in [[ConsistentUnits Command#Legacy and Consistent Units\|length units]]). When <tt>(scale)≥0</tt>, the increment in value on any particle will be the calculated increment times the value of <tt>(function)</tt>. When <tt>(scale)<0</tt>, the function is required and gives property change rate [[ConsistentUnits Command#Legacy and Consistent Units\|per alt time units]] (see [[#Incremental Changes on Particles\|below]] for more details).		* <tt>(function)</tt> - [[User Defined Functions\|user-defined function]] of time (in [[ConsistentUnits Command#Legacy and Consistent Units\|alt time units]]) and particle position (in [[ConsistentUnits Command#Legacy and Consistent Units\|length units]]). When <tt>(scale)≥0</tt>, the increment in value on any particle will be the calculated increment times the value of <tt>(function)</tt>. When <tt>(scale)<0</tt>, the function is required and gives property change rate [[ConsistentUnits Command#Legacy and Consistent Units\|per alt time units]] (see [[#Incremental Changes on Particles\|below]] for more details). Because this function is evaluated for every particle on every time step, complicated functions will slow down simulations during the ramp period.

	The units for <tt>(delta)</tt> depend on property being ramped:		The units for <tt>(delta)</tt> depend on property being ramped:

Nairnj: /* Incremental Changes on Particles */

2024-05-02T16:54:27Z

Incremental Changes on Particles

← Older revision		Revision as of 16:54, 2 May 2024
Line 99:		Line 99:
	=== Incremental Changes on Particles ===		=== Incremental Changes on Particles ===

	When <tt>(style)≥0</tt>, the first step is to calculate the current ramp value <math>f(t)</math>, that increases from 0 to 1 or the property ramp <tt>(time)</tt>. Then, for the current time step, the increment in property, <math>\Delta P</math>, is given by:		When <tt>(style)≥0</tt>, the first step is to calculate the current ramp value <math>f(t)</math>, that increases from 0 to 1 over the property ramp <tt>(time)</tt>. Then, for the current time step, the increment in property, <math>\Delta P</math>, is given by:

Nairnj: /* Incremental Changes on Particles */

2024-05-02T16:54:09Z

Incremental Changes on Particles

← Older revision		Revision as of 16:54, 2 May 2024
Line 99:		Line 99:
	=== Incremental Changes on Particles ===		=== Incremental Changes on Particles ===

	When <tt>(style)≥0</tt>, the first step is to calculate the current ramp value <math>f(t)</math>, ~~which increased~~ from 0 to 1 or the property ramp <tt>(time)</tt>. Then, for the current time step, the increment in property, <math>\Delta P</math>, is given by:		When <tt>(style)≥0</tt>, the first step is to calculate the current ramp value <math>f(t)</math>, that increases from 0 to 1 or the property ramp <tt>(time)</tt>. Then, for the current time step, the increment in property, <math>\Delta P</math>, is given by:

Nairnj: /* Incremental Changes on Particles */

2024-05-02T16:53:13Z

Incremental Changes on Particles

← Older revision		Revision as of 16:53, 2 May 2024
Line 99:		Line 99:
	=== Incremental Changes on Particles ===		=== Incremental Changes on Particles ===

	~~Given~~ <math>f(t)</math> from the ~~chosen~~ ramp ~~function~~, the increment in property, <math>\Delta P</math>, ~~on each time step~~ is given by:		When <tt>(style)≥0</tt>, the first step is to calculate the current ramp value <math>f(t)</math>, which increased from 0 to 1 or the property ramp <tt>(time)</tt>. Then, for the current time step, the increment in property, <math>\Delta P</math>, is given by:


Line 110:		Line 110:

	These relative values are typically applied in a single time step where <math>f(t)=1</math> and <math>u(\vec x_p,t)</math> can define position-dependent relative values (the function is not used when setting properties from image or text data). By this approach, they are all set on the first time step.		These relative values are typically applied in a single time step where <math>f(t)=1</math> and <math>u(\vec x_p,t)</math> can define position-dependent relative values (the function is not used when setting properties from image or text data). By this approach, they are all set on the first time step.

			When <tt>(style)<0</tt>, the required user-defined function directly sets the property change rate resulting in


			<math>\Delta P = u(\vec x_p,t)\Delta t</math>

			Note that input <tt>(delta)</tt> is ignored. Because Relative Initiation Stress and Toughness are not applied incrementally, that are just set using the function or:


			<math>R = u(\vec x_p,t)</math>

			Typically this is done on one time step and the function only depends on position to allow some position-dependent failure properties. More commonly, Relative Initiation Stress and Toughness are set with image or text data.

	=== Property Change from Image Data ===		=== Property Change from Image Data ===

Nairnj: /* Calculate Property Change During the Ramp */

2024-05-02T16:46:15Z

Calculate Property Change During the Ramp

← Older revision		Revision as of 16:46, 2 May 2024
Line 85:		Line 85:

	* <tt>(delta)</tt> - the final property change to apply to all particles (or the magnitude of the change after the ramp is done). The ramp will [[#Incremental Changes on Particles\|apply this change incrementally]] by the chosen ramp style during the duration of the ramp. Once the ramp is done, no more changes will be made.		* <tt>(delta)</tt> - the final property change to apply to all particles (or the magnitude of the change after the ramp is done). The ramp will [[#Incremental Changes on Particles\|apply this change incrementally]] by the chosen ramp style during the duration of the ramp. Once the ramp is done, no more changes will be made.
	* <tt>(function)</tt> - [[User Defined Functions\|user-defined function]] of time (in [[ConsistentUnits Command#Legacy and Consistent Units\|alt time units]]) and particle position (in [[ConsistentUnits Command#Legacy and Consistent Units\|length units]]). When <tt>(scale)≥0</tt>, the increment in value on any particle will be the calculated increment times the value of <tt>(function)</tt>. When <tt>(scale)<0</tt>, the function is required and gives property change rate [[ConsistentUnits Command#Legacy and Consistent Units\|per alt time units]].		* <tt>(function)</tt> - [[User Defined Functions\|user-defined function]] of time (in [[ConsistentUnits Command#Legacy and Consistent Units\|alt time units]]) and particle position (in [[ConsistentUnits Command#Legacy and Consistent Units\|length units]]). When <tt>(scale)≥0</tt>, the increment in value on any particle will be the calculated increment times the value of <tt>(function)</tt>. When <tt>(scale)<0</tt>, the function is required and gives property change rate [[ConsistentUnits Command#Legacy and Consistent Units\|per alt time units]] (see [[#Incremental Changes on Particles\|below]] for more details).

	The units for <tt>(delta)</tt> depend on property being ramped:		The units for <tt>(delta)</tt> depend on property being ramped:

Nairnj: /* Calculate Property Change During the Ramp */

2024-05-02T16:45:23Z

Calculate Property Change During the Ramp

← Older revision		Revision as of 16:45, 2 May 2024
Line 85:		Line 85:

	* <tt>(delta)</tt> - the final property change to apply to all particles (or the magnitude of the change after the ramp is done). The ramp will [[#Incremental Changes on Particles\|apply this change incrementally]] by the chosen ramp style during the duration of the ramp. Once the ramp is done, no more changes will be made.		* <tt>(delta)</tt> - the final property change to apply to all particles (or the magnitude of the change after the ramp is done). The ramp will [[#Incremental Changes on Particles\|apply this change incrementally]] by the chosen ramp style during the duration of the ramp. Once the ramp is done, no more changes will be made.
	* <tt>(function)</tt> - [[User Defined Functions\|user-defined function]] of time (in [[ConsistentUnits Command#Legacy and Consistent Units\|alt time units]]) and particle position. ~~is a when this optional parameter is used, the applied~~ <tt>(~~delta~~)</tt> ~~ramp is scaled by any [[User Defined Functions\|user-defined function]] of time and particle position. The~~ increment in value on any particle will be the calculated increment times the value of <tt>(function)</tt> ~~evaluated at~~ the ~~particle location~~ and ~~current~~ time.		* <tt>(function)</tt> - [[User Defined Functions\|user-defined function]] of time (in [[ConsistentUnits Command#Legacy and Consistent Units\|alt time units]]) and particle position (in [[ConsistentUnits Command#Legacy and Consistent Units\|length units]]). When <tt>(scale)≥0</tt>, the increment in value on any particle will be the calculated increment times the value of <tt>(function)</tt>. When <tt>(scale)<0</tt>, the function is required and gives property change rate [[ConsistentUnits Command#Legacy and Consistent Units\|per alt time units]].

	The units for <tt>(delta)</tt> depend on property being ramped:		The units for <tt>(delta)</tt> depend on property being ramped:

Nairnj: /* Calculate Property Change During the Ramp */

2024-05-02T16:41:28Z

Calculate Property Change During the Ramp

← Older revision		Revision as of 16:41, 2 May 2024
Line 85:		Line 85:

	* <tt>(delta)</tt> - the final property change to apply to all particles (or the magnitude of the change after the ramp is done). The ramp will [[#Incremental Changes on Particles\|apply this change incrementally]] by the chosen ramp style during the duration of the ramp. Once the ramp is done, no more changes will be made.		* <tt>(delta)</tt> - the final property change to apply to all particles (or the magnitude of the change after the ramp is done). The ramp will [[#Incremental Changes on Particles\|apply this change incrementally]] by the chosen ramp style during the duration of the ramp. Once the ramp is done, no more changes will be made.
	* <tt>(function)</tt> - [[User Defined Functions\|user-defined function]] of time and particle position. is a when this optional parameter is used, the applied <tt>(delta)</tt> ramp is scaled by any [[User Defined Functions\|user-defined function]] of time and particle position. The increment in value on any particle will be the calculated increment times the value of <tt>(function)</tt> evaluated at the particle location and current time.		* <tt>(function)</tt> - [[User Defined Functions\|user-defined function]] of time (in [[ConsistentUnits Command#Legacy and Consistent Units\|alt time units]]) and particle position. is a when this optional parameter is used, the applied <tt>(delta)</tt> ramp is scaled by any [[User Defined Functions\|user-defined function]] of time and particle position. The increment in value on any particle will be the calculated increment times the value of <tt>(function)</tt> evaluated at the particle location and current time.

	The units for <tt>(delta)</tt> depend on property being ramped:		The units for <tt>(delta)</tt> depend on property being ramped:

Nairnj: /* Specified Property Change */

2024-05-02T16:40:32Z

Specified Property Change

← Older revision		Revision as of 16:40, 2 May 2024
Line 85:		Line 85:

	* <tt>(delta)</tt> - the final property change to apply to all particles (or the magnitude of the change after the ramp is done). The ramp will [[#Incremental Changes on Particles\|apply this change incrementally]] by the chosen ramp style during the duration of the ramp. Once the ramp is done, no more changes will be made.		* <tt>(delta)</tt> - the final property change to apply to all particles (or the magnitude of the change after the ramp is done). The ramp will [[#Incremental Changes on Particles\|apply this change incrementally]] by the chosen ramp style during the duration of the ramp. Once the ramp is done, no more changes will be made.
	* <tt>(function)</tt> - when this optional parameter is used, the applied <tt>(delta)</tt> ramp is scaled by any [[User Defined Functions\|user-defined function]] of time and particle position. The increment in value on any particle will be the calculated increment times the value of <tt>(function)</tt> evaluated at the particle location and current time.		* <tt>(function)</tt> - [[User Defined Functions\|user-defined function]] of time and particle position. is a when this optional parameter is used, the applied <tt>(delta)</tt> ramp is scaled by any [[User Defined Functions\|user-defined function]] of time and particle position. The increment in value on any particle will be the calculated increment times the value of <tt>(function)</tt> evaluated at the particle location and current time.

	The units for <tt>(delta)</tt> depend on property being ramped:		The units for <tt>(delta)</tt> depend on property being ramped:

Nairnj: /* Task Scheduling and Ramp Settings */

2024-05-02T16:36:39Z

Task Scheduling and Ramp Settings

← Older revision		Revision as of 16:36, 2 May 2024
Line 53:		Line 53:
	\qquad f = \frac{1+\exp(-k/2)}{1-\exp(-k)}\frac{1-\exp(-kt/t_{ramp})}{1+\exp\left(-k\left(\frac{t}{t_{ramp}}-\frac{1}{2}\right)\right)} \quad({\rm sigmoidal})</math>		\qquad f = \frac{1+\exp(-k/2)}{1-\exp(-k)}\frac{1-\exp(-kt/t_{ramp})}{1+\exp\left(-k\left(\frac{t}{t_{ramp}}-\frac{1}{2}\right)\right)} \quad({\rm sigmoidal})</math>

	where k defaults to 12 (but can be changed by providing <tt>(stretch)</tt>). A sigmoidal ramp may reduce dynamic effects at the start and end of the ramp. If <tt>(lifetimes)</tt> is provided, the ramp ~~will use~~ an exponential function		where k defaults to 12 (but can be changed by providing <tt>(stretch)</tt>). A sigmoidal ramp may reduce dynamic effects at the start and end of the ramp.

			If <tt>(lifetimes)</tt> is provided, the ramp changes to an exponential function (and the <tt>(style)=0</tt> setting is ignored):

Nairnj: /* Task Scheduling and Ramp Settings */

2024-05-02T16:33:35Z

Task Scheduling and Ramp Settings

← Older revision		Revision as of 16:33, 2 May 2024
Line 42:		Line 42:
	<li><tt>(time)</tt> - Enter the time interval for applying ramp the particle property (in [[ConsistentUnits Command#Legacy and Consistent Units\|alt time units]]). This parameter is optional; if omitted, enter ramp value is applied in one time step.</li>		<li><tt>(time)</tt> - Enter the time interval for applying ramp the particle property (in [[ConsistentUnits Command#Legacy and Consistent Units\|alt time units]]). This parameter is optional; if omitted, enter ramp value is applied in one time step.</li>
	<li><tt>(start)</tt> - Enter the start time for the ramp (in [[ConsistentUnits Command#Legacy and Consistent Units\|alt time units]]). This parameter is optional; if omitted, the ramp starts at time zero. The ramp ends at time <tt>(start)</tt>+<tt>(time)</tt>.</li>		<li><tt>(start)</tt> - Enter the start time for the ramp (in [[ConsistentUnits Command#Legacy and Consistent Units\|alt time units]]). This parameter is optional; if omitted, the ramp starts at time zero. The ramp ends at time <tt>(start)</tt>+<tt>(time)</tt>.</li>
	<li><tt>(style)</tt>, <tt>(lifetimes)</tt>, and <tt>(stretch)</tt> - Determines the type of ramp.</li>		<li><tt>(style)</tt>, <tt>(lifetimes)</tt>, and <tt>(stretch)</tt> - Determines the type of ramp as explained in the following.</li>
	</ul>		</ul>

	[[File:RampStyle.png\|right]]		[[File:RampStyle.png\|right]]

	The plot on the right shows four types of ramps. If <tt>(lifetimes)</tt> is not set (or is set less than or equal to zero), the ramp ~~will be~~ linear or sigmoidal ~~for~~ <tt>(style)</tt> ~~equal to 0 or 1, respectively~~ (if no <tt>(style)</tt> is provided, the default is 0 or linear). The resulting ramps as fraction of the maximum value are:		The plot on the right shows four types of ramps. If <tt>(lifetimes)</tt> is not set (or is set less than or equal to zero), the ramp is determined by <tt>(style)</tt> — <tt>(style)=0</tt> gives a linear ramp, <tt>(style)>0</tt> gives a sigmoidal ramp, and <tt>(style)<0</tt> means a user-defined function provides the change rate (if no <tt>(style)</tt> is provided, the default is 0 or linear). The resulting ramps for <tt>(style)≥0</tt> as fraction of the maximum value are: