RayKernelBase.h

Go to the documentation of this file.

//* 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

// Local Includes
#include "RayTracingObject.h"

// MOOSE includes
#include "CoupleableMooseVariableDependencyIntermediateInterface.h"
#include "BlockRestrictable.h"
#include "RandomInterface.h"
#include "MaterialPropertyInterface.h"
#include "Restartable.h"

class RayKernelBase : public RayTracingObject,
                      public CoupleableMooseVariableDependencyIntermediateInterface,
                      public BlockRestrictable,
                      public RandomInterface,
                      public MaterialPropertyInterface,
                      public Restartable
{
public:
  RayKernelBase(const InputParameters & params);
  virtual ~RayKernelBase();

  static InputParameters validParams();

  virtual void onSegment() = 0;

  virtual void preTrace();

  virtual void postTrace();

  bool needSegmentReinit() const { return _need_segment_reinit; }

protected:
  void changeRayStartDirection(const Point & start, const Point & direction);

  std::shared_ptr<Ray> acquireRay(const Point & start, const Point & direction);

  void moveRayToBuffer(std::shared_ptr<Ray> & ray);

  const Point & _current_segment_start;
  const Point & _current_segment_end;
  const Real & _current_segment_length;
  const unsigned short & _current_incoming_side;

  const bool _need_segment_reinit;
};

#define usingRayKernelBaseMembers                                                                  \
  usingRayTracingObjectMembers;                                                                    \
  usingBlockRestrictableMembers;                                                                   \
  using RayKernelBase::changeRayStartDirection;                                                    \
  using RayKernelBase::acquireRay;                                                                 \
  using RayKernelBase::moveRayToBuffer