Base class for a MooseObject used in ray tracing. More...

#include <RayTracingObject.h>

Inheritance diagram for RayTracingObject:

Public Types
typedef DataFileName	DataFileParameterType

Public Member Functions
	RayTracingObject (const InputParameters &params)

const std::set< std::string > &	getRequestedItems () override

const std::set< std::string > &	getSuppliedItems () override

RayTracingStudy &	study ()
	The RayTracingStudy associated with this object. More...

const RayTracingStudy &	study () const
	The RayTracingStudy associated with this object. More...

template<typename T >
T &	getStudy ()
	Casts the RayTracingStudy associated with this object to a study of type T with a meaningful error message if it fails. More...

virtual void	preExecuteStudy ()
	Insertion point called immediately before executing the RayTracingStudy. More...

virtual void	postExecuteStudy ()
	Insertion point called immediately after executing the RayTracingStudy. More...

virtual bool	enabled () const

std::shared_ptr< MooseObject >	getSharedPtr ()

std::shared_ptr< const MooseObject >	getSharedPtr () const

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

const Parallel::Communicator &	comm () const

processor_id_type	n_processors () const

processor_id_type	processor_id () const

virtual void	initialSetup ()

virtual void	timestepSetup ()

virtual void	jacobianSetup ()

virtual void	residualSetup ()

virtual void	subdomainSetup ()

virtual void	customSetup (const ExecFlagType &)

const ExecFlagEnum &	getExecuteOnEnum () const

const Function &	getFunction (const std::string &name) const

const Function &	getFunctionByName (const FunctionName &name) const

bool	hasFunction (const std::string &param_name) const

bool	hasFunctionByName (const FunctionName &name) const

bool	isDefaultPostprocessorValue (const std::string &param_name, const unsigned int index=0) const

bool	hasPostprocessor (const std::string &param_name, const unsigned int index=0) const

bool	hasPostprocessorByName (const PostprocessorName &name) const

std::size_t	coupledPostprocessors (const std::string &param_name) const

const PostprocessorName &	getPostprocessorName (const std::string &param_name, const unsigned int index=0) const

const PostprocessorValue &	getPostprocessorValue (const std::string &param_name, const unsigned int index=0) const

const PostprocessorValue &	getPostprocessorValue (const std::string &param_name, const unsigned int index=0) const

const PostprocessorValue &	getPostprocessorValueOld (const std::string &param_name, const unsigned int index=0) const

const PostprocessorValue &	getPostprocessorValueOld (const std::string &param_name, const unsigned int index=0) const

const PostprocessorValue &	getPostprocessorValueOlder (const std::string &param_name, const unsigned int index=0) const

const PostprocessorValue &	getPostprocessorValueOlder (const std::string &param_name, const unsigned int index=0) const

virtual const PostprocessorValue &	getPostprocessorValueByName (const PostprocessorName &name) const

virtual const PostprocessorValue &	getPostprocessorValueByName (const PostprocessorName &name) const

const PostprocessorValue &	getPostprocessorValueOldByName (const PostprocessorName &name) const

const PostprocessorValue &	getPostprocessorValueOldByName (const PostprocessorName &name) const

const PostprocessorValue &	getPostprocessorValueOlderByName (const PostprocessorName &name) const

const PostprocessorValue &	getPostprocessorValueOlderByName (const PostprocessorName &name) const

const VectorPostprocessorValue &	getVectorPostprocessorValue (const std::string &param_name, const std::string &vector_name) const

const VectorPostprocessorValue &	getVectorPostprocessorValue (const std::string &param_name, const std::string &vector_name, bool needs_broadcast) const

const VectorPostprocessorValue &	getVectorPostprocessorValueByName (const VectorPostprocessorName &name, const std::string &vector_name) const

const VectorPostprocessorValue &	getVectorPostprocessorValueByName (const VectorPostprocessorName &name, const std::string &vector_name, bool needs_broadcast) const

const VectorPostprocessorValue &	getVectorPostprocessorValueOld (const std::string &param_name, const std::string &vector_name) const

const VectorPostprocessorValue &	getVectorPostprocessorValueOld (const std::string &param_name, const std::string &vector_name, bool needs_broadcast) const

const VectorPostprocessorValue &	getVectorPostprocessorValueOldByName (const VectorPostprocessorName &name, const std::string &vector_name) const

const VectorPostprocessorValue &	getVectorPostprocessorValueOldByName (const VectorPostprocessorName &name, const std::string &vector_name, bool needs_broadcast) const

