Base class for outputting Ray data in a mesh format, where EDGE2 elems represent the individual Ray segments. More...

#include <RayTracingMeshOutput.h>

Inheritance diagram for RayTracingMeshOutput:

Public Types
typedef DataFileName	DataFileParameterType

Public Member Functions
	RayTracingMeshOutput (const InputParameters &parameters)

virtual std::string	filename () override

void	output () override

void	setFileBase (const std::string &file_base)

void	setFileNumber (unsigned int num)

unsigned int	getFileNumber ()

virtual Real	time () override

virtual Real	timeOld ()

virtual Real	dt ()

virtual Real	dtOld ()

virtual int	timeStep ()

const unsigned int &	interval () const

const MultiMooseEnum &	executeOn () const

bool	isAdvanced ()

virtual const OutputOnWarehouse &	advancedExecuteOn () const

void	allowOutput (bool state)

virtual void	outputStep (const ExecFlagType &type)

const std::set< Real > &	getSyncTimes ()

virtual bool	supportsMaterialPropertyOutput () const

virtual bool	enabled () const

std::shared_ptr< MooseObject >	getSharedPtr ()

std::shared_ptr< const MooseObject >	getSharedPtr () const

bool	isKokkosObject () const

MooseApp &	getMooseApp () const

const std::string &	type () const

const std::string &	name () const

std::string	typeAndName () const

MooseObjectParameterName	uniqueParameterName (const std::string &parameter_name) const

MooseObjectName	uniqueName () const

const InputParameters &	parameters () const

const hit::Node *	getHitNode () const

bool	hasBase () const

const std::string &	getBase () const

const T &	getParam (const std::string &name) const

std::vector< std::pair< T1, T2 > >	getParam (const std::string &param1, const std::string &param2) const

const T *	queryParam (const std::string &name) const

const T &	getRenamedParam (const std::string &old_name, const std::string &new_name) const

T	getCheckedPointerParam (const std::string &name, const std::string &error_string="") const

bool	isParamValid (const std::string &name) const

bool	isParamSetByUser (const std::string &name) const

void	connectControllableParams (const std::string &parameter, const std::string &object_type, const std::string &object_name, const std::string &object_parameter) const

void	paramError (const std::string &param, Args... args) const

void	paramWarning (const std::string &param, Args... args) const

void	paramWarning (const std::string &param, Args... args) const

void	paramInfo (const std::string &param, Args... args) const

std::string	messagePrefix (const bool hit_prefix=true) const

std::string	errorPrefix (const std::string &) const

void	mooseError (Args &&... args) const

void	mooseDocumentedError (const std::string &repo_name, const unsigned int issue_num, Args &&... args) const

void	mooseErrorNonPrefixed (Args &&... args) const

void	mooseWarning (Args &&... args) const

void	mooseWarning (Args &&... args) const

void	mooseWarningNonPrefixed (Args &&... args) const

void	mooseWarningNonPrefixed (Args &&... args) const

void	mooseDeprecated (Args &&... args) const

void	mooseDeprecated (Args &&... args) const

void	mooseDeprecatedNoTrace (Args &&... args) const

void	mooseInfo (Args &&... args) const

void	callMooseError (std::string msg, const bool with_prefix, const hit::Node *node=nullptr, const bool show_trace=true) const

std::string	getDataFileName (const std::string &param) const

std::string	getDataFileNameByName (const std::string &relative_path) const

std::string	getDataFilePath (const std::string &relative_path) const

virtual void	meshChanged ()

virtual void	initialSetup ()

virtual void	timestepSetup ()

virtual void	jacobianSetup ()

virtual void	residualSetup ()

virtual void	subdomainSetup ()

virtual void	customSetup (const ExecFlagType &)

const ExecFlagEnum &	getExecuteOnEnum () const

const Function &	getFunction (const std::string &name) const

const Function &	getFunctionByName (const FunctionName &name) const

bool	hasFunction (const std::string &param_name) const

bool	hasFunctionByName (const FunctionName &name) const

Moose::Kokkos::Function	getKokkosFunction (const std::string &name) const

const T &	getKokkosFunction (const std::string &name) const

Moose::Kokkos::Function	getKokkosFunctionByName (const FunctionName &name) const

const T &	getKokkosFunctionByName (const FunctionName &name) const

bool	hasKokkosFunction (const std::string &param_name) const

bool	hasKokkosFunctionByName (const FunctionName &name) const

bool	isDefaultPostprocessorValue (const std::string &param_name, const unsigned int index=0) const

bool	hasPostprocessor (const std::string &param_name, const unsigned int index=0) const

bool	hasPostprocessorByName (const PostprocessorName &name) const

std::size_t	coupledPostprocessors (const std::string &param_name) const

const PostprocessorName &	getPostprocessorName (const std::string &param_name, const unsigned int index=0) const

const VectorPostprocessorValue &	getVectorPostprocessorValue (const std::string &param_name, const std::string &vector_name) const

const VectorPostprocessorValue &	getVectorPostprocessorValue (const std::string &param_name, const std::string &vector_name, bool needs_broadcast) const

const VectorPostprocessorValue &	getVectorPostprocessorValueByName (const VectorPostprocessorName &name, const std::string &vector_name) const

const VectorPostprocessorValue &	getVectorPostprocessorValueByName (const VectorPostprocessorName &name, const std::string &vector_name, bool needs_broadcast) const

const VectorPostprocessorValue &	getVectorPostprocessorValueOld (const std::string &param_name, const std::string &vector_name) const

const VectorPostprocessorValue &	getVectorPostprocessorValueOld (const std::string &param_name, const std::string &vector_name, bool needs_broadcast) const

const VectorPostprocessorValue &	getVectorPostprocessorValueOldByName (const VectorPostprocessorName &name, const std::string &vector_name) const

const VectorPostprocessorValue &	getVectorPostprocessorValueOldByName (const VectorPostprocessorName &name, const std::string &vector_name, bool needs_broadcast) const

const ScatterVectorPostprocessorValue &	getScatterVectorPostprocessorValue (const std::string &param_name, const std::string &vector_name) const

const ScatterVectorPostprocessorValue &	getScatterVectorPostprocessorValueByName (const VectorPostprocessorName &name, const std::string &vector_name) const

const ScatterVectorPostprocessorValue &	getScatterVectorPostprocessorValueOld (const std::string &param_name, const std::string &vector_name) const

const ScatterVectorPostprocessorValue &	getScatterVectorPostprocessorValueOldByName (const VectorPostprocessorName &name, const std::string &vector_name) const

bool	hasVectorPostprocessor (const std::string &param_name, const std::string &vector_name) const

bool	hasVectorPostprocessor (const std::string &param_name) const

bool	hasVectorPostprocessorByName (const VectorPostprocessorName &name, const std::string &vector_name) const

bool	hasVectorPostprocessorByName (const VectorPostprocessorName &name) const

const VectorPostprocessorName &	getVectorPostprocessorName (const std::string &param_name) const

PerfGraph &	perfGraph ()

const PostprocessorValue &	getPostprocessorValue (const std::string &param_name, const unsigned int index=0) const

const PostprocessorValue &	getPostprocessorValue (const std::string &param_name, const unsigned int index=0) const

const PostprocessorValue &	getPostprocessorValueOld (const std::string &param_name, const unsigned int index=0) const

const PostprocessorValue &	getPostprocessorValueOld (const std::string &param_name, const unsigned int index=0) const

const PostprocessorValue &	getPostprocessorValueOlder (const std::string &param_name, const unsigned int index=0) const

