- 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
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
SimpleStepper
This stepper does not modify the particle velocity; it simply updates the direction and maximum distance based on the current velocity and timestep.
The SimpleStepper is intended to be used when simulating flows where the particles in the system are not subject to any external forces. One example of this is neutral particle simulations. This object sets the particles to trace along its current direction with the maximum distance set by the current velocity and time step.
Example Input Syntax
[UserObjects<<<{"href": "../../syntax/UserObjects/index.html"}>>>]
[stepper]
type = SimpleStepper<<<{"description": "This stepper does not modify the particle velocity; it simply updates the direction and maximum distance based on the current velocity and timestep.", "href": "SimpleStepper.html"}>>>
[]
[velocity_initializer]
type = ConstantVelocityInitializer<<<{"description": "Provides particles with velocities sampled from a user provided list of velocities.", "href": "ConstantVelocityInitializer.html"}>>>
velocities<<<{"description": "The velocites which will be cycled through when initializing particles."}>>> = '0.5 0.1 4.1
-1.34 -1.63 6.3
0.5 0.9 10.8'
[]
[particle_initializer]
type = TestPlacedParticleInitializer
start_points = '1.0 1.0 0.0
9.0 8.0 0.0
4.5 3.3 0.0'
velocity_initializer = 'velocity_initializer'
[]
[study]
type = TestInitializedPICStudy
stepper = stepper
particle_initializer = particle_initializer
use_custom_rayids = false
always_cache_traces = true
data_on_cache_traces = true
execute_on = 'TIMESTEP_BEGIN'
[]
[]Input 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
- (test/tests/userobjects/particle_stepper/simple_stepping/simple_stepping.i)
- (test/tests/utils/auxaccumulator/simple_potential_solve_aux.i)
- (test/tests/userobjects/particle_initializer/uniform_grid/uniform_grid.i)
- (test/tests/utils/auxaccumulator/charge_accumulator_base.i)
- (test/tests/userobjects/particle_quantity_accumulation/number_density_accumulator.i)
- (test/tests/raybcs/reflection_base.i)
- (test/tests/userobjects/particle_initializer/bounding_box/elements/initializer_base.i)
- (test/tests/utils/variable_sampler/variable_sampler.i)
- (test/tests/userobjects/particle_initializer/bounding_box/errors/errors.i)
- (test/tests/userobjects/particle_initializer/per_element/elements/initializer_base.i)
- (test/tests/userobjects/particle_quantity_accumulation/simple_potential_solve.i)
- (test/tests/userobjects/particle_initializer/per_element/errors/errors.i)