7.15.1.27. User_Plugin

Syntax

Ic For DofName [{of} SpeciesName | {in} MaterialPhaseName | {ls} {a | b | c}] {on} MeshExtent = User_Plugin [Power_Output = power_output | Flux_Output = flux_output | Toggle = toggle | Name = Name | plugin_parameters]

Summary

Value from a user plugin

Description

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}

–

{on}

{@ | at | for | in | on | over}

–

MeshExtent

string

–

power_output

“string”

–

flux_output

“string”

–

toggle

“string”

–

Name

“string”

–

plugin_parameters

“string”

–