CartesianGridDivision

Divide the mesh along a Cartesian grid. Numbering increases from bottom to top and from left to right and from back to front. The inner ordering is X, then Y, then Z

The number of mesh divisions/regions is the product of the number of bins in each direction.

Points that lie outside the Cartesian grid may be assigned to the grid outer bins using the "assign_domain_outside_grid_to_border" parameter.

Using a Positions object as the "center_positions" parameter, multiple Cartesian grids can be created around each position computed by that object. The division index of a point is then:

var element = document.getElementById("moose-equation-0dcd8526-b36d-4503-b06d-3bee28d0b08b");katex.render("\\text{division index} = (i - 1) N_{\\text{single division}} + \\text{division index in Cartesian grid centered around position i}", element, {displayMode:true,throwOnError:false});

with $var element = document.getElementById("moose-equation-1ad65913-7df4-4325-8c5b-cd648d7cf937");katex.render("i", element, {displayMode:false,throwOnError:false});$ the index in the Positions object of the position nearest from the point and $var element = document.getElementById("moose-equation-d9ce2e98-3d7a-4db6-8fd5-1f8595676876");katex.render("N_{\\text{single division}}", element, {displayMode:false,throwOnError:false});$ the number of divisions for a single Cartesian grid, based on the X/Y/Z discretization specified.

note

For points lying within the standard tolerance of an internal boundary of the Cartesian grid, this object will output a warning. If you do not mind the indetermination on which bins they belong to but do mind that a warning is output, please reach out to a MOOSE (or any MOOSE app) developer.

Input Parameters

nxNumber of divisions in X
C++ Type:unsigned int
Unit:(no unit assumed)
Controllable:No
Description:Number of divisions in X
nyNumber of divisions in Y
C++ Type:unsigned int
Unit:(no unit assumed)
Controllable:No
Description:Number of divisions in Y
nzNumber of divisions in Z
C++ Type:unsigned int
Unit:(no unit assumed)
Controllable:No
Description:Number of divisions in Z

Required Parameters

assign_domain_outside_grid_to_borderFalseWhether to map the domain outside the grid back to the border of the grid
Default:False
C++ Type:bool
Unit:(no unit assumed)
Controllable:No
Description:Whether to map the domain outside the grid back to the border of the grid
bottom_leftBottom-back-left corner of the grid
C++ Type:libMesh::Point
Unit:(no unit assumed)
Controllable:No
Description:Bottom-back-left corner of the grid
centerCenter of the Cartesian grid
C++ Type:libMesh::Point
Unit:(no unit assumed)
Controllable:No
Description:Center of the Cartesian grid
center_positionsPositions of the centers of divided Cartesian grids
C++ Type:PositionsName
Unit:(no unit assumed)
Controllable:No
Description:Positions of the centers of divided Cartesian grids
top_rightTop-front-right corner of the grid
C++ Type:libMesh::Point
Unit:(no unit assumed)
Controllable:No
Description:Top-front-right corner of the grid
widthsWidths in the X, Y and Z directions
C++ Type:libMesh::Point
Unit:(no unit assumed)
Controllable:No
Description:Widths in the X, Y and Z directions

Optional Parameters

control_tagsAdds user-defined labels for accessing object parameters via control logic.
C++ Type:std::vector<std::string>
Unit:(no unit assumed)
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
Unit:(no unit assumed)
Controllable:No
Description:Set the enabled status of the MooseObject.

Advanced Parameters

Input Parameters