# User_Function

Syntax

  User Expression ([{of} SpeciesName] | [{in} MaterialPhaseName] | [{ls} {a | b | c}]) = User_Function (User_Tag = user_tag | Name = name | X = x | [X_Multiplier = x_multiplier] | [Multiplier = multiplier] | [Toggle = toggle] | [Equations = Equations…])

Summary

  User function user expression

Description

  Provides an expression with the name given by the user_tag parameter using the provided user function. The provided user tag should not include operator, subindex, phase, component, or material phase prefixes or suffixes. See General Naming Convention for more detail about those.

  The following options are present in most boundary conditions/sources. The meaning of each option is as follows:

  Toggle

    If given, specifies which toggle block controls whether this BC is active or not.

Parameter | Value | Default
--- | --- | ---
{of} | {of | species | subindex} | –
SpeciesName | string | –
{in} | {in | material_phase} | –
MaterialPhaseName | string | –
{ls} | {levelset_phase | ls} | –
user_tag | “string” | –
name | “string” | –
x | “string” | –
x_multiplier | real | 1
multiplier | real | 1
toggle | “string” | –
Equations | string… | –