const PostprocessorValue &	getPostprocessorValueOlder (const std::string &param_name, const unsigned int index=0) const

virtual const PostprocessorValue &	getPostprocessorValueByName (const PostprocessorName &name) const

virtual const PostprocessorValue &	getPostprocessorValueByName (const PostprocessorName &name) const

const PostprocessorValue &	getPostprocessorValueOldByName (const PostprocessorName &name) const

const PostprocessorValue &	getPostprocessorValueOldByName (const PostprocessorName &name) const

const PostprocessorValue &	getPostprocessorValueOlderByName (const PostprocessorName &name) const

const PostprocessorValue &	getPostprocessorValueOlderByName (const PostprocessorName &name) const

bool	isVectorPostprocessorDistributed (const std::string &param_name) const

bool	isVectorPostprocessorDistributed (const std::string &param_name) const

bool	isVectorPostprocessorDistributedByName (const VectorPostprocessorName &name) const

bool	isVectorPostprocessorDistributedByName (const VectorPostprocessorName &name) const

const Parallel::Communicator &	comm () const

processor_id_type	n_processors () const

processor_id_type	processor_id () const

UserObjectName	getUserObjectName (const std::string &param_name) const

const T &	getUserObject (const std::string &param_name, bool is_dependency=true) const

const T &	getUserObjectByName (const UserObjectName &object_name, bool is_dependency=true) const

const UserObjectBase &	getUserObjectBase (const std::string &param_name, bool is_dependency=true) const

const UserObjectBase &	getUserObjectBaseByName (const UserObjectName &object_name, bool is_dependency=true) const

bool	hasUserObject (const std::string &param_name) const

bool	hasUserObject (const std::string &param_name) const

bool	hasUserObject (const std::string &param_name) const

bool	hasUserObject (const std::string &param_name) const

bool	hasUserObjectByName (const UserObjectName &object_name) const

bool	hasUserObjectByName (const UserObjectName &object_name) const

bool	hasUserObjectByName (const UserObjectName &object_name) const

bool	hasUserObjectByName (const UserObjectName &object_name) const

Static Public Member Functions
static InputParameters	validParams ()

static void	callMooseError (MooseApp const app, const InputParameters &params, std::string msg, const bool with_prefix, const hit::Node node, const bool show_trace=true)

static ExecFlagEnum	getDefaultExecFlagEnum ()

static void	addDeprecatedInputParameters (InputParameters &params)

Public Attributes
	usingCombinedWarningSolutionWarnings

const ConsoleStream	_console

Static Public Attributes
static const std::string	type_param

static const std::string	name_param

static const std::string	unique_name_param

static const std::string	app_param

static const std::string	moose_base_param

static const std::string	kokkos_object_param

Protected Member Functions
virtual void	outputMesh ()=0
	Output the mesh - to be overridden.

virtual std::string	fileExtension () const =0
	Return the file extension.

virtual bool	shouldOutput () override

bool	checkFilename ()

virtual void	setFileBaseInternal (const std::string &file_base)

bool	inNonlinearTimeWindow ()

bool	inLinearTimeWindow ()

virtual Real	getOutputTime ()

virtual bool	onInterval ()

void	setWallTimeIntervalFromCommandLineParam ()

void	flagInvalidSolutionInternal (const InvalidSolutionID invalid_solution_id) const

InvalidSolutionID	registerInvalidSolutionInternal (const std::string &message, const bool warning) const

T &	declareRestartableData (const std::string &data_name, Args &&... args)

ManagedValue< T >	declareManagedRestartableDataWithContext (const std::string &data_name, void *context, Args &&... args)

const T &	getRestartableData (const std::string &data_name) const

T &	declareRestartableDataWithContext (const std::string &data_name, void *context, Args &&... args)

T &	declareRecoverableData (const std::string &data_name, Args &&... args)

T &	declareRestartableDataWithObjectName (const std::string &data_name, const std::string &object_name, Args &&... args)

T &	declareRestartableDataWithObjectNameWithContext (const std::string &data_name, const std::string &object_name, void *context, Args &&... args)

std::string	restartableName (const std::string &data_name) const

virtual void	addPostprocessorDependencyHelper (const PostprocessorName &) const

virtual void	addVectorPostprocessorDependencyHelper (const VectorPostprocessorName &) const

const ReporterContextBase &	getReporterContextBaseByName (const ReporterName &reporter_name) const

const ReporterName &	getReporterName (const std::string &param_name) const

virtual void	addReporterDependencyHelper (const ReporterName &)

PerfID	registerTimedSection (const std::string &section_name, const unsigned int level) const

PerfID	registerTimedSection (const std::string &section_name, const unsigned int level, const std::string &live_message, const bool print_dots=true) const

std::string	timedSectionName (const std::string &section_name) const

const T &	getReporterValue (const std::string &param_name, const std::size_t time_index=0)

const T &	getReporterValue (const std::string &param_name, ReporterMode mode, const std::size_t time_index=0)

const T &	getReporterValue (const std::string &param_name, const std::size_t time_index=0)

const T &	getReporterValue (const std::string &param_name, ReporterMode mode, const std::size_t time_index=0)

const T &	getReporterValueByName (const ReporterName &reporter_name, const std::size_t time_index=0)

const T &	getReporterValueByName (const ReporterName &reporter_name, ReporterMode mode, const std::size_t time_index=0)

const T &	getReporterValueByName (const ReporterName &reporter_name, const std::size_t time_index=0)

const T &	getReporterValueByName (const ReporterName &reporter_name, ReporterMode mode, const std::size_t time_index=0)

bool	hasReporterValue (const std::string &param_name) const

bool	hasReporterValue (const std::string &param_name) const

bool	hasReporterValue (const std::string &param_name) const

bool	hasReporterValue (const std::string &param_name) const

bool	hasReporterValueByName (const ReporterName &reporter_name) const

bool	hasReporterValueByName (const ReporterName &reporter_name) const

bool	hasReporterValueByName (const ReporterName &reporter_name) const

bool	hasReporterValueByName (const ReporterName &reporter_name) const

virtual void	addUserObjectDependencyHelper (const UserObjectBase &) const

Static Protected Member Functions
static PetscErrorCode	petscNonlinearOutput (SNES, PetscInt its, PetscReal fnorm, void *void_ptr)

static PetscErrorCode	petscLinearOutput (KSP, PetscInt its, PetscReal fnorm, void *void_ptr)

Protected Attributes
const RayTracingStudy &	_study
	The RayTracingStudy.

const bool	_output_data
	Whether or not to output all of the Ray's data.

const std::vector< std::string > *const	_output_data_names
	Specific Ray data to output.

const bool	_output_data_nodal
	Whether or not to output the Ray's data in a nodal, linear sense.

const bool	_output_aux_data
	Whether or not to output the Ray's aux data.

const std::vector< std::string > *const	_output_aux_data_names
	Specific Ray Aux data to output.

std::unique_ptr< MeshBase >	_segment_mesh
	The mesh that contains the segments.

std::unique_ptr< libMesh::EquationSystems >	_es
	The EquationSystems.

libMesh::ExplicitSystem *	_sys
	The system that stores the field data.

unsigned int &	_file_num

unsigned int	_padding

std::vector< std::string >	_output_if_base_contains

std::string	_file_base

Real	_norm

PetscInt	_nonlinear_iter

PetscInt	_linear_iter

bool	_on_linear_residual

bool	_on_nonlinear_residual

FEProblemBase *	_problem_ptr

bool	_transient

