https://mooseframework.inl.gov
AddRayBCAction.C
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 #include "AddRayBCAction.h"
11 
13 #include "PeriodicRayBC.h"
15 
16 registerMooseAction("RayTracingApp", AddRayBCAction, "add_ray_boundary_condition");
17 
20 {
22  params.addClassDescription("Adds a RayBC for use in ray tracing to the simulation.");
23  return params;
24 }
25 
27 {
28 }
29 
30 void
32 {
33  // Special case for the PeriodicRayBC, which needs to have geometric
34  // ghosting and periodic boundaries setup before the object is constructed.
35  // A SetupPeriodicRayBCAction will exist for every RayBC, and if this
36  // is a PeriodicRayBC, will setup the periodic boundaries early
40 
42 }
const T & getAction(const std::string &name) const
const std::string & _name
Action that sets up the periodic boundary conditions for a PeriodicRayBC.
static InputParameters validParams()
void addRayTracingObject() override final
Calls addObject on the problem to add the desired object after _ray_tracing_study is set in _moose_ob...
const std::string & name() const
registerMooseAction("RayTracingApp", AddRayBCAction, "add_ray_boundary_condition")
ActionWarehouse & actionWarehouse()
Action for creating a RayBC and associating it with the necessary RayTracingStudy objects...
std::string _type
InputParameters _moose_object_pars
static bool isPeriodicRayBC(const InputParameters &params)
Whether or not the RayBC params belong to a PeriodicRayBC.
Definition: PeriodicRayBC.C:52
std::shared_ptr< FEProblemBase > & _problem
AddRayBCAction(const InputParameters &params)
static InputParameters validParams()
Base class for the RayBC syntax.
Base class for adding a RayTracingObject and associating it with the necessary RayTracingStudy.