7.40. Toggle

This section is referenced in the following other sections

Simulation Setup: Feature Toggling

7.40.1. Toggle Block

Scope: Sierra
Summary: This command block defines the period(s), state and initial conditions for model feature toggling.
Description: Defines a generic entity toggling specification and associate it with name ModelName. The same ModelName can be used for various model features such as element blocks, boundary conditions, contact and volumetric sources.

begin Toggle Block ModelName

   Freeze Element Block Solution State

   Period {=} Period_list...

   State {=} {active | inactive}

end Toggle Block ModelName

7.40.1.1. Line Commands

Freeze Element Block Solution State

Syntax: Freeze Element Block Solution State
Summary: Specify that the solution state remain the same when an element block has been toggled on.
Description: Specifies that the initial condition is not reset on any associated element block that has been toggled. The default behavior is to have the initial conditions reset on element blocks that have been toggled back on.

Period

Syntax: Period {=} Period_list…
Summary: Specify the periods over which this toggling model is to be used.
Description: Defines the time periods over which this toggling model is to be used. Note that more than one PERIOD can be appear in the command block.

Parameter	Value	Default
{=}	{= \| are \| is}	–
Period_list	string…	–

State

Syntax: State {=} {active | inactive}
Summary: Specify the state for this toggling model over the periods it is to be used.
Description: Defines the toggle state for the time periods over which this toggling model is to be used. Note that more than one STATE can be appear in the command block.

Parameter	Value	Default
{=}	{= \| are \| is}	–
ToggleState	{active \| inactive}	–

7.40.2. Use Toggle Block

Syntax: Use Toggle Block ToggleName [ {on} ElementBlockList… ]
Summary: Specification for toggling entities in the computational model based on Toggle Block parameters. When used at the region level, the list of element blocks to be toggled must be provided. Otherwise a listing of entities is not needed as the Toggle Block will be associated with the command line or the enclosing command block.

Parameter	Value	Default
ToggleName	string	–