BoundingBoxParticleInitializer

This initializer performs the same task as PerElementParticleInitializer, however, only particles that exist within the bounding box are created.

Overview

In this initializer, all of the elements that are at least partially contained within the requested bounding box are first collected. Then, the requested number (particles_per_element) of spatial locations are sampled within each element. Finally, all potential particle locations which are within the element but are not within the bounding box are discarded.

commentnote

This method does not give explict control over the number of macro particles per element that will be created. If an entire element is contained within the bounding box, then that element will contain the requested particles per element. On average elements which are partially contained within the bounding box will contain a number of macro particles approximately proportional to the fraction of the elements' volume that is contained within the bounding box.

Example Input Syntax

[UserObjects<<<{"href": "../../syntax/UserObjects/index.html"}>>>]
  [initializer]
    type = BoundingBoxParticleInitializer<<<{"description": "This initializer performs the same task as [PerElementParticleInitializer.md], however, only particles that exist within the bounding box are created.", "href": "BoundingBoxParticleInitializer.html"}>>>
    # values are chosen to ensure the bounding box cuts elements
    # in some interesting ways
    bottom_left<<<{"description": "The bottom left corner of the bounding box"}>>> = '1.1 3.6 2.6'
    top_right<<<{"description": "The top right corner of the bounding box"}>>> = '4.25 5.7 8.3'
    mass<<<{"description": "The mass of the particles being placed in the mesh"}>>> = 1
    charge<<<{"description": "The charge of the particles being placed in the mesh"}>>> = 1
    number_density<<<{"description": "The number density of particles you want to represent"}>>> = ${charge_density}
    velocity_distributions<<<{"description": "The distribution names to be sampled when initializing the velocity of each particle"}>>> = 'zero zero zero'
  []
[]
(test/tests/userobjects/particle_initializer/bounding_box/elements/1d.i)

Input Parameters

  • bottom_leftThe bottom left corner of the bounding box

    C++ Type:libMesh::Point

    Controllable:No

    Description:The bottom left corner of the bounding box

  • top_rightThe top right corner of the bounding box

    C++ Type:libMesh::Point

    Controllable:No

    Description:The top right corner of the bounding box

  • 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 of particles you want to represent

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:No

    Description:The number density of particles you want to represent

  • particles_per_elementThe number of computational particles that should be placed in each element

    C++ Type:unsigned int

    Controllable:No

    Description:The number of computational particles that should be placed in each element

  • 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

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

References

No citations exist within this document.