https://mooseframework.inl.gov
Private Member Functions | Friends | List of all members
RayTracingStudy::AcquireRayInternalKey Class Reference

Key that is used for restricting access to acquireRayInternal(). More...

#include <RayTracingStudy.h>

Private Member Functions

 AcquireRayInternalKey ()
 
 AcquireRayInternalKey (const AcquireRayInternalKey &)
 

Friends

class Parallel::Packing< std::shared_ptr< Ray > >
 
void dataLoad (std::istream &stream, std::shared_ptr< Ray > &ray, void *context)
 

Detailed Description

Key that is used for restricting access to acquireRayInternal().

In general, we restrict access to the construction of Rays to only protected methods within RayTracingStudy. However, there are a few classes/functions that have a legimate reason to construct Rays. Here, the friends are said classes/functions.

Definition at line 53 of file RayTracingStudy.h.

Constructor & Destructor Documentation

◆ AcquireRayInternalKey() [1/2]

RayTracingStudy::AcquireRayInternalKey::AcquireRayInternalKey ( )
inlineprivate

Definition at line 57 of file RayTracingStudy.h.

57 {}

◆ AcquireRayInternalKey() [2/2]

RayTracingStudy::AcquireRayInternalKey::AcquireRayInternalKey ( const AcquireRayInternalKey )
inlineprivate

Definition at line 58 of file RayTracingStudy.h.

58 {}

Friends And Related Function Documentation

◆ dataLoad

void dataLoad ( std::istream &  stream,
std::shared_ptr< Ray > &  ray,
void context 
)
friend

Definition at line 724 of file Ray.C.

725 {
726  mooseAssert(context, "Missing RayTracingStudy context");
727  RayTracingStudy * study = static_cast<RayTracingStudy *>(context);
728 
729  RayID id;
730  loadHelper(stream, id, context);
731  ray = study->acquireRayInternal(id,
732  /* data_size = */ 0,
733  /* aux_data_size = */ 0,
734  /* reset = */ true,
736 
737  loadHelper(stream, ray->_current_point, context);
738  loadHelper(stream, ray->_direction, context);
739  dof_id_type current_elem_id;
740  loadHelper(stream, current_elem_id, context);
741  ray->_current_elem = study->meshBase().query_elem_ptr(current_elem_id);
742  loadHelper(stream, ray->_current_incoming_side, context);
743  loadHelper(stream, ray->_end_set, context);
744  loadHelper(stream, ray->_processor_crossings, context);
745  loadHelper(stream, ray->_intersections, context);
746  loadHelper(stream, ray->_trajectory_changes, context);
747  loadHelper(stream, ray->_trajectory_changed, context);
748  loadHelper(stream, ray->_distance, context);
749  loadHelper(stream, ray->_max_distance, context);
750  loadHelper(stream, ray->_should_continue, context);
751  loadHelper(stream, ray->_data, context);
752  loadHelper(stream, ray->_aux_data, context);
753 
754  if (ray->hasTraced())
755  mooseAssert(!study->currentlyGenerating() && !study->currentlyPropagating(),
756  "Cannot not load a Ray that has already traced during generation or propagation; "
757  "reset the Ray first");
758 }
bool currentlyGenerating() const
Whether or not the study is generating.
unsigned long int RayID
Type for a Ray&#39;s ID.
Definition: Ray.h:43
std::shared_ptr< Ray > acquireRayInternal(const RayID id, const std::size_t data_size, const std::size_t aux_data_size, const bool reset, const AcquireRayInternalKey &)
Key that is used for restricting access to acquireRayInternal().
virtual const Elem * query_elem_ptr(const dof_id_type i) const=0
bool currentlyPropagating() const
Whether or not the study is propagating (tracing Rays)
MeshBase & meshBase() const
Access to the libMesh MeshBase.
void loadHelper(std::istream &stream, P &data, void *context)
uint8_t dof_id_type
Base class for Ray tracing studies that will generate Rays and then propagate all of them to terminat...

◆ Parallel::Packing< std::shared_ptr< Ray > >

friend class Parallel::Packing< std::shared_ptr< Ray > >
friend

Definition at line 55 of file RayTracingStudy.h.


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