7.14.1.8.28. User_Plugin

Syntax

Bc Dirichlet For Dof Name ([{of} SpeciesName] | [{in} MaterialPhaseName] | [{ls} {a | b | c}]) {@ | at | for | on | over} Mesh Extent Name ([Touching TouchingMeshExtent] | [Opposing OpposingMeshExtent]) = User_Plugin [Using Data Specification Data Spec Name] ([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

Dof Name

string

–

{of}

{of | species | subindex}

–

SpeciesName

string

–

{in}

{in | material_phase}

–

MaterialPhaseName

string

–

{ls}

{levelset_phase | ls}

–

Mesh Extent Name

string

–

TouchingMeshExtent

string

–

OpposingMeshExtent

string

–

Data Spec Name

string

–

power_output

“string”

–

flux_output

“string”

–

toggle

“string”

–

Name

“string”

–

plugin_parameters

“string”

–