- boundaryThe list of boundary IDs from the mesh where this object applies
C++ Type:std::vector<BoundaryName>
Controllable:No
Description:The list of boundary IDs from the mesh where this object applies
- functionThe name of the FunctionSeries "Function" object with which to generate this functional expansion.
C++ Type:FunctionName
Unit:(no unit assumed)
Controllable:No
Description:The name of the FunctionSeries "Function" object with which to generate this functional expansion.
- variableThe name of the variable that this boundary condition applies to
C++ Type:std::vector<VariableName>
Unit:(no unit assumed)
Controllable:No
Description:The name of the variable that this boundary condition applies to
FX Boundary Value UserObject
Generates an Functional Expansion representation for a boundary value condition using a 'FunctionSeries'-type Function
Description
This UserObject captures the moments of an FX representing the value at a boundary. It does this via subclassing the templated FXIntegralBaseUserObject with SideIntegralVariableUserObject as the policy parameter.
FXIntegralBaseUserObject also ensures that the provided Function is a subclass of FunctionSeries.
Example Input File Syntax
Listing 1: Example use of FXBoundaryValueUserObject
[UserObjects<<<{"href": "../../syntax/UserObjects/index.html"}>>>]
[./FX_Value_UserObject_Sub]
type = FXBoundaryValueUserObject<<<{"description": "Generates an Functional Expansion representation for a boundary value condition using a 'FunctionSeries'-type Function", "href": "FXBoundaryValueUserObject.html"}>>>
function<<<{"description": "The name of the FunctionSeries \"Function\" object with which to generate this functional expansion."}>>> = FX_Basis_Value_Sub
variable<<<{"description": "The name of the variable that this boundary condition applies to"}>>> = s
boundary<<<{"description": "The list of boundary IDs from the mesh where this object applies"}>>> = left
[../]
[./FX_Flux_UserObject_Sub]
type = FXBoundaryFluxUserObject<<<{"description": "Generates an Functional Expansion representation for a boundary flux condition using a 'FunctionSeries'-type Function", "href": "FXBoundaryFluxUserObject.html"}>>>
function<<<{"description": "The name of the FunctionSeries \"Function\" object with which to generate this functional expansion."}>>> = FX_Basis_Flux_Sub
variable<<<{"description": "The name of the variable that this boundary condition applies to"}>>> = s
boundary<<<{"description": "The list of boundary IDs from the mesh where this object applies"}>>> = left
diffusivity<<<{"description": "The name of the material diffusivity property, or raw value, that will be used in the flux computation."}>>> = thermal_conductivity
[../]
[]Input Parameters
- keep_historyFalseKeep the expansion coefficients from previous solves
Default:False
C++ Type:bool
Controllable:No
Description:Keep the expansion coefficients from previous solves
- print_stateFalsePrint the state of the zeroth instance each solve
Default:False
C++ Type:bool
Controllable:No
Description:Print the state of the zeroth instance each solve
- print_when_setFalsePrint the array of coefficients when set
Default:False
C++ Type:bool
Controllable:No
Description:Print the array of coefficients when set
Optional Parameters
- allow_duplicate_execution_on_initialFalseIn the case where this UserObject is depended upon by an initial condition, allow it to be executed twice during the initial setup (once before the IC and again after mesh adaptivity (if applicable).
Default:False
C++ Type:bool
Controllable:No
Description:In the case where this UserObject is depended upon by an initial condition, allow it to be executed twice during the initial setup (once before the IC and again after mesh adaptivity (if applicable).
- execute_onTIMESTEP_ENDThe list of flag(s) indicating when this object should be executed. For a description of each flag, see https://mooseframework.inl.gov/source/interfaces/SetupInterface.html.
Default:TIMESTEP_END
C++ Type:ExecFlagEnum
Controllable:No
Description:The list of flag(s) indicating when this object should be executed. For a description of each flag, see https://mooseframework.inl.gov/source/interfaces/SetupInterface.html.
- execution_order_group0Execution order groups are executed in increasing order (e.g., the lowest number is executed first). Note that negative group numbers may be used to execute groups before the default (0) group. Please refer to the user object documentation for ordering of user object execution within a group.
Default:0
C++ Type:int
Controllable:No
Description:Execution order groups are executed in increasing order (e.g., the lowest number is executed first). Note that negative group numbers may be used to execute groups before the default (0) group. Please refer to the user object documentation for ordering of user object execution within a group.
- force_postauxFalseForces the UserObject to be executed in POSTAUX
Default:False
C++ Type:bool
Controllable:No
Description:Forces the UserObject to be executed in POSTAUX
- force_preauxFalseForces the UserObject to be executed in PREAUX
Default:False
C++ Type:bool
Controllable:No
Description:Forces the UserObject to be executed in PREAUX
- force_preicFalseForces the UserObject to be executed in PREIC during initial setup
Default:False
C++ Type:bool
Controllable:No
Description:Forces the UserObject to be executed in PREIC during initial setup
Execution Scheduling Parameters
- control_tagsAdds user-defined labels for accessing object parameters via control logic.
C++ Type:std::vector<std::string>
Controllable:No
Description:Adds user-defined labels for accessing object parameters via control logic.
- enableTrueSet the enabled status of the MooseObject.
Default:True
C++ Type:bool
Controllable:Yes
Description:Set the enabled status of the MooseObject.
- 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
Controllable:No
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
- 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
Unit:(no unit assumed)
Controllable:No
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.
- use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.
Default:False
C++ Type:bool
Controllable:No
Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.