Base class for Ray tracing studies that will generate Rays and then propagate all of them to termination. More...
#include <RayTracingStudy.h>
Classes | |
| class | AcquireMoveDuringTraceKey |
| Key that is used for restricting access to moveRayToBufferDuringTrace() and acquireRayDuringTrace(). More... | |
| class | AcquireRayInternalKey |
| Key that is used for restricting access to acquireRayInternal(). More... | |
Public Types | |
| typedef DataFileName | DataFileParameterType |
Public Member Functions | |
| RayTracingStudy (const InputParameters ¶meters) | |
| virtual void | initialSetup () override |
| virtual void | residualSetup () override |
| virtual void | jacobianSetup () override |
| virtual void | meshChanged () override |
| virtual void | timestepSetup () override |
| virtual void | initialize () override |
| virtual void | finalize () override |
| virtual void | execute () override |
| Executes the study (generates and propagates Rays) More... | |
| virtual void | segmentSubdomainSetup (const SubdomainID subdomain, const THREAD_ID tid, const RayID ray_id) |
| Setup for on subdomain change or subdomain AND ray change during ray tracing. More... | |
| virtual void | reinitSegment (const Elem *elem, const Point &start, const Point &end, const Real length, THREAD_ID tid) |
| Reinitialize objects for a Ray segment for ray tracing. More... | |
| virtual void | postOnSegment (const THREAD_ID tid, const std::shared_ptr< Ray > &ray) |
| Called at the end of a Ray segment. More... | |
| virtual void | preTrace (const THREAD_ID, const std::shared_ptr< Ray > &) |
| Called at the beginning of a trace for a ray. More... | |
| void | executeStudy () |
| Method for executing the study so that it can be called out of the standard UO execute() More... | |
| unsigned long long int | endingProcessorCrossings () const |
| Total number of processor crossings for Rays that finished on this processor. More... | |
| unsigned int | endingMaxProcessorCrossings () const |
| Max number of total processor crossings for Rays that finished on this processor. More... | |
| unsigned long long int | totalProcessorCrossings () const |
| Total number of processor crossings. More... | |
| unsigned int | maxProcessorCrossings () const |
| Max number of processor crossings for all Rays. More... | |
| unsigned long long int | endingIntersections () const |
| Total number of Ray/element intersections for Rays that finished on this processor. More... | |
| unsigned int | endingMaxIntersections () const |
| Max number of intersections for Rays that finished on this processor. More... | |
| unsigned long long int | totalIntersections () const |
| Total number of Ray/element intersections. More... | |
| unsigned int | maxIntersections () const |
| Max number of intersections for a Ray. More... | |
| unsigned int | maxTrajectoryChanges () const |
| Max number of trajectory changes for a Ray. More... | |
| Real | endingDistance () const |
| Total amount of distance traveled by the rays that end on this processor. More... | |
| Real | totalDistance () const |
| Total distance traveled by all Rays. More... | |
| unsigned long long int | localTraceRayResult (const int result) const |
| const ParallelRayStudy & | parallelRayStudy () const |
| Real | rayMaxDistance () const |
| Max distance any Ray can travel. More... | |
| Real | executionTime () |
| Duration for execute() in seconds. More... | |
| Real | executionTimeNano () |
| Duration for execute() in nanoseconds. More... | |
| Real | generationTime () const |
| Duration for creation of all Rays in seconds. More... | |
| Real | propagationTime () const |
| Duration for creation of all Rays in seconds. More... | |
| bool | tolerateFailure () const |
| Whether or not to tolerate failure. More... | |
| bool | bankRaysOnCompletion () const |
| Whether or not to bank Rays on completion. More... | |
| bool | rayDependentSubdomainSetup () const |
| Whether or not to use Ray dependent subdomain setup. More... | |
| RayDataIndex | registerRayData (const std::string &name) |
| Register a value to be filled in the data on a Ray with a given name. More... | |
| std::vector< RayDataIndex > | registerRayData (const std::vector< std::string > &names) |
| Register values to be filled in the data on a Ray with a given name. More... | |
| RayDataIndex | getRayDataIndex (const std::string &name, const bool graceful=false) const |
| Gets the index associated with a registered value in the Ray data. More... | |
| std::vector< RayDataIndex > | getRayDataIndices (const std::vector< std::string > &names, const bool graceful=false) const |
| Gets the indices associated with registered values in the Ray data. More... | |
| const std::string & | getRayDataName (const RayDataIndex index) const |
| Gets the name associated with a registered value in the Ray data. More... | |
| std::vector< std::string > | getRayDataNames (const std::vector< RayDataIndex > &indices) const |
| Gets the names associated with registered values in the Ray data. More... | |
| std::size_t | rayDataSize () const |
| The registered size of values in the Ray data. More... | |
| bool | hasRayData () const |
| Whether or not any Ray data are registered. More... | |
| const std::vector< std::string > & | rayDataNames () const |
| The Ray data names. More... | |
| RayDataIndex | registerRayAuxData (const std::string &name) |
| Register a value to be filled in the aux data on a Ray with a given name. More... | |
| std::vector< RayDataIndex > | registerRayAuxData (const std::vector< std::string > &names) |
| Register values to be filled in the aux data on a Ray with a given name. More... | |
| RayDataIndex | getRayAuxDataIndex (const std::string &name, const bool graceful=false) const |
| Gets the index associated with a registered value in the Ray aux data. More... | |
| std::vector< RayDataIndex > | getRayAuxDataIndices (const std::vector< std::string > &names, const bool graceful=false) const |
| Gets the indices associated with registered values in the Ray aux data. More... | |
| const std::string & | getRayAuxDataName (const RayDataIndex index) const |
| Gets the name associated with a registered value in the Ray aux data. More... | |
| std::vector< std::string > | getRayAuxDataNames (const std::vector< RayDataIndex > &indices) const |
| Gets the names associated with registered values in the Ray aux data. More... | |
| std::size_t | rayAuxDataSize () const |
| The registered size of values in the Ray aux data. More... | |
| bool | hasRayAuxData () const |
| Whether or not any Ray aux data are registered. More... | |
| const std::vector< std::string > & | rayAuxDataNames () const |
| The Ray aux data names. More... | |
| bool | hasRayKernels (const THREAD_ID tid) |
| Whether or not there are currently any active RayKernel objects. More... | |
| void | getRayKernels (std::vector< RayKernelBase *> &result, SubdomainID id, THREAD_ID tid) |
| Fills the active RayKernels associated with this study and a block into result. More... | |
| template<typename T > | |
| void | getRayKernels (std::vector< T *> &result, THREAD_ID tid) |
| Fills the active RayKernels associated with this study into result. More... | |
| void | getRayKernels (std::vector< RayKernelBase *> &result, SubdomainID id, THREAD_ID tid, RayID ray_id) |
| Fills the active RayKernels associeted with this study, block, and potentially Ray into result. More... | |
| void | getRayBCs (std::vector< RayBoundaryConditionBase *> &result, BoundaryID id, THREAD_ID tid) |
| Fills the active RayBCs associated with this study and a boundary into result. More... | |
| template<typename T > | |
| void | getRayBCs (std::vector< T *> &result, const std::vector< BoundaryID > &ids, THREAD_ID tid) |
| Fills the active RayBCs associated with this study and boundaries result. More... | |
| template<typename T > | |
| void | getRayBCs (std::vector< T *> &result, THREAD_ID tid) |
| Fills the active RayBCs associated with this study into result. More... | |
| virtual void | getRayBCs (std::vector< RayBoundaryConditionBase *> &result, const std::vector< TraceRayBndElement > &bnd_elems, THREAD_ID tid, RayID ray_id) |
| Fills the active RayBCs associated with thie study, boundary elements, and potentially Ray into result. More... | |
| const std::vector< RayKernelBase * > & | currentRayKernels (THREAD_ID tid) const |
| Gets the current RayKernels for a thread, which are set in segmentSubdomainSetup() More... | |
| const BoundingBox & | boundingBox () const |
| Get the nodal bounding box for the domain. More... | |
| const BoundingBox & | looseBoundingBox () const |
| Get the loose nodal bounding box for the domain. More... | |
| Real | domainMaxLength () const |
| Get the inflated maximum length across the domain. More... | |
| Real | totalVolume () const |
| Get the current total volume of the domain. More... | |
| bool | isRectangularDomain () const |
| Whether or not the domain is rectangular (if it is prefectly encompassed by its bounding box) More... | |
| bool | hasInternalSidesets () const |
| Whether or not the local mesh has internal sidesets that have RayBCs on them. More... | |
| const std::vector< std::vector< BoundaryID > > & | getInternalSidesets (const Elem *elem) const |
| Get the internal sidesets (that have RayBC(s)) for each side for a given element. More... | |
| const std::set< BoundaryID > & | getInternalSidesets () const |
| Gets the internal sidesets (that have RayBCs) within the local domain. More... | |
| bool | sideIsNonPlanar (const Elem *elem, const unsigned short s) const |
Whether or not the side on elem elem is non-planar. More... | |
| bool | hasSameLevelActiveElems () const |
| Whether or not the mesh has active elements of the same level. More... | |
| void | moveRayToBufferDuringTrace (std::shared_ptr< Ray > &ray, const THREAD_ID tid, const AcquireMoveDuringTraceKey &) |
| INTERNAL method for moving a Ray into the buffer during tracing. More... | |
| MeshBase & | meshBase () const |
| Access to the libMesh MeshBase. More... | |
| MooseMesh & | mesh () |
| virtual const Point & | getSideNormal (const Elem *elem, const unsigned short side, const THREAD_ID tid) |
| Get the outward normal for a given element side. More... | |
| virtual const Point * | getElemNormals (const Elem *, const THREAD_ID) |
| Gets the outward normals for a given element. More... | |
| RayData | getBankedRayData (const RayID ray_id, const RayDataIndex index) const |
| Gets the data value for a banked ray with a given ID. More... | |
| RayData | getBankedRayAuxData (const RayID ray_id, const RayDataIndex index) const |
| Gets the data value for a banked ray with a given ID. More... | |
| RayID | registeredRayID (const std::string &name, const bool graceful=false) const |
| Gets the ID of a registered ray. More... | |
| const std::string & | registeredRayName (const RayID ray_id) const |
| Gets the name of a registered ray. More... | |
| bool | useRayRegistration () const |
| Whether or not ray registration is being used. More... | |
| bool | dataOnCacheTraces () const |
| Whether or not to store the Ray data on the cached Ray traces. More... | |
| bool | auxDataOnCacheTraces () const |
| Whether or not to store the Ray aux data on the cached Ray traces. More... | |
| bool | segmentsOnCacheTraces () const |
| Whether or not to cache individual element segments when _cache_traces = true. More... | |
| virtual bool | shouldCacheTrace (const std::shared_ptr< Ray > &) const |
| Virtual that allows for selection in if a Ray should be cached or not (only used when _cache_traces). More... | |
| TraceData & | initThreadedCachedTrace (const std::shared_ptr< Ray > &ray, THREAD_ID tid) |
| Initialize a Ray in the threaded cached trace map to be filled with segments. More... | |
| const std::vector< TraceData > & | getCachedTraces () const |
| Get the cached trace data structure. More... | |
| Real | subdomainHmax (const SubdomainID subdomain_id) const |
| Get the cached hmax for all elements in a subdomain. More... | |
| virtual void | onCompleteRay (const std::shared_ptr< Ray > &ray) |
| Entry point for acting on a ray when it is completed (shouldContinue() == false) More... | |
| void | verifyUniqueRayIDs (const std::vector< std::shared_ptr< Ray >>::const_iterator begin, const std::vector< std::shared_ptr< Ray >>::const_iterator end, const bool global, const std::string &error_suffix) const |
| Verifies that the Rays in the given range have unique Ray IDs. More... | |
| void | verifyUniqueRays (const std::vector< std::shared_ptr< Ray >>::const_iterator begin, const std::vector< std::shared_ptr< Ray >>::const_iterator end, const std::string &error_suffix) |
| Verifies that the Rays in the given range are unique. More... | |
| bool | currentlyPropagating () const |
| Whether or not the study is propagating (tracing Rays) More... | |
| bool | currentlyGenerating () const |
| Whether or not the study is generating. More... | |
| bool | verifyRays () const |
| Whether or not to verify if Rays have valid information before being traced. More... | |
| bool | verifyTraceIntersections () const |
| Whether or not trace verification is enabled in devel/dbg modes. More... | |
| bool | sideIsIncoming (const Elem *const elem, const unsigned short side, const Point &direction, const THREAD_ID tid) |
Whether or not side is incoming on element elem in direction direction. More... | |
| bool | warnNonPlanar () const |
| Whether or not to produce a warning when interacting with a non-planar mesh. More... | |
| ParallelStudy< std::shared_ptr< Ray >, Ray > * | parallelStudy () |
| The underlying parallel study: used for the context for calling the packed range routines. More... | |
| const libMesh::Elem & | elemSide (const libMesh::Elem &elem, const unsigned int s, const THREAD_ID tid=0) |
| Get an element's side pointer without excessive memory allocation. More... | |
| virtual Real | spatialValue (const Point &) const |
| virtual const std::vector< Point > | spatialPoints () const |
| void | setPrimaryThreadCopy (UserObject *primary) |
| UserObject * | primaryThreadCopy () |
| SubProblem & | getSubProblem () const |
| bool | shouldDuplicateInitialExecution () const |
| void | gatherSum (T &value) |
| void | gatherMax (T &value) |
| void | gatherMin (T &value) |
| void | gatherProxyValueMax (T1 &proxy, T2 &value) |
| void | gatherProxyValueMin (T1 &proxy, T2 &value) |
| std::set< UserObjectName > | getDependObjects () const |
| const std::set< std::string > & | getRequestedItems () override |
| const std::set< std::string > & | getSuppliedItems () override |
| unsigned int | systemNumber () const |
| virtual bool | needThreadedCopy () 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 ¶meter_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 ¶m1, const std::string ¶m2) 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 | haveParameter (const std::string &name) const |
| bool | isParamValid (const std::string &name) const |
| bool | isParamSetByUser (const std::string &name) const |
| void | connectControllableParams (const std::string ¶meter, const std::string &object_type, const std::string &object_name, const std::string &object_parameter) const |
| void | paramError (const std::string ¶m, Args... args) const |
| void | paramWarning (const std::string ¶m, Args... args) const |
| void | paramWarning (const std::string ¶m, Args... args) const |
| void | paramInfo (const std::string ¶m, 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 ¶m) const |
| std::string | getDataFileNameByName (const std::string &relative_path) const |
| std::string | getDataFilePath (const std::string &relative_path) const |
| virtual void | customSetup (const ExecFlagType &) |
| const ExecFlagEnum & | getExecuteOnEnum () const |
| UserObjectName | getUserObjectName (const std::string ¶m_name) const |
| const T & | getUserObject (const std::string ¶m_name, bool is_dependency=true) const |
| const T & | getUserObjectByName (const UserObjectName &object_name, bool is_dependency=true) const |
| const UserObjectBase & | getUserObjectBase (const std::string ¶m_name, bool is_dependency=true) const |
| const UserObjectBase & | getUserObjectBaseByName (const UserObjectName &object_name, bool is_dependency=true) const |
| const std::vector< MooseVariableScalar *> & | getCoupledMooseScalarVars () |
| const std::set< TagID > & | getScalarVariableCoupleableVectorTags () const |
| const std::set< TagID > & | getScalarVariableCoupleableMatrixTags () const |
| const GenericMaterialProperty< T, is_ad > & | getGenericMaterialProperty (const std::string &name, MaterialData &material_data, const unsigned int state=0) |
| const GenericMaterialProperty< T, is_ad > & | getGenericMaterialProperty (const std::string &name, const unsigned int state=0) |
| const GenericMaterialProperty< T, is_ad > & | getGenericMaterialProperty (const std::string &name, const unsigned int state=0) |
| const MaterialProperty< T > & | getMaterialProperty (const std::string &name, MaterialData &material_data, const unsigned int state=0) |
| const MaterialProperty< T > & | getMaterialProperty (const std::string &name, const unsigned int state=0) |
| const MaterialProperty< T > & | getMaterialProperty (const std::string &name, const unsigned int state=0) |
| const ADMaterialProperty< T > & | getADMaterialProperty (const std::string &name, MaterialData &material_data) |
| const ADMaterialProperty< T > & | getADMaterialProperty (const std::string &name) |
| const ADMaterialProperty< T > & | getADMaterialProperty (const std::string &name) |
| const MaterialProperty< T > & | getMaterialPropertyOld (const std::string &name, MaterialData &material_data) |
| const MaterialProperty< T > & | getMaterialPropertyOld (const std::string &name) |
| const MaterialProperty< T > & | getMaterialPropertyOld (const std::string &name) |
| const MaterialProperty< T > & | getMaterialPropertyOlder (const std::string &name, MaterialData &material_data) |
| const MaterialProperty< T > & | getMaterialPropertyOlder (const std::string &name) |
| const MaterialProperty< T > & | getMaterialPropertyOlder (const std::string &name) |
| const GenericMaterialProperty< T, is_ad > & | getGenericMaterialPropertyByName (const MaterialPropertyName &name, MaterialData &material_data, const unsigned int state) |
| const GenericMaterialProperty< T, is_ad > & | getGenericMaterialPropertyByName (const MaterialPropertyName &name, const unsigned int state=0) |
| const GenericMaterialProperty< T, is_ad > & | getGenericMaterialPropertyByName (const MaterialPropertyName &name, const unsigned int state=0) |
| const MaterialProperty< T > & | getMaterialPropertyByName (const MaterialPropertyName &name, MaterialData &material_data, const unsigned int state=0) |
| const MaterialProperty< T > & | getMaterialPropertyByName (const MaterialPropertyName &name, const unsigned int state=0) |
| const MaterialProperty< T > & | getMaterialPropertyByName (const MaterialPropertyName &name, const unsigned int state=0) |
| const ADMaterialProperty< T > & | getADMaterialPropertyByName (const MaterialPropertyName &name, MaterialData &material_data) |
| const ADMaterialProperty< T > & | getADMaterialPropertyByName (const MaterialPropertyName &name) |
| const ADMaterialProperty< T > & | getADMaterialPropertyByName (const MaterialPropertyName &name) |
| const MaterialProperty< T > & | getMaterialPropertyOldByName (const MaterialPropertyName &name, MaterialData &material_data) |
| const MaterialProperty< T > & | getMaterialPropertyOldByName (const MaterialPropertyName &name) |
| const MaterialProperty< T > & | getMaterialPropertyOldByName (const MaterialPropertyName &name) |
| const MaterialProperty< T > & | getMaterialPropertyOlderByName (const MaterialPropertyName &name, MaterialData &material_data) |
| const MaterialProperty< T > & | getMaterialPropertyOlderByName (const MaterialPropertyName &name) |
| const MaterialProperty< T > & | getMaterialPropertyOlderByName (const MaterialPropertyName &name) |
| Moose::Kokkos::MaterialProperty< T, dimension > | getKokkosMaterialPropertyByName (const std::string &prop_name_in) |
| Moose::Kokkos::MaterialProperty< T, dimension > | getKokkosMaterialPropertyOldByName (const std::string &prop_name) |
| Moose::Kokkos::MaterialProperty< T, dimension > | getKokkosMaterialPropertyOlderByName (const std::string &prop_name) |
| Moose::Kokkos::MaterialProperty< T, dimension > | getKokkosMaterialProperty (const std::string &name) |
| Moose::Kokkos::MaterialProperty< T, dimension > | getKokkosMaterialPropertyOld (const std::string &name) |
| Moose::Kokkos::MaterialProperty< T, dimension > | getKokkosMaterialPropertyOlder (const std::string &name) |
| std::pair< const MaterialProperty< T > *, std::set< SubdomainID > > | getBlockMaterialProperty (const MaterialPropertyName &name) |
| std::pair< Moose::Kokkos::MaterialProperty< T, dimension >, std::set< SubdomainID > > | getKokkosBlockMaterialProperty (const MaterialPropertyName &name) |
| const GenericMaterialProperty< T, is_ad > & | getGenericZeroMaterialProperty (const std::string &name) |
| const GenericMaterialProperty< T, is_ad > & | getGenericZeroMaterialProperty () |
| const GenericMaterialProperty< T, is_ad > & | getGenericZeroMaterialPropertyByName (const std::string &prop_name) |
| const MaterialProperty< T > & | getZeroMaterialProperty (Ts... args) |
| std::set< SubdomainID > | getMaterialPropertyBlocks (const std::string &name) |
| std::vector< SubdomainName > | getMaterialPropertyBlockNames (const std::string &name) |
| std::set< BoundaryID > | getMaterialPropertyBoundaryIDs (const std::string &name) |
| std::vector< BoundaryName > | getMaterialPropertyBoundaryNames (const std::string &name) |
| void | checkBlockAndBoundaryCompatibility (std::shared_ptr< MaterialBase > discrete) |
| std::unordered_map< SubdomainID, std::vector< MaterialBase *> > | buildRequiredMaterials (bool allow_stateful=true) |
| void | statefulPropertiesAllowed (bool) |
| virtual bool | getMaterialPropertyCalled () const |
| virtual const std::unordered_set< unsigned int > & | getMatPropDependencies () const |
| virtual void | resolveOptionalProperties () |
| const GenericMaterialProperty< T, is_ad > & | getPossiblyConstantGenericMaterialPropertyByName (const MaterialPropertyName &prop_name, MaterialData &material_data, const unsigned int state) |
| bool | isImplicit () |
| Moose::StateArg | determineState () const |
| virtual void | threadJoin (const UserObject &) override |
| virtual void | threadJoin (const UserObject &) override |
| virtual void | subdomainSetup () override |
| virtual void | subdomainSetup () override |
| bool | hasUserObject (const std::string ¶m_name) const |
| bool | hasUserObject (const std::string ¶m_name) const |
| bool | hasUserObject (const std::string ¶m_name) const |
| bool | hasUserObject (const std::string ¶m_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 |
| const GenericOptionalMaterialProperty< T, is_ad > & | getGenericOptionalMaterialProperty (const std::string &name, const unsigned int state=0) |
| const GenericOptionalMaterialProperty< T, is_ad > & | getGenericOptionalMaterialProperty (const std::string &name, const unsigned int state=0) |
| const OptionalMaterialProperty< T > & | getOptionalMaterialProperty (const std::string &name, const unsigned int state=0) |
| const OptionalMaterialProperty< T > & | getOptionalMaterialProperty (const std::string &name, const unsigned int state=0) |
| const OptionalADMaterialProperty< T > & | getOptionalADMaterialProperty (const std::string &name) |
| const OptionalADMaterialProperty< T > & | getOptionalADMaterialProperty (const std::string &name) |
| const OptionalMaterialProperty< T > & | getOptionalMaterialPropertyOld (const std::string &name) |
| const OptionalMaterialProperty< T > & | getOptionalMaterialPropertyOld (const std::string &name) |
| const OptionalMaterialProperty< T > & | getOptionalMaterialPropertyOlder (const std::string &name) |
| const OptionalMaterialProperty< T > & | getOptionalMaterialPropertyOlder (const std::string &name) |
| MaterialBase & | getMaterial (const std::string &name) |
| MaterialBase & | getMaterial (const std::string &name) |
| MaterialBase & | getMaterialByName (const std::string &name, bool no_warn=false) |
| MaterialBase & | getMaterialByName (const std::string &name, bool no_warn=false) |
| bool | hasMaterialProperty (const std::string &name) |
| bool | hasMaterialProperty (const std::string &name) |
| bool | hasMaterialPropertyByName (const std::string &name) |
| bool | hasMaterialPropertyByName (const std::string &name) |
| bool | hasADMaterialProperty (const std::string &name) |
| bool | hasADMaterialProperty (const std::string &name) |
| bool | hasADMaterialPropertyByName (const std::string &name) |
| bool | hasADMaterialPropertyByName (const std::string &name) |
| bool | hasKokkosMaterialProperty (const std::string &name) |
| bool | hasKokkosMaterialProperty (const std::string &name) |
| bool | hasKokkosMaterialPropertyByName (const std::string &name) |
| bool | hasKokkosMaterialPropertyByName (const std::string &name) |
| bool | hasGenericMaterialProperty (const std::string &name) |
| bool | hasGenericMaterialProperty (const std::string &name) |
| bool | hasGenericMaterialPropertyByName (const std::string &name) |
| bool | hasGenericMaterialPropertyByName (const std::string &name) |
| const Function & | getFunction (const std::string &name) const |
| const Function & | getFunctionByName (const FunctionName &name) const |
| bool | hasFunction (const std::string ¶m_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 ¶m_name) const |
| bool | hasKokkosFunctionByName (const FunctionName &name) const |
| bool | isDefaultPostprocessorValue (const std::string ¶m_name, const unsigned int index=0) const |
| bool | hasPostprocessor (const std::string ¶m_name, const unsigned int index=0) const |
| bool | hasPostprocessorByName (const PostprocessorName &name) const |
| std::size_t | coupledPostprocessors (const std::string ¶m_name) const |
| const PostprocessorName & | getPostprocessorName (const std::string ¶m_name, const unsigned int index=0) const |
| const VectorPostprocessorValue & | getVectorPostprocessorValue (const std::string ¶m_name, const std::string &vector_name) const |
| const VectorPostprocessorValue & | getVectorPostprocessorValue (const std::string ¶m_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 ¶m_name, const std::string &vector_name) const |
| const VectorPostprocessorValue & | getVectorPostprocessorValueOld (const std::string ¶m_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 ¶m_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 ¶m_name, const std::string &vector_name) const |
| const ScatterVectorPostprocessorValue & | getScatterVectorPostprocessorValueOldByName (const VectorPostprocessorName &name, const std::string &vector_name) const |
| bool | hasVectorPostprocessor (const std::string ¶m_name, const std::string &vector_name) const |
| bool | hasVectorPostprocessor (const std::string ¶m_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 ¶m_name) const |
| T & | getSampler (const std::string &name) |
| Sampler & | getSampler (const std::string &name) |
| T & | getSamplerByName (const SamplerName &name) |
| Sampler & | getSamplerByName (const SamplerName &name) |
| virtual void | meshDisplaced () |
| PerfGraph & | perfGraph () |
| const PostprocessorValue & | getPostprocessorValue (const std::string ¶m_name, const unsigned int index=0) const |
| const PostprocessorValue & | getPostprocessorValue (const std::string ¶m_name, const unsigned int index=0) const |
| const PostprocessorValue & | getPostprocessorValueOld (const std::string ¶m_name, const unsigned int index=0) const |
| const PostprocessorValue & | getPostprocessorValueOld (const std::string ¶m_name, const unsigned int index=0) const |
| const PostprocessorValue & | getPostprocessorValueOlder (const std::string ¶m_name, const unsigned int index=0) const |
| const PostprocessorValue & | getPostprocessorValueOlder (const std::string ¶m_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 ¶m_name) const |
| bool | isVectorPostprocessorDistributed (const std::string ¶m_name) const |
| bool | isVectorPostprocessorDistributedByName (const VectorPostprocessorName &name) const |
| bool | isVectorPostprocessorDistributedByName (const VectorPostprocessorName &name) const |
| const Distribution & | getDistribution (const std::string &name) const |
| const T & | getDistribution (const std::string &name) const |
| const Distribution & | getDistribution (const std::string &name) const |
| const T & | getDistribution (const std::string &name) const |
| const Distribution & | getDistributionByName (const DistributionName &name) const |
| const T & | getDistributionByName (const std::string &name) const |
| const Distribution & | getDistributionByName (const DistributionName &name) const |
| const T & | getDistributionByName (const std::string &name) const |
| const Parallel::Communicator & | comm () const |
| processor_id_type | n_processors () const |
| processor_id_type | processor_id () const |
| std::shared_ptr< Ray > | acquireRayDuringTrace (const THREAD_ID tid, const AcquireMoveDuringTraceKey &) |
| INTERNAL methods for acquiring a Ray during a trace in RayKernels and RayBCs. More... | |
| 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 &) |
| TraceRay & | traceRay (const THREAD_ID tid) |
Gets the threaded TraceRay object for tid. More... | |
| const TraceRay & | traceRay (const THREAD_ID tid) const |
Static Public Member Functions | |
| static InputParameters | validParams () |
| static void | callMooseError (MooseApp *const app, const InputParameters ¶ms, std::string msg, const bool with_prefix, const hit::Node *node, const bool show_trace=true) |
| static void | sort (typename std::vector< T > &vector) |
| static void | sortDFS (typename std::vector< T > &vector) |
| static void | cyclicDependencyError (CyclicDependencyException< T2 > &e, const std::string &header, NameFunc &&name_func) |
| static void | cyclicDependencyError (CyclicDependencyException< T2 > &e, const std::string &header) |
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 |
| static constexpr PropertyValue::id_type | default_property_id |
| static constexpr PropertyValue::id_type | zero_property_id |
| static constexpr auto | SYSTEM |
| static constexpr auto | NAME |
Protected Member Functions | |
| virtual void | generateRays ()=0 |
| Subclasses should override this to determine how to generate Rays. More... | |
| virtual void | preExecuteStudy () |
| Entry point before study execution. More... | |
| virtual void | postExecuteStudy () |
| Entry point after study execution. More... | |
| Real | computeTotalVolume () |
| Helper function for computing the total domain volume. More... | |
| std::vector< RayKernelBase * > & | currentRayKernelsWrite (THREAD_ID tid) |
| Gets the writeable current RayKernels for a thread. More... | |
| void | reserveRayBuffer (const std::size_t size) |
Reserve size entires in the Ray buffer. More... | |
| bool | sameLevelActiveElems () const |
| Determine whether or not the mesh currently has active elements that are all the same level. More... | |
| virtual void | buildSegmentQuadrature (const Point &start, const Point &end, const Real length, std::vector< Point > &points, std::vector< Real > &weights) const |
| Builds quadrature points for a given segment using the _segment_qrule. More... | |
| const std::vector< std::shared_ptr< Ray > > & | rayBank () const |
| Get the Ray bank. More... | |
| std::shared_ptr< Ray > | getBankedRay (const RayID ray_id) const |
Gets the Ray with the ID ray_id from the Ray bank. More... | |
| void | resetUniqueRayIDs () |
| Resets the generation of unique RayIDs via generateUniqueRayID() to the beginning of the range. More... | |
| void | resetReplicatedRayIDs () |
| Resets the generation of unique replicated RayIDs accessed via generateReplicatedRayID(). More... | |
| std::vector< RayTracingObject * > | getRayTracingObjects () |
| Gets all of the currently active RayTracingObjects. More... | |
| virtual RayID | generateUniqueRayID (const THREAD_ID tid) |
| Generates a unique RayID to be used for a Ray. More... | |
| RayID | generateReplicatedRayID () |
| Generates a Ray ID that is replicated across all processors. More... | |
| void | moveRayToBuffer (std::shared_ptr< Ray > &ray) |
| Moves a ray to the buffer to be traced during generateRays(). More... | |
| void | moveRaysToBuffer (std::vector< std::shared_ptr< Ray >> &rays) |
| Moves rays to the buffer to be traced during generateRays(). More... | |
| virtual void | addPostprocessorDependencyHelper (const PostprocessorName &name) const override |
| virtual void | addVectorPostprocessorDependencyHelper (const VectorPostprocessorName &name) const override |
| virtual void | addUserObjectDependencyHelper (const UserObjectBase &uo) const override |
| void | addReporterDependencyHelper (const ReporterName &reporter_name) override |
| void | flagInvalidSolutionInternal (const InvalidSolutionID invalid_solution_id) const |
| InvalidSolutionID | registerInvalidSolutionInternal (const std::string &message, const bool warning) const |
| const ReporterContextBase & | getReporterContextBaseByName (const ReporterName &reporter_name) const |
| const ReporterName & | getReporterName (const std::string ¶m_name) 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 |
| const T & | getMeshProperty (const std::string &data_name, const std::string &prefix) |
| const T & | getMeshProperty (const std::string &data_name) |
| bool | hasMeshProperty (const std::string &data_name, const std::string &prefix) const |
| bool | hasMeshProperty (const std::string &data_name, const std::string &prefix) const |
| bool | hasMeshProperty (const std::string &data_name) const |
| bool | hasMeshProperty (const std::string &data_name) const |
| std::string | meshPropertyName (const std::string &data_name) const |
| PerfID | registerTimedSection (const std::string §ion_name, const unsigned int level) const |
| PerfID | registerTimedSection (const std::string §ion_name, const unsigned int level, const std::string &live_message, const bool print_dots=true) const |
| std::string | timedSectionName (const std::string §ion_name) const |
| bool | isCoupledScalar (const std::string &var_name, unsigned int i=0) const |
| unsigned int | coupledScalarComponents (const std::string &var_name) const |
| unsigned int | coupledScalar (const std::string &var_name, unsigned int comp=0) const |
| libMesh::Order | coupledScalarOrder (const std::string &var_name, unsigned int comp=0) const |
| const VariableValue & | coupledScalarValue (const std::string &var_name, unsigned int comp=0) const |
| const ADVariableValue & | adCoupledScalarValue (const std::string &var_name, unsigned int comp=0) const |
| const GenericVariableValue< is_ad > & | coupledGenericScalarValue (const std::string &var_name, unsigned int comp=0) const |
| const GenericVariableValue< false > & | coupledGenericScalarValue (const std::string &var_name, const unsigned int comp) const |
| const GenericVariableValue< true > & | coupledGenericScalarValue (const std::string &var_name, const unsigned int comp) const |
| const VariableValue & | coupledVectorTagScalarValue (const std::string &var_name, TagID tag, unsigned int comp=0) const |
| const VariableValue & | coupledMatrixTagScalarValue (const std::string &var_name, TagID tag, unsigned int comp=0) const |
| const VariableValue & | coupledScalarValueOld (const std::string &var_name, unsigned int comp=0) const |
| const VariableValue & | coupledScalarValueOlder (const std::string &var_name, unsigned int comp=0) const |
| const VariableValue & | coupledScalarDot (const std::string &var_name, unsigned int comp=0) const |
| const ADVariableValue & | adCoupledScalarDot (const std::string &var_name, unsigned int comp=0) const |
| const VariableValue & | coupledScalarDotDot (const std::string &var_name, unsigned int comp=0) const |
| const VariableValue & | coupledScalarDotOld (const std::string &var_name, unsigned int comp=0) const |
| const VariableValue & | coupledScalarDotDotOld (const std::string &var_name, unsigned int comp=0) const |
| const VariableValue & | coupledScalarDotDu (const std::string &var_name, unsigned int comp=0) const |
| const VariableValue & | coupledScalarDotDotDu (const std::string &var_name, unsigned int comp=0) const |
| const MooseVariableScalar * | getScalarVar (const std::string &var_name, unsigned int comp) const |
| virtual void | checkMaterialProperty (const std::string &name, const unsigned int state) |
| virtual void | getKokkosMaterialPropertyHook (const std::string &, const unsigned int) |
| void | markMatPropRequested (const std::string &) |
| MaterialPropertyName | getMaterialPropertyName (const std::string &name) const |
| void | checkExecutionStage () |
| const T & | getReporterValue (const std::string ¶m_name, const std::size_t time_index=0) |
| const T & | getReporterValue (const std::string ¶m_name, ReporterMode mode, const std::size_t time_index=0) |
| const T & | getReporterValue (const std::string ¶m_name, const std::size_t time_index=0) |
| const T & | getReporterValue (const std::string ¶m_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 ¶m_name) const |
| bool | hasReporterValue (const std::string ¶m_name) const |
| bool | hasReporterValue (const std::string ¶m_name) const |
| bool | hasReporterValue (const std::string ¶m_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 |
| const GenericMaterialProperty< T, is_ad > * | defaultGenericMaterialProperty (const std::string &name) |
| const GenericMaterialProperty< T, is_ad > * | defaultGenericMaterialProperty (const std::string &name) |
| const MaterialProperty< T > * | defaultMaterialProperty (const std::string &name) |
| const MaterialProperty< T > * | defaultMaterialProperty (const std::string &name) |
| const ADMaterialProperty< T > * | defaultADMaterialProperty (const std::string &name) |
| const ADMaterialProperty< T > * | defaultADMaterialProperty (const std::string &name) |
| std::shared_ptr< Ray > | acquireRay () |
| User APIs for constructing Rays within the RayTracingStudy. More... | |
| std::shared_ptr< Ray > | acquireUnsizedRay () |
| Acquire a Ray from the pool of Rays within generateRays(), without resizing the data (sizes the data to zero). More... | |
| std::shared_ptr< Ray > | acquireReplicatedRay () |
| Acquire a Ray from the pool of Rays within generateRays() in a replicated fashion. More... | |
| std::shared_ptr< Ray > | acquireCopiedRay (const Ray &ray) |
| Acquires a Ray that that is copied from another Ray within generateRays(). More... | |
| std::shared_ptr< Ray > | acquireRegisteredRay (const std::string &name) |
| Acquires a Ray with a given name within generateRays(). More... | |
Static Protected Member Functions | |
| static std::string | meshPropertyName (const std::string &data_name, const std::string &prefix) |
Protected Attributes | |
| MooseMesh & | _mesh |
| The Mesh. More... | |
| const Parallel::Communicator & | _comm |
| The Communicator. More... | |
| const processor_id_type | _pid |
| The rank of this processor (this actually takes time to lookup - so just do it once) More... | |
| const bool | _ray_kernel_coverage_check |
| Whether or not to perform coverage checks on RayKernels. More... | |
| const bool | _warn_non_planar |
| Whether not to warn if non-planar faces are found. More... | |
| const bool | _use_ray_registration |
| Whether or not to use Ray registration. More... | |
| const bool | _use_internal_sidesets |
| Whether or not to use the internal sidesets in ray tracing. More... | |
| const bool | _tolerate_failure |
| Whether or not to tolerate a Ray Tracing failure. More... | |
| const bool | _bank_rays_on_completion |
| Whether or not to bank rays on completion. More... | |
| const bool | _ray_dependent_subdomain_setup |
| Whether or not subdomain setup is dependent on the Ray. More... | |
| bool | _always_cache_traces |
| Whether or not to cache traces on every trace execution. More... | |
| const bool | _data_on_cache_traces |
| Whether or not to store the Ray data on the cache traces. More... | |
| const bool | _aux_data_on_cache_traces |
| Whether or not to store the Ray aux data on the cache traces. More... | |
| const bool | _segments_on_cache_traces |
| Whether or not to cache individual element segments when caching. More... | |
| const Real | _ray_max_distance |
| Max distance a Ray can travel before being killed (can change) More... | |
| const bool | _verify_rays |
| Whether or not to verify if Rays have valid information before being traced. More... | |
| const bool | _verify_trace_intersections |
| Whether or not to verify the trace intersections in devel and dbg modes. More... | |
| const Moose::CoordinateSystemType & | _coord_sys |
| const THREAD_ID | _tid |
| SubProblem & | _subproblem |
| FEProblemBase & | _fe_problem |
| SystemBase & | _sys |
| Assembly & | _assembly |
| const bool | _duplicate_initial_execution |
| std::set< std::string > | _depend_uo |
| const bool & | _enabled |
| MooseApp & | _app |
| Factory & | _factory |
| ActionFactory & | _action_factory |
| const std::string & | _type |
| const std::string & | _name |
| const InputParameters & | _pars |
| const ExecFlagEnum & | _execute_enum |
| const ExecFlagType & | _current_execute_flag |
| MooseApp & | _restartable_app |
| const std::string | _restartable_system_name |
| const THREAD_ID | _restartable_tid |
| const bool | _restartable_read_only |
| FEProblemBase & | _mci_feproblem |
| FEProblemBase & | _mdi_feproblem |
| MooseApp & | _pg_moose_app |
| const std::string | _prefix |
| FEProblemBase & | _sc_fe_problem |
| const THREAD_ID | _sc_tid |
| const Real & | _real_zero |
| const VariableValue & | _scalar_zero |
| const Point & | _point_zero |
| const InputParameters & | _mi_params |
| const std::string | _mi_name |
| const MooseObjectName | _mi_moose_object_name |
| FEProblemBase & | _mi_feproblem |
| SubProblem & | _mi_subproblem |
| const THREAD_ID | _mi_tid |
| const bool | _is_kokkos_object |
| const Moose::MaterialDataType | _material_data_type |
| MaterialData & | _material_data |
| bool | _stateful_allowed |
| bool | _get_material_property_called |
| std::vector< std::unique_ptr< PropertyValue > > | _default_properties |
| std::unordered_set< unsigned int > | _material_property_dependencies |
| const MaterialPropertyName | _get_suffix |
| const bool | _use_interpolated_state |
| const InputParameters & | _ti_params |
| FEProblemBase & | _ti_feproblem |
| bool | _is_implicit |
| Real & | _t |
| const Real & | _t_old |
| int & | _t_step |
| Real & | _dt |
| Real & | _dt_old |
| bool | _is_transient |
| const Parallel::Communicator & | _communicator |
Static Protected Attributes | |
| static const std::string | _interpolated_old |
| static const std::string | _interpolated_older |
Private Member Functions | |
| void | coverageChecks () |
| Perform coverage checks (coverage of RayMaterials and RayKernels, if enabled) More... | |
| void | dependencyChecks () |
| Perform checks to see if the listed dependencies in the RayTracingObjects exist. More... | |
| void | verifyDependenciesExist (const std::vector< RayTracingObject *> &rtos) |
| Verifies that the dependencies exist for a set of RayTracingObjects. More... | |
| void | traceableMeshChecks () |
| Check for if all of the element types in the mesh are supported by ray tracing. More... | |
| void | periodicBoundaryChecks () |
| Check for overlapping PeriodicRayBC boundaries and check for cases in which ghosting may not be sufficient with distributed mesh for overlapping periodic boundaries. More... | |
| void | internalSidesetSetup () |
| Does the setup for internal sidesets. More... | |
| void | nonPlanarSideSetup () |
| Sets up the caching of whether or not each element side is non-planar, which is stored in _non_planar_sides. More... | |
| void | localElemIndexSetup () |
| Sets up the _elem_index_helper, which is used for obtaining a contiguous index for all elements that this processor knows about. More... | |
| void | registeredRaySetup () |
| Sets up the maps from Ray to associated RayTracingObjects if _use_ray_registration. More... | |
| void | zeroAuxVariables () |
| Zero the AuxVariables that the registered AuxRayKernels contribute to. More... | |
| void | subdomainHMaxSetup () |
| Caches the hmax for all elements in each subdomain. More... | |
| RayDataIndex | registerRayDataInternal (const std::string &name, const bool aux) |
| Internal method for registering Ray data or Ray aux data with a name. More... | |
| std::vector< RayDataIndex > | registerRayDataInternal (const std::vector< std::string > &names, const bool aux) |
| Internal method for registering Ray data or Ray aux data with names. More... | |
| RayDataIndex | getRayDataIndexInternal (const std::string &name, const bool aux, const bool graceful) const |
| Internal method for getting the index of Ray data or Ray aux data. More... | |
| std::vector< RayDataIndex > | getRayDataIndicesInternal (const std::vector< std::string > &names, const bool aux, const bool graceful) const |
| Internal method for getting the indicies of Ray data or Ray aux data. More... | |
| const std::string & | getRayDataNameInternal (const RayDataIndex index, const bool aux) const |
| Internal method for getting the name of Ray data or Ray aux data. More... | |
| RayData | getBankedRayDataInternal (const RayID ray_id, const RayDataIndex index, const bool aux) const |
| Internal method for getting the value (replicated across all processors) in a Ray's data or aux data from the Ray banks. More... | |
| RayID | registerRay (const std::string &name) |
| Registers a Ray with a given name. More... | |
Private Attributes | |
| std::vector< libMesh::ElemSideBuilder > | _threaded_elem_side_builders |
| Threaded helpers for building element sides without extraneous allocation. More... | |
| std::unordered_map< std::string, RayDataIndex > | _ray_data_map |
| The map from Ray data names to index. More... | |
| std::unordered_map< std::string, RayDataIndex > | _ray_aux_data_map |
| The map from Ray aux data names to index. More... | |
| std::vector< std::string > | _ray_data_names |
| The names for each Ray data entry. More... | |
| std::vector< std::string > | _ray_aux_data_names |
| The names for each Ray aux data entry. More... | |
| std::unordered_map< std::string, RayID > & | _registered_ray_map |
| Map from registered Ray name to ID. More... | |
| std::vector< std::string > & | _reverse_registered_ray_map |
| Map from registered Ray ID to name. More... | |
| std::vector< TraceData > | _cached_traces |
| Storage for the cached traces. More... | |
| std::vector< std::vector< TraceData > > | _threaded_cached_traces |
| The threaded storage for cached traces. More... | |
| std::vector< std::size_t > | _num_cached |
| Number of currently cached objects for Jacobian/residual for each thread. More... | |
| std::set< BoundaryID > | _internal_sidesets |
| The BoundaryIDs on the local mesh that have internal RayBCs. More... | |
| std::vector< std::vector< std::vector< BoundaryID > > > | _internal_sidesets_map |
| Internal sideset data, if internal sidesets exist (indexed with getLocalElemIndex()) More... | |
| bool | _has_non_planar_sides |
| Whether or not the local mesh has elements with non-planar sides. More... | |
| std::vector< std::vector< unsigned short > > | _non_planar_sides |
| Non planar side data, which is for quick checking if an elem side is non-planar We use unsigned short here to avoid a std::vector<bool>; 0 = false, otherwise true. More... | |
| bool | _has_same_level_active_elems |
| Whether or not the mesh has active elements of the same level. More... | |
| libMesh::BoundingBox | _b_box |
| Nodal bounding box for the domain. More... | |
| libMesh::BoundingBox | _loose_b_box |
| Loose nodal bounding box for the domain. More... | |
| Real | _domain_max_length |
| An inflated max distance for the domain. More... | |
| Real | _total_volume |
| The total volume of the domain. More... | |
| std::vector< TheWarehouse::QueryCache< AttribSubdomains > > | _threaded_cache_ray_kernel |
| Threaded cached subdomain query for RayKernelBase objects pertaining to this study. More... | |
| std::vector< TheWarehouse::QueryCache< AttribBoundaries > > | _threaded_cache_ray_bc |
| Threaded cached boundary query for RayBC objects pertaining to this study. More... | |
| std::vector< std::vector< std::set< const RayTracingObject * > > > | _threaded_ray_object_registration |
| Threaded storage for all of the RayTracingObjects associated with a single Ray. More... | |
| std::vector< std::vector< RayKernelBase * > > | _threaded_current_ray_kernels |
| The current RayKernel objects for each thread. More... | |
| std::vector< std::shared_ptr< TraceRay > > | _threaded_trace_ray |
| The TraceRay objects for each thread (they do the physical tracing) More... | |
| std::vector< std::unique_ptr< libMesh::FEBase > > | _threaded_fe_face |
| Face FE used for computing face normals for each thread. More... | |
| std::vector< std::unique_ptr< libMesh::QBase > > | _threaded_q_face |
| Face quadrature used for computing face normals for each thread. More... | |
| std::vector< std::unordered_map< std::pair< const Elem *, unsigned short >, Point > > | _threaded_cached_normals |
| Threaded cache for side normals that have been computed already during tracing. More... | |
| std::vector< std::shared_ptr< Ray > > | _ray_bank |
| Cumulative Ray bank - stored only when _bank_rays_on_completion. More... | |
| std::vector< RayID > | _threaded_next_ray_id |
| Storage for the next available unique RayID, obtained via generateUniqueRayID() More... | |
| RayID | _replicated_next_ray_id |
| Storage for the next available replicated RayID, obtained via generateReplicatedRayID() More... | |
| const std::unique_ptr< ParallelRayStudy > | _parallel_ray_study |
| The study that used is to actually execute (trace) the Rays. More... | |
| std::unique_ptr< libMesh::QBase > | _segment_qrule |
| Quadrature rule for laying points across a 1D ray segment. More... | |
| unsigned long long int | _ending_processor_crossings |
| Total number of processor crossings for Rays that finished on this processor. More... | |
| unsigned int | _ending_max_processor_crossings |
| Max number of total processor crossings for Rays that finished on this processor. More... | |
| unsigned long long int | _total_processor_crossings |
| Total number of processor crossings. More... | |
| unsigned int | _max_processor_crossings |
| Max number of processor crossings for all Rays. More... | |
| unsigned long long int | _ending_intersections |
| Total number of Ray/element intersections for Rays that finished on this processor. More... | |
| unsigned int | _ending_max_intersections |
| Max number of intersections for Rays that finished on this processor. More... | |
| unsigned int | _ending_max_trajectory_changes |
| Max number of trajectory changes for Rays that finished on this processor. More... | |
| unsigned long long int | _total_intersections |
| Total number of Ray/element intersections. More... | |
| unsigned int | _max_intersections |
| Max number of intersections for a single Ray. More... | |
| unsigned int | _max_trajectory_changes |
| Max number of trajectory changes for a single Ray. More... | |
| Real | _ending_distance |
| Total distance traveled by Rays that end on this processor. More... | |
| Real | _total_distance |
| Total distance traveled by all Rays. More... | |
| std::vector< unsigned long long int > | _local_trace_ray_results |
| Cumulative results on this processor from the threaded TraceRay objects. More... | |
| std::unordered_map< SubdomainID, Real > | _subdomain_hmax |
| The cached hmax for all elements in a subdomain. More... | |
| bool | _called_initial_setup |
| Whether or not we've called initial setup - used to stop from late registration. More... | |
| ElemIndexHelper | _elem_index_helper |
| Helper for defining a local contiguous index for each element. More... | |
| Threads::spin_mutex | _spin_mutex |
| Spin mutex object for locks. More... | |
| std::chrono::steady_clock::time_point | _execution_start_time |
| Timing. More... | |
| std::chrono::steady_clock::duration | _execution_time |
| std::chrono::steady_clock::duration | _generation_time |
| std::chrono::steady_clock::duration | _propagation_time |
Base class for Ray tracing studies that will generate Rays and then propagate all of them to termination.
Subclasses must override generateRays()
Definition at line 40 of file RayTracingStudy.h.
| RayTracingStudy::RayTracingStudy | ( | const InputParameters & | parameters | ) |
Definition at line 130 of file RayTracingStudy.C.
Acquires a Ray that that is copied from another Ray within generateRays().
All of the information is copied except for the counters (intersections, processor crossings, etc), which are reset.
Definition at line 1835 of file RayTracingStudy.C.
Referenced by RepeatableRayStudyBaseTest::defineRays(), RayTracingStudyTest::generateRays(), and RepeatableRayStudyBase::generateRays().
|
protected |
User APIs for constructing Rays within the RayTracingStudy.
Rays can ONLY be constructed by users within the RayTracingStudy via the following methods. Acquire a Ray from the pool of Rays within generateRays().
A unique ID is generated and assigned to the acquired Ray. The data and aux data sizes are set according to the sizes required by the RayTracingStudy.
Definition at line 1771 of file RayTracingStudy.C.
Referenced by LotsOfRaysRayStudy::defineRay(), StationaryRayStudyTest::generateRays(), TestRay::generateRays(), RayTracingStudyTest::generateRays(), TestReuseRaysStudy::generateRays(), TestTransientRaysStudy::generateRays(), and ViewFactorRayStudy::generateRays().
| std::shared_ptr< Ray > RayTracingStudy::acquireRayDuringTrace | ( | const THREAD_ID | tid, |
| const AcquireMoveDuringTraceKey & | |||
| ) |
INTERNAL methods for acquiring a Ray during a trace in RayKernels and RayBCs.
You should not use these APIs directly. If you wish to acquire a Ray during generation during generateRays()), use the protected RayTracingStudy::acquire{}Ray() methods. If you wish to acquire a Ray during propagation in RayKernels and RayBC, use the protected RayKernelBase::acquireRay() and RayBoundaryConditionBase::acquireRay(), respectively.
Definition at line 1843 of file RayTracingStudy.C.
Referenced by RayBoundaryConditionBase::acquireRay(), and RayKernelBase::acquireRay().
|
inline |
Definition at line 489 of file RayTracingStudy.h.
Referenced by dataLoad(), and libMesh::Parallel::Packing< std::shared_ptr< Ray > >::unpack().
|
protected |
Acquires a Ray with a given name within generateRays().
Used when ray registration is enabled, that is, the private paramater '_use_ray_registration' == true.
This method must be called on all processors at the same time with the same name. This method can only be called on thread 0, which is why there is no thread argument.
Definition at line 1816 of file RayTracingStudy.C.
Referenced by RepeatableRayStudyBaseTest::defineRays(), RepeatableRayStudy::defineRays(), and RayTracingStudyTest::generateRays().
|
protected |
Acquire a Ray from the pool of Rays within generateRays() in a replicated fashion.
That is, this method must be called on all processors at the same time and the ID of the resulting Ray is the same across all processors.
The data and aux data sizes are set according to the sizes required by the RayTracingStudy.
Definition at line 1800 of file RayTracingStudy.C.
Referenced by ConeRayStudy::defineRays(), and TestPICRayStudy::generateRays().
|
protected |
Acquire a Ray from the pool of Rays within generateRays(), without resizing the data (sizes the data to zero).
A unique ID is generated and assigned to the acquired Ray.
Definition at line 1786 of file RayTracingStudy.C.
Referenced by LotsOfRaysRayStudy::defineRay().
|
inline |
Whether or not to store the Ray aux data on the cached Ray traces.
Definition at line 573 of file RayTracingStudy.h.
Referenced by TraceRay::continueTraceOffProcessor(), TraceRay::onCompleteTrace(), TraceRay::onContinueTrace(), TraceRay::onTrajectoryChanged(), RayTracingMeshOutput::RayTracingMeshOutput(), and TraceRay::trace().
|
inline |
Whether or not to bank Rays on completion.
Definition at line 214 of file RayTracingStudy.h.
Referenced by RayIntegralValue::initialize(), and RayDataValue::RayDataValue().
|
inline |
Get the nodal bounding box for the domain.
Definition at line 422 of file RayTracingStudy.h.
Referenced by TestRayDataStudy::auxDataValue(), TestRayDataStudy::dataValue(), LotsOfRaysRayStudy::defineRays(), and TraceRay::trace().
|
protectedvirtual |
Builds quadrature points for a given segment using the _segment_qrule.
| start | Start point of the segment |
| end | End point of the segment |
| length | The lengh of the start -> end segment |
| points | Points to fill into (should be sized ahead of time) |
| weights | Weights to fill into (should be sized ahead of time) |
Definition at line 814 of file RayTracingStudy.C.
Referenced by reinitSegment().
|
protected |
Helper function for computing the total domain volume.
Definition at line 1491 of file RayTracingStudy.C.
|
private |
Perform coverage checks (coverage of RayMaterials and RayKernels, if enabled)
Definition at line 319 of file RayTracingStudy.C.
Referenced by initialSetup().
|
inline |
Whether or not the study is generating.
Definition at line 641 of file RayTracingStudy.h.
Referenced by acquireCopiedRay(), acquireRay(), acquireRegisteredRay(), acquireReplicatedRay(), acquireUnsizedRay(), dataLoad(), moveRaysToBuffer(), moveRayToBuffer(), rayBank(), reserveRayBuffer(), Ray::resetCounters(), resetReplicatedRayIDs(), and resetUniqueRayIDs().
|
inline |
Whether or not the study is propagating (tracing Rays)
Definition at line 637 of file RayTracingStudy.h.
Referenced by RayBoundaryConditionBase::acquireRay(), RayKernelBase::acquireRay(), acquireRayDuringTrace(), ViewFactorRayStudy::addToViewFactorInfo(), RayKernelBase::changeRayStartDirection(), dataLoad(), initThreadedCachedTrace(), RayBoundaryConditionBase::moveRayToBuffer(), RayKernelBase::moveRayToBuffer(), moveRayToBufferDuringTrace(), onCompleteRay(), postOnSegment(), rayBank(), reinitSegment(), resetReplicatedRayIDs(), resetUniqueRayIDs(), segmentSubdomainSetup(), and TraceRay::trace().
|
inline |
Gets the current RayKernels for a thread, which are set in segmentSubdomainSetup()
Definition at line 414 of file RayTracingStudy.h.
Referenced by TraceRay::onCompleteTrace(), TraceRay::onSegment(), TraceRay::onSubdomainChanged(), reinitSegment(), and TraceRay::trace().
|
inlineprotected |
Gets the writeable current RayKernels for a thread.
Allows for other ray studies to fill the current ray kernels in a custom manner
Definition at line 721 of file RayTracingStudy.h.
|
inline |
Whether or not to store the Ray data on the cached Ray traces.
Definition at line 569 of file RayTracingStudy.h.
Referenced by TraceRay::continueTraceOffProcessor(), TraceRay::onCompleteTrace(), TraceRay::onContinueTrace(), TraceRay::onTrajectoryChanged(), RayTracingMeshOutput::RayTracingMeshOutput(), and TraceRay::trace().
|
private |
Perform checks to see if the listed dependencies in the RayTracingObjects exist.
Definition at line 351 of file RayTracingStudy.C.
Referenced by initialSetup().
|
inline |
Get the inflated maximum length across the domain.
Definition at line 433 of file RayTracingStudy.h.
Referenced by TraceRay::exitsElem(), and TraceRay::trace().
|
inline |
Get an element's side pointer without excessive memory allocation.
| elem | The element to build a side for |
| s | The side to build |
| tid | The thread id |
Definition at line 689 of file RayTracingStudy.h.
Referenced by LotsOfRaysRayStudy::defineRays(), StationaryRayStudyTest::generateRays(), nonPlanarSideSetup(), and ClaimRays::postClaimRay().
|
inline |
Total amount of distance traveled by the rays that end on this processor.
Definition at line 168 of file RayTracingStudy.h.
|
inline |
Total number of Ray/element intersections for Rays that finished on this processor.
Definition at line 147 of file RayTracingStudy.h.
|
inline |
Max number of intersections for Rays that finished on this processor.
Definition at line 151 of file RayTracingStudy.h.
|
inline |
Max number of total processor crossings for Rays that finished on this processor.
Definition at line 134 of file RayTracingStudy.h.
|
inline |
Total number of processor crossings for Rays that finished on this processor.
Definition at line 130 of file RayTracingStudy.h.
|
overridevirtual |
Executes the study (generates and propagates Rays)
Implements GeneralUserObject.
Reimplemented in SingleTraceLineSourceTest.
Definition at line 313 of file RayTracingStudy.C.
Referenced by SingleTraceLineSourceTest::execute().
| void RayTracingStudy::executeStudy | ( | ) |
Method for executing the study so that it can be called out of the standard UO execute()
Definition at line 875 of file RayTracingStudy.C.
Referenced by execute().
|
inline |
Duration for execute() in seconds.
Definition at line 189 of file RayTracingStudy.h.
|
inline |
Duration for execute() in nanoseconds.
Definition at line 193 of file RayTracingStudy.h.
|
inlineoverridevirtual |
|
protectedpure virtual |
Subclasses should override this to determine how to generate Rays.
This will be called within execute() and makes up the "generation phase" of the algorithm.
Implemented in ViewFactorRayStudy, RayTracingStudyWithRegistrationTest, RayTracingStudyNoBankingTest, RepeatableRayStudyBase, TestTransientRaysStudy, TestReuseRaysStudy, TestPICRayStudy, RayTracingStudyTest, StationaryRayStudyTest, and TestRay.
Referenced by executeStudy().
|
protected |
Generates a Ray ID that is replicated across all processors.
Definition at line 1754 of file RayTracingStudy.C.
Referenced by acquireReplicatedRay().
Generates a unique RayID to be used for a Ray.
This is used internally when acquiring new Rays.
Definition at line 1729 of file RayTracingStudy.C.
Referenced by acquireRay(), acquireRayDuringTrace(), and acquireUnsizedRay().
|
inline |
Duration for creation of all Rays in seconds.
Definition at line 200 of file RayTracingStudy.h.
Referenced by PerProcessorRayTracingResultsVectorPostprocessor::execute().
Gets the Ray with the ID ray_id from the Ray bank.
If the Ray with ray_id is not found across all processors, this will error.
This will ONLY return a valid Ray (not a null shared_ptr) on the processor that has the Ray.
Definition at line 1381 of file RayTracingStudy.C.
Referenced by getBankedRayDataInternal().
| RayData RayTracingStudy::getBankedRayAuxData | ( | const RayID | ray_id, |
| const RayDataIndex | index | ||
| ) | const |
Gets the data value for a banked ray with a given ID.
This will return the value replicated across all processors
Definition at line 1425 of file RayTracingStudy.C.
Referenced by RayDataValue::getValue().
| RayData RayTracingStudy::getBankedRayData | ( | const RayID | ray_id, |
| const RayDataIndex | index | ||
| ) | const |
Gets the data value for a banked ray with a given ID.
This will return the value replicated across all processors
Definition at line 1419 of file RayTracingStudy.C.
Referenced by RayDataValue::getValue(), and RayIntegralValue::getValue().
|
private |
Internal method for getting the value (replicated across all processors) in a Ray's data or aux data from the Ray banks.
Definition at line 1406 of file RayTracingStudy.C.
Referenced by getBankedRayAuxData(), and getBankedRayData().
|
inline |
Get the cached trace data structure.
Definition at line 595 of file RayTracingStudy.h.
Referenced by RayTracingMeshOutput::buildIDMap(), RayTracingMeshOutput::buildSegmentMesh(), RayTracingMeshOutput::fillFields(), and RayTracingMeshOutput::output().
|
inlinevirtual |
Gets the outward normals for a given element.
Returns a pointer to the normal for the zeroth side.
Reimplemented in BackfaceCullingStudyTest.
Definition at line 531 of file RayTracingStudy.h.
Referenced by TraceRay::moveThroughNeighbor(), RayTracingStudyTest::RayTracingStudyTest(), and TraceRay::trace().
| const std::vector<std::vector<BoundaryID> >& RayTracingStudy::getInternalSidesets | ( | const Elem * | elem | ) | const |
Get the internal sidesets (that have RayBC(s)) for each side for a given element.
This will be empty if the elem does not have any internal sidesets that have RayBC(s)
Referenced by TraceRay::applyOnInternalBoundary().
|
inline |
Gets the internal sidesets (that have RayBCs) within the local domain.
Definition at line 459 of file RayTracingStudy.h.
Referenced by ViewFactorRayStudy::initialSetup().
| RayDataIndex RayTracingStudy::getRayAuxDataIndex | ( | const std::string & | name, |
| const bool | graceful = false |
||
| ) | const |
Gets the index associated with a registered value in the Ray aux data.
| name | The value name to get the index of |
| graceful | Whether or not to exit gracefully if none is found (return INVALID_RAY_DATA_INDEX) |
Definition at line 1214 of file RayTracingStudy.C.
Referenced by RayDataValue::initialize(), RayTracingStudyTest::RayTracingStudyTest(), and RayTracingMeshOutput::setupEquationSystem().
| std::vector< RayDataIndex > RayTracingStudy::getRayAuxDataIndices | ( | const std::vector< std::string > & | names, |
| const bool | graceful = false |
||
| ) | const |
Gets the indices associated with registered values in the Ray aux data.
| names | The value names to get the indices of |
| graceful | Whether or not to exit gracefully if none is found (index is filled with INVALID_RAY_DATA_INDEX) |
Definition at line 1221 of file RayTracingStudy.C.
| const std::string & RayTracingStudy::getRayAuxDataName | ( | const RayDataIndex | index | ) | const |
Gets the name associated with a registered value in the Ray aux data.
| index | The index to get the name of |
Definition at line 1228 of file RayTracingStudy.C.
Referenced by Ray::getInfo().
| std::vector<std::string> RayTracingStudy::getRayAuxDataNames | ( | const std::vector< RayDataIndex > & | indices | ) | const |
Gets the names associated with registered values in the Ray aux data.
| indices | The indices to get the names of |
| void RayTracingStudy::getRayBCs | ( | std::vector< RayBoundaryConditionBase *> & | result, |
| BoundaryID | id, | ||
| THREAD_ID | tid | ||
| ) |
Fills the active RayBCs associated with this study and a boundary into result.
Definition at line 1292 of file RayTracingStudy.C.
Referenced by dependencyChecks(), getRayBCs(), ViewFactorRayStudy::initialSetup(), internalSidesetSetup(), TraceRay::onBoundary(), periodicBoundaryChecks(), and RayTracingStudyTest::RayTracingStudyTest().
|
inline |
Fills the active RayBCs associated with this study and boundaries result.
Definition at line 376 of file RayTracingStudy.h.
|
inline |
Fills the active RayBCs associated with this study into result.
Definition at line 390 of file RayTracingStudy.h.
|
virtual |
Fills the active RayBCs associated with thie study, boundary elements, and potentially Ray into result.
This is purposely virtual because it allows derived studies to optimize the retrieval of RayBCs during the trace in TraceRay.
Definition at line 1315 of file RayTracingStudy.C.
| RayDataIndex RayTracingStudy::getRayDataIndex | ( | const std::string & | name, |
| const bool | graceful = false |
||
| ) | const |
Gets the index associated with a registered value in the Ray data.
| name | The value name to get the index of |
| graceful | Whether or not to exit gracefully if none is found (return INVALID_RAY_DATA_INDEX) |
Definition at line 1183 of file RayTracingStudy.C.
Referenced by RayDataValue::initialize(), RayIntegralValue::initialize(), RayTracingStudyTest::RayTracingStudyTest(), and RayTracingMeshOutput::setupEquationSystem().
|
private |
Internal method for getting the index of Ray data or Ray aux data.
Definition at line 1119 of file RayTracingStudy.C.
Referenced by getRayAuxDataIndex(), getRayDataIndex(), and getRayDataIndicesInternal().
| std::vector< RayDataIndex > RayTracingStudy::getRayDataIndices | ( | const std::vector< std::string > & | names, |
| const bool | graceful = false |
||
| ) | const |
Gets the indices associated with registered values in the Ray data.
| names | The value names to get the indices of |
| graceful | Whether or not to exit gracefully if none is found (index is filled with INVALID_RAY_DATA_INDEX) |
Definition at line 1189 of file RayTracingStudy.C.
|
private |
Internal method for getting the indicies of Ray data or Ray aux data.
Definition at line 1150 of file RayTracingStudy.C.
Referenced by getRayAuxDataIndices(), and getRayDataIndices().
| const std::string & RayTracingStudy::getRayDataName | ( | const RayDataIndex | index | ) | const |
Gets the name associated with a registered value in the Ray data.
| index | The index to get the name of |
Definition at line 1196 of file RayTracingStudy.C.
Referenced by Ray::getInfo(), and RayTracingStudyTest::RayTracingStudyTest().
|
private |
Internal method for getting the name of Ray data or Ray aux data.
Definition at line 1161 of file RayTracingStudy.C.
Referenced by getRayAuxDataName(), and getRayDataName().
| std::vector<std::string> RayTracingStudy::getRayDataNames | ( | const std::vector< RayDataIndex > & | indices | ) | const |
Gets the names associated with registered values in the Ray data.
| indices | The indices to get the names of |
| void RayTracingStudy::getRayKernels | ( | std::vector< RayKernelBase *> & | result, |
| SubdomainID | id, | ||
| THREAD_ID | tid | ||
| ) |
Fills the active RayKernels associated with this study and a block into result.
Definition at line 1242 of file RayTracingStudy.C.
Referenced by coverageChecks(), dependencyChecks(), getRayKernels(), hasRayKernels(), initialSetup(), RayTracingStudyTest::RayTracingStudyTest(), segmentSubdomainSetup(), and zeroAuxVariables().
|
inline |
Fills the active RayKernels associated with this study into result.
Definition at line 354 of file RayTracingStudy.h.
| void RayTracingStudy::getRayKernels | ( | std::vector< RayKernelBase *> & | result, |
| SubdomainID | id, | ||
| THREAD_ID | tid, | ||
| RayID | ray_id | ||
| ) |
Fills the active RayKernels associeted with this study, block, and potentially Ray into result.
Definition at line 1263 of file RayTracingStudy.C.
|
protected |
Gets all of the currently active RayTracingObjects.
Definition at line 1361 of file RayTracingStudy.C.
Referenced by executeStudy(), initialSetup(), jacobianSetup(), registeredRaySetup(), residualSetup(), and timestepSetup().
|
virtual |
Get the outward normal for a given element side.
Definition at line 1654 of file RayTracingStudy.C.
Referenced by LotsOfRaysRayStudy::defineRays(), BackfaceCullingStudyTest::generateNormals(), ViewFactorRayStudy::generateRays(), TraceRay::getPointNeighbors(), ReflectRayBC::onBoundary(), sideIsIncoming(), and TraceRay::trace().
|
inline |
Whether or not the local mesh has internal sidesets that have RayBCs on them.
NOTE: if useInternalSidesets() == false, this will be false even if the mesh does have internal sidesets
Definition at line 449 of file RayTracingStudy.h.
Referenced by TraceRay::applyOnInternalBoundary(), and TraceRay::trace().
|
inline |
Whether or not any Ray aux data are registered.
Definition at line 336 of file RayTracingStudy.h.
|
inline |
Whether or not any Ray data are registered.
Definition at line 276 of file RayTracingStudy.h.
Referenced by RayTracingMeshOutput::fillFields().
| bool RayTracingStudy::hasRayKernels | ( | const THREAD_ID | tid | ) |
Whether or not there are currently any active RayKernel objects.
Definition at line 1234 of file RayTracingStudy.C.
Referenced by ViewFactorRayStudy::initialSetup(), and TraceRay::preExecute().
|
inline |
Whether or not the mesh has active elements of the same level.
Use this over sameLevelActiveElems(), which is for internally setting _has_same_level_active_elems
Definition at line 475 of file RayTracingStudy.h.
Referenced by TraceRay::applyOnInternalBoundary(), and TraceRay::trace().
|
inlineoverridevirtual |
|
overridevirtual |
Reimplemented from GeneralUserObject.
Reimplemented in BackfaceCullingStudyTest, and ViewFactorRayStudy.
Definition at line 226 of file RayTracingStudy.C.
Referenced by ViewFactorRayStudy::initialSetup(), and BackfaceCullingStudyTest::initialSetup().
| TraceData & RayTracingStudy::initThreadedCachedTrace | ( | const std::shared_ptr< Ray > & | ray, |
| THREAD_ID | tid | ||
| ) |
Initialize a Ray in the threaded cached trace map to be filled with segments.
Definition at line 1513 of file RayTracingStudy.C.
Referenced by TraceRay::trace().
|
private |
Does the setup for internal sidesets.
This includes:
If _use_internal_sidesets == false, this will still check to make sure that the user does not have internal sidesets with RayBCs on them, and will report an error if so.
Definition at line 516 of file RayTracingStudy.C.
Referenced by initialSetup(), and meshChanged().
| bool RayTracingStudy::isRectangularDomain | ( | ) | const |
Whether or not the domain is rectangular (if it is prefectly encompassed by its bounding box)
Definition at line 1705 of file RayTracingStudy.C.
Referenced by LotsOfRaysRayStudy::LotsOfRaysRayStudy(), and TraceRay::preExecute().
|
overridevirtual |
Reimplemented from GeneralUserObject.
Definition at line 282 of file RayTracingStudy.C.
|
private |
Sets up the _elem_index_helper, which is used for obtaining a contiguous index for all elements that this processor knows about.
Said index is used for quickly accessing things like internal sidesets and checking if an element side is non-planar during tracing.
Definition at line 508 of file RayTracingStudy.C.
Referenced by initialSetup(), and meshChanged().
Definition at line 174 of file RayTracingStudy.h.
Referenced by PerProcessorRayTracingResultsVectorPostprocessor::execute().
|
inline |
Get the loose nodal bounding box for the domain.
BoundingBox::contains_point does not have a tolerance, so we need to stretch the box a little bit for some contains_point checks.
Definition at line 429 of file RayTracingStudy.h.
Referenced by Ray::setStart(), and Ray::setStartingEndPoint().
|
inline |
Max number of intersections for a Ray.
Definition at line 159 of file RayTracingStudy.h.
|
inline |
Max number of processor crossings for all Rays.
Definition at line 142 of file RayTracingStudy.h.
Referenced by RayTracingStudyResult::getValue().
|
inline |
Max number of trajectory changes for a Ray.
Definition at line 163 of file RayTracingStudy.h.
|
inline |
Definition at line 520 of file RayTracingStudy.h.
|
inline |
Access to the libMesh MeshBase.
This is needed for unpack routines for a Ray, which has a context of this study.
Definition at line 515 of file RayTracingStudy.h.
Referenced by dataLoad(), TestRay::generateRays(), libMesh::Parallel::Packing< ViewFactorRayStudy::StartElem >::pack(), libMesh::Parallel::Packing< std::shared_ptr< Ray > >::pack(), TestRayLots::postExecuteStudy(), RayTracingStudyTest::RayTracingStudyTest(), Ray::setStart(), libMesh::Parallel::Packing< ViewFactorRayStudy::StartElem >::unpack(), and libMesh::Parallel::Packing< std::shared_ptr< Ray > >::unpack().
|
overridevirtual |
Reimplemented from GeneralUserObject.
Reimplemented in RepeatableRayStudyBase, and BackfaceCullingStudyTest.
Definition at line 299 of file RayTracingStudy.C.
Referenced by RepeatableRayStudyBase::meshChanged().
Moves rays to the buffer to be traced during generateRays().
This moves the rays into the buffer (with std::move), therefore all valid rays in rays will be nullptr after this call.
Definition at line 1619 of file RayTracingStudy.C.
Referenced by TestPICRayStudy::generateRays(), TestReuseRaysStudy::generateRays(), and TestTransientRaysStudy::generateRays().
Moves a ray to the buffer to be traced during generateRays().
This moves the Ray into the buffer (with std::move), therefore ray will be nullptr after this call.
Definition at line 1609 of file RayTracingStudy.C.
Referenced by RayTracingStudyTest::generateRays(), StationaryRayStudyTest::generateRays(), TestReuseRaysStudy::generateRays(), TestTransientRaysStudy::generateRays(), RepeatableRayStudyBase::generateRays(), and ViewFactorRayStudy::generateRays().
| void RayTracingStudy::moveRayToBufferDuringTrace | ( | std::shared_ptr< Ray > & | ray, |
| const THREAD_ID | tid, | ||
| const AcquireMoveDuringTraceKey & | |||
| ) |
INTERNAL method for moving a Ray into the buffer during tracing.
You should not and cannot use this API. It is protected by the AcquireMoveDuringTraceKey, which is only constructable by RayKernelBase and RayBoundaryConditionBase.
Definition at line 1634 of file RayTracingStudy.C.
Referenced by RayBoundaryConditionBase::moveRayToBuffer(), and RayKernelBase::moveRayToBuffer().
|
private |
Sets up the caching of whether or not each element side is non-planar, which is stored in _non_planar_sides.
This is done because this check is made within TraceRay, and determining whether or not a side is non planar is quite expensive and we don't want to call it mid-trace.
Definition at line 573 of file RayTracingStudy.C.
Referenced by initialSetup(), and meshChanged().
Entry point for acting on a ray when it is completed (shouldContinue() == false)
Reimplemented in TestRayDataStudy.
Definition at line 1058 of file RayTracingStudy.C.
Referenced by TestRayDataStudy::onCompleteRay(), and ParallelRayStudy::postExecuteChunk().
|
inline |
Definition at line 179 of file RayTracingStudy.h.
Referenced by PerProcessorRayTracingResultsVectorPostprocessor::execute(), and RayTracingStudyResult::getValue().
|
inline |
The underlying parallel study: used for the context for calling the packed range routines.
Definition at line 678 of file RayTracingStudy.h.
Referenced by RayTracingStudyTest::generateRays(), and RepeatableRayStudyBase::verifyReplicatedRays().
|
private |
Check for overlapping PeriodicRayBC boundaries and check for cases in which ghosting may not be sufficient with distributed mesh for overlapping periodic boundaries.
Definition at line 401 of file RayTracingStudy.C.
Referenced by initialSetup().
|
inlineprotectedvirtual |
Entry point after study execution.
Reimplemented in ViewFactorRayStudy, TestTransientRaysStudy, TestReuseRaysStudy, TestPICRayStudy, RayTracingStudyTest, and TestRayLots.
Definition at line 709 of file RayTracingStudy.h.
Referenced by executeStudy().
|
virtual |
Called at the end of a Ray segment.
| tid | Thread id |
| ray | The ray |
Definition at line 842 of file RayTracingStudy.C.
Referenced by TraceRay::trace().
|
inlineprotectedvirtual |
Entry point before study execution.
Reimplemented in ViewFactorRayStudy.
Definition at line 705 of file RayTracingStudy.h.
Referenced by executeStudy().
|
inlinevirtual |
Called at the beginning of a trace for a ray.
| tid | Thread id |
| ray | The ray |
Definition at line 120 of file RayTracingStudy.h.
Referenced by TraceRay::trace().
|
inline |
Duration for creation of all Rays in seconds.
Definition at line 204 of file RayTracingStudy.h.
Referenced by PerProcessorRayTracingResultsVectorPostprocessor::execute().
|
inline |
The Ray aux data names.
Definition at line 340 of file RayTracingStudy.h.
Referenced by RayTracingMeshOutput::setupEquationSystem().
|
inline |
The registered size of values in the Ray aux data.
Definition at line 332 of file RayTracingStudy.h.
Referenced by acquireRay(), acquireRayDuringTrace(), acquireRegisteredRay(), acquireReplicatedRay(), Ray::auxData(), and getRayDataNameInternal().
|
protected |
Get the Ray bank.
This is the bank of Rays that have completed on this processor after an execution of the study.
This is only available when the private parameter _bank_rays_on_completion is set to true.
Definition at line 1369 of file RayTracingStudy.C.
Referenced by RayTracingStudyTest::generateRays(), getBankedRay(), TestRayLots::postExecuteStudy(), RayTracingStudyTest::postExecuteStudy(), TestPICRayStudy::postExecuteStudy(), TestReuseRaysStudy::postExecuteStudy(), TestTransientRaysStudy::postExecuteStudy(), and RayTracingStudyNoBankingTest::RayTracingStudyNoBankingTest().
|
inline |
The Ray data names.
Definition at line 280 of file RayTracingStudy.h.
Referenced by RayTracingExodus::outputMesh(), RayTracingNemesis::outputMesh(), and RayTracingMeshOutput::setupEquationSystem().
|
inline |
The registered size of values in the Ray data.
Definition at line 272 of file RayTracingStudy.h.
Referenced by acquireRay(), acquireRayDuringTrace(), acquireRegisteredRay(), acquireReplicatedRay(), Ray::data(), and getRayDataNameInternal().
|
inline |
Whether or not to use Ray dependent subdomain setup.
Definition at line 219 of file RayTracingStudy.h.
Referenced by TraceRay::trace().
|
inline |
Max distance any Ray can travel.
Definition at line 184 of file RayTracingStudy.h.
Referenced by TraceRay::trace().
| RayID RayTracingStudy::registeredRayID | ( | const std::string & | name, |
| const bool | graceful = false |
||
| ) | const |
Gets the ID of a registered ray.
| name | The name of said ray |
| graceful | Whether or not to exit gracefully if none is found (with invalid_id) |
Definition at line 1455 of file RayTracingStudy.C.
Referenced by RayDataValue::getValue(), RayIntegralValue::initialize(), RayTracingStudyTest::RayTracingStudyTest(), RayTracingStudyWithRegistrationTest::RayTracingStudyWithRegistrationTest(), and registeredRaySetup().
| const std::string & RayTracingStudy::registeredRayName | ( | const RayID | ray_id | ) | const |
Gets the name of a registered ray.
| ray_id | The ID of said ray |
Definition at line 1475 of file RayTracingStudy.C.
Referenced by Ray::getInfo(), RayTracingStudyTest::RayTracingStudyTest(), and RayTracingStudyWithRegistrationTest::RayTracingStudyWithRegistrationTest().
|
private |
Sets up the maps from Ray to associated RayTracingObjects if _use_ray_registration.
If ray registration is disabled, this makes sure no RayTracingObjects provided rays.
Definition at line 671 of file RayTracingStudy.C.
Referenced by executeStudy().
|
private |
Registers a Ray with a given name.
This is for internal use only and is an internal map for replicated Ray IDs -> names for easy access for studies that have a small number of rays to generate.
| name | The name to register |
Definition at line 1431 of file RayTracingStudy.C.
Referenced by acquireRegisteredRay().
| RayDataIndex RayTracingStudy::registerRayAuxData | ( | const std::string & | name | ) |
Register a value to be filled in the aux data on a Ray with a given name.
| name | The name to register |
Note that this does not actually allocate the storage. It is simply a registration system to keep track of the values stored in the Ray aux data.
Definition at line 1202 of file RayTracingStudy.C.
Referenced by RayTracingStudyTest::RayTracingStudyTest(), StationaryRayStudyTest::StationaryRayStudyTest(), TestRayDataStudy::TestRayDataStudy(), and TestRayLots::TestRayLots().
| std::vector< RayDataIndex > RayTracingStudy::registerRayAuxData | ( | const std::vector< std::string > & | names | ) |
Register values to be filled in the aux data on a Ray with a given name.
| names | The names to register |
Note that this does not actually allocate the storage. It is simply a registration system to keep track of the values stored in the Ray aux data.
Definition at line 1208 of file RayTracingStudy.C.
| RayDataIndex RayTracingStudy::registerRayData | ( | const std::string & | name | ) |
Register a value to be filled in the data on a Ray with a given name.
| name | The name to register |
Note that this does not actually allocate the storage. It is simply a registration system to keep track of the values stored in the Ray data.
Definition at line 1171 of file RayTracingStudy.C.
Referenced by RayTracingStudyTest::generateRays(), RayTracingStudyTest::RayTracingStudyTest(), StationaryRayStudyTest::StationaryRayStudyTest(), TestRayDataStudy::TestRayDataStudy(), and TestRayLots::TestRayLots().
| std::vector< RayDataIndex > RayTracingStudy::registerRayData | ( | const std::vector< std::string > & | names | ) |
Register values to be filled in the data on a Ray with a given name.
| names | The names to register |
Note that this does not actually allocate the storage. It is simply a registration system to keep track of the values stored in the Ray data.
Definition at line 1177 of file RayTracingStudy.C.
|
private |
Internal method for registering Ray data or Ray aux data with a name.
Definition at line 1079 of file RayTracingStudy.C.
Referenced by registerRayAuxData(), registerRayData(), and registerRayDataInternal().
|
private |
Internal method for registering Ray data or Ray aux data with names.
Definition at line 1110 of file RayTracingStudy.C.
|
virtual |
Reinitialize objects for a Ray segment for ray tracing.
| elem | The elem the segment is in |
| start | Start point of the segment |
| end | End point of the segment |
| length | The length of the start -> end segment |
| tid | Thread id |
Definition at line 778 of file RayTracingStudy.C.
Referenced by TraceRay::onSegment().
|
protected |
Reserve size entires in the Ray buffer.
This can only be used within generateRays() and should be used when possible to reserve entires in the buffer before adding Rays via moveRay(s)ToBuffer.
Definition at line 1645 of file RayTracingStudy.C.
Referenced by RepeatableRayStudyBase::generateRays(), ViewFactorRayStudy::generateRays(), and RayTracingStudyTest::RayTracingStudyTest().
|
protected |
Resets the generation of unique replicated RayIDs accessed via generateReplicatedRayID().
Definition at line 1741 of file RayTracingStudy.C.
Referenced by RayTracingStudy().
|
protected |
Resets the generation of unique RayIDs via generateUniqueRayID() to the beginning of the range.
Definition at line 1715 of file RayTracingStudy.C.
Referenced by RayTracingStudy().
|
overridevirtual |
Reimplemented from GeneralUserObject.
Definition at line 272 of file RayTracingStudy.C.
|
protected |
Determine whether or not the mesh currently has active elements that are all the same level.
Definition at line 1677 of file RayTracingStudy.C.
Referenced by meshChanged().
|
inline |
Whether or not to cache individual element segments when _cache_traces = true.
Definition at line 577 of file RayTracingStudy.h.
Referenced by RayTracingMeshOutput::buildSegmentMesh(), RayTracingMeshOutput::neededNodes(), TraceRay::onContinueTrace(), TraceRay::onTrajectoryChanged(), RayTracingMeshOutput::RayTracingMeshOutput(), and RayTracingMeshOutput::startingIDs().
|
virtual |
Setup for on subdomain change or subdomain AND ray change during ray tracing.
| subdomain | The subdomain changed to |
| tid | Thread id |
| ray_id | ID of the ray initiating the change |
Definition at line 743 of file RayTracingStudy.C.
Referenced by TraceRay::onSubdomainChanged().
|
inlinevirtual |
Virtual that allows for selection in if a Ray should be cached or not (only used when _cache_traces).
Definition at line 583 of file RayTracingStudy.h.
Referenced by initThreadedCachedTrace(), and TraceRay::trace().
| bool RayTracingStudy::sideIsIncoming | ( | const Elem *const | elem, |
| const unsigned short | side, | ||
| const Point & | direction, | ||
| const THREAD_ID | tid | ||
| ) |
Whether or not side is incoming on element elem in direction direction.
Definition at line 1760 of file RayTracingStudy.C.
Referenced by TraceRay::findExternalBoundarySide(), TraceRay::onSegment(), ClaimRays::postClaimRay(), and TraceRay::trace().
|
inline |
Whether or not the side on elem elem is non-planar.
This is cached because checking whether or not a face is planar is costly
Definition at line 465 of file RayTracingStudy.h.
Referenced by TraceRay::exitsElem(), ViewFactorRayStudy::generateRays(), ReflectRayBC::onBoundary(), TraceRay::onSegment(), TraceRay::possiblyAddToBoundaryElems(), Ray::setStart(), and TraceRay::trace().
| Real RayTracingStudy::subdomainHmax | ( | const SubdomainID | subdomain_id | ) | const |
Get the cached hmax for all elements in a subdomain.
Used for scaling tolerances in ray tracing.
Definition at line 1696 of file RayTracingStudy.C.
Referenced by RayTracingStudyTest::generateRays(), TraceRay::onSubdomainChanged(), TraceRay::subdomainHmax(), and subdomainHMaxSetup().
|
private |
Caches the hmax for all elements in each subdomain.
Definition at line 617 of file RayTracingStudy.C.
Referenced by initialSetup(), and meshChanged().
|
overridevirtual |
Reimplemented from GeneralUserObject.
Definition at line 292 of file RayTracingStudy.C.
|
inline |
Whether or not to tolerate failure.
Definition at line 209 of file RayTracingStudy.h.
Referenced by TraceRay::exitsElem(), TraceRay::onBoundary(), and TraceRay::trace().
|
inline |
Total distance traveled by all Rays.
Definition at line 172 of file RayTracingStudy.h.
Referenced by RayTracingStudyResult::getValue().
|
inline |
Total number of Ray/element intersections.
Definition at line 155 of file RayTracingStudy.h.
|
inline |
Total number of processor crossings.
Definition at line 138 of file RayTracingStudy.h.
Referenced by RayTracingStudyResult::getValue().
|
inline |
Get the current total volume of the domain.
Definition at line 437 of file RayTracingStudy.h.
Referenced by isRectangularDomain().
|
private |
Check for if all of the element types in the mesh are supported by ray tracing.
Definition at line 382 of file RayTracingStudy.C.
Referenced by initialSetup().
Gets the threaded TraceRay object for tid.
Definition at line 647 of file RayTracingStudy.h.
Referenced by BackfaceCullingStudyTest::BackfaceCullingStudyTest().
Definition at line 648 of file RayTracingStudy.h.
|
inline |
Whether or not ray registration is being used.
Definition at line 564 of file RayTracingStudy.h.
Referenced by Ray::getInfo(), RayIntegralValue::initialize(), and RayDataValue::RayDataValue().
|
static |
Whether or not subdomain setup is dependent on the Ray
Definition at line 33 of file RayTracingStudy.C.
Referenced by StationaryRayStudyTest::validParams(), TestRay::validParams(), RayTracingStudyTest::validParams(), TestPICRayStudy::validParams(), ViewFactorRayStudy::validParams(), TestReuseRaysStudy::validParams(), TestTransientRaysStudy::validParams(), RepeatableRayStudyBase::validParams(), RayTracingStudyNoBankingTest::validParams(), and RayTracingStudyWithRegistrationTest::validParams().
|
private |
Verifies that the dependencies exist for a set of RayTracingObjects.
Definition at line 363 of file RayTracingStudy.C.
Referenced by dependencyChecks().
|
inline |
Whether or not to verify if Rays have valid information before being traced.
Definition at line 654 of file RayTracingStudy.h.
Referenced by RayKernelBase::changeRayStartDirection(), ClaimRays::claim(), RepeatableRayStudyBase::defineRaysInternal(), executeStudy(), Ray::setStart(), Ray::setStartingEndPoint(), and TraceRay::trace().
|
inline |
Whether or not trace verification is enabled in devel/dbg modes.
Definition at line 659 of file RayTracingStudy.h.
Referenced by TraceRay::exitsElem(), TraceRay::onSegment(), TraceRay::onTrajectoryChanged(), and TraceRay::trace().
| void RayTracingStudy::verifyUniqueRayIDs | ( | const std::vector< std::shared_ptr< Ray >>::const_iterator | begin, |
| const std::vector< std::shared_ptr< Ray >>::const_iterator | end, | ||
| const bool | global, | ||
| const std::string & | error_suffix | ||
| ) | const |
Verifies that the Rays in the given range have unique Ray IDs.
| begin | The beginning of the range of Rays to check |
| end | The end of the range of Rays to check |
| global | If true, this will complete the verification across all processors |
| error_suffix | Entry point for additional information in the error message |
Definition at line 1523 of file RayTracingStudy.C.
Referenced by executeStudy(), and RepeatableRayStudyBase::verifyReplicatedRays().
| void RayTracingStudy::verifyUniqueRays | ( | const std::vector< std::shared_ptr< Ray >>::const_iterator | begin, |
| const std::vector< std::shared_ptr< Ray >>::const_iterator | end, | ||
| const std::string & | error_suffix | ||
| ) |
Verifies that the Rays in the given range are unique.
That is, that there are not multiple shared_ptrs that point to the same Ray
| begin | The beginning of the range of Rays to check |
| end | The end of the range of Rays to check |
| error_suffix | Entry point for additional information in the error message |
Definition at line 1595 of file RayTracingStudy.C.
Referenced by executeStudy().
|
inline |
Whether or not to produce a warning when interacting with a non-planar mesh.
Definition at line 673 of file RayTracingStudy.h.
|
private |
Zero the AuxVariables that the registered AuxRayKernels contribute to.
Definition at line 725 of file RayTracingStudy.C.
Referenced by executeStudy().
|
protected |
Whether or not to cache traces on every trace execution.
Definition at line 883 of file RayTracingStudy.h.
Referenced by shouldCacheTrace().
|
protected |
Whether or not to store the Ray aux data on the cache traces.
Definition at line 887 of file RayTracingStudy.h.
Referenced by auxDataOnCacheTraces().
|
private |
Nodal bounding box for the domain.
Definition at line 1067 of file RayTracingStudy.h.
Referenced by boundingBox(), isRectangularDomain(), and RayTracingStudy().
|
protected |
Whether or not to bank rays on completion.
Definition at line 878 of file RayTracingStudy.h.
Referenced by bankRaysOnCompletion(), onCompleteRay(), and rayBank().
|
private |
Storage for the cached traces.
Definition at line 1047 of file RayTracingStudy.h.
Referenced by executeStudy(), and getCachedTraces().
|
private |
Whether or not we've called initial setup - used to stop from late registration.
Definition at line 1139 of file RayTracingStudy.h.
Referenced by executeStudy(), getRayBCs(), getRayKernels(), initialSetup(), and registerRayDataInternal().
|
protected |
The Communicator.
Definition at line 863 of file RayTracingStudy.h.
Referenced by LotsOfRaysRayStudy::defineRays().
|
protected |
Whether or not to store the Ray data on the cache traces.
Definition at line 885 of file RayTracingStudy.h.
Referenced by dataOnCacheTraces().
|
private |
An inflated max distance for the domain.
Definition at line 1071 of file RayTracingStudy.h.
Referenced by domainMaxLength().
|
private |
Helper for defining a local contiguous index for each element.
Definition at line 1142 of file RayTracingStudy.h.
Referenced by internalSidesetSetup(), localElemIndexSetup(), nonPlanarSideSetup(), and sideIsNonPlanar().
|
private |
Total distance traveled by Rays that end on this processor.
Definition at line 1128 of file RayTracingStudy.h.
Referenced by endingDistance(), executeStudy(), and onCompleteRay().
|
private |
Total number of Ray/element intersections for Rays that finished on this processor.
Definition at line 1115 of file RayTracingStudy.h.
Referenced by endingIntersections(), executeStudy(), and onCompleteRay().
|
private |
Max number of intersections for Rays that finished on this processor.
Definition at line 1117 of file RayTracingStudy.h.
Referenced by endingMaxIntersections(), executeStudy(), and onCompleteRay().
|
private |
Max number of total processor crossings for Rays that finished on this processor.
Definition at line 1108 of file RayTracingStudy.h.
Referenced by endingMaxProcessorCrossings(), executeStudy(), and onCompleteRay().
|
private |
Max number of trajectory changes for Rays that finished on this processor.
Definition at line 1119 of file RayTracingStudy.h.
Referenced by executeStudy(), and onCompleteRay().
|
private |
Total number of processor crossings for Rays that finished on this processor.
Definition at line 1106 of file RayTracingStudy.h.
Referenced by endingProcessorCrossings(), executeStudy(), and onCompleteRay().
|
private |
|
private |
Definition at line 1026 of file RayTracingStudy.h.
Referenced by executeStudy(), executionTime(), and executionTimeNano().
|
private |
Definition at line 1027 of file RayTracingStudy.h.
Referenced by executeStudy(), and generationTime().
|
private |
Whether or not the local mesh has elements with non-planar sides.
Definition at line 1059 of file RayTracingStudy.h.
Referenced by nonPlanarSideSetup(), and sideIsNonPlanar().
|
private |
Whether or not the mesh has active elements of the same level.
Definition at line 1064 of file RayTracingStudy.h.
Referenced by hasSameLevelActiveElems(), and meshChanged().
|
private |
The BoundaryIDs on the local mesh that have internal RayBCs.
Definition at line 1055 of file RayTracingStudy.h.
Referenced by getInternalSidesets(), hasInternalSidesets(), and internalSidesetSetup().
|
private |
Internal sideset data, if internal sidesets exist (indexed with getLocalElemIndex())
Definition at line 1057 of file RayTracingStudy.h.
Referenced by internalSidesetSetup().
|
private |
Cumulative results on this processor from the threaded TraceRay objects.
Definition at line 1133 of file RayTracingStudy.h.
Referenced by executeStudy(), and localTraceRayResult().
|
private |
Loose nodal bounding box for the domain.
Definition at line 1069 of file RayTracingStudy.h.
Referenced by looseBoundingBox(), and RayTracingStudy().
|
private |
Max number of intersections for a single Ray.
Definition at line 1123 of file RayTracingStudy.h.
Referenced by executeStudy(), and maxIntersections().
|
private |
Max number of processor crossings for all Rays.
Definition at line 1112 of file RayTracingStudy.h.
Referenced by executeStudy(), and maxProcessorCrossings().
|
private |
Max number of trajectory changes for a single Ray.
Definition at line 1125 of file RayTracingStudy.h.
Referenced by executeStudy(), and maxTrajectoryChanges().
|
protected |
The Mesh.
Definition at line 861 of file RayTracingStudy.h.
Referenced by computeTotalVolume(), ConeRayStudy::ConeRayStudy(), coverageChecks(), RepeatableRayStudyBaseTest::defineRays(), ConeRayStudy::defineRays(), LotsOfRaysRayStudy::defineRays(), BackfaceCullingStudyTest::generateNormals(), RayTracingStudyTest::generateRays(), StationaryRayStudyTest::generateRays(), TestRay::generateRays(), TestReuseRaysStudy::generateRays(), TestTransientRaysStudy::generateRays(), ViewFactorRayStudy::generateStartElems(), internalSidesetSetup(), isRectangularDomain(), localElemIndexSetup(), LotsOfRaysRayStudy::LotsOfRaysRayStudy(), mesh(), meshBase(), nonPlanarSideSetup(), periodicBoundaryChecks(), RayTracingStudy(), sameLevelActiveElems(), subdomainHMaxSetup(), TestReuseRaysStudy::TestReuseRaysStudy(), traceableMeshChecks(), and ViewFactorRayStudy::ViewFactorRayStudy().
|
private |
Non planar side data, which is for quick checking if an elem side is non-planar We use unsigned short here to avoid a std::vector<bool>; 0 = false, otherwise true.
Definition at line 1062 of file RayTracingStudy.h.
Referenced by nonPlanarSideSetup(), and sideIsNonPlanar().
|
private |
Number of currently cached objects for Jacobian/residual for each thread.
Definition at line 1052 of file RayTracingStudy.h.
Referenced by executeStudy(), jacobianSetup(), postOnSegment(), and residualSetup().
|
private |
The study that used is to actually execute (trace) the Rays.
Definition at line 1100 of file RayTracingStudy.h.
Referenced by acquireCopiedRay(), acquireRay(), acquireRayDuringTrace(), acquireRayInternal(), acquireRegisteredRay(), acquireReplicatedRay(), acquireUnsizedRay(), currentlyGenerating(), currentlyPropagating(), executeStudy(), moveRaysToBuffer(), moveRayToBuffer(), moveRayToBufferDuringTrace(), parallelRayStudy(), parallelStudy(), and reserveRayBuffer().
|
protected |
The rank of this processor (this actually takes time to lookup - so just do it once)
Definition at line 865 of file RayTracingStudy.h.
Referenced by RepeatableRayStudyBaseTest::defineRays(), LotsOfRaysRayStudy::defineRays(), StationaryRayStudyTest::generateRays(), RayTracingStudyTest::generateRays(), ViewFactorRayStudy::generateStartElems(), resetUniqueRayIDs(), RepeatableRayStudyBase::verifyReplicatedRays(), and verifyUniqueRayIDs().
|
private |
Definition at line 1028 of file RayTracingStudy.h.
Referenced by executeStudy(), and propagationTime().
|
private |
The map from Ray aux data names to index.
Definition at line 1034 of file RayTracingStudy.h.
Referenced by getRayDataIndexInternal(), and registerRayDataInternal().
|
private |
The names for each Ray aux data entry.
Definition at line 1039 of file RayTracingStudy.h.
Referenced by getRayDataNameInternal(), hasRayAuxData(), rayAuxDataNames(), rayAuxDataSize(), and registerRayDataInternal().
|
private |
Cumulative Ray bank - stored only when _bank_rays_on_completion.
Definition at line 1093 of file RayTracingStudy.h.
Referenced by executeStudy(), onCompleteRay(), and rayBank().
|
private |
The map from Ray data names to index.
Definition at line 1032 of file RayTracingStudy.h.
Referenced by getRayDataIndexInternal(), and registerRayDataInternal().
|
private |
The names for each Ray data entry.
Definition at line 1037 of file RayTracingStudy.h.
Referenced by getRayDataNameInternal(), hasRayData(), rayDataNames(), rayDataSize(), and registerRayDataInternal().
|
protected |
Whether or not subdomain setup is dependent on the Ray.
Definition at line 880 of file RayTracingStudy.h.
Referenced by rayDependentSubdomainSetup().
|
protected |
Whether or not to perform coverage checks on RayKernels.
Definition at line 868 of file RayTracingStudy.h.
Referenced by coverageChecks().
|
protected |
Max distance a Ray can travel before being killed (can change)
Definition at line 891 of file RayTracingStudy.h.
Referenced by rayMaxDistance().
|
private |
Map from registered Ray name to ID.
Definition at line 1042 of file RayTracingStudy.h.
Referenced by registeredRayID(), registeredRaySetup(), and registerRay().
|
private |
Storage for the next available replicated RayID, obtained via generateReplicatedRayID()
Definition at line 1097 of file RayTracingStudy.h.
Referenced by generateReplicatedRayID(), and resetReplicatedRayIDs().
|
private |
Map from registered Ray ID to name.
Definition at line 1044 of file RayTracingStudy.h.
Referenced by registeredRayName(), and registerRay().
|
private |
Quadrature rule for laying points across a 1D ray segment.
Definition at line 1103 of file RayTracingStudy.h.
Referenced by buildSegmentQuadrature(), and initialSetup().
|
protected |
Whether or not to cache individual element segments when caching.
Definition at line 889 of file RayTracingStudy.h.
Referenced by segmentsOnCacheTraces().
|
mutableprivate |
Spin mutex object for locks.
Definition at line 1145 of file RayTracingStudy.h.
Referenced by getRayDataIndexInternal(), getRayDataNameInternal(), postOnSegment(), registeredRayID(), registeredRayName(), registerRay(), registerRayDataInternal(), resetReplicatedRayIDs(), and resetUniqueRayIDs().
|
private |
The cached hmax for all elements in a subdomain.
Definition at line 1136 of file RayTracingStudy.h.
Referenced by subdomainHmax(), and subdomainHMaxSetup().
|
private |
Threaded cached boundary query for RayBC objects pertaining to this study.
Definition at line 1078 of file RayTracingStudy.h.
Referenced by getRayBCs().
|
private |
Threaded cached subdomain query for RayKernelBase objects pertaining to this study.
Definition at line 1076 of file RayTracingStudy.h.
Referenced by getRayKernels().
|
private |
Threaded cache for side normals that have been computed already during tracing.
Definition at line 1091 of file RayTracingStudy.h.
Referenced by executeStudy(), and getSideNormal().
|
private |
The threaded storage for cached traces.
Definition at line 1049 of file RayTracingStudy.h.
Referenced by executeStudy(), and initThreadedCachedTrace().
|
private |
The current RayKernel objects for each thread.
Definition at line 1082 of file RayTracingStudy.h.
Referenced by currentRayKernels(), currentRayKernelsWrite(), executeStudy(), and segmentSubdomainSetup().
|
private |
Threaded helpers for building element sides without extraneous allocation.
Definition at line 1021 of file RayTracingStudy.h.
Referenced by elemSide().
|
private |
Face FE used for computing face normals for each thread.
Definition at line 1086 of file RayTracingStudy.h.
Referenced by getSideNormal(), and RayTracingStudy().
|
private |
Storage for the next available unique RayID, obtained via generateUniqueRayID()
Definition at line 1095 of file RayTracingStudy.h.
Referenced by generateUniqueRayID(), and resetUniqueRayIDs().
|
private |
Face quadrature used for computing face normals for each thread.
Definition at line 1088 of file RayTracingStudy.h.
Referenced by RayTracingStudy().
|
private |
Threaded storage for all of the RayTracingObjects associated with a single Ray.
Definition at line 1080 of file RayTracingStudy.h.
Referenced by getRayBCs(), getRayKernels(), and registeredRaySetup().
|
private |
The TraceRay objects for each thread (they do the physical tracing)
Definition at line 1084 of file RayTracingStudy.h.
Referenced by executeStudy(), meshChanged(), RayTracingStudy(), and traceRay().
|
protected |
Whether or not to tolerate a Ray Tracing failure.
Definition at line 876 of file RayTracingStudy.h.
Referenced by executeStudy(), and tolerateFailure().
|
private |
Total distance traveled by all Rays.
Definition at line 1130 of file RayTracingStudy.h.
Referenced by executeStudy(), and totalDistance().
|
private |
Total number of Ray/element intersections.
Definition at line 1121 of file RayTracingStudy.h.
Referenced by executeStudy(), and totalIntersections().
|
private |
Total number of processor crossings.
Definition at line 1110 of file RayTracingStudy.h.
Referenced by executeStudy(), and totalProcessorCrossings().
|
private |
The total volume of the domain.
Definition at line 1073 of file RayTracingStudy.h.
Referenced by totalVolume().
|
protected |
Whether or not to use the internal sidesets in ray tracing.
Definition at line 874 of file RayTracingStudy.h.
Referenced by internalSidesetSetup().
|
protected |
Whether or not to use Ray registration.
Definition at line 872 of file RayTracingStudy.h.
Referenced by getRayBCs(), getRayKernels(), registeredRayID(), registeredRayName(), registeredRaySetup(), registerRay(), and useRayRegistration().
|
protected |
Whether or not to verify if Rays have valid information before being traced.
Definition at line 893 of file RayTracingStudy.h.
Referenced by verifyRays().
|
protected |
Whether or not to verify the trace intersections in devel and dbg modes.
Definition at line 896 of file RayTracingStudy.h.
Referenced by verifyTraceIntersections().
|
protected |
Whether not to warn if non-planar faces are found.
Definition at line 870 of file RayTracingStudy.h.
Referenced by nonPlanarSideSetup(), and warnNonPlanar().
1.8.14
