# 7.16.1.24. Scalar_String_Function

Syntax

  Ic For DofName ([{of} SpeciesName] | [{in} MaterialPhaseName] | [{ls} {a | b | c}]) {@ | at | for | on | over} MeshExtent = Scalar_String_Function ([Power_Output = power_output] | [Flux_Output = flux_output] | [Toggle = toggle] | F = f)

Summary

  Value from a string function

Description

  The value, , is calculated from the user-defined string function, which can be a function of time (), coordinates (, , ), or any valid expression name. Check the String Functions chapter (String Functions) for more details about valid functions and variables that can be used.

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

  Power_Output

    If specified, the total (integrated) power of the given BC/Src is calculated and stored into the global variable name specified as the power_output argument.

  Flux_Output

    If specified, the average flux of the given BC/Src is calculated and stored into the global variable name specified as the flux_output argument.

  Toggle

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

Parameter | Value | Default
--- | --- | ---
DofName | string | –
{of} | {of | species | subindex} | –
SpeciesName | string | –
{in} | {in | material_phase} | –
MaterialPhaseName | string | –
{ls} | {levelset_phase | ls} | –
MeshExtent | string | –
power_output | “string” | –
flux_output | “string” | –
toggle | “string” | –
f | “string” | –