FunctorAutoNuclideMaterial

buildconstruction:Undocumented Class

The FunctorAutoNuclideMaterial 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.

This material provides parameters for isotope mass transport problems. It should not be exposed to the user, but should be automatically generated using a radionuclide system action.

Overview

Example Input File Syntax

Input Parameters

  • dynamic_viscosityThe dynamic viscosity of the bulk fluid ($g/(cm s)$). A functor is any of the following: a variable, a functor material property, a function, a post-processor, or a number.

    C++ Type:MooseFunctorName

    Unit:(no unit assumed)

    Controllable:No

    Description:The dynamic viscosity of the bulk fluid ($g/(cm s)$). A functor is any of the following: a variable, a functor material property, a function, a post-processor, or a number.

  • isotope_nameThe name of the isotope variable.

    C++ Type:NonlinearVariableName

    Unit:(no unit assumed)

    Controllable:No

    Description:The name of the isotope variable.

  • radiiThe radius of the particles the field represents (cm).

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:No

    Description:The radius of the particles the field represents (cm).

  • schemeThe discretization and stabilization scheme that the nuclide system should use.

    C++ Type:MooseEnum

    Options:supg_fe, fv

    Controllable:No

    Description:The discretization and stabilization scheme that the nuclide system should use.

  • temperatureThe temperature of the bulk fluid ($K$). A functor is any of the following: a variable, a functor material property, a function, a post-processor, or a number.

    C++ Type:MooseFunctorName

    Unit:(no unit assumed)

    Controllable:No

    Description:The temperature of the bulk fluid ($K$). A functor is any of the following: a variable, a functor material property, a function, a post-processor, or a number.

  • turbulence_handlingThe type of diffusion coefficient to use.

    C++ Type:MooseEnum

    Options:none, mixing-length

    Controllable:No

    Description:The type of diffusion coefficient to use.

Required Parameters

  • blockThe list of blocks (ids or names) that this object will be applied

    C++ Type:std::vector<SubdomainName>

    Controllable:No

    Description:The list of blocks (ids or names) that this object will be applied

  • declare_suffixAn optional suffix parameter that can be appended to any declared 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 declared properties. The suffix will be prepended with a '_' character.

  • execute_onLINEARThe 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:LINEAR

    C++ Type:ExecFlagEnum

    Options:NONE, INITIAL, LINEAR, NONLINEAR_CONVERGENCE, NONLINEAR, POSTCHECK, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, CUSTOM

    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.

  • ghost_layers2The number of layers of elements to ghost.

    Default:2

    C++ Type:unsigned short

    Controllable:No

    Description:The number of layers of elements to ghost.

  • mixing_lengthThe turbulent mixing length. A functor is any of the following: a variable, a functor material property, a function, a post-processor, or a number.

    C++ Type:MooseFunctorName

    Unit:(no unit assumed)

    Controllable:No

    Description:The turbulent mixing length. A functor is any of the following: a variable, a functor material property, a function, a post-processor, or a number.

  • schmidt_number0.7The turbulent Schmidt number that relates the turbulent scalar diffusivity to the turbulent momentum diffusivity.

    Default:0.7

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:No

    Description:The turbulent Schmidt number that relates the turbulent scalar diffusivity to the turbulent momentum diffusivity.

  • uThe velocity in the x direction ($cm/s$). A functor is any of the following: a variable, a functor material property, a function, a post-processor, or a number.

    C++ Type:MooseFunctorName

    Unit:(no unit assumed)

    Controllable:No

    Description:The velocity in the x direction ($cm/s$). A functor is any of the following: a variable, a functor material property, a function, a post-processor, or a number.

  • vThe velocity in the y direction ($cm/s$). A functor is any of the following: a variable, a functor material property, a function, a post-processor, or a number.

    C++ Type:MooseFunctorName

    Unit:(no unit assumed)

    Controllable:No

    Description:The velocity in the y direction ($cm/s$). A functor is any of the following: a variable, a functor material property, a function, a post-processor, or a number.

  • wThe velocity in the z direction ($cm/s$). A functor is any of the following: a variable, a functor material property, a function, a post-processor, or a number.

    C++ Type:MooseFunctorName

    Unit:(no unit assumed)

    Controllable:No

    Description:The velocity in the z direction ($cm/s$). A functor is any of the following: a variable, a functor material property, a function, a post-processor, or a number.

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

  • implicitTrueDetermines whether this object is calculated using an implicit or explicit form

    Default:True

    C++ Type:bool

    Controllable:No

    Description:Determines whether this object is calculated using an implicit or explicit form

  • seed0The seed for the master random number generator

    Default:0

    C++ Type:unsigned int

    Controllable:No

    Description:The seed for the master random number generator

Advanced Parameters

  • output_propertiesList of material properties, from this material, to output (outputs must also be defined to an output type)

    C++ Type:std::vector<std::string>

    Controllable:No

    Description:List of material properties, from this material, to output (outputs must also be defined to an output type)

  • outputsnone Vector of output names where you would like to restrict the output of variables(s) associated with this object

    Default:none

    C++ Type:std::vector<OutputName>

    Controllable:No

    Description:Vector of output names where you would like to restrict the output of variables(s) associated with this object

Outputs Parameters