bool	_use_displaced

libMesh::EquationSystems *	_es_ptr

MooseMesh *	_mesh_ptr

bool	_sequence

ExecFlagEnum	_execute_on

ExecFlagType	_current_execute_flag

Real &	_time

Real &	_time_old

int &	_t_step

Real &	_dt

Real &	_dt_old

unsigned int	_num

const bool	_time_step_interval_set_by_addparam

unsigned int	_time_step_interval

const Real	_min_simulation_time_interval

Real	_wall_time_interval

std::set< Real >	_sync_times

const Times *const	_sync_times_object

Real	_start_time

Real	_end_time

int	_start_step

int	_end_step

Real	_t_tol

bool	_sync_only

bool	_allow_output

bool	_is_advanced

OutputOnWarehouse	_advanced_execute_on

Real &	_last_output_simulation_time

std::chrono::time_point< std::chrono::steady_clock >	_last_output_wall_time

Real	_wall_time_since_last_output

const bool &	_enabled

MooseApp &	_app

Factory &	_factory

ActionFactory &	_action_factory

const std::string &	_type

const std::string &	_name

const InputParameters &	_pars

MooseApp &	_restartable_app

const std::string	_restartable_system_name

const THREAD_ID	_restartable_tid

const bool	_restartable_read_only

FEProblemBase &	_mci_feproblem

const ExecFlagEnum &	_execute_enum

MooseApp &	_pg_moose_app

const std::string	_prefix

PetscOutput *	_petsc_output

const Parallel::Communicator &	_communicator

Private Member Functions
void	buildBoundingBoxes ()
	Build the inflated neighbor bounding boxes stored in _inflated_neighbor_bboxes for the purposes of identifying processors that may contain nodes that we need to decide on ownership for.

void	buildIDMap ()
	Builds a map for each Ray to starting element and node ID for the EDGE2 mesh that will represent said Ray.

void	buildSegmentMesh ()
	Build the mesh that contains the ray tracing segments.

void	setupEquationSystem ()
	Setup the equation system that stores the segment-wise field data.

void	fillFields ()
	Fill the Ray field data.

dof_id_type	neededNodes (const TraceData &trace_data) const
	Gets the number of nodes needed to represent a given trace.

void	startingIDs (const TraceData &trace_data, dof_id_type &start_node_id, dof_id_type &start_elem_id) const
	Gets the starting node and element IDs in the EDGE2 mesh for a given trace.

void	solveSetup () override

RestartableDataValue &	registerRestartableDataOnApp (std::unique_ptr< RestartableDataValue > data, THREAD_ID tid) const

void	registerRestartableNameWithFilterOnApp (const std::string &name, Moose::RESTARTABLE_FILTER filter)

RestartableData< T > &	declareRestartableDataHelper (const std::string &data_name, void *context, Args &&... args) const

const Moose::FunctionBase *	getKokkosFunctionByNameHelper (const FunctionName &name) const

const PostprocessorName &	getPostprocessorNameInternal (const std::string &param_name, const unsigned int index, const bool allow_default_value=true) const

bool	isDefaultPostprocessorValueByName (const PostprocessorName &name) const

PostprocessorValue	getDefaultPostprocessorValueByName (const PostprocessorName &name) const

void	checkParam (const std::string &param_name, const unsigned int index=std::numeric_limits< unsigned int >::max()) const

bool	postprocessorsAdded () const

const VectorPostprocessorValue &	getVectorPostprocessorByNameHelper (const VectorPostprocessorName &name, const std::string &vector_name, bool broadcast, std::size_t t_index) const

const VectorPostprocessorContext< VectorPostprocessorValue > &	getVectorPostprocessorContextByNameHelper (const VectorPostprocessorName &name, const std::string &vector_name) const

bool	vectorPostprocessorsAdded () const

bool	reportersAdded () const

void	possiblyCheckHasReporter (const ReporterName &reporter_name, const std::string &param_name="") const

const PostprocessorValue &	getPostprocessorValueInternal (const std::string &param_name, unsigned int index, std::size_t t_index) const

const PostprocessorValue &	getPostprocessorValueInternal (const std::string &param_name, unsigned int index, std::size_t t_index) const

const PostprocessorValue &	getPostprocessorValueByNameInternal (const PostprocessorName &name, std::size_t t_index) const

const PostprocessorValue &	getPostprocessorValueByNameInternal (const PostprocessorName &name, std::size_t t_index) const

void	possiblyCheckHasVectorPostprocessor (const std::string &param_name, const std::string &vector_name) const

void	possiblyCheckHasVectorPostprocessor (const std::string &param_name, const std::string &vector_name) const

void	possiblyCheckHasVectorPostprocessorByName (const VectorPostprocessorName &name, const std::string &vector_name) const

void	possiblyCheckHasVectorPostprocessorByName (const VectorPostprocessorName &name, const std::string &vector_name) const

const UserObjectBase &	getUserObjectFromFEProblem (const UserObjectName &object_name, const THREAD_ID tid=0) const

const T &	castUserObject (const UserObjectBase &uo_base, const std::string &param_name="") const

void	mooseObjectError (const std::string &param_name, std::stringstream &oss) const

const std::string &	userObjectType (const UserObjectBase &uo) const

const std::string &	userObjectName (const UserObjectBase &uo) const

Static Private Member Functions
static const hit::Node *	getHitNode (const InputParameters &params)

static std::string	messagePrefix (const InputParameters &params, const bool hit_prefix)

Private Attributes
unsigned int	_ray_id_var
	The variable index in _sys for the Ray's ID (if any)

unsigned int	_intersections_var
	The variable index in _sys for the intersection ID (if any)

unsigned int	_pid_var
	The variable index in _sys for the Ray's processor id (if any)

unsigned int	_processor_crossings_var
	The variable index in _sys for the Ray's processor crossings (if any)

unsigned int	_trajectory_changes_var
	The variable index in _sys for the Ray's trajectory changes (if any)

std::vector< std::pair< RayDataIndex, unsigned int > >	_data_vars
	The ray data index -> variable index map.

std::vector< std::pair< RayDataIndex, unsigned int > >	_aux_data_vars
	The ray aux data index -> variable index map.

BoundingBox	_bbox
	The bounding box for this processor.

std::vector< BoundingBox >	_inflated_bboxes
	The inflated bounding boxes for all processors.

std::vector< std::pair< processor_id_type, BoundingBox > >	_inflated_neighbor_bboxes
	Inflated bounding boxes that are neighboring to this processor (pid : bbox for each entry)

std::unordered_map< RayID, std::pair< dof_id_type, dof_id_type > >	_ray_starting_id_map
	The map from RayID to the starting element and node ID of the mesh element for said Ray.

dof_id_type	_max_node_id
	The max node ID for the ray tracing mesh for creating unique elem IDs.

bool	_segmented_rays
	Whether or not we have segmented rays.

Real	_nonlinear_time

Real	_nonlinear_dt

Real	_linear_time

Real	_linear_dt

Real	_nonlinear_dt_divisor

Real	_linear_dt_divisor

Real	_nonlinear_start_time

Real	_linear_start_time

Real	_nonlinear_end_time

Real	_linear_end_time

const ParallelParamObject &	_parent

const MooseBase &	_si_moose_base

const FEProblemBase *	_si_problem

const RestartableDataMapName	_metaname

std::string	_restartable_name

ExecFlagEnum	_empty_execute_enum

const MooseObject &	_fni_object

const InputParameters &	_fni_params

FEProblemBase &	_fni_feproblem

