- meshThe name of the mesh file (must be xda or exodusII file).
C++ Type:MeshFileName
Description:The name of the mesh file (must be xda or exodusII file).
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
- scale1 1 1 Scale factor for points in the simulation
Default:1 1 1
C++ Type:std::vector
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
Description:Scale multiplying factor for points in the simulation
- rotation1_vector0 0 1Vector about which to rotate points of the simulation.
Default:0 0 1
C++ Type:libMesh::VectorValue
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
Description:Anticlockwise rotation angle (in degrees) to use for rotation about rotation1_vector.
- 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
Description:Index of the single timestep used or "LATEST" for the last timestep (exodusII only). If not supplied, time interpolation will occur.
- 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
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.
- systemnl0The name of the system to pull values out of (xda only).
Default:nl0
C++ Type:std::string
Description:The name of the system to pull values out of (xda only).
- system_variablesThe name of the nodal and elemental variables from the file you want to use for values
C++ Type:std::vector
Description:The name of the nodal and elemental variables from the file you want to use for values
- rotation0_angle0Anticlockwise rotation angle (in degrees) to use for rotation about rotation0_vector.
Default:0
C++ Type:double
Description:Anticlockwise rotation angle (in degrees) to use for rotation about rotation0_vector.
- 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
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.
- translation0 0 0 Translation factors for x,y,z coordinates of the simulation
Default:0 0 0
C++ Type:std::vector
Description:Translation factors for x,y,z coordinates of the simulation
- rotation0_vector0 0 1Vector about which to rotate points of the simulation.
Default:0 0 1
C++ Type:libMesh::VectorValue
Description:Vector about which to rotate points of the simulation.
- es
The name of the file holding the equation system info in xda format (xda only). Default:
C++ Type:FileName
Description:The name of the file holding the equation system info in xda format (xda only).
Optional Parameters
- control_tagsAdds user-defined labels for accessing object parameters via control logic.
C++ Type:std::vector
Description:Adds user-defined labels for accessing object parameters via control logic.
- enableTrueSet the enabled status of the MooseObject.
Default:True
C++ Type:bool
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
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
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.
- force_preauxFalseForces the GeneralUserObject to be executed in PREAUX
Default:False
C++ Type:bool
Description:Forces the GeneralUserObject to be executed in PREAUX