SolutionUserObject

Reads a variable from a mesh in one simulation to another

Description

A solution user object reads a variable from a mesh in one simulation to another. In order to use a SolutionUserObject three additional parameters are required, an AuxVariable , a Function and an AuxKernel. The AuxVariable represents the variable to be read by the solution user object. The SolutionUserObject is set up to read the old output file. A SolutionFunction is required to interpolate in time and space the data from the SolutionUserObject. Finally, the Function is required that will query the function and write the value into the AuxVariable.

Example Input Syntax

[UserObjects]
  [./soln]
    type = SolutionUserObject
    mesh = cubesource.e
    system_variables = source_nodal
  [../]
[]

Input Parameters

meshThe name of the mesh file (must be xda/xdr or exodusII file).
C++ Type:MeshFileName
Controllable:No
Description:The name of the mesh file (must be xda/xdr or exodusII file).

Required Parameters

esThe name of the file holding the equation system info in xda/xdr format (xda/xdr only).
Default:
C++ Type:FileName
Controllable:No
Description:The name of the file holding the equation system info in xda/xdr format (xda/xdr only).
execute_onTIMESTEP_ENDThe list of flag(s) indicating when this object should be executed, the available options include NONE, INITIAL, LINEAR, NONLINEAR, POSTCHECK, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, CUSTOM.
Default:TIMESTEP_END
C++ Type:ExecFlagEnum
Options:NONE, INITIAL, LINEAR, 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, the available options include NONE, INITIAL, LINEAR, NONLINEAR, POSTCHECK, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, FINAL, CUSTOM.
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
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.
rotation1_vector0 0 1Vector about which to rotate points of the simulation.
Default:0 0 1
C++ Type:libMesh::VectorValue<double>
Controllable:No
Description:Vector about which to rotate points of the simulation.
systemnl0The 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'
Default:nl0
C++ Type:std::string
Controllable:No
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'
system_variablesThe name of the nodal and elemental variables from the file you want to use for values
C++ Type:std::vector<std::string>
Controllable:No
Description:The name of the nodal and elemental variables from the file you want to use for values
timestepIndex of the single timestep used or "LATEST" for the last timestep (exodusII only). If not supplied, time interpolation will occur.
C++ Type:std::string
Controllable:No
Description:Index of the single timestep used or "LATEST" for the last timestep (exodusII only). If not supplied, time interpolation will occur.
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.

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

rotation0_angle0Anticlockwise rotation angle (in degrees) to use for rotation about rotation0_vector.
Default:0
C++ Type:double
Controllable:No
Description:Anticlockwise rotation angle (in degrees) to use for rotation about rotation0_vector.
rotation0_vector0 0 1Vector about which to rotate points of the simulation.
Default:0 0 1
C++ Type:libMesh::VectorValue<double>
Controllable:No
Description:Vector about which to rotate points of the simulation.
rotation1_angle0Anticlockwise rotation angle (in degrees) to use for rotation about rotation1_vector.
Default:0
C++ Type:double
Controllable:No
Description:Anticlockwise rotation angle (in degrees) to use for rotation about rotation1_vector.
scale1 1 1 Scale factor for points in the simulation
Default:1 1 1
C++ Type:std::vector<double>
Controllable:No
Description:Scale factor for points in the simulation
scale_multiplier1 1 1 Scale multiplying factor for points in the simulation
Default:1 1 1
C++ Type:std::vector<double>
Controllable:No
Description:Scale multiplying factor for points in the simulation
transformation_ordertranslation scaleThe order to perform the operations in. Define R0 to be the rotation matrix encoded by rotation0_vector and rotation0_angle. Similarly for R1. Denote the scale by s, the scale_multiplier by m, and the translation by t. Then, given a point x in the simulation, if transformation_order = 'rotation0 scale_multiplier translation scale rotation1' then form p = R1*(R0*x*m - t)/s. Then the values provided by the SolutionUserObject at point x in the simulation are the variable values at point p in the mesh.
Default:translation scale
C++ Type:MultiMooseEnum
Options:rotation0, translation, scale, rotation1, scale_multiplier
Controllable:No
Description:The order to perform the operations in. Define R0 to be the rotation matrix encoded by rotation0_vector and rotation0_angle. Similarly for R1. Denote the scale by s, the scale_multiplier by m, and the translation by t. Then, given a point x in the simulation, if transformation_order = 'rotation0 scale_multiplier translation scale rotation1' then form p = R1*(R0*x*m - t)/s. Then the values provided by the SolutionUserObject at point x in the simulation are the variable values at point p in the mesh.
translation0 0 0 Translation factors for x,y,z coordinates of the simulation
Default:0 0 0
C++ Type:std::vector<double>
Controllable:No
Description:Translation factors for x,y,z coordinates of the simulation

Coordinate System Transformation Parameters

(moose/test/tests/auxkernels/solution_aux/solution_aux_exodus_interp.i)

[Mesh]
  type = FileMesh
  file = cubesource.e
  # This test uses SolutionUserObject which doesn't work with DistributedMesh.
  parallel_type = replicated
[]

[Variables]
  [./u]
    order = FIRST
    family = LAGRANGE
    initial_condition = 0.0
  [../]
[]

[AuxVariables]
  [./nn]
    order = FIRST
    family = LAGRANGE
  [../]
[]

[Kernels]
  [./diff]
    type = Diffusion
    variable = u
  [../]
[]

[AuxKernels]
  [./nn]
    type = SolutionAux
    variable = nn
    solution = soln
  [../]
[]

[UserObjects]
  [./soln]
    type = SolutionUserObject
    mesh = cubesource.e
    system_variables = source_nodal
  [../]
[]

[BCs]
  [./stuff]
    type = DirichletBC
    variable = u
    boundary = '1 2'
    value = 0.0
  [../]
[]

[Executioner]
  type = Transient

  solve_type = 'NEWTON'
  l_max_its = 800
  nl_rel_tol = 1e-10
  num_steps = 50
  end_time = 5
  dt = 0.5
[]

[Outputs]
  execute_on = 'timestep_end'
  exodus = true
[]