Action for creating a RayKernel and associating it with the necessary RayTracingStudy objects. More...

#include <AddRayKernelAction.h>

Inheritance diagram for AddRayKernelAction:

Public Types
typedef DataFileName	DataFileParameterType

Public Member Functions
	AddRayKernelAction (const InputParameters &params)

void	act () override final

virtual void	addRelationshipManagers (Moose::RelationshipManagerType when_type) override

bool	addRelationshipManagers (Moose::RelationshipManagerType when_type, const InputParameters &moose_object_pars)

virtual void	addRelationshipManagers (Moose::RelationshipManagerType when_type)

InputParameters &	getObjectParams ()

const InputParameters &	getObjectParams () const

const std::string &	getMooseObjectType () const

void	timedAct ()

MooseObjectName	uniqueActionName () const

const std::string &	specificTaskName () const

const std::set< std::string > &	getAllTasks () const

void	appendTask (const std::string &task)

MooseApp &	getMooseApp () const

const std::string &	type () const

virtual const std::string &	name () const

std::string	typeAndName () const

std::string	errorPrefix (const std::string &error_type) const

void	callMooseError (std::string msg, const bool with_prefix) const

MooseObjectParameterName	uniqueParameterName (const std::string &parameter_name) const

const InputParameters &	parameters () const

MooseObjectName	uniqueName () const

const T &	getParam (const std::string &name) const

std::vector< std::pair< T1, T2 > >	getParam (const std::string &param1, const std::string &param2) 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	isParamValid (const std::string &name) const

bool	isParamSetByUser (const std::string &nm) const

void	paramError (const std::string &param, Args... args) const

void	paramWarning (const std::string &param, Args... args) const

void	paramInfo (const std::string &param, Args... args) const

void	connectControllableParams (const std::string &parameter, const std::string &object_type, const std::string &object_name, const std::string &object_parameter) const

void	mooseError (Args &&... args) const

void	mooseErrorNonPrefixed (Args &&... args) const

void	mooseDocumentedError (const std::string &repo_name, const unsigned int issue_num, Args &&... args) const

void	mooseWarning (Args &&... args) const

void	mooseWarningNonPrefixed (Args &&... args) const

void	mooseDeprecated (Args &&... args) const

void	mooseInfo (Args &&... args) const

std::string	getDataFileName (const std::string &param) const

std::string	getDataFileNameByName (const std::string &relative_path) const

std::string	getDataFilePath (const std::string &relative_path) const

PerfGraph &	perfGraph ()

const Parallel::Communicator &	comm () const

processor_id_type	n_processors () const

processor_id_type	processor_id () const

Static Public Member Functions
static InputParameters	validParams ()

Public Attributes
const ConsoleStream	_console

Static Public Attributes
static constexpr auto	SYSTEM

static constexpr auto	NAME

Protected Member Functions
void	addRayTracingObject () override final
	Calls addObject on the problem to add the desired object after _ray_tracing_study is set in _moose_object_pars. More...

bool	addRelationshipManagers (Moose::RelationshipManagerType when_type, const InputParameters &moose_object_pars)

void	associateWithParameter (const std::string &param_name, InputParameters &params) const

void	associateWithParameter (const InputParameters &from_params, const std::string &param_name, InputParameters &params) 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 &section_name, const unsigned int level) const

PerfID	registerTimedSection (const std::string &section_name, const unsigned int level, const std::string &live_message, const bool print_dots=true) const

std::string	timedSectionName (const std::string &section_name) const

Static Protected Member Functions
static std::string	meshPropertyName (const std::string &data_name, const std::string &prefix)

Protected Attributes
std::string	_type

InputParameters	_moose_object_pars

std::string	_registered_identifier

std::string	_specific_task_name

std::set< std::string >	_all_tasks

ActionWarehouse &	_awh

const std::string &	_current_task

std::shared_ptr< MooseMesh > &	_mesh

