SolutionFunction

Function for reading a solution from file.

The solution is a variable in the file but the SolutionFunction makes it available as a function. The SolutionUserObject specified as the solution parameter is used to compute the variable values.

commentnote

The accuracy on the evaluation of this variable in various locations may be diminished by the solution file format. Exodus for example does not store higher order variables accurately.

Example input syntax

In this input file, we load in u_xda_func a reference solution for the problem, previously computed and stored in aux_nonlinear_solution_out_0001.xda, then compare it to the current solution u.

[Functions<<<{"href": "../../syntax/Functions/index.html"}>>>]
  [./u_xda_func]
    type = SolutionFunction<<<{"description": "Function for reading a solution from file.", "href": "SolutionFunction.html"}>>>
    solution<<<{"description": "The SolutionUserObject to extract data from."}>>> = xda_u
  [../]
[]

[UserObjects<<<{"href": "../../syntax/UserObjects/index.html"}>>>]
  [./xda_u]
    type = SolutionUserObject<<<{"description": "Reads a variable from a mesh in one simulation to another", "href": "../userobjects/SolutionUserObject.html"}>>>
    system<<<{"description": "The name of the system to pull values out of (xda/xdr only). The default name for the nonlinear system is 'nl0', auxiliary system is 'aux0'"}>>> = nl0
    mesh<<<{"description": "The name of the mesh file (must be xda/xdr or exodusII file)."}>>> = aux_nonlinear_solution_out_0001_mesh.xda
    es<<<{"description": "The name of the file holding the equation system info in xda/xdr format (xda/xdr only)."}>>> = aux_nonlinear_solution_out_0001.xda
    system_variables<<<{"description": "The name of the nodal and elemental variables from the file you want to use for values"}>>> = u
    execute_on<<<{"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."}>>> = initial
  [../]
[]

[Postprocessors<<<{"href": "../../syntax/Postprocessors/index.html"}>>>]
  [./unorm]
    type = ElementL2Norm<<<{"description": "Computes a volume integral of the specified variable", "href": "../postprocessors/ElementL2Norm.html"}>>>
    variable<<<{"description": "The name of the variable that this object operates on"}>>> = u
  [../]
  [./uerror]
    type = ElementL2Error<<<{"description": "Computes L2 error between a field variable and an analytical function", "href": "../postprocessors/ElementL2Error.html"}>>>
    variable<<<{"description": "The name of the variable that this object operates on"}>>> = u
    function<<<{"description": "The analytic solution to compare against"}>>> = u_xda_func
  [../]
[]
(moose/test/tests/auxkernels/solution_aux/thread_xda.i)

Input Parameters

  • solutionThe SolutionUserObject to extract data from.

    C++ Type:UserObjectName

    Controllable:No

    Description:The SolutionUserObject to extract data from.

Required Parameters

  • add_factor0Add this value (b) to the solution (x): ax+b, where a is the 'scale_factor'

    Default:0

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:No

    Description:Add this value (b) to the solution (x): ax+b, where a is the 'scale_factor'

  • from_variableThe name of the variable in the file that is to be extracted

    C++ Type:std::string

    Controllable:No

    Description:The name of the variable in the file that is to be extracted

  • scale_factor1Scale factor (a) to be applied to the solution (x): ax+b, where b is the 'add_factor'

    Default:1

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:No

    Description:Scale factor (a) to be applied to the solution (x): ax+b, where b is the 'add_factor'

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:No

    Description:Set the enabled status of the MooseObject.

Advanced Parameters