const THREAD_ID	_fni_tid

const MooseObject &	_ppi_moose_object

const InputParameters &	_ppi_params

const FEProblemBase &	_ppi_feproblem

std::map< PostprocessorName, std::unique_ptr< PostprocessorValue > >	_default_values

const bool	_broadcast_by_default

const MooseObject &	_vpi_moose_object

const FEProblemBase &	_vpi_feproblem

const THREAD_ID	_vpi_tid

const InputParameters &	_ri_params

FEProblemBase &	_ri_fe_problem_base

const ReporterData &	_ri_reporter_data

const MooseObject &	_ri_moose_object

const MooseObject &	_uoi_moose_object

const FEProblemBase &	_uoi_feproblem

const THREAD_ID	_uoi_tid

Detailed Description

Base class for outputting Ray data in a mesh format, where EDGE2 elems represent the individual Ray segments.

Definition at line 33 of file RayTracingMeshOutput.h.

Constructor & Destructor Documentation

◆ RayTracingMeshOutput()

RayTracingMeshOutput::RayTracingMeshOutput ( const InputParameters & parameters )

Definition at line 54 of file RayTracingMeshOutput.C.

  : FileOutput(params),
    UserObjectInterface(this),
    _study(getUserObject<RayTracingStudy>("study")),
    _output_data(getParam<bool>("output_data")),
    _output_data_names(isParamValid("output_data_names")
                           ? &getParam<std::vector<std::string>>("output_data_names")
                           : nullptr),
    _output_data_nodal(getParam<bool>("output_data_nodal")),
    _output_aux_data(getParam<bool>("output_aux_data")),
    _output_aux_data_names(isParamValid("output_aux_data_names")
                               ? &getParam<std::vector<std::string>>("output_aux_data_names")
                               : nullptr),
    _ray_id_var(invalid_uint),
    _intersections_var(invalid_uint),
    _pid_var(invalid_uint),
    _processor_crossings_var(invalid_uint),
    _trajectory_changes_var(invalid_uint),
    _segmented_rays(false)
{
  if ((_output_data || _output_data_names) && !_study.dataOnCacheTraces())
    mooseError("In order to output Ray data in output '",
               name(),
               "', the RayTracingStudy '",
               _study.name(),
               "' must set data_on_cache_traces = true");
  if ((_output_aux_data || _output_aux_data_names) && !_study.auxDataOnCacheTraces())
    mooseError("In order to output Ray aux data in output '",
               name(),
               "', the RayTracingStudy '",
               _study.name(),
               "' must set aux_data_on_cache_traces = true");
  if (_output_data_nodal && !_output_data && !_output_data_names)
    paramError("output_data_nodal",
               "Cannot be used unless there is data to output; in addition set either "
               "'output_data' or 'output_data_names");
  if (_output_data_nodal && !_study.segmentsOnCacheTraces())
    paramError("output_data_nodal", "Not supported when study segments_on_cache_traces = false");
  if (_output_data && _output_data_names)
    paramError("output_data", "Cannot be used in addition to 'output_data_names'; choose one");
  if (_output_aux_data && _output_aux_data_names)
    paramError("output_aux_data",
               "Cannot be used in addition to 'output_aux_data_names'; choose one");
}

Member Function Documentation

◆ buildBoundingBoxes()

void RayTracingMeshOutput::buildBoundingBoxes ( )

private

Build the inflated neighbor bounding boxes stored in _inflated_neighbor_bboxes for the purposes of identifying processors that may contain nodes that we need to decide on ownership for.

Definition at line 651 of file RayTracingMeshOutput.C.

{
  TIME_SECTION("buildBoundingBoxes", 3, "Building Bounding Boxes for RayTracing Mesh Output");
 
  // Not used in the one proc case
  if (_communicator.size() == 1)
    return;
 
  // Local bounding box
  _bbox = MeshTools::create_local_bounding_box(_mesh_ptr->getMesh());
 
  // Gather the bounding boxes of all processors
  std::vector<std::pair<Point, Point>> bb_points = {static_cast<std::pair<Point, Point>>(_bbox)};
  _communicator.allgather(bb_points, true);
  _inflated_bboxes.resize(_communicator.size());
  for (processor_id_type pid = 0; pid < _communicator.size(); ++pid)
  {
    BoundingBox pid_bbox = static_cast<BoundingBox>(bb_points[pid]);
    pid_bbox.scale(0.01);
    _inflated_bboxes[pid] = pid_bbox;
  }
 
  // Find intersecting (neighbor) bounding boxes
  _inflated_neighbor_bboxes.clear();
  for (processor_id_type pid = 0; pid < _communicator.size(); ++pid)
    if (pid != processor_id())
    {
      // Insert if the searched processor's bbox intersects my bbox
      const auto & pid_bbox = _inflated_bboxes[pid];
      if (_bbox.intersects(pid_bbox))
        _inflated_neighbor_bboxes.emplace_back(pid, pid_bbox);
    }
}

Referenced by output().

◆ buildIDMap()

void RayTracingMeshOutput::buildIDMap ( )

private

Builds a map for each Ray to starting element and node ID for the EDGE2 mesh that will represent said Ray.

Definition at line 148 of file RayTracingMeshOutput.C.

{
  TIME_SECTION("buildIDMap", 3, "Building RayTracing ID Map");
 
  // Build the maximum number of nodes required to represent each one of my local Rays
  std::map<RayID, dof_id_type> local_ray_needed_nodes;
  for (const auto & trace_data : _study.getCachedTraces())
  {
    const auto find = local_ray_needed_nodes.find(trace_data._ray_id);
    if (find == local_ray_needed_nodes.end())
      local_ray_needed_nodes[trace_data._ray_id] = neededNodes(trace_data);
    else
    {
      auto & value = find->second;
      value = std::max(value, neededNodes(trace_data));
    }
  }
 
  // Fill all of my local Ray maxima to be sent to processor 0
  std::map<processor_id_type, std::vector<std::pair<RayID, dof_id_type>>> send_needed_nodes;
  if (local_ray_needed_nodes.size())
  {
    auto & root_entry = send_needed_nodes[0];
    for (const auto & id_nodes_pair : local_ray_needed_nodes)
      root_entry.emplace_back(id_nodes_pair);
  }
 
  // The global map of ray -> required nodes needed to be filled on processor 0
  std::map<RayID, dof_id_type> global_needed_nodes;
  // Keep track of what Ray IDs we received from what processors so we know who to send back to
  std::unordered_map<processor_id_type, std::set<RayID>> pid_received_ids;
  // Take the required nodes for each Ray and determine on processor 0 the global maximum
  // nodes needed to represent each Ray
  const auto append_global_max =
      [&global_needed_nodes, &pid_received_ids](
          processor_id_type pid, const std::vector<std::pair<RayID, dof_id_type>> & pairs)
  {
    auto & pid_received_entry = pid_received_ids[pid];
    for (const auto & id_max_pair : pairs)
    {
      const RayID ray_id = id_max_pair.first;
      const dof_id_type max = id_max_pair.second;
 
      const auto find = global_needed_nodes.find(ray_id);
      if (find == global_needed_nodes.end())
        global_needed_nodes.emplace(ray_id, max);
      else
      {
        auto & current_max = find->second;
        current_max = std::max(current_max, max);
      }
 
      pid_received_entry.insert(ray_id);
    }
  };
  Parallel::push_parallel_vector_data(comm(), send_needed_nodes, append_global_max);
 
  // Decide on the starting representative starting node and elem ID for each Ray
  std::map<RayID, std::pair<dof_id_type, dof_id_type>> global_ids;
  dof_id_type current_node_id = 0;
  dof_id_type current_elem_id = 0;
  for (auto & pair : global_needed_nodes)
  {
    const RayID ray_id = pair.first;
    const dof_id_type max_nodes = pair.second;
 
    global_ids.emplace(ray_id, std::make_pair(current_node_id, current_elem_id));
 
    current_node_id += max_nodes;
    if (max_nodes > 1)
      current_elem_id += max_nodes - 1;
    else // stationary
      current_elem_id += 1;
  }
 
  // Share the max node IDs so that we have a starting point for unique IDs for elems
  _max_node_id = current_node_id;
  comm().max(_max_node_id);
 
  // Fill the starting ID information to each processor that needs it from processor 0
  std::unordered_map<processor_id_type, std::vector<std::tuple<RayID, dof_id_type, dof_id_type>>>
      send_ids;
  for (auto & pid_ids_pair : pid_received_ids)
  {
    const processor_id_type pid = pid_ids_pair.first;
    const std::set<RayID> & ray_ids = pid_ids_pair.second;
 
    auto & pid_send = send_ids[pid];
    for (const RayID ray_id : ray_ids)
    {
      const auto & global_entry = global_ids.at(ray_id);
      const dof_id_type node_id = global_entry.first;
      const dof_id_type elem_id = global_entry.second;
      pid_send.emplace_back(ray_id, node_id, elem_id);
    }
  }
 
  // Take the starting ID information from processor 0 and store it locally
  const auto append_ids =
      [&](processor_id_type,
          const std::vector<std::tuple<RayID, dof_id_type, dof_id_type>> & tuples)
  {
    for (const auto & tuple : tuples)
    {
      const RayID ray_id = std::get<0>(tuple);
      const dof_id_type node_id = std::get<1>(tuple);
      const dof_id_type elem_id = std::get<2>(tuple);
      _ray_starting_id_map.emplace(ray_id, std::make_pair(node_id, elem_id));
    }
  };
 
  _ray_starting_id_map.clear();
  Parallel::push_parallel_vector_data(comm(), send_ids, append_ids);
}

