SPPARKSUserObject

construction:Undocumented Class

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

Overview

Example Input File Syntax

Input Parameters

double_varsDouble Vars to send to SPPARKS.
C++ Type:std::vector<std::string>
Controllable:No
Description:Double Vars to send to SPPARKS.
fileSPPARKS input file
C++ Type:std::string
Controllable:No
Description:SPPARKS input file
from_dvarIndex into SPPARKS darray. This data will be extracted from SPPARKS.
C++ Type:std::vector<unsigned int>
Controllable:No
Description:Index into SPPARKS darray. This data will be extracted from SPPARKS.
from_ivarIndex into SPPARKS iarray. This data will be extracted from SPPARKS.
C++ Type:std::vector<unsigned int>
Controllable:No
Description:Index into SPPARKS iarray. This data will be extracted from SPPARKS.
init_spparksFalseSet values of SPPARKS variables at time zero.
Default:False
C++ Type:bool
Controllable:No
Description:Set values of SPPARKS variables at time zero.
int_varsInteger Vars to send to SPPARKS.
C++ Type:std::vector<std::string>
Controllable:No
Description:Integer Vars to send to SPPARKS.
one_time_runFalseRun SPPARKS just once at time zero.
Default:False
C++ Type:bool
Controllable:No
Description:Run SPPARKS just once at time zero.
sol_varsDouble solving-for Vars obtained from SPPARKS.
C++ Type:std::vector<std::string>
Controllable:No
Description:Double solving-for Vars obtained from SPPARKS.
spparks_onlyFalseWhether to run SPPARKS independently of MOOSE
Default:False
C++ Type:bool
Controllable:No
Description:Whether to run SPPARKS independently of MOOSE
time_spparks_time_ratio1Ratio of time to SPPARKS time.
Default:1
C++ Type:double
Unit:(no unit assumed)
Controllable:No
Description:Ratio of time to SPPARKS time.
to_dvarIndex into SPPARKS darray. This data will be copied to SPPARKS.
C++ Type:std::vector<unsigned int>
Controllable:No
Description:Index into SPPARKS darray. This data will be copied to SPPARKS.
to_ivarIndex into SPPARKS iarray. This data will be copied to SPPARKS.
C++ Type:std::vector<unsigned int>
Controllable:No
Description:Index into SPPARKS iarray. This data will be copied to SPPARKS.
xmax1Upper X Coordinate of the generated mesh
Default:1
C++ Type:double
Unit:(no unit assumed)
Controllable:No
Description:Upper X Coordinate of the generated mesh
xmin0Lower X Coordinate of the generated mesh
Default:0
C++ Type:double
Unit:(no unit assumed)
Controllable:No
Description:Lower X Coordinate of the generated mesh
ymax1Upper Y Coordinate of the generated mesh
Default:1
C++ Type:double
Unit:(no unit assumed)
Controllable:No
Description:Upper Y Coordinate of the generated mesh
ymin0Lower Y Coordinate of the generated mesh
Default:0
C++ Type:double
Unit:(no unit assumed)
Controllable:No
Description:Lower Y Coordinate of the generated mesh
zmax1Upper Z Coordinate of the generated mesh
Default:1
C++ Type:double
Unit:(no unit assumed)
Controllable:No
Description:Upper Z Coordinate of the generated mesh
zmin0Lower Z Coordinate of the generated mesh
Default:0
C++ Type:double
Unit:(no unit assumed)
Controllable:No
Description:Lower Z Coordinate of the generated mesh

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).
execute_onTIMESTEP_ENDThe 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:TIMESTEP_END
C++ Type:ExecFlagEnum
Options:NONE, INITIAL, LINEAR, LINEAR_CONVERGENCE, NONLINEAR, NONLINEAR_CONVERGENCE, POSTCHECK, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, MULTIAPP_FIXED_POINT_CONVERGENCE, 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.
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

Execution Scheduling 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.
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

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
Unit:(no unit assumed)
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.
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.

Material Property Retrieval Parameters

Input Files

(tests/userobjects/spparks/tofrom_spparks.i)

(tests/userobjects/spparks/tofrom_spparks.i)

[GlobalParams]
  xmin = 0
  ymin = 0
  zmin = 0
  xmax = 8
  ymax = 8
  zmax = 4
[]

[Mesh]
  type = GeneratedMesh
  dim = 3
  nx = 8
  ny = 8
  nz = 4
[]

[Functions]
  [conc]
    type = ParsedFunction
    expression = 0.5
  []
  [linear]
    type = ParsedFunction
    expression = t+7
  []
[]

[Variables]
  [c]
    order = FIRST
    family = LAGRANGE
  []
[]

[ICs]
  [c]
    type = FunctionIC
    function = conc
    variable = c
  []
[]

[Kernels]
  [diff]
    type = Diffusion
    variable = c
  []
  [time]
    type = TimeDerivative
    variable = c
  []
[]

[BCs]
  [Periodic]
    [all]
      auto_direction = 'x y'
    []
  []
[]

[Executioner]
  type = Transient

  #Preconditioned JFNK (default)
  solve_type = 'PJFNK'

  petsc_options_iname = '-pc_type -ksp_grmres_restart -sub_ksp_type -sub_pc_type -pc_asm_overlap'
  petsc_options_value = 'asm      101                 preonly       lu           1'

  l_max_its = 30
  l_tol = 1.0e-3

  nl_max_its = 50
  nl_rel_tol = 1e-8 #1.0e-10
  nl_abs_tol = 1e-10

  num_steps = 1
[]

[Outputs]
  exodus = true
  time_step_interval = 1
  execute_on = 'TIMESTEP_END'
  [console]
    type = Console
    output_linear = true
  []
[]

[UserObjects]
  [spparks]
    type = SPPARKSUserObject
    file = in.rpv.fs
    one_time_run = true
    from_ivar = '1 2'
    from_dvar = 5
    sol_vars = c
    init_spparks = false
    execute_on = 'timestep_end'
    time_spparks_time_ratio = 0.000001
  []
[]

Overview
Example Input File Syntax
Input Parameters
Input Files