# Binary_State

Syntax

  User Expression ([{of} SpeciesName] | [{in} MaterialPhaseName] | [{ls} {a | b | c}]) = Binary_State (User_Tag = user_tag | Location = location | [Initial_State = initial_state] | [Activation_Function = activation_function] | [Deactivation_Function = deactivation_function] | [Equations = Equations…])

Summary

  Binary State user expression

Description

  Provides an expression that represents the active/inactive state with criteria for transition. Parameters are:

  User_Tag - Name of expression and field to provide

  Location - Either ELEMENT to create an element field/expression or NODE to create a nodal field/expression

  Initial State - Either ON/ACTIVE or OFF/INACTIVE

  Activation Function - String function criteria that will set field state to active

  Deactivation Function - String function criteria that will set field state to inactive

  Either an activation function, deactivation function, or both must be provided.

Parameter | Value | Default
--- | --- | ---
{of} | {of | species | subindex} | –
SpeciesName | string | –
{in} | {in | material_phase} | –
MaterialPhaseName | string | –
{ls} | {levelset_phase | ls} | –
user_tag | “string” | –
location | “string” | –
initial_state | “string” | –
activation_function | “string” | –
deactivation_function | “string” | –
Equations | string… | –