Referenced by buildSegmentMesh().

◆ buildSegmentMesh()

void RayTracingMeshOutput::buildSegmentMesh ( )

private

Build the mesh that contains the ray tracing segments.

Definition at line 264 of file RayTracingMeshOutput.C.

{
  TIME_SECTION("buildSegmentMesh", 3, "Building RayTracing Mesh Output");
 
  _segmented_rays = false;
 
  // Tally nodes and elems for the local mesh ahead of time so we can reserve
  // Each segment requires an element, and we need one more node than elems
  dof_id_type num_nodes = 0;
  dof_id_type num_elems = 0;
  for (const auto & entry : _study.getCachedTraces())
  {
    const auto num_segments = entry.numSegments();
    num_nodes += num_segments + 1;
    if (num_segments >= 1)
    {
      _segmented_rays = true;
      num_elems += num_segments;
    }
    else if (entry.stationary())
      num_elems += 1;
  }
 
  comm().max(_segmented_rays);
 
  // Build the segment mesh
  mooseAssert(!_segment_mesh, "Not cleared");
  if (_communicator.size() == 1)
    _segment_mesh = std::make_unique<ReplicatedMesh>(_communicator, _mesh_ptr->dimension());
  else
  {
    _segment_mesh = std::make_unique<DistributedMesh>(_communicator, _mesh_ptr->dimension());
    _segment_mesh->set_distributed();
  }
  // We set neighbor links
  _segment_mesh->allow_find_neighbors(false);
  // Don't renumber so that we can remain consistent between processor counts
  _segment_mesh->allow_renumbering(false);
  // As we're building segments for just this partiton, we're partitioning on our own
  _segment_mesh->skip_partitioning(true);
  // Reserve nodes and elems
  _segment_mesh->reserve_nodes(num_nodes);
  _segment_mesh->reserve_elem(num_elems);
 
  buildIDMap();
 
  // Decide on a starting ID for each processor
  // Build a mesh segment for each local Ray segment
  // Each one of these objects represents a single Ray's path through this processor
  for (const auto & trace_data : _study.getCachedTraces())
  {
    // If we have no segments, this is a trace that skimmed the corner of a processor boundary and
    // didn't contribute anything
    if (trace_data.numSegments() == 0 && !trace_data.stationary())
      continue;
 
    dof_id_type node_id, elem_id;
    startingIDs(trace_data, node_id, elem_id);
 
    // Add the start point
    mooseAssert(!_segment_mesh->query_node_ptr(node_id), "Node already exists");
    Node * last_node =
        _segment_mesh->add_point(trace_data._point_data[0]._point, node_id, processor_id());
    last_node->set_unique_id(node_id++);
 
    // Stationary, add a NodeElem
    if (trace_data.stationary())
    {
      mooseAssert(!_segment_mesh->query_elem_ptr(elem_id), "Elem already exists");
      auto elem = _segment_mesh->add_elem(Elem::build_with_id(NODEELEM, elem_id));
      elem->processor_id(processor_id());
      elem->set_unique_id(_max_node_id + elem_id++);
      elem->set_node(0, last_node);
    }
    // Not stationary; add a point and element for each segment
    else
    {
      Elem * last_elem = nullptr;
 
      for (std::size_t i = 1; i < trace_data._point_data.size(); ++i)
      {
        const auto & point = trace_data._point_data[i]._point;
 
        // Add next point on the trace
        mooseAssert(!_segment_mesh->query_node_ptr(node_id), "Node already exists");
        Node * node = _segment_mesh->add_point(point, node_id, processor_id());
        node->set_unique_id(node_id++);
 
        // Build a segment from this point to the last
        mooseAssert(!_segment_mesh->query_elem_ptr(elem_id), "Elem already exists");
        Elem * elem = _segment_mesh->add_elem(Elem::build_with_id(EDGE2, elem_id));
        elem->processor_id(processor_id());
        elem->set_unique_id(_max_node_id + elem_id++);
        elem->set_node(0, last_node);
        elem->set_node(1, node);
 
        // Set neighbor links
        if (last_elem)
        {
          elem->set_neighbor(0, last_elem);
          last_elem->set_neighbor(1, elem);
        }
 
        last_elem = elem;
        last_node = node;
      }
    }
  }
 
  // If the mesh is replicated, everything that follows is unnecessary. Prepare and be done.
  if (_segment_mesh->is_replicated())
  {
    _segment_mesh->prepare_for_use();
    return;
  }
 
  // Find the Nodes on processor boundaries that we need to decide on owners for. Also set up
  // remote_elem links for neighbors we clearly don't have. We don't build the neighbor maps at
  // all, so all we have are nullptr and remote_elem. We can only do all of this after the mesh is
  // built because the mesh isn't necessarily built in the order Rays are traced
  std::vector<Node *> need_node_owners;
  for (const auto & trace_data : _study.getCachedTraces())
  {
    const auto num_segments = trace_data.numSegments();
 
    if (num_segments == 0)
      continue;
 
    dof_id_type start_node_id, start_elem_id;
    startingIDs(trace_data, start_node_id, start_elem_id);
 
    // Another part of the trace for this Ray happened before this one
    if ((_study.segmentsOnCacheTraces() ? trace_data._intersections
                                        : (unsigned long int)(trace_data._processor_crossings +
                                                              trace_data._trajectory_changes)) != 0)
    {
      // The element before start_elem (may be nullptr, meaning it didn't trace on this proc)
      Elem * previous_elem = _segment_mesh->query_elem_ptr(start_elem_id - 1);
 
      // We don't have the previous element segment, so it exists on another processor
      // Set the remote_elem and mark that we need to find out who owns the first node on this
      // trace
      if (!previous_elem)
      {
        Elem * start_elem = _segment_mesh->elem_ptr(start_elem_id);
        start_elem->set_neighbor(0, const_cast<RemoteElem *>(remote_elem));
        start_elem->node_ptr(0)->invalidate_processor_id();
        need_node_owners.push_back(start_elem->node_ptr(0));
      }
    }
 
    // If you have multiple sets of segments on a single processor, it is possible
    // to have part of the trace on another processor within the segments we know about.
    // In this case, we have to do some magic to the neighbor links so that the mesh
    // doesn't fail in assertions.
    if (!trace_data._last)
    {
      // The element after end_elem (may be nullptr, meaning it didn't happen on this proc)
      Elem * next_elem = _segment_mesh->query_elem_ptr(start_elem_id + num_segments);
 
      // We have the next element from another trace, set neighbors as we own both
      if (!next_elem)
      {
        Elem * end_elem = _segment_mesh->elem_ptr(start_elem_id + num_segments - 1);
        end_elem->set_neighbor(1, const_cast<RemoteElem *>(remote_elem));
        end_elem->node_ptr(1)->invalidate_processor_id();
        need_node_owners.push_back(end_elem->node_ptr(1));
      }
    }
  }
 
  // Sort through the neighboring bounding boxes and prepare requests to each processor that /may/
  // also have one of the nodes that we need to decide on an owner for
  std::unordered_map<processor_id_type, std::vector<dof_id_type>> need_node_owners_sends;
  for (const Node * node : need_node_owners)
    for (const auto & neighbor_pid_bbox_pair : _inflated_neighbor_bboxes)
    {
      const auto neighbor_pid = neighbor_pid_bbox_pair.first;
      const auto & neighbor_bbox = neighbor_pid_bbox_pair.second;
      if (neighbor_bbox.contains_point(*node))
        need_node_owners_sends[neighbor_pid].push_back(node->id());
    }
 
  // Functor that takes in a set of incoming node IDs from a processor and decides on an owner.
  // For every node that we need an owner for, this should be called for said node on both
  // processors. Therefore, just pick the minimum processor ID as the owner. This should never
  // happen more than once for a single node because we're building 1D elems and we can only ever
  // have two procs that touch a node.
  std::unordered_map<processor_id_type, std::vector<dof_id_type>> confirm_node_owners_sends;
  auto decide_node_owners_functor =
      [this, &confirm_node_owners_sends](processor_id_type pid,
                                         const std::vector<dof_id_type> & incoming_node_ids)
  {
    auto & confirm_pid = confirm_node_owners_sends[pid];
    for (const auto & node_id : incoming_node_ids)
    {
      Node * node = _segment_mesh->query_node_ptr(node_id);
      if (node)
      {
        mooseAssert(!node->valid_processor_id(), "Should be invalid");
        node->processor_id() = std::min(pid, processor_id());
        confirm_pid.push_back(node_id);
      }
    }
  };
 
  // Ship the nodes that need owners for and pick an owner when we receive
  Parallel::push_parallel_vector_data(
      _communicator, need_node_owners_sends, decide_node_owners_functor);
 
  // At this point, any nodes that we actually need ghosts for should have their processor_ids
  // satisfied. Anything that is left isn't actually ghosted and is ours. Therefore, set
  // everything left that is invalid to be owned by this proc.
  for (Node * node : need_node_owners)
    if (!node->valid_processor_id())
      node->processor_id() = processor_id();
 
  // We're done!
  _segment_mesh->prepare_for_use();
}