const ScatterVectorPostprocessorValue &	getScatterVectorPostprocessorValue (const std::string &param_name, const std::string &vector_name) const

const ScatterVectorPostprocessorValue &	getScatterVectorPostprocessorValueByName (const VectorPostprocessorName &name, const std::string &vector_name) const

const ScatterVectorPostprocessorValue &	getScatterVectorPostprocessorValueOld (const std::string &param_name, const std::string &vector_name) const

const ScatterVectorPostprocessorValue &	getScatterVectorPostprocessorValueOldByName (const VectorPostprocessorName &name, const std::string &vector_name) const

bool	hasVectorPostprocessor (const std::string &param_name, const std::string &vector_name) const

bool	hasVectorPostprocessor (const std::string &param_name) const

bool	hasVectorPostprocessorByName (const VectorPostprocessorName &name, const std::string &vector_name) const

bool	hasVectorPostprocessorByName (const VectorPostprocessorName &name) const

const VectorPostprocessorName &	getVectorPostprocessorName (const std::string &param_name) const

bool	isVectorPostprocessorDistributed (const std::string &param_name) const

bool	isVectorPostprocessorDistributed (const std::string &param_name) const

bool	isVectorPostprocessorDistributedByName (const VectorPostprocessorName &name) const

bool	isVectorPostprocessorDistributedByName (const VectorPostprocessorName &name) const

virtual void	meshChanged ()

bool	isImplicit ()

Moose::StateArg	determineState () const

UserObjectName	getUserObjectName (const std::string &param_name) const

const T &	getUserObject (const std::string &param_name, bool is_dependency=true) const

const T &	getUserObjectByName (const UserObjectName &object_name, bool is_dependency=true) const

const UserObject &	getUserObjectBase (const std::string &param_name, bool is_dependency=true) const

const UserObject &	getUserObjectBaseByName (const UserObjectName &object_name, bool is_dependency=true) const

bool	hasUserObject (const std::string &param_name) const

bool	hasUserObject (const std::string &param_name) const

bool	hasUserObject (const std::string &param_name) const

bool	hasUserObject (const std::string &param_name) const

bool	hasUserObjectByName (const UserObjectName &object_name) const

bool	hasUserObjectByName (const UserObjectName &object_name) const

bool	hasUserObjectByName (const UserObjectName &object_name) const

bool	hasUserObjectByName (const UserObjectName &object_name) const

Static Public Member Functions
static InputParameters	validParams ()

static void	sort (typename std::vector< T > &vector)

static void	sortDFS (typename std::vector< T > &vector)

static void	cyclicDependencyError (CyclicDependencyException< T2 > &e, const std::string &header)

Public Attributes
const ConsoleStream	_console

Protected Member Functions
const std::shared_ptr< Ray > &	currentRay () const
	Gets the current Ray that this is working on. More...

void	dependsOn (const std::string name)
	Add an object of this classes base type that this class depends on. More...

NonlinearSystemBase *	getNonlinearSystem ()
	Get the right nonlinear system. More...

virtual void	addPostprocessorDependencyHelper (const PostprocessorName &) const

virtual void	addVectorPostprocessorDependencyHelper (const VectorPostprocessorName &) const

virtual void	addUserObjectDependencyHelper (const UserObject &) const

Protected Attributes
const THREAD_ID	_tid
	The thread id. More...

FEProblemBase &	_fe_problem
	The FEProblemBase. More...

RayTracingStudy &	_study
	The RayTracingStudy associated with this object. More...

const TraceRay &	_trace_ray
	The TraceRay object associated with this thread. More...

NonlinearSystemBase *	_nl
	The nonlinear system, we might not have one. More...

AuxiliarySystem &	_aux
	The aux system. More...

MooseMesh &	_mesh
	The MooseMesh. More...

const Elem *const &	_current_elem
	The current Elem that _current_ray is tracing through. More...

const SubdomainID &	_current_subdomain_id
	The subdomain ID of the _current_elem that the ray is tracing through. More...

const unsigned short &	_current_intersected_side
	The side that _current_ray intersects (if any) More...

const ElemExtrema &	_current_intersected_extrema
	The elem extrema (vertex/edge) that _current_ray intersects (if any) More...

const bool &	_enabled

MooseApp &	_app

const std::string	_type

const std::string	_name

const InputParameters &	_pars

Factory &	_factory