std::shared_ptr< MooseMesh > &	_displaced_mesh

std::shared_ptr< FEProblemBase > &	_problem

PerfID	_act_timer

MooseApp &	_app

const std::string	_name

const InputParameters &	_pars

Factory &	_factory

ActionFactory &	_action_factory

MooseApp &	_pg_moose_app

const std::string	_prefix

const Parallel::Communicator &	_communicator

Detailed Description

Action for creating a RayKernel and associating it with the necessary RayTracingStudy objects.

Definition at line 17 of file AddRayKernelAction.h.

Constructor & Destructor Documentation

◆ AddRayKernelAction()

AddRayKernelAction::AddRayKernelAction ( const InputParameters & params )

Definition at line 25 of file AddRayKernelAction.C.

   : AddRayTracingObjectAction(params)
 {
 }

Member Function Documentation

◆ act()

void AddRayTracingObjectAction::act ( )

finaloverridevirtualinherited

Implements MooseObjectAction.

Definition at line 30 of file AddRayTracingObjectAction.C.

 {
   RayTracingStudy * rts = nullptr;
 
   // Query into UserObjects
   std::vector<UserObject *> uos;
   auto query = _problem->theWarehouse().query().condition<AttribSystem>("UserObject");
 
   // Object has a study: see if it exists
   if (_moose_object_pars.isParamSetByUser("study"))
   {
     const auto study_name = _moose_object_pars.get<UserObjectName>("study");
     query.condition<AttribName>(study_name);
     query.queryInto(uos);
 
     if (uos.empty())
       mooseError(_type, " '", _name, "': Could not find the requested study '", study_name, "'.");
 
     rts = dynamic_cast<RayTracingStudy *>(uos[0]);
     if (!rts)
       mooseError(_type,
                  " '",
                  _name,
                  "' requested the study ",
                  study_name,
                  " but the provided study is not a RayTracingStudy-derived object.");
   }
   // Object doesn't have a study: find one and only one study to associate with it
   else
   {
     query.queryInto(uos);
 
     for (auto & uo : uos)
     {
       RayTracingStudy * rts_temp = dynamic_cast<RayTracingStudy *>(uo);
       if (rts_temp)
       {
         if (rts)
           mooseError("While constructing the ",
                      _type,
                      " '",
                      _name,
                      "', multiple RayTracingStudy objects were found.\n\nYou must associate one "
                      "of the RayTracingStudy objects by setting the 'study' parameter in ",
                      _type,
                      " '",
                      _name,
                      "'");
 
         rts = rts_temp;
       }
     }
 
     if (!rts)
       mooseError(
           _type,
           " '",
           _name,
           "' did not provide a RayTracingStudy to associate with via the 'study' parameter "
           "and a study was not found.\n\nYou must add a RayTracingStudy to use said object.");
   }
 
   _moose_object_pars.set<RayTracingStudy *>("_ray_tracing_study") = rts;
 
   addRayTracingObject();
 }

◆ addRayTracingObject()

void AddRayKernelAction::addRayTracingObject ( )

finaloverrideprotectedvirtual

Calls addObject on the problem to add the desired object after _ray_tracing_study is set in _moose_object_pars.

Implements AddRayTracingObjectAction.

Definition at line 31 of file AddRayKernelAction.C.

 {
   _problem->addObject<RayKernelBase>(_type, _name, _moose_object_pars);
 }

◆ validParams()

InputParameters AddRayKernelAction::validParams ( )

static

Definition at line 18 of file AddRayKernelAction.C.

 {
   auto params = AddRayTracingObjectAction::validParams();
   params.addClassDescription("Adds a RayKernel for use in ray tracing to the simulation.");
   return params;
 }

The documentation for this class was generated from the following files:

ray_tracing/include/actions/AddRayKernelAction.h
ray_tracing/src/actions/AddRayKernelAction.C

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Static Protected Member Functions