Function Series to Aux

AuxKernel to convert a functional expansion (Functions object, type = FunctionSeries) to an AuxVariable

Description

This AuxKernel expands an FX into the named AuxVariable** before the initial nonlinear solve. It subclasses FunctionAux to perform the actual work. The only differences in FunctionSeriesToAux are: 1) it ensures that the provided Function is a subclass of FunctionSeries 2) it ensures that it is executed at EXEC_TIMESTEP_BEGIN**

Example Input File Syntax

Listing 1: Example use of FunctionSeriesToAux


[AuxKernels]
  [./reconstruct_s_in]
    type = FunctionSeriesToAux
    variable = s_in
    function = FX_Basis_Value_Main
  [../]
[]
(modules/functional_expansion_tools/examples/1D_volumetric_Cartesian/main.i)

Input Parameters

  • functionThe function to use as the value

    C++ Type:FunctionName

    Options:

    Description:The function to use as the value

  • variableThe name of the variable that this object applies to

    C++ Type:AuxVariableName

    Options:

    Description:The name of the variable that this object applies to

Required Parameters

  • 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

  • blockThe list of block ids (SubdomainID) that this object will be applied

    C++ Type:std::vector

    Options:

    Description:The list of block ids (SubdomainID) that this object will be applied

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.

  • 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

Input Files