UniformGridParticleInitializer

Particle initializer that places particles along a line with approximate uniform spacing between particles

warningwarning

This initializer has only been implemented for a one-dimensional domain!

The initializer first computes the total length of the domain and how much of the domain is owned by each process. The total number of particles requested is then divided between the processors, with the division being proportional to the fraction of the total domain each process is responsible for. Each process then calculates the space that should be between each particle based on the total length of the domain. Each process then places particles evenly on its section of the domain using a spacing calculation based on the total length of the domain and the total number of particles requested.

commentnote:Initializer Behaviour

Because this initializer divides the work based on the fraction of the total domain each process should own, there is a possibility that the total number of particles created will not exactly equal the total number of particles requested. Additionally, because the global spacing is used when placing particles there is a potential that particles will not be evenly spaced globally depending on how the mesh is partitioned between processes.

Example Input Syntax

[UserObjects<<<{"href": "../../syntax/UserObjects/index.html"}>>>]
  [initializer]
    type = UniformGridParticleInitializer<<<{"description": "Particle initializer that places particles along a line with approximate uniform spacing between particles", "href": "UniformGridParticleInitializer.html"}>>>
    mass<<<{"description": "The mass of the particles being placed in the mesh"}>>> = ${m}
    charge<<<{"description": "The charge of the particles being placed in the mesh"}>>> = ${q}
    total_particles<<<{"description": "The number of computational particles that should be placed along the line"}>>> = 100
    number_density<<<{"description": "The number density to represent with computational particles"}>>> = ${number_density}
    velocity_distributions<<<{"description": "The distribution names to be sampled when initializing the velocity of each particle"}>>> = 'zero zero zero'
  []
[]
(test/tests/benchmarking/lieberman.i)

Input Parameters

  • velocity_distributionsThe distribution names to be sampled when initializing the velocity of each particle

    C++ Type:std::vector<DistributionName>

    Controllable:No

    Description:The distribution names to be sampled when initializing the velocity of each particle

Required Parameters

  • charge1The charge of the particles being placed in the mesh

    Default:1

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:No

    Description:The charge of the particles being placed in the mesh

  • mass1The mass of the particles being placed in the mesh

    Default:1

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:No

    Description:The mass of the particles being placed in the mesh

  • number_densityThe number density to represent with computational particles

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:No

    Description:The number density to represent with computational particles

  • seed0An additional seed for the random number generators

    Default:0

    C++ Type:unsigned int

    Controllable:No

    Description:An additional seed for the random number generators

  • speciesThe type of particle that is being initialized

    C++ Type:std::string

    Controllable:No

    Description:The type of particle that is being initialized

  • total_particlesThe number of computational particles that should be placed along the line

    C++ Type:unsigned int

    Controllable:No

    Description:The number of computational particles that should be placed along the line

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