Referenced by output().

◆ fileExtension()

virtual std::string RayTracingMeshOutput::fileExtension ( ) const

protectedpure virtual

Return the file extension.

Implemented in RayTracingExodus, and RayTracingNemesis.

Referenced by filename().

◆ filename()

std::string RayTracingMeshOutput::filename ( )

overridevirtual

Reimplemented from FileOutput.

Definition at line 100 of file RayTracingMeshOutput.C.

{
  // Append the file extension on the base file name
  std::ostringstream output;
  output << _file_base << fileExtension();
 
  // Add the _000x extension to the file
  if (_file_num > 0)
    output << "-s" << std::setw(_padding) << std::setprecision(0) << std::setfill('0') << std::right
           << _file_num;
 
  // Return the filename
  return output.str();
}

Referenced by RayTracingExodus::outputMesh(), and RayTracingNemesis::outputMesh().

◆ fillFields()

void RayTracingMeshOutput::fillFields ( )

private

Fill the Ray field data.

Definition at line 572 of file RayTracingMeshOutput.C.

{
  TIME_SECTION("fillFields", 3, "Filling RayTracing MeshOutput Fields");
 
  // Helper for setting the solution (if enabled)
  const auto set_solution =
      [this](const DofObject * const dof, const unsigned int var, const Real value)
  {
    mooseAssert(dof, "Nullptr dof");
    if (var != invalid_uint)
    {
      const auto dof_number = dof->dof_number(_sys->number(), var, 0);
      _sys->solution->set(dof_number, value);
    }
  };
 
  // Helper for filling data and aux data (if enabled)
  const auto fill_data =
      [&set_solution](const DofObject * const dof, const auto & vars, const auto & data)
  {
    mooseAssert(dof, "Nullptr dof");
    for (const auto & [data_index, var_num] : vars)
      set_solution(dof, var_num, data[data_index]);
  };
 
  for (const auto & trace_data : _study.getCachedTraces())
  {
    auto intersection = trace_data._intersections;
 
    // No segments and not stationary; means this ray bounced off
    // this processor and never actually moved on this processor
    if (!trace_data.numSegments() && !trace_data.stationary())
      continue;
 
    dof_id_type node_id, elem_id;
    startingIDs(trace_data, node_id, elem_id);
 
    const Elem * elem = _segment_mesh->elem_ptr(elem_id);
 
    // Fill first node's nodal data if we need it; the loop that follows will handle
    // the rest of the nodes
    if (_output_data_nodal && _study.hasRayData() && !trace_data.stationary())
      fill_data(elem->node_ptr(0), _data_vars, trace_data._point_data[0]._data);
 
    const std::size_t start = trace_data.stationary() ? 0 : 1;
    for (const auto i : make_range(start, trace_data._point_data.size()))
    {
      mooseAssert(elem, "Nullptr elem");
 
      // Elemental ID and pid
      set_solution(elem, _ray_id_var, trace_data._ray_id);
      set_solution(elem, _pid_var, processor_id());
      // Elemental properties that only apply to segments
      if (!trace_data.stationary())
      {
        set_solution(elem, _intersections_var, intersection++);
        set_solution(elem, _processor_crossings_var, trace_data._processor_crossings);
        set_solution(elem, _trajectory_changes_var, trace_data._trajectory_changes);
      }
      const auto & point_data = trace_data._point_data[i];
      // Data fields
      if (_output_data_nodal && !trace_data.stationary())
        fill_data(elem->node_ptr(1), _data_vars, point_data._data);
      else
        fill_data(elem, _data_vars, point_data._data);
      // Aux data fields
      fill_data(elem, _aux_data_vars, point_data._aux_data);
 
      // Advance to the next element
      if (!trace_data.stationary())
        elem = elem->neighbor_ptr(1);
    }
  }
 
  _sys->solution->close();
  _sys->update();
}

