CartesianGridPositions

Create positions along a Cartesian grid.

Certain pins may be excluded using the "pattern" and "include_in_pattern" parameter. The last two CartesianGridPositions objects created in the following snippet display this feature by only including the '1' position in the pattern.

[Positions<<<{"href": "../../syntax/Positions/index.html"}>>>]
  # active = 'cart_grid'
  [cart_grid]
    type = CartesianGridPositions<<<{"description": "Create positions along a Cartesian grid.", "href": "CartesianGridPositions.html"}>>>
    center<<<{"description": "Center of the Cartesian grid"}>>> = '0 0 0'
    nx<<<{"description": "Number of points in the X direction"}>>> = 3
    ny<<<{"description": "Number of points in the Y direction"}>>> = 2
    nz<<<{"description": "Number of points in the Z direction"}>>> = 1
    dx<<<{"description": "Lattice extent in the X direction"}>>> = 10
    dy<<<{"description": "Lattice extent in the Y direction"}>>> = 4
    dz<<<{"description": "Lattice extent in the Z direction"}>>> = 2
    outputs<<<{"description": "Vector of output names where you would like to restrict the output of variables(s) associated with this object"}>>> = 'out'
  []
  [cart_grid_exclusions_2D]
    type = CartesianGridPositions<<<{"description": "Create positions along a Cartesian grid.", "href": "CartesianGridPositions.html"}>>>
    center<<<{"description": "Center of the Cartesian grid"}>>> = '100 100 0'
    nx<<<{"description": "Number of points in the X direction"}>>> = 3
    ny<<<{"description": "Number of points in the Y direction"}>>> = 2
    nz<<<{"description": "Number of points in the Z direction"}>>> = 1
    dx<<<{"description": "Lattice extent in the X direction"}>>> = 10
    dy<<<{"description": "Lattice extent in the Y direction"}>>> = 4
    dz<<<{"description": "Lattice extent in the Z direction"}>>> = 2
    pattern<<<{"description": "A double-indexed Cartesian-shaped array starting with the upper-left corner."}>>> = '1 1 1;
               2 1 1'
    include_in_pattern<<<{"description": "A vector of the numbers in the pattern to include"}>>> = '1'
    outputs<<<{"description": "Vector of output names where you would like to restrict the output of variables(s) associated with this object"}>>> = 'out'
  []
  [cart_grid_exclusions_3D]
    type = CartesianGridPositions<<<{"description": "Create positions along a Cartesian grid.", "href": "CartesianGridPositions.html"}>>>
    center<<<{"description": "Center of the Cartesian grid"}>>> = '100 100 0'
    nx<<<{"description": "Number of points in the X direction"}>>> = 3
    ny<<<{"description": "Number of points in the Y direction"}>>> = 2
    nz<<<{"description": "Number of points in the Z direction"}>>> = 2
    dx<<<{"description": "Lattice extent in the X direction"}>>> = 10
    dy<<<{"description": "Lattice extent in the Y direction"}>>> = 4
    dz<<<{"description": "Lattice extent in the Z direction"}>>> = 2
    pattern<<<{"description": "A double-indexed Cartesian-shaped array starting with the upper-left corner."}>>> = '1 1 1;
               2 1 1|
               10 1 0;
               1 1 0'
    include_in_pattern<<<{"description": "A vector of the numbers in the pattern to include"}>>> = '1'
    outputs<<<{"description": "Vector of output names where you would like to restrict the output of variables(s) associated with this object"}>>> = 'out'
  []
[]

Input Parameters

centerCenter of the Cartesian grid
C++ Type:libMesh::Point
Controllable:No
Description:Center of the Cartesian grid
dxLattice extent in the X direction
C++ Type:double
Unit:(no unit assumed)
Controllable:No
Description:Lattice extent in the X direction
dyLattice extent in the Y direction
C++ Type:double
Unit:(no unit assumed)
Controllable:No
Description:Lattice extent in the Y direction
dzLattice extent in the Z direction
C++ Type:double
Unit:(no unit assumed)
Controllable:No
Description:Lattice extent in the Z direction
nxNumber of points in the X direction
C++ Type:unsigned int
Controllable:No
Description:Number of points in the X direction
nyNumber of points in the Y direction
C++ Type:unsigned int
Controllable:No
Description:Number of points in the Y direction
nzNumber of points in the Z direction
C++ Type:unsigned int
Controllable:No
Description:Number of points in the Z direction

