FX Boundary Flux UserObject

Generates an Functional Expansion representation for a boundary flux condition using a 'FunctionSeries'-type Function

Description

This UserObject captures the moments of an FX representing the flux at a boundary. It does this via subclassing the templated FXIntegralBaseUserObject with SideIntegralVariableUserObject as the policy parameter. It also requires a diffusivity parameter, which can either be a constant value or the name of a material property.

FXIntegralBaseUserObject also ensures that the provided Function is a subclass of FunctionSeries.

Example Input File Syntax

Listing 1: Example use of FXBoundaryFluxUserObject

[UserObjects]
  [./FX_Flux_UserObject_Main]
    type = FXBoundaryFluxUserObject
    function = FX_Basis_Flux_Main
    variable = m
    boundary = right
    diffusivity = thermal_conductivity
  [../]
[]
(modules/functional_expansion_tools/examples/2D_interface/main.i)

Input Parameters

  • functionThe name of the FunctionSeries "Function" object with which to generate this functional expansion.

    C++ Type:FunctionName

    Options:

    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

    Options:

    Description:The name of the variable that this boundary condition applies to

  • boundaryThe list of boundary IDs from the mesh where this boundary condition applies

    C++ Type:std::vector

    Options:

    Description:The list of boundary IDs from the mesh where this boundary condition applies

  • diffusivityThe name of the material diffusivity property, or raw value, that will be used in the flux computation.

    C++ Type:std::string

    Options:

    Description:The name of the material diffusivity property, or raw value, that will be used in the flux computation.

Required Parameters

  • execute_onTIMESTEP_ENDThe list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, FINAL, CUSTOM.

    Default:TIMESTEP_END

    C++ Type:ExecFlagEnum

    Options:NONE INITIAL LINEAR NONLINEAR TIMESTEP_END TIMESTEP_BEGIN FINAL CUSTOM

    Description:The list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, TIMESTEP_END, TIMESTEP_BEGIN, FINAL, CUSTOM.

  • keep_historyFalseKeep the expansion coefficients from previous solves

    Default:False

    C++ Type:bool

    Options:

    Description:Keep the expansion coefficients from previous solves

  • print_stateFalsePrint the state of the zeroth instance each solve

    Default:False

    C++ Type:bool

    Options:

    Description:Print the state of the zeroth instance each solve

  • print_when_setFalsePrint the array of coefficients when set

    Default:False

    C++ Type:bool

    Options:

    Description:Print the array of coefficients when set

Optional Parameters

  • control_tagsAdds user-defined labels for accessing object parameters via control logic.

    C++ Type:std::vector

    Options:

    Description:Adds user-defined labels for accessing object parameters via control logic.

  • enableTrueSet the enabled status of the MooseObject.

    Default:True

    C++ Type:bool

    Options:

    Description:Set the enabled status of the MooseObject.

  • 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

    Options:

    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).

  • 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

Input Files