Referenced by output().

◆ neededNodes()

dof_id_type RayTracingMeshOutput::neededNodes ( const TraceData & trace_data ) const

private

Gets the number of nodes needed to represent a given trace.

Definition at line 704 of file RayTracingMeshOutput.C.

{
  if (_study.segmentsOnCacheTraces())
    return trace_data._intersections + trace_data._point_data.size();
  return trace_data._processor_crossings + trace_data._trajectory_changes +
         trace_data._point_data.size();
}

Referenced by buildIDMap().

◆ output()

void RayTracingMeshOutput::output ( )

overridevirtual

Implements FileOutput.

Definition at line 116 of file RayTracingMeshOutput.C.

{
  // Do we even have any traces?
  auto num_segments = _study.getCachedTraces().size();
  _communicator.sum(num_segments);
  if (!num_segments)
    mooseError("No cached trace segments were found in the study '", _study.name(), "'.");
 
  // Build the _inflated_neighbor_bboxes
  buildBoundingBoxes();
 
  // Build the _segment_mesh
  buildSegmentMesh();
 
  // Setup the system to store the Ray field data
  setupEquationSystem();
 
  // Fill the field data
  fillFields();
 
  // And output
  outputMesh();
 
  // Done with these
  // We don't necessarily need to create a new mesh every time, but it's easier than
  // checking if the Rays have changed from last time we built a mesh
  _es = nullptr;
  _sys = nullptr;
  _segment_mesh = nullptr;
}

Referenced by filename().

◆ outputMesh()

virtual void RayTracingMeshOutput::outputMesh ( )

protectedpure virtual

Output the mesh - to be overridden.

Implemented in RayTracingExodus, and RayTracingNemesis.

Referenced by output().

◆ setupEquationSystem()

void RayTracingMeshOutput::setupEquationSystem ( )

private

Setup the equation system that stores the segment-wise field data.

Definition at line 486 of file RayTracingMeshOutput.C.

{
  TIME_SECTION("setupEquationSystem", 3, "Setting Up Ray Tracing MeshOutput Equation System");
 
  _es = std::make_unique<EquationSystems>(*_segment_mesh);
  _sys = &_es->add_system<libMesh::ExplicitSystem>("sys");
  _data_vars.clear();
  _aux_data_vars.clear();
 
  // Add variables for the basic properties if enabled
  _ray_id_var = invalid_uint;
  _intersections_var = invalid_uint;
  _pid_var = invalid_uint;
  _processor_crossings_var = invalid_uint;
  _trajectory_changes_var = invalid_uint;
  for (auto & prop : _pars.get<MultiMooseEnum>("output_properties"))
    switch (prop)
    {
      case 0: // ray_id (stationary and segments)
        _ray_id_var = _sys->add_variable("ray_id", CONSTANT, MONOMIAL);
        break;
      case 1: // intersections (segments only)
        if (_segmented_rays)
          _intersections_var = _sys->add_variable("intersections", CONSTANT, MONOMIAL);
        break;
      case 2: // pid (stationary and segments)
        _pid_var = _sys->add_variable("pid", CONSTANT, MONOMIAL);
        break;
      case 3: // processor_crossings (segments only)
        if (_segmented_rays)
          _processor_crossings_var = _sys->add_variable("processor_crossings", CONSTANT, MONOMIAL);
        break;
      case 4: // trajectory_changes (segments only)
        if (_segmented_rays)
          _trajectory_changes_var = _sys->add_variable("trajectory_changes", CONSTANT, MONOMIAL);
        break;
      default:
        mooseError("Invalid property");
    }
 
  const auto get_data_vars = [this](const bool aux)
  {
    // The data index -> variable result
    std::vector<std::pair<RayDataIndex, unsigned int>> vars;
 
    const auto from_names =
        aux ? (_output_aux_data ? &_study.rayAuxDataNames() : _output_aux_data_names)
            : (_output_data ? &_study.rayDataNames() : _output_data_names);
 
    // Nothing to output
    if (!from_names)
      return vars;
 
    const auto output_data_nodal = aux ? false : _output_data_nodal;
 
    for (const auto & name : *from_names)
    {
      const auto data_index =
          aux ? _study.getRayAuxDataIndex(name, true) : _study.getRayDataIndex(name, true);
      if (data_index == Ray::INVALID_RAY_DATA_INDEX)
      {
        const std::string names_param = aux ? "output_aux_data_names" : "output_data_names";
        const std::string data_prefix = aux ? "aux " : "";
        paramError(names_param, "The ray ", data_prefix, "data '", name, "' is not registered");
      }
 
      const std::string var_prefix = aux ? "aux_" : "";
      if (output_data_nodal)
        _sys->add_variable(var_prefix + name, FIRST, LAGRANGE);
      else
        _sys->add_variable(var_prefix + name, CONSTANT, MONOMIAL);
      const auto var_num = _sys->variable_number(var_prefix + name);
      vars.emplace_back(data_index, var_num);
    }
 
    return vars;
  };
 
  _data_vars = get_data_vars(false);
  _aux_data_vars = get_data_vars(true);
 
  // All done
  _es->init();
}

Referenced by output().

◆ startingIDs()

void RayTracingMeshOutput::startingIDs	(	const TraceData &	trace_data,
		dof_id_type &	start_node_id,
		dof_id_type &	start_elem_id
	)		const

private

Gets the starting node and element IDs in the EDGE2 mesh for a given trace.

Definition at line 686 of file RayTracingMeshOutput.C.

{
  const auto [begin_node_id, begin_elem_id] = _ray_starting_id_map.at(trace_data._ray_id);
 
  const auto offset =
      trace_data.stationary()
          ? 1
          : (_study.segmentsOnCacheTraces()
                 ? trace_data._intersections
                 : (trace_data._processor_crossings + trace_data._trajectory_changes));
 
  start_node_id = begin_node_id + offset;
  start_elem_id = begin_elem_id + offset;
}

Referenced by buildSegmentMesh(), and fillFields().

◆ validParams()

InputParameters RayTracingMeshOutput::validParams ( )

static

Definition at line 28 of file RayTracingMeshOutput.C.

{
  InputParameters params = FileOutput::validParams();
 
  params.addRequiredParam<UserObjectName>("study", "The RayTracingStudy to get the segments from");
 
  params.addParam<bool>("output_data", false, "Whether or not to also output the Ray's data");
  params.addParam<std::vector<std::string>>("output_data_names",
                                            "The names of specific data to output");
  params.addParam<bool>("output_data_nodal",
                        false,
                        "Whether or not to output the Ray's data in a nodal sense, in which the "
                        "data is interpolated linearly across segments");
 
  params.addParam<bool>(
      "output_aux_data", false, "Whether or not to also output the Ray's aux data");
  params.addParam<std::vector<std::string>>("output_aux_data_names",
                                            "The names of specific aux data to output");
 
  MultiMooseEnum props("ray_id intersections pid processor_crossings trajectory_changes",
                       "ray_id intersections");
  params.addParam<MultiMooseEnum>("output_properties", props, "Which Ray properties to output");
 
  return params;
}

Referenced by RayTracingExodus::validParams(), and RayTracingNemesis::validParams().

Member Data Documentation

◆ _aux_data_vars

std::vector<std::pair<RayDataIndex, unsigned int> > RayTracingMeshOutput::_aux_data_vars

private

The ray aux data index -> variable index map.

Definition at line 122 of file RayTracingMeshOutput.h.