ActionFactory &	_action_factory

const Parallel::Communicator &	_communicator

const ExecFlagEnum &	_execute_enum

const ExecFlagType &	_current_execute_flag

FEProblemBase &	_mci_feproblem

const InputParameters &	_ti_params

FEProblemBase &	_ti_feproblem

bool	_is_implicit

Real &	_t

const Real &	_t_old

int &	_t_step

Real &	_dt

Real &	_dt_old

bool	_is_transient

Private Attributes
std::set< std::string >	_depend_names
	The names of the objects this depends on. More...

std::set< std::string >	_supplied_names
	The names of the supplied objects: just this one. More...

const std::shared_ptr< Ray > *const &	_current_ray
	The current Ray that the action is being applied to. More...

Detailed Description

Base class for a MooseObject used in ray tracing.

Definition at line 36 of file RayTracingObject.h.

Constructor & Destructor Documentation

◆ RayTracingObject()

RayTracingObject::RayTracingObject ( const InputParameters & params )

Definition at line 38 of file RayTracingObject.C.

   : MooseObject(params),
     SetupInterface(this),
     FunctionInterface(this),
     PostprocessorInterface(this),
     VectorPostprocessorInterface(this),
     MeshChangedInterface(params),
     TransientInterface(this),
     UserObjectInterface(this),
     DependencyResolverInterface(),
     _tid(params.get<THREAD_ID>("_tid")),
     _fe_problem(*params.getCheckedPointerParam<FEProblemBase *>("_fe_problem_base")),
     _study(*params.getCheckedPointerParam<RayTracingStudy *>("_ray_tracing_study")),
     _trace_ray(const_cast<const RayTracingStudy &>(_study).traceRay(_tid)),
     _nl(getNonlinearSystem()),
     _aux(_fe_problem.getAuxiliarySystem()),
     _mesh(_fe_problem.mesh()),
     _current_elem(_trace_ray.currentElem()),
     _current_subdomain_id(_trace_ray.currentSubdomainID()),
     _current_intersected_side(_trace_ray.currentIntersectedSide()),
     _current_intersected_extrema(_trace_ray.currentIntersectedExtrema()),
     _current_ray(_trace_ray.currentRay())
 {
   // Supplies only itself
   _supplied_names.insert(name());
 }

Member Function Documentation

◆ currentRay()

const std::shared_ptr<Ray>& RayTracingObject::currentRay ( ) const

inlineprotected

Gets the current Ray that this is working on.

Definition at line 83 of file RayTracingObject.h.

Referenced by RayBoundaryConditionBase::changeRayDirection(), RayKernelBase::changeRayStartDirection(), ChangeRayRayBCTest::onBoundary(), ReflectRayBC::onBoundary(), KillRayBC::onBoundary(), CreateRayRayBCTest::onBoundary(), ViewFactorRayBC::onBoundary(), ChangeRayRayKernelTest::onSegment(), KillRayKernel::onSegment(), TestRayDataRayKernel::onSegment(), CreateRayRayKernelTest::onSegment(), IntegralRayKernel::onSegment(), and RefractionRayKernelTest::onSegment().

83 { return *_current_ray; }

RayTracingObject::_current_ray

const std::shared_ptr< Ray > *const & _current_ray

The current Ray that the action is being applied to.

Definition: RayTracingObject.h:132

◆ dependsOn()

void RayTracingObject::dependsOn ( const std::string name )

inlineprotected

Add an object of this classes base type that this class depends on.

Definition at line 88 of file RayTracingObject.h.

Referenced by RayBoundaryConditionBase::RayBoundaryConditionBase(), and RayKernelBase::RayKernelBase().

88 { _depend_names.insert(name); }

MooseObject::name

virtual const std::string & name() const

RayTracingObject::_depend_names

std::set< std::string > _depend_names

The names of the objects this depends on.

Definition: RayTracingObject.h:127

◆ getNonlinearSystem()

NonlinearSystemBase * RayTracingObject::getNonlinearSystem ( )

protected

Get the right nonlinear system.

Some simulations might not have one, if some user objects only operate on aux variables we need a special treatment

Definition at line 66 of file RayTracingObject.C.

 {
   // If this object actually operates with a nonlinear variable that belongs to a system
   // we use the variable's system
   if (_study.systemNumber() < _fe_problem.numNonlinearSystems())
     return &_fe_problem.getNonlinearSystemBase(_study.systemNumber());
 
   // If the user operates on auxiliary variables we just use the first nonlinear
   // system if there is any
   if (_fe_problem.numNonlinearSystems())
     return &_fe_problem.getNonlinearSystemBase(0);
 
   return nullptr;
 }

