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

#include <AddRayBCAction.h>

Inheritance diagram for AddRayBCAction:

Public Types
typedef DataFileName	DataFileParameterType

Public Member Functions
	AddRayBCAction (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

const std::string &	name () const

std::string	typeAndName () const

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

MooseObjectName	uniqueName () const

const InputParameters &	parameters () const

const hit::Node *	getHitNode () const

bool	hasBase () const

const std::string &	getBase () 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 &name) const

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

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

void	paramWarning (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

std::string	messagePrefix (const bool hit_prefix=true) const

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

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

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

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

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

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

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

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

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

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

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

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

void	callMooseError (std::string msg, const bool with_prefix, const hit::Node *node=nullptr, const bool show_trace=true) 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 ()

static void	callMooseError (MooseApp const app, const InputParameters &params, std::string msg, const bool with_prefix, const hit::Node node, const bool show_trace=true)

Public Attributes
	usingCombinedWarningSolutionWarnings

const ConsoleStream	_console

Static Public Attributes
static const std::string	unique_action_name_param

static const std::string	type_param

static const std::string	name_param

static const std::string	unique_name_param

static const std::string	app_param

static const std::string	moose_base_param

static const std::string	kokkos_object_param

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.

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

void	flagInvalidSolutionInternal (const InvalidSolutionID invalid_solution_id) const

InvalidSolutionID	registerInvalidSolutionInternal (const std::string &message, const bool warning) 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

Factory &	_factory

ActionFactory &	_action_factory

const std::string &	_name

const InputParameters &	_pars

MooseApp &	_pg_moose_app

const std::string	_prefix

const Parallel::Communicator &	_communicator

Private Member Functions
bool	addRelationshipManager (Moose::RelationshipManagerType input_rm_type, const InputParameters &moose_object_pars, std::string rm_name, Moose::RelationshipManagerType rm_type, Moose::RelationshipManagerInputParameterCallback rm_input_parameter_func, Moose::RMSystemType sys_type=Moose::RMSystemType::NONE)

virtual std::string	meshPropertyPrefix (const std::string &data_name) const

const RestartableDataValue &	getMeshPropertyInternal (const std::string &data_name, const std::string &prefix) const

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

Static Private Member Functions
static const hit::Node *	getHitNode (const InputParameters &params)

static std::string	messagePrefix (const InputParameters &params, const bool hit_prefix)

Private Attributes
const ParallelParamObject &	_parent

MooseApp &	_meta_data_app

const MooseObject *const	_meta_data_object

const MooseBase &	_si_moose_base

const FEProblemBase *	_si_problem

Detailed Description

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

Definition at line 17 of file AddRayBCAction.h.

Constructor & Destructor Documentation

◆ AddRayBCAction()

AddRayBCAction::AddRayBCAction ( const InputParameters & params )

Definition at line 26 of file AddRayBCAction.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 AddRayBCAction::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 AddRayBCAction.C.

{
  // Special case for the PeriodicRayBC, which needs to have geometric
  // ghosting and periodic boundaries setup before the object is constructed.
  // A SetupPeriodicRayBCAction will exist for every RayBC, and if this
  // is a PeriodicRayBC, will setup the periodic boundaries early
  if (PeriodicRayBC::isPeriodicRayBC(_moose_object_pars))
    _app.actionWarehouse().getAction<SetupPeriodicRayBCAction>(name()).setupPeriodicRayBC(
        _moose_object_pars);
 
  _problem->addObject<RayBoundaryConditionBase>(_type, _name, _moose_object_pars);
}

◆ validParams()

InputParameters AddRayBCAction::validParams ( )

static

Definition at line 19 of file AddRayBCAction.C.

{
  auto params = AddRayTracingObjectAction::validParams();
  params.addClassDescription("Adds a RayBC 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/AddRayBCAction.h
ray_tracing/src/actions/AddRayBCAction.C

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Private Member Functions

Static Private Member Functions