PointTransformationAux

Spatial point transformation used for points sent in/out of OpenMC

Description

Displays the $var element = document.getElementById("moose-equation-dc877fb6-ccd1-47de-9c8b-42c50c14de07");katex.render("x", element, {displayMode:false,throwOnError:false});$ , $var element = document.getElementById("moose-equation-621d8537-a0e7-4035-885f-265dc99c6b98");katex.render("y", element, {displayMode:false,throwOnError:false});$ , or $var element = document.getElementById("moose-equation-5d53863c-af24-4d67-97d7-d0d8163668be");katex.render("z", element, {displayMode:false,throwOnError:false});$ coordinates that get mapped to OpenMC. This auxiliary kernel can be used to ensure that the normal, rotation_axis, and rotation_angle parameters on SymmetryPointGenerator apply the desired transformations. In other words, this class displays the transformed spatial coordinates.

Example Input Syntax

As an example, we can visualize the transformed $var element = document.getElementById("moose-equation-01827104-cc81-450c-b973-4639344dea73");katex.render("x", element, {displayMode:false,throwOnError:false});$ , $var element = document.getElementById("moose-equation-cdb6190f-42ed-44a7-a72b-bf86be6504d5");katex.render("y", element, {displayMode:false,throwOnError:false});$ , and $var element = document.getElementById("moose-equation-4f6b7e21-81fd-4d53-8d7f-90cf27ef7b6f");katex.render("z", element, {displayMode:false,throwOnError:false});$ coordinates for a mapping that obeys 1/6th symmetry with a symmetry plane normal of $var element = document.getElementById("moose-equation-6a510dc1-c8cb-4f8f-a8d1-762e7cf84914");katex.render("\\hat{n}=\\hat{y}", element, {displayMode:false,throwOnError:false});$ and a symmetry axis of $var element = document.getElementById("moose-equation-af2ca727-22d1-4be6-acff-36b0c46aa56b");katex.render("\\hat{m}=\\hat{z}", element, {displayMode:false,throwOnError:false});$ with the following.

[AuxKernels<<<{"href": "../../syntax/AuxKernels/index.html"}>>>]
  [x]
    type = PointTransformationAux<<<{"description": "Spatial point transformation used for points sent in/out of OpenMC", "href": "PointTransformationAux.html"}>>>
    variable<<<{"description": "The name of the variable that this object applies to"}>>> = x
    component<<<{"description": "Component to visualize with this auxiliary kernel"}>>> = x
  []
  [y]
    type = PointTransformationAux<<<{"description": "Spatial point transformation used for points sent in/out of OpenMC", "href": "PointTransformationAux.html"}>>>
    variable<<<{"description": "The name of the variable that this object applies to"}>>> = y
    component<<<{"description": "Component to visualize with this auxiliary kernel"}>>> = y
  []
  [z]
    type = PointTransformationAux<<<{"description": "Spatial point transformation used for points sent in/out of OpenMC", "href": "PointTransformationAux.html"}>>>
    variable<<<{"description": "The name of the variable that this object applies to"}>>> = z
    component<<<{"description": "Component to visualize with this auxiliary kernel"}>>> = z
  []
[]

[Problem<<<{"href": "../../syntax/Problem/index.html"}>>>]
  type = OpenMCCellAverageProblem
  symmetry_mapper = sym
[]

[UserObjects<<<{"href": "../../syntax/UserObjects/index.html"}>>>]
  [sym]
    type = SymmetryPointGenerator<<<{"description": "Maps from a point (x, y, z) to a new point that is either mirror-symmetric or rotationally-symmetric from the point.", "href": "../userobjects/SymmetryPointGenerator.html"}>>>
    normal<<<{"description": "Normal of the symmetry plane"}>>> = '0.0 1.0 0.0'
    rotation_axis<<<{"description": "If rotationally symmetric, the axis about which to rotate. If not specified, then the geometry is mirror-symmetric."}>>> = '0.0 0.0 1.0'
    rotation_angle<<<{"description": "If rotationally symmetric, the angle (degrees) from the 'normal' plane through which to rotate to form the symmetric wedge. If not specified, then thegeometry is mirror-symmetric."}>>> = ${fparse 360.0 / 6.0}
  []
[]

Then, the x variable will show the transformed $var element = document.getElementById("moose-equation-cfc7d775-58de-45e7-a20a-f5625a7a5107");katex.render("x", element, {displayMode:false,throwOnError:false});$ coordinate - as shown in Figure 1, the $var element = document.getElementById("moose-equation-4401b02a-8c22-4099-8757-60dd229d3436");katex.render("x", element, {displayMode:false,throwOnError:false});$ coordinate obeys 1/6th symmetry.

Example visualization of the transformed $x$, as viewed looking down the negative $z$ axis

Figure 1: Example visualization of the transformed $var element = document.getElementById("moose-equation-120c5de3-43a6-4e56-b2a4-376e173b2b3a");katex.render("x", element, {displayMode:false,throwOnError:false});$ , as viewed looking down the negative $var element = document.getElementById("moose-equation-638e22b0-007f-4c35-b8ec-5b811c2e0849");katex.render("z", element, {displayMode:false,throwOnError:false});$ axis

The OpenMC model would then need to correspond to the blue 1/6th slice in Figure 2 in order for the applied normal, rotation_axis, and rotation_angle to properly map to the OpenMC domain.

Figure 2: Intended mapping of mesh elements to 1/6th symmetry OpenMC model, the blue slice

Input Parameters

componentComponent to visualize with this auxiliary kernel
C++ Type:MooseEnum
Options:x, y, z
Controllable:No
Description:Component to visualize with this auxiliary kernel
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

Required 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
Options:XFEM_MARK, 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, PRE_DISPLACE
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.

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.
search_methodnearest_node_connected_sidesChoice of search algorithm. All options begin by finding the nearest node in the primary boundary to a query point in the secondary boundary. In the default nearest_node_connected_sides algorithm, primary boundary elements are searched iff that nearest node is one of their nodes. This is fast to determine via a pregenerated node-to-elem map and is robust on conforming meshes. In the optional all_proximate_sides algorithm, primary boundary elements are searched iff they touch that nearest node, even if they are not topologically connected to it. This is more CPU-intensive but is necessary for robustness on any boundary surfaces which has disconnections (such as Flex IGA meshes) or non-conformity (such as hanging nodes in adaptively h-refined meshes).
Default:nearest_node_connected_sides
C++ Type:MooseEnum
Options:nearest_node_connected_sides, all_proximate_sides
Controllable:No
Description:Choice of search algorithm. All options begin by finding the nearest node in the primary boundary to a query point in the secondary boundary. In the default nearest_node_connected_sides algorithm, primary boundary elements are searched iff that nearest node is one of their nodes. This is fast to determine via a pregenerated node-to-elem map and is robust on conforming meshes. In the optional all_proximate_sides algorithm, primary boundary elements are searched iff they touch that nearest node, even if they are not topologically connected to it. This is more CPU-intensive but is necessary for robustness on any boundary surfaces which has disconnections (such as Flex IGA meshes) or non-conformity (such as hanging nodes in adaptively h-refined meshes).
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

(test/tests/symmetry/rotation.i)

[Mesh]
  # using a finer mesh will more clearly show the symmetry plane,
  # but we use coarser here to have a smaller gold file
  [sphere]
    type = FileMeshGenerator
    file = ../neutronics/meshes/sphere.e
    #file = ../../../tutorials/pebbles/sphere_finer.e
  []
  [solid_ids]
    type = SubdomainIDGenerator
    input = sphere
    subdomain_id = '100'
  []
[]

[AuxVariables]
  [x]
    family = MONOMIAL
    order = CONSTANT
  []
  [y]
    family = MONOMIAL
    order = CONSTANT
  []
  [z]
    family = MONOMIAL
    order = CONSTANT
  []
[]

[AuxKernels]
  [x]
    type = PointTransformationAux
    variable = x
    component = x
  []
  [y]
    type = PointTransformationAux
    variable = y
    component = y
  []
  [z]
    type = PointTransformationAux
    variable = z
    component = z
  []
[]

[Problem]
  type = OpenMCCellAverageProblem
  symmetry_mapper = sym
[]

[UserObjects]
  [sym]
    type = SymmetryPointGenerator
    normal = '0.0 1.0 0.0'
    rotation_axis = '0.0 0.0 1.0'
    rotation_angle = ${fparse 360.0 / 6.0}
  []
[]

[Executioner]
  type = Transient
  num_steps = 1
[]

[Outputs]
  exodus = true
[]

(test/tests/symmetry/reflection.i)

[Mesh]
  # using a finer mesh will more clearly show the symmetry plane,
  # but we use coarser here to have a smaller gold file
  [sphere]
    type = FileMeshGenerator
    file = ../neutronics/meshes/sphere.e
  []
  [solid_ids]
    type = SubdomainIDGenerator
    input = sphere
    subdomain_id = '100'
  []
[]

[AuxVariables]
  [x]
    family = MONOMIAL
    order = CONSTANT
  []
  [y]
    family = MONOMIAL
    order = CONSTANT
  []
  [z]
    family = MONOMIAL
    order = CONSTANT
  []
[]

[AuxKernels]
  [x]
    type = PointTransformationAux
    variable = x
    component = x
  []
  [y]
    type = PointTransformationAux
    variable = y
    component = y
  []
  [z]
    type = PointTransformationAux
    variable = z
    component = z
  []
[]

[Problem]
  type = OpenMCCellAverageProblem
  symmetry_mapper = sym
[]

[UserObjects]
  [sym]
    type = SymmetryPointGenerator
    normal = '1.0 1.0 1.0'
  []
[]

[Executioner]
  type = Transient
  num_steps = 1
[]

[Outputs]
  exodus = true
[]

(test/tests/symmetry/rotation.i)

[Mesh]
  # using a finer mesh will more clearly show the symmetry plane,
  # but we use coarser here to have a smaller gold file
  [sphere]
    type = FileMeshGenerator
    file = ../neutronics/meshes/sphere.e
    #file = ../../../tutorials/pebbles/sphere_finer.e
  []
  [solid_ids]
    type = SubdomainIDGenerator
    input = sphere
    subdomain_id = '100'
  []
[]

[AuxVariables]
  [x]
    family = MONOMIAL
    order = CONSTANT
  []
  [y]
    family = MONOMIAL
    order = CONSTANT
  []
  [z]
    family = MONOMIAL
    order = CONSTANT
  []
[]

[AuxKernels]
  [x]
    type = PointTransformationAux
    variable = x
    component = x
  []
  [y]
    type = PointTransformationAux
    variable = y
    component = y
  []
  [z]
    type = PointTransformationAux
    variable = z
    component = z
  []
[]

[Problem]
  type = OpenMCCellAverageProblem
  symmetry_mapper = sym
[]

[UserObjects]
  [sym]
    type = SymmetryPointGenerator
    normal = '0.0 1.0 0.0'
    rotation_axis = '0.0 0.0 1.0'
    rotation_angle = ${fparse 360.0 / 6.0}
  []
[]

[Executioner]
  type = Transient
  num_steps = 1
[]

[Outputs]
  exodus = true
[]

Description
Example Input Syntax
Input Parameters
Input Files