Required Parameters

include_in_patternA vector of the numbers in the pattern to include
C++ Type:std::vector<unsigned int>
Controllable:No
Description:A vector of the numbers in the pattern to include
initial_positionsPositions at the beginning of the simulation
C++ Type:PositionsName
Controllable:No
Description:Positions at the beginning of the simulation
patternA double-indexed Cartesian-shaped array starting with the upper-left corner.
C++ Type:std::vector<std::vector<std::vector<unsigned int, std::allocator<unsigned int>>>>
Controllable:No
Description:A double-indexed Cartesian-shaped array starting with the upper-left corner.

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_onNONEThe 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:NONE
C++ Type:ExecFlagEnum
Options:XFEM_MARK, FORWARD, ADJOINT, HOMOGENEOUS_FORWARD, ADJOINT_TIMESTEP_BEGIN, ADJOINT_TIMESTEP_END, 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

auto_broadcastFalseWether Positions should be broadcasted across all ranks
Default:False
C++ Type:bool
Controllable:No
Description:Wether Positions should be broadcasted across all ranks
auto_sortFalseWhether Positions should be sorted by coordinates
Default:False
C++ Type:bool
Controllable:No
Description:Whether Positions should be sorted by coordinates
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.
outputsVector of output names where you would like to restrict the output of variables(s) associated with this object
C++ Type:std::vector<OutputName>
Controllable:No
Description:Vector of output names where you would like to restrict the output of variables(s) associated with this object
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

(modules/reactor/test/tests/positions/cartesian_grid_positions.i)

(modules/reactor/test/tests/positions/cartesian_grid_positions.i)

[Mesh]
  [cmg]
    type = CartesianMeshGenerator
    dx = 1
    dim = 1
  []
[]

[Positions]
  # active = 'cart_grid'
  [cart_grid]
    type = CartesianGridPositions
    center = '0 0 0'
    nx = 3
    ny = 2
    nz = 1
    dx = 10
    dy = 4
    dz = 2
    outputs = 'out'
  []
  [cart_grid_exclusions_2D]
    type = CartesianGridPositions
    center = '100 100 0'
    nx = 3
    ny = 2
    nz = 1
    dx = 10
    dy = 4
    dz = 2
    pattern = '1 1 1;
               2 1 1'
    include_in_pattern = '1'
    outputs = 'out'
  []
  [cart_grid_exclusions_3D]
    type = CartesianGridPositions
    center = '100 100 0'
    nx = 3
    ny = 2
    nz = 2
    dx = 10
    dy = 4
    dz = 2
    pattern = '1 1 1;
               2 1 1|
               10 1 0;
               1 1 0'
    include_in_pattern = '1'
    outputs = 'out'
  []
[]

[Problem]
  solve = false
[]

[Executioner]
  type = Steady
[]

[Outputs]
  [out]
    type = JSON
    execute_on = FINAL
    execute_system_information_on = none
  []
[]

(modules/reactor/test/tests/positions/cartesian_grid_positions.i)

[Mesh]
  [cmg]
    type = CartesianMeshGenerator
    dx = 1
    dim = 1
  []
[]

[Positions]
  # active = 'cart_grid'
  [cart_grid]
    type = CartesianGridPositions
    center = '0 0 0'
    nx = 3
    ny = 2
    nz = 1
    dx = 10
    dy = 4
    dz = 2
    outputs = 'out'
  []
  [cart_grid_exclusions_2D]
    type = CartesianGridPositions
    center = '100 100 0'
    nx = 3
    ny = 2
    nz = 1
    dx = 10
    dy = 4
    dz = 2
    pattern = '1 1 1;
               2 1 1'
    include_in_pattern = '1'
    outputs = 'out'
  []
  [cart_grid_exclusions_3D]
    type = CartesianGridPositions
    center = '100 100 0'
    nx = 3
    ny = 2
    nz = 2
    dx = 10
    dy = 4
    dz = 2
    pattern = '1 1 1;
               2 1 1|
               10 1 0;
               1 1 0'
    include_in_pattern = '1'
    outputs = 'out'
  []
[]

[Problem]
  solve = false
[]

[Executioner]
  type = Steady
[]

[Outputs]
  [out]
    type = JSON
    execute_on = FINAL
    execute_system_information_on = none
  []
[]

Input Parameters
Input Files