Action that sets up the periodic boundary conditions for a PeriodicRayBC. More...

#include <SetupPeriodicRayBCAction.h>

Inheritance diagram for SetupPeriodicRayBCAction:

Public Types
typedef DataFileName	DataFileParameterType

Public Member Functions
	SetupPeriodicRayBCAction (const InputParameters &params)

void	act () override final

void	setupPeriodicRayBC (InputParameters &params) const
	Method to be called from the AddRayBCAction that is associated with the same RayBC this Action is associated with. More...

void	timedAct ()

virtual void	addRelationshipManagers (Moose::RelationshipManagerType when_type)

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

void	flagInvalidSolutionInternal (const InvalidSolutionID invalid_solution_id) const

InvalidSolutionID	registerInvalidSolutionInternal (const std::string &message, const bool warning) const

void	checkPeriodicParams () const

void	setupPeriodicBoundaries (FEProblemBase &problem)

virtual void	onSetupPeriodicBoundary (libMesh::PeriodicBoundaryBase &)

const libMesh::PeriodicBoundaries &	getPeriodicBoundaries () const

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

Protected Attributes
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 &	_type

const std::string &	_name

const InputParameters &	_pars

MooseApp &	_pg_moose_app

const std::string	_prefix

const Parallel::Communicator &	_communicator

Private Member Functions
const AddRayBCAction &	getAddRayBCAction () const
	Helper for getting the AddRayBCAction that is responsible for building the RayBC this action is associated with. More...

Private Attributes
const bool	_is_periodic_ray_bc
	Whether or not we are acting on a PeriodicRayBC. More...

Detailed Description

Action that sets up the periodic boundary conditions for a PeriodicRayBC.

This Action is applied to every RayBC, but it will only perform its actions if the associated RayBC is a PeriodicRayBC.

Definition at line 25 of file SetupPeriodicRayBCAction.h.

Constructor & Destructor Documentation

◆ SetupPeriodicRayBCAction()

SetupPeriodicRayBCAction::SetupPeriodicRayBCAction ( const InputParameters & params )

Definition at line 26 of file SetupPeriodicRayBCAction.C.

   : Action(params),
     Moose::PeriodicBCHelper(getAddRayBCAction()),
     _is_periodic_ray_bc(PeriodicRayBC::isPeriodicRayBC(getAddRayBCAction().getObjectParams()))
 {
   if (_is_periodic_ray_bc)
     checkPeriodicParams();
 }

Member Function Documentation

◆ act()

void SetupPeriodicRayBCAction::act ( )

finaloverridevirtual

Implements Action.

Definition at line 36 of file SetupPeriodicRayBCAction.C.

 {
   if (!_is_periodic_ray_bc)
     return;
 
   // Tell the mesh to hold off on deleting remote elements because we need to wait for our
   // periodic boundaries to be added
   if (_current_task == "add_geometric_rm")
     _mesh->allowRemoteElementRemoval(false);
   else if (_current_task == "add_periodic_bc")
     setupPeriodicBoundaries(*_problem);
 }

◆ getAddRayBCAction()

const AddRayBCAction & SetupPeriodicRayBCAction::getAddRayBCAction ( ) const

private

Helper for getting the AddRayBCAction that is responsible for building the RayBC this action is associated with.

Definition at line 68 of file SetupPeriodicRayBCAction.C.

 {
   return _app.actionWarehouse().getAction<AddRayBCAction>(name());
 }

◆ setupPeriodicRayBC()

void SetupPeriodicRayBCAction::setupPeriodicRayBC ( InputParameters & params ) const

Method to be called from the AddRayBCAction that is associated with the same RayBC this Action is associated with.

Is used to set the necessary parameters for the PeriodicRayBC.

Definition at line 50 of file SetupPeriodicRayBCAction.C.

 {
   mooseAssert(_is_periodic_ray_bc, "Not a PeriodicRayBC");
 
   const auto & periodic_boundaries = getPeriodicBoundaries();
 
   // Form boundaries for hidden "boundary" param
   std::vector<BoundaryName> boundary;
   for (const auto & it : periodic_boundaries)
     boundary.push_back(std::to_string(it.first));
   params.set<std::vector<BoundaryName>>("boundary") = boundary;
 
   // Allow BC to access the PeriodicBoundaries object
   params.set<const libMesh::PeriodicBoundaries *>(PeriodicRayBC::periodic_boundaries_param) =
       &periodic_boundaries;
 }

◆ validParams()

InputParameters SetupPeriodicRayBCAction::validParams ( )

static

Definition at line 19 of file SetupPeriodicRayBCAction.C.

 {
   auto params = Action::validParams();
   params.addClassDescription("Sets up the periodic boundaries for a PeriodicRayBC if applicable.");
   return params;
 }

Member Data Documentation

◆ _is_periodic_ray_bc

const bool SetupPeriodicRayBCAction::_is_periodic_ray_bc

private

Whether or not we are acting on a PeriodicRayBC.

Definition at line 50 of file SetupPeriodicRayBCAction.h.

Referenced by act(), setupPeriodicRayBC(), and SetupPeriodicRayBCAction().

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

ray_tracing/include/actions/SetupPeriodicRayBCAction.h
ray_tracing/src/actions/SetupPeriodicRayBCAction.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

Private Attributes