Referenced by fillFields(), and setupEquationSystem().

◆ _bbox

BoundingBox RayTracingMeshOutput::_bbox

private

The bounding box for this processor.

Definition at line 125 of file RayTracingMeshOutput.h.

Referenced by buildBoundingBoxes().

◆ _data_vars

std::vector<std::pair<RayDataIndex, unsigned int> > RayTracingMeshOutput::_data_vars

private

The ray data index -> variable index map.

Definition at line 120 of file RayTracingMeshOutput.h.

Referenced by fillFields(), and setupEquationSystem().

◆ _es

std::unique_ptr<libMesh::EquationSystems> RayTracingMeshOutput::_es

protected

The EquationSystems.

Definition at line 70 of file RayTracingMeshOutput.h.

Referenced by output(), RayTracingExodus::outputMesh(), RayTracingNemesis::outputMesh(), and setupEquationSystem().

◆ _inflated_bboxes

std::vector<BoundingBox> RayTracingMeshOutput::_inflated_bboxes

private

The inflated bounding boxes for all processors.

Definition at line 127 of file RayTracingMeshOutput.h.

Referenced by buildBoundingBoxes().

◆ _inflated_neighbor_bboxes

std::vector<std::pair<processor_id_type, BoundingBox> > RayTracingMeshOutput::_inflated_neighbor_bboxes

private

Inflated bounding boxes that are neighboring to this processor (pid : bbox for each entry)

Definition at line 129 of file RayTracingMeshOutput.h.

Referenced by buildBoundingBoxes(), and buildSegmentMesh().

◆ _intersections_var

unsigned int RayTracingMeshOutput::_intersections_var

private

The variable index in _sys for the intersection ID (if any)

Definition at line 112 of file RayTracingMeshOutput.h.

Referenced by fillFields(), and setupEquationSystem().

◆ _max_node_id

dof_id_type RayTracingMeshOutput::_max_node_id

private

The max node ID for the ray tracing mesh for creating unique elem IDs.

Definition at line 134 of file RayTracingMeshOutput.h.

Referenced by buildIDMap(), and buildSegmentMesh().

◆ _output_aux_data

const bool RayTracingMeshOutput::_output_aux_data

protected

Whether or not to output the Ray's aux data.

Definition at line 63 of file RayTracingMeshOutput.h.

Referenced by RayTracingMeshOutput(), and setupEquationSystem().

◆ _output_aux_data_names

const std::vector<std::string>* const RayTracingMeshOutput::_output_aux_data_names

protected

Specific Ray Aux data to output.

Definition at line 65 of file RayTracingMeshOutput.h.

Referenced by RayTracingMeshOutput(), and setupEquationSystem().

◆ _output_data

const bool RayTracingMeshOutput::_output_data

protected

Whether or not to output all of the Ray's data.

Definition at line 57 of file RayTracingMeshOutput.h.

Referenced by RayTracingMeshOutput(), and setupEquationSystem().

◆ _output_data_names

const std::vector<std::string>* const RayTracingMeshOutput::_output_data_names

protected

Specific Ray data to output.

Definition at line 59 of file RayTracingMeshOutput.h.

Referenced by RayTracingMeshOutput(), and setupEquationSystem().

◆ _output_data_nodal

const bool RayTracingMeshOutput::_output_data_nodal

protected

Whether or not to output the Ray's data in a nodal, linear sense.

Definition at line 61 of file RayTracingMeshOutput.h.

Referenced by fillFields(), RayTracingExodus::outputMesh(), RayTracingNemesis::outputMesh(), RayTracingMeshOutput(), and setupEquationSystem().

◆ _pid_var

unsigned int RayTracingMeshOutput::_pid_var

private

The variable index in _sys for the Ray's processor id (if any)

Definition at line 114 of file RayTracingMeshOutput.h.

Referenced by fillFields(), and setupEquationSystem().

◆ _processor_crossings_var

unsigned int RayTracingMeshOutput::_processor_crossings_var

private

The variable index in _sys for the Ray's processor crossings (if any)

Definition at line 116 of file RayTracingMeshOutput.h.

Referenced by fillFields(), and setupEquationSystem().

◆ _ray_id_var

unsigned int RayTracingMeshOutput::_ray_id_var

private

The variable index in _sys for the Ray's ID (if any)

Definition at line 110 of file RayTracingMeshOutput.h.

Referenced by fillFields(), and setupEquationSystem().

◆ _ray_starting_id_map

std::unordered_map<RayID, std::pair<dof_id_type, dof_id_type> > RayTracingMeshOutput::_ray_starting_id_map

private

The map from RayID to the starting element and node ID of the mesh element for said Ray.

Definition at line 132 of file RayTracingMeshOutput.h.

Referenced by buildIDMap(), and startingIDs().

◆ _segment_mesh

std::unique_ptr<MeshBase> RayTracingMeshOutput::_segment_mesh

protected

The mesh that contains the segments.

Definition at line 68 of file RayTracingMeshOutput.h.

Referenced by buildSegmentMesh(), fillFields(), output(), RayTracingExodus::outputMesh(), RayTracingNemesis::outputMesh(), and setupEquationSystem().

◆ _segmented_rays

bool RayTracingMeshOutput::_segmented_rays

private

Whether or not we have segmented rays.

Definition at line 136 of file RayTracingMeshOutput.h.

Referenced by buildSegmentMesh(), and setupEquationSystem().

◆ _study

const RayTracingStudy& RayTracingMeshOutput::_study

protected

The RayTracingStudy.

Definition at line 54 of file RayTracingMeshOutput.h.

Referenced by buildIDMap(), buildSegmentMesh(), fillFields(), neededNodes(), output(), RayTracingExodus::outputMesh(), RayTracingNemesis::outputMesh(), RayTracingMeshOutput(), setupEquationSystem(), and startingIDs().

◆ _sys

libMesh::ExplicitSystem* RayTracingMeshOutput::_sys

protected

The system that stores the field data.

Definition at line 72 of file RayTracingMeshOutput.h.

Referenced by fillFields(), output(), and setupEquationSystem().

◆ _trajectory_changes_var

unsigned int RayTracingMeshOutput::_trajectory_changes_var

private

The variable index in _sys for the Ray's trajectory changes (if any)

Definition at line 118 of file RayTracingMeshOutput.h.

Referenced by fillFields(), and setupEquationSystem().

The documentation for this class was generated from the following files:

ray_tracing/include/outputs/RayTracingMeshOutput.h
ray_tracing/src/outputs/RayTracingMeshOutput.C

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Private Member Functions

Static Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ RayTracingMeshOutput()

Member Function Documentation

◆ buildBoundingBoxes()

◆ buildIDMap()

◆ buildSegmentMesh()

◆ fileExtension()

◆ filename()

◆ fillFields()

◆ neededNodes()

◆ output()

◆ outputMesh()

◆ setupEquationSystem()

◆ startingIDs()

◆ validParams()

Member Data Documentation

◆ _aux_data_vars

◆ _bbox

◆ _data_vars

◆ _es

◆ _inflated_bboxes

◆ _inflated_neighbor_bboxes

◆ _intersections_var

◆ _max_node_id

◆ _output_aux_data

◆ _output_aux_data_names

◆ _output_data

◆ _output_data_names

◆ _output_data_nodal

◆ _pid_var

◆ _processor_crossings_var

◆ _ray_id_var

◆ _ray_starting_id_map

◆ _segment_mesh

◆ _segmented_rays

◆ _study

◆ _sys

◆ _trajectory_changes_var