◆ getRequestedItems()

const std::set<std::string>& RayTracingObject::getRequestedItems ( )

inlineoverridevirtual

Implements DependencyResolverInterface.

Definition at line 51 of file RayTracingObject.h.

51 { return _depend_names; }

RayTracingObject::_depend_names

std::set< std::string > _depend_names

The names of the objects this depends on.

Definition: RayTracingObject.h:127

◆ getStudy()

template<typename T >

T & RayTracingObject::getStudy ( )

Casts the RayTracingStudy associated with this object to a study of type T with a meaningful error message if it fails.

Definition at line 137 of file RayTracingObject.h.

 {
   static_assert(std::is_base_of<RayTracingStudy, T>::value, "Not derived from a RayTracingStudy");
 
   if (T * cast_study = dynamic_cast<T *>(&_study))
     return *cast_study;
 
   std::stringstream err;
   err << "Supplied study of type " << _study.type() << " is not the required study type "
       << MooseUtils::prettyCppType<T>();
   if (isParamValid("study"))
     paramError("study", err.str());
   else
     mooseError(err.str());
 }

◆ getSuppliedItems()

const std::set<std::string>& RayTracingObject::getSuppliedItems ( )

inlineoverridevirtual

Implements DependencyResolverInterface.

Definition at line 52 of file RayTracingObject.h.

52 { return _supplied_names; }

RayTracingObject::_supplied_names

std::set< std::string > _supplied_names

The names of the supplied objects: just this one.

Definition: RayTracingObject.h:129

◆ postExecuteStudy()

virtual void RayTracingObject::postExecuteStudy ( )

inlinevirtual

Insertion point called immediately after executing the RayTracingStudy.

Definition at line 77 of file RayTracingObject.h.

77 {};

◆ preExecuteStudy()

virtual void RayTracingObject::preExecuteStudy ( )

inlinevirtual

Insertion point called immediately before executing the RayTracingStudy.

Reimplemented in IntegralRayKernelBase.

Definition at line 73 of file RayTracingObject.h.

73 {};

◆ study() [1/2]

RayTracingStudy& RayTracingObject::study ( )

inline

The RayTracingStudy associated with this object.

Definition at line 57 of file RayTracingObject.h.

Referenced by AttribRayTracingStudy::initFrom().

57 { return _study; }

RayTracingObject::_study

RayTracingStudy & _study

The RayTracingStudy associated with this object.

Definition: RayTracingObject.h:104

◆ study() [2/2]

const RayTracingStudy& RayTracingObject::study ( ) const

inline

The RayTracingStudy associated with this object.

Definition at line 61 of file RayTracingObject.h.

61 { return _study; }

RayTracingObject::_study

RayTracingStudy & _study

The RayTracingStudy associated with this object.

Definition: RayTracingObject.h:104

◆ validParams()

InputParameters RayTracingObject::validParams ( )

static

Definition at line 15 of file RayTracingObject.C.

Referenced by RayBoundaryConditionBase::validParams(), and RayKernelBase::validParams().

 {
   auto params = MooseObject::validParams();
   params += SetupInterface::validParams();
   params += TransientInterface::validParams();
   params += MeshChangedInterface::validParams();
 
   params.addParam<UserObjectName>("study",
                                   "The RayTracingStudy associated with this object. If none "
                                   "provided, this will default to the one study that exists.");
   params.addParam<std::vector<std::string>>(
       "rays",
       "The name of the Rays associated with this object; only used if Ray registration is enabled "
       "within the study. If no Rays are supplied, this object will be applied to all Rays.");
 
   params.addPrivateParam<RayTracingStudy *>("_ray_tracing_study");
 
   // Execute flags don't make sense here because the RayTracingStudy calls this object
   params.suppressParameter<ExecFlagEnum>("execute_on");
 
   return params;
 }

Member Data Documentation

◆ _aux

AuxiliarySystem& RayTracingObject::_aux

protected

The aux system.

Definition at line 111 of file RayTracingObject.h.

◆ _current_elem

const Elem* const& RayTracingObject::_current_elem

protected

The current Elem that _current_ray is tracing through.

Definition at line 117 of file RayTracingObject.h.

Referenced by RayBoundaryConditionBase::acquireRay(), RayKernelBase::acquireRay(), RayKernelBase::changeRayStartDirection(), ReflectRayBC::onBoundary(), and ChangeRayRayKernelTest::onSegment().

◆ _current_intersected_extrema

const ElemExtrema& RayTracingObject::_current_intersected_extrema

protected

The elem extrema (vertex/edge) that _current_ray intersects (if any)

Definition at line 123 of file RayTracingObject.h.

◆ _current_intersected_side

const unsigned short& RayTracingObject::_current_intersected_side

protected

The side that _current_ray intersects (if any)

Definition at line 121 of file RayTracingObject.h.

Referenced by RayBoundaryConditionBase::acquireRay(), and ReflectRayBC::onBoundary().

◆ _current_ray

const std::shared_ptr<Ray>* const& RayTracingObject::_current_ray

private

The current Ray that the action is being applied to.

Definition at line 132 of file RayTracingObject.h.

Referenced by currentRay().

◆ _current_subdomain_id

const SubdomainID& RayTracingObject::_current_subdomain_id

protected

The subdomain ID of the _current_elem that the ray is tracing through.

Definition at line 119 of file RayTracingObject.h.

◆ _depend_names

std::set<std::string> RayTracingObject::_depend_names

private

The names of the objects this depends on.

Definition at line 127 of file RayTracingObject.h.

Referenced by dependsOn(), and getRequestedItems().

◆ _fe_problem

FEProblemBase& RayTracingObject::_fe_problem

protected

The FEProblemBase.

Definition at line 101 of file RayTracingObject.h.

Referenced by ADRayKernelTempl< T >::ADRayKernelTempl(), getNonlinearSystem(), and RayKernelTempl< T >::RayKernelTempl().

◆ _mesh

MooseMesh& RayTracingObject::_mesh

protected

The MooseMesh.

Definition at line 114 of file RayTracingObject.h.

Referenced by ADRayKernelTempl< T >::ADRayKernelTempl(), and RayKernelTempl< T >::RayKernelTempl().

◆ _nl

NonlinearSystemBase* RayTracingObject::_nl

protected

The nonlinear system, we might not have one.

Definition at line 109 of file RayTracingObject.h.

◆ _study

RayTracingStudy& RayTracingObject::_study

protected

The RayTracingStudy associated with this object.

Definition at line 104 of file RayTracingObject.h.

Referenced by RayBoundaryConditionBase::acquireRay(), RayKernelBase::acquireRay(), RayKernelBase::changeRayStartDirection(), getNonlinearSystem(), getStudy(), RayBoundaryConditionBase::moveRayToBuffer(), RayKernelBase::moveRayToBuffer(), ReflectRayBC::onBoundary(), and study().

◆ _supplied_names

std::set<std::string> RayTracingObject::_supplied_names

private

The names of the supplied objects: just this one.

Definition at line 129 of file RayTracingObject.h.

Referenced by getSuppliedItems(), and RayTracingObject().

◆ _tid

const THREAD_ID RayTracingObject::_tid

protected

The thread id.

Definition at line 98 of file RayTracingObject.h.

Referenced by RayBoundaryConditionBase::acquireRay(), RayKernelBase::acquireRay(), RayBoundaryConditionBase::moveRayToBuffer(), RayKernelBase::moveRayToBuffer(), ReflectRayBC::onBoundary(), and ViewFactorRayBC::onBoundary().

◆ _trace_ray

const TraceRay& RayTracingObject::_trace_ray

protected

The TraceRay object associated with this thread.

Definition at line 106 of file RayTracingObject.h.

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

ray_tracing/include/base/RayTracingObject.h
ray_tracing/src/base/RayTracingObject.C

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ RayTracingObject()

Member Function Documentation

◆ currentRay()

◆ dependsOn()

◆ getNonlinearSystem()

◆ getRequestedItems()

◆ getStudy()

◆ getSuppliedItems()

◆ postExecuteStudy()

◆ preExecuteStudy()

◆ study() [1/2]

◆ study() [2/2]

◆ validParams()

Member Data Documentation

◆ _aux

◆ _current_elem

◆ _current_intersected_extrema

◆ _current_intersected_side

◆ _current_ray

◆ _current_subdomain_id

◆ _depend_names

◆ _fe_problem

◆ _mesh

◆ _nl

◆ _study

◆ _supplied_names

◆ _tid

◆ _trace_ray