https://mooseframework.inl.gov
Loading...
Searching...
No Matches
LotsOfRaysRayStudy.h
Go to the documentation of this file.
1//* This file is part of the MOOSE framework
2//* https://mooseframework.inl.gov
3//*
4//* All rights reserved, see COPYRIGHT for full restrictions
5//* https://github.com/idaholab/moose/blob/master/COPYRIGHT
6//*
7//* Licensed under LGPL 2.1, please see LICENSE for details
8//* https://www.gnu.org/licenses/lgpl-2.1.html
9
10#pragma once
11
13
14// Local includes
16
21{
22public:
24
26
34 Real expectedDistance() const { return _expected_distance; }
35
36protected:
37 virtual void defineRays() override;
38
39 void defineRay(const Elem * starting_elem,
40 const unsigned short incoming_side,
41 const Point & p1,
42 const Point & p2,
43 const bool ends_within_mesh);
44
49 virtual void modifyRays();
50
54 const bool _edge_to_edge;
55 const bool _side_aq;
56 const bool _centroid_aq;
57
60
62 const unsigned int _polar_quad_order;
64 const unsigned int _azimuthal_quad_order;
65
68
69private:
72
74 std::unique_ptr<BoundingBoxIntersectionHelper> _bbox_intersection_helper;
75};
A RayTracingStudy used for generating a lot of rays for testing purposes.
const unsigned int _azimuthal_quad_order
Azimuthal angular quadrature order for aq tests.
Real & _expected_distance
The expected total distance Rays should travel.
const bool _centroid_to_centroid
std::unique_ptr< BoundingBoxIntersectionHelper > _bbox_intersection_helper
Helper for computing the end point for Rays that don't end within mesh.
void defineRay(const Elem *starting_elem, const unsigned short incoming_side, const Point &p1, const Point &p2, const bool ends_within_mesh)
virtual void defineRays() override
Entry point for the user to create Rays.
bool hasExpectedDistance() const
Whether or not the expected distance is being computed.
const unsigned int _polar_quad_order
Polar angular quadrature order for aq tests.
Real expectedDistance() const
Get the expected total distance Rays should travel.
virtual void modifyRays()
Insertion point for after _rays is defined for other derived test studies to modify the Rays.
const bool _compute_expected_distance
Whether or not to compute the expected distance for generated rays.
static InputParameters validParams()
const InputParameters & parameters() const
A RayTracingStudy that generates and traces Rays repeatedly that a user defines only once.