- studyThe RayTracingStudy to get results from
C++ Type:UserObjectName
Unit:(no unit assumed)
Controllable:No
Description:The RayTracingStudy to get results from
PerProcessorRayTracingResultsVectorPostprocessor
Accumulates ray tracing results (information about the trace) on a per-processor basis.
This object is particularly useful for quantifying load balance between processors when using the Ray Tracing Module. It pairs well with a VectorPostprocessorVisualizationAux for visualization.
The non-advanced results that are available are as follows:
rays_started: The number of rays started on a processorrays_finished: The number of rays finished (rays that end) on a processorrays_received: The number of rays received on a processorrays_sent: The number of rays sent from a processorintersections: The number of intersections encountered by all rays on a processorgeneration_time: The time spent ingenerateRays()on a processorpropagation_time: The time spent inpropagateRays()on a processorray_pool_created: The number of rays created in the Ray Pool on a processorface_hit: The number of trace hits on faces on a processorvertex_hit: The number of trace hits on vertices on a processoredge_hit: The number of trace hits on edges on a processormoved_through_neighbors: The number of times a trace moves through neighbors on a processorintersection_calls: The number of times a trace has attempted to find an intersection on an element, on a processorvertex_neighbor_builds: The number of times the neighbor map for a vertex has been built on a processorvertex_neighbor_lookups: The number of times the neighbor map for a vertex has been looked up on a processoredge_neighbor_builds: The number of times the neighbor map for an edge has been built on a processoredge_neighbor_lookups: The number of times the neighbor map for an edge has been looked up on a processorpoint_neighbor_builds: The number of times a point neighbor lookup has been performed on a processorfailed_traces: The number of allowed trace failures that have occurred on a processor
Input Parameters
- contains_complete_historyFalseSet this flag to indicate that the values in all vectors declared by this VPP represent a time history (e.g. with each invocation, new values are added and old values are never removed). This changes the output so that only a single file is output and updated with each invocation
Default:False
C++ Type:bool
Unit:(no unit assumed)
Controllable:No
Description:Set this flag to indicate that the values in all vectors declared by this VPP represent a time history (e.g. with each invocation, new values are added and old values are never removed). This changes the output so that only a single file is output and updated with each invocation
- 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
Unit:(no unit assumed)
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.
- parallel_typeREPLICATEDSet how the data is represented within the VectorPostprocessor (VPP); 'distributed' indicates that data within the VPP is distributed and no auto communication is performed, this setting will result in parallel output within the CSV output; 'replicated' indicates that the data within the VPP is correct on processor 0, the data will automatically be broadcast to all processors unless the '_auto_broadcast' param is set to false within the validParams function.
Default:REPLICATED
C++ Type:MooseEnum
Unit:(no unit assumed)
Controllable:No
Description:Set how the data is represented within the VectorPostprocessor (VPP); 'distributed' indicates that data within the VPP is distributed and no auto communication is performed, this setting will result in parallel output within the CSV output; 'replicated' indicates that the data within the VPP is correct on processor 0, the data will automatically be broadcast to all processors unless the '_auto_broadcast' param is set to false within the validParams function.
- 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.
- resultsrays_started rays_traced chunks_traced rays_received buffers_received rays_sent buffers_sent intersections generation_time propagation_time num_probes ray_pool_created receive_ray_pool_created receive_buffer_pool_created send_buffer_pool_created face_hit vertex_hit edge_hit moved_through_neighbors backface_culling_successes backface_culling_failures intersection_calls vertex_neighbor_builds vertex_neighbor_lookups edge_neighbor_builds edge_neighbor_lookups point_neighbor_builds failed_tracesThe selection of results you want reported
Default:rays_started rays_traced chunks_traced rays_received buffers_received rays_sent buffers_sent intersections generation_time propagation_time num_probes ray_pool_created receive_ray_pool_created receive_buffer_pool_created send_buffer_pool_created face_hit vertex_hit edge_hit moved_through_neighbors backface_culling_successes backface_culling_failures intersection_calls vertex_neighbor_builds vertex_neighbor_lookups edge_neighbor_builds edge_neighbor_lookups point_neighbor_builds failed_traces
C++ Type:MultiMooseEnum
Unit:(no unit assumed)
Controllable:No
Description:The selection of results you want reported
- 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
Unit:(no unit assumed)
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.
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
Unit:(no unit assumed)
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).
- 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:Yes
Description:Set the enabled status of the MooseObject.
- 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
Unit:(no unit assumed)
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
Unit:(no unit assumed)
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
Unit:(no unit assumed)
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
Unit:(no unit assumed)
Controllable:No
Description:Forces the UserObject to be executed in PREIC during initial setup
- outputsVector of output names where you would like to restrict the output of variables(s) associated with this object
C++ Type:std::vector<OutputName>
Unit:(no unit assumed)
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
Unit:(no unit assumed)
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.