- nxNumber of bins in x direction
C++ Type:unsigned int
Controllable:No
Description:Number of bins in x direction
- nyNumber of bins in y direction
C++ Type:unsigned int
Controllable:No
Description:Number of bins in y direction
- nzNumber of bins in z direction
C++ Type:unsigned int
Controllable:No
Description:Number of bins in z direction
- variableThe name of the variable that this object applies to
C++ Type:AuxVariableName
Unit:(no unit assumed)
Controllable:No
Description:The name of the variable that this object applies to
CartesianGrid
Indices to divide space into 3-D Cartesian bins
Description
Subdivide the mesh into a 3-D Cartesian grid, and assign each bin index to an auxiliary variable. This can be used, in place of a temperature/density distribution, to control how the on-the-fly skinning is imposed on DAGMC models.
Example Input Syntax
As an example, the syntax below subdivides a mesh into a 4x4x4 grid.
[AuxKernels<<<{"href": "../../syntax/AuxKernels/index.html"}>>>]
[g]
type = CartesianGrid<<<{"description": "Indices to divide space into 3-D Cartesian bins", "href": "CartesianGrid.html"}>>>
variable<<<{"description": "The name of the variable that this object applies to"}>>> = g
nx<<<{"description": "Number of bins in x direction"}>>> = 4
ny<<<{"description": "Number of bins in y direction"}>>> = 4
nz<<<{"description": "Number of bins in z direction"}>>> = 4
[]
[]Input Parameters
- blockThe list of blocks (ids or names) that this object will be applied
C++ Type:std::vector<SubdomainName>
Controllable:No
Description:The list of blocks (ids or names) that this object will be applied
- boundaryThe list of boundaries (ids or names) from the mesh where this object applies
C++ Type:std::vector<BoundaryName>
Controllable:No
Description:The list of boundaries (ids or names) from the mesh where this object applies
- check_boundary_restrictedTrueWhether to check for multiple element sides on the boundary in the case of a boundary restricted, element aux variable. Setting this to false will allow contribution to a single element's elemental value(s) from multiple boundary sides on the same element (example: when the restricted boundary exists on two or more sides of an element, such as at a corner of a mesh
Default:True
C++ Type:bool
Controllable:No
Description:Whether to check for multiple element sides on the boundary in the case of a boundary restricted, element aux variable. Setting this to false will allow contribution to a single element's elemental value(s) from multiple boundary sides on the same element (example: when the restricted boundary exists on two or more sides of an element, such as at a corner of a mesh
- execute_onLINEAR TIMESTEP_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:LINEAR 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.
- shift0Optional shift to add to bin value
Default:0
C++ Type:double
Unit:(no unit assumed)
Controllable:No
Description:Optional shift to add to bin value
Optional 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.
- seed0The seed for the master random number generator
Default:0
C++ Type:unsigned int
Controllable:No
Description:The seed for the master random number generator
- 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/sam_coupling/sam_sub/cardinal_master.i)
- (test/tests/bison_coupling/bison_master/cardinal_sub.i)
- (test/tests/sam_coupling/sam_master/cardinal_sub.i)
- (test/tests/bison_coupling/bison_sub/cardinal.i)
- (test/tests/sockeye_coupling/sockeye_sub/cardinal_master.i)
- (test/tests/auxkernels/cartesian_grid/grid.i)
- (test/tests/sockeye_coupling/sockeye_master/cardinal_sub.i)