doxygen/modules/ConeRayStudy_8h_source.html

 //* This file is part of the MOOSE framework
 //* https://mooseframework.inl.gov
 //*
 //* All rights reserved, see COPYRIGHT for full restrictions
 //* https://github.com/idaholab/moose/blob/master/COPYRIGHT
 //*
 //* Licensed under LGPL 2.1, please see LICENSE for details
 //* https://www.gnu.org/licenses/lgpl-2.1.html

 #pragma once

 #include "RepeatableRayStudyBase.h"

 class ConeRayStudy : public RepeatableRayStudyBase
 {
 public:
   ConeRayStudy(const InputParameters & parameters);

   static InputParameters validParams();

 protected:
   virtual void defineRays() override;

   const std::vector<Point> _start_points;
   const std::vector<Point> _directions;
   const std::vector<Real> _scaling_factors;

   const std::vector<Real> _half_cone_angles;
   const std::vector<unsigned int> _polar_quad_orders;
   const std::vector<unsigned int> _azimuthal_quad_orders;

   const RayDataIndex _ray_data_index;
 };
ConeRayStudy::defineRays
virtual void defineRays() override
Entry point for the user to create Rays.
Definition: ConeRayStudy.C:95

ConeRayStudy::_half_cone_angles
const std::vector< Real > _half_cone_angles
The half-cone angles in degrees for each cone.
Definition: ConeRayStudy.h:36

ConeRayStudy::ConeRayStudy
ConeRayStudy(const InputParameters &parameters)
Definition: ConeRayStudy.C:55

RepeatableRayStudyBase.h

InputParameters

RayDataIndex
unsigned int RayDataIndex
Type for the index into the data and aux data on a Ray.
Definition: Ray.h:51

ConeRayStudy
Ray study that spawns Rays in a cone from a given set of starting points for the cones and half angle...
Definition: ConeRayStudy.h:18

ConeRayStudy::_azimuthal_quad_orders
const std::vector< unsigned int > _azimuthal_quad_orders
The azimuthal quadrature orders for each cone.
Definition: ConeRayStudy.h:40

ConeRayStudy::_polar_quad_orders
const std::vector< unsigned int > _polar_quad_orders
The polar quadrature orders for each cone.
Definition: ConeRayStudy.h:38

ConeRayStudy::_directions
const std::vector< Point > _directions
The directions that define the cones (points down the center of the cone)
Definition: ConeRayStudy.h:31

ConeRayStudy::_start_points
const std::vector< Point > _start_points
The points to start the Rays from (the cone points)
Definition: ConeRayStudy.h:29

ConeRayStudy::_scaling_factors
const std::vector< Real > _scaling_factors
Scaling factors for each cone&#39;s Rays (defaults to 1)
Definition: ConeRayStudy.h:33

ConeRayStudy::validParams
static InputParameters validParams()
Definition: ConeRayStudy.C:18

GeneralUserObject::parameters
const InputParameters & parameters() const

RepeatableRayStudyBase
A RayTracingStudy that generates and traces Rays repeatedly that a user defines only once...
Definition: RepeatableRayStudyBase.h:22

ConeRayStudy::_ray_data_index
const RayDataIndex _ray_data_index
The index into the Ray&#39;s data for storing the angular quadrature weight and scaling factor...
Definition: ConeRayStudy.h:43