PfcFunctionFluxRampBC

construction:Undocumented Class

The PfcFunctionFluxRampBC has not been documented. The content listed below should be used as a starting point for documenting the class, which includes the typical automatic documentation associated with a MooseObject; however, what is contained is ultimately determined by what is necessary to make the documentation clear for users.

Imposes the essential boundary condition $var element = document.getElementById("moose-equation-99f5e9d6-872b-48a7-b3fa-9e92ca3c401b");katex.render("u=g", element, {displayMode:false,throwOnError:false});$ , where $var element = document.getElementById("moose-equation-8895caeb-70e5-4265-9e94-0b84a7b9e74c");katex.render("g", element, {displayMode:false,throwOnError:false});$ is a constant calculated assuming the recombination fluxquickly becomes equal to the incident flux. The recombination term is calculated using the simulation temperature and the pre-exponent and Energy values provided

Overview

This option implements the integrated boundary condition for the special case of an incident particle flux with surface recombination as shown in equation Eq. (1).

$(1)var element = document.getElementById("moose-equation-29aba7db-e631-45a6-b641-530ab1e86a76");katex.render(" \\varphi_{net} = \\varphi_{incident} - K_{r}(T)C_{m}^2", element, {displayMode:true,throwOnError:false});$

Input parameters must be supplied for $var element = document.getElementById("moose-equation-72754830-cccf-4d11-94d7-c75bc89c8ea5");katex.render("K_0", element, {displayMode:false,throwOnError:false});$ and $var element = document.getElementById("moose-equation-4477276f-9409-47c7-a6e3-d18d8e5acfe4");katex.render("E_r", element, {displayMode:false,throwOnError:false});$ with a function describing the variation of the incident flux, $var element = document.getElementById("moose-equation-eea4e43e-5db5-4664-9427-1e7302d53ca6");katex.render("\\varphi", element, {displayMode:false,throwOnError:false});$ , (in time and/or space). Temperature is taken from a coupled variable and a scale factor must be provided for the conversion of concentration units from $var element = document.getElementById("moose-equation-61247e6e-11c9-44b7-ab96-ef4f5aebca1a");katex.render("\\text{m}^{-3}", element, {displayMode:false,throwOnError:false});$ to atomic fraction.

Example Input File Syntax

Input Parameters

EEnergy Barrier in Arhhenious Expression
C++ Type:double
Options:
Description:Energy Barrier in Arhhenious Expression
TTemperature
C++ Type:std::vector<VariableName>
Options:
Description:Temperature
boundaryThe list of boundary IDs from the mesh where this boundary condition applies
C++ Type:std::vector<BoundaryName>
Options:
Description:The list of boundary IDs from the mesh where this boundary condition applies
k0pre-exponent factor
C++ Type:double
Options:
Description:pre-exponent factor
scale_factorscale factor
C++ Type:double
Options:
Description:scale factor
variableThe name of the variable that this residual object operates on
C++ Type:NonlinearVariableName
Options:
Description:The name of the variable that this residual object operates on

Required Parameters

displacementsThe displacements
C++ Type:std::vector<VariableName>
Options:
Description:The displacements
function0The function describing the Dirichlet condition
Default:0
C++ Type:FunctionName
Options:
Description:The function describing the Dirichlet condition
prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.
C++ Type:MaterialPropertyName
Options:
Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

Optional Parameters

control_tagsAdds user-defined labels for accessing object parameters via control logic.
C++ Type:std::vector<std::string>
Options:
Description:Adds user-defined labels for accessing object parameters via control logic.
diag_save_inThe name of auxiliary variables to save this BC's diagonal jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
C++ Type:std::vector<AuxVariableName>
Options:
Description:The name of auxiliary variables to save this BC's diagonal jacobian contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
enableTrueSet the enabled status of the MooseObject.
Default:True
C++ Type:bool
Options:
Description:Set the enabled status of the MooseObject.
implicitTrueDetermines whether this object is calculated using an implicit or explicit form
Default:True
C++ Type:bool
Options:
Description:Determines whether this object is calculated using an implicit or explicit form
save_inThe name of auxiliary variables to save this BC's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
C++ Type:std::vector<AuxVariableName>
Options:
Description:The name of auxiliary variables to save this BC's residual contributions to. Everything about that variable must match everything about this variable (the type, what blocks it's on, etc.)
seed0The seed for the master random number generator
Default:0
C++ Type:unsigned int
Options:
Description:The seed for the master random number generator
use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.
Default:False
C++ Type:bool
Options:
Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

Advanced Parameters

extra_matrix_tagsThe extra tags for the matrices this Kernel should fill
C++ Type:std::vector<TagName>
Options:
Description:The extra tags for the matrices this Kernel should fill
extra_vector_tagsThe extra tags for the vectors this Kernel should fill
C++ Type:std::vector<TagName>
Options:
Description:The extra tags for the vectors this Kernel should fill
matrix_tagssystemThe tag for the matrices this Kernel should fill
Default:system
C++ Type:MultiMooseEnum
Options:nontime, system
Description:The tag for the matrices this Kernel should fill
vector_tagsnontimeThe tag for the vectors this Kernel should fill
Default:nontime
C++ Type:MultiMooseEnum
Options:nontime, time
Description:The tag for the vectors this Kernel should fill

Tagging Parameters

Overview
Example Input File Syntax
Input Parameters

Module

Examples

Source Code

Comparison to Analytical Solution

Thermal Desorption Spectrum

Kernels

BCs

Materials

Postprocessors