A function that returns an absorber fraction for multiple control drums application. More...

#include <MultiControlDrumFunction.h>

Inheritance diagram for MultiControlDrumFunction:

Public Types
typedef DataFileName	DataFileParameterType

typedef FunctorBase< Real >	FunctorType

typedef Real	ValueType

typedef typename FunctorReturnType< Real, FunctorEvaluationKind::Gradient >::type	GradientType

typedef ValueType	DotType

Public Member Functions
	MultiControlDrumFunction (const InputParameters &parameters)

virtual Real	value (Real t, const Point &p) const override

virtual Real	value (Real t, const Point &p) const

virtual ADReal	value (const ADReal &t, const ADPoint &p) const

ChainedReal	value (const ChainedReal &t) const

auto	value (const U &t) const

auto	value (const U &t, const U &x, const U &y=0, const U &z=0) const

ChainedReal	value (const ChainedReal &t) const

auto	value (const U &t) const

auto	value (const U &t, const U &x, const U &y=0, const U &z=0) const

virtual RealVectorValue	vectorValue (Real t, const Point &p) const

virtual RealVectorValue	curl (Real t, const Point &p) const

virtual Real	div (Real t, const Point &p) const

virtual RealGradient	gradient (Real t, const Point &p) const

GradientType	gradient (const ElemArg &elem, const StateArg &state) const

GradientType	gradient (const FaceArg &face, const StateArg &state) const

GradientType	gradient (const ElemQpArg &qp, const StateArg &state) const

GradientType	gradient (const ElemSideQpArg &qp, const StateArg &state) const

GradientType	gradient (const ElemPointArg &elem_point, const StateArg &state) const

GradientType	gradient (const NodeArg &node, const StateArg &state) const

GradientType	gradient (const ElemArg &elem, const StateArg &state) const

GradientType	gradient (const FaceArg &face, const StateArg &state) const

GradientType	gradient (const ElemQpArg &qp, const StateArg &state) const

GradientType	gradient (const ElemSideQpArg &qp, const StateArg &state) const

GradientType	gradient (const ElemPointArg &elem_point, const StateArg &state) const

GradientType	gradient (const NodeArg &node, const StateArg &state) const

GradientType	gradient (const ElemArg &elem, const StateArg &state) const

GradientType	gradient (const FaceArg &face, const StateArg &state) const

GradientType	gradient (const ElemQpArg &qp, const StateArg &state) const

GradientType	gradient (const ElemSideQpArg &qp, const StateArg &state) const

GradientType	gradient (const ElemPointArg &elem_point, const StateArg &state) const

GradientType	gradient (const NodeArg &node, const StateArg &state) const

virtual Real	timeDerivative (Real t, const Point &p) const

auto	timeDerivative (const U &t) const

auto	timeDerivative (const U &t, const U &x, const U &y=0, const U &z=0) const

auto	timeDerivative (const U &t) const

auto	timeDerivative (const U &t, const U &x, const U &y=0, const U &z=0) const

virtual Real	integral () const

virtual Real	average () const

virtual Real	timeIntegral (Real t1, Real t2, const Point &p) const

void	timestepSetup () override

void	residualSetup () override final

void	jacobianSetup () override final

void	customSetup (const ExecFlagType &exec_type) override final

bool	hasBlocks (SubdomainID) const override

bool	supportsFaceArg () const override final

bool	supportsElemSideQpArg () const override final

virtual bool	enabled () const

std::shared_ptr< MooseObject >	getSharedPtr ()

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

bool	isKokkosObject () const

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

virtual void	initialSetup ()

virtual void	subdomainSetup ()

const ExecFlagEnum &	getExecuteOnEnum () const

bool	isImplicit ()

Moose::StateArg	determineState () 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

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 UserObjectBase &	getUserObjectBase (const std::string &param_name, bool is_dependency=true) const

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

virtual void	meshChanged ()

const std::vector< MooseVariableScalar * > &	getCoupledMooseScalarVars ()

const std::set< TagID > &	getScalarVariableCoupleableVectorTags () const

const std::set< TagID > &	getScalarVariableCoupleableMatrixTags () const

FunctorReturnType< Real, FET >::type	genericEvaluate (const Space &r, const State &state) const

const MooseFunctorName &	functorName () const

void	setCacheClearanceSchedule (const std::set< ExecFlagType > &clearance_schedule)

virtual bool	isExtrapolatedBoundaryFace (const FaceInfo &, const Elem *, const StateArg &) const

virtual bool	isExtrapolatedBoundaryFace (const FaceInfo &, const Elem *, const StateArg &) const

bool	isInternalFace (const FaceInfo &) const

virtual bool	isConstant () const

virtual bool	hasFaceSide (const FaceInfo &fi, const bool fi_elem_side) const override

void	checkFace (const Moose::FaceArg &face) 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

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

ValueType	operator() (const ElemArg &elem, const StateArg &state) const

ValueType	operator() (const FaceArg &face, const StateArg &state) const

ValueType	operator() (const ElemQpArg &qp, const StateArg &state) const

ValueType	operator() (const ElemSideQpArg &qp, const StateArg &state) const

ValueType	operator() (const ElemPointArg &elem_point, const StateArg &state) const

ValueType	operator() (const NodeArg &node, const StateArg &state) const

ValueType	operator() (const ElemArg &elem, const StateArg &state) const

ValueType	operator() (const FaceArg &face, const StateArg &state) const

ValueType	operator() (const ElemQpArg &qp, const StateArg &state) const

ValueType	operator() (const ElemSideQpArg &qp, const StateArg &state) const

ValueType	operator() (const ElemPointArg &elem_point, const StateArg &state) const

ValueType	operator() (const NodeArg &node, const StateArg &state) const

ValueType	operator() (const ElemArg &elem, const StateArg &state) const

ValueType	operator() (const FaceArg &face, const StateArg &state) const

ValueType	operator() (const ElemQpArg &qp, const StateArg &state) const

ValueType	operator() (const ElemSideQpArg &qp, const StateArg &state) const

ValueType	operator() (const ElemPointArg &elem_point, const StateArg &state) const

ValueType	operator() (const NodeArg &node, const StateArg &state) const

DotType	dot (const ElemArg &elem, const StateArg &state) const

DotType	dot (const FaceArg &face, const StateArg &state) const

DotType	dot (const ElemQpArg &qp, const StateArg &state) const

DotType	dot (const ElemSideQpArg &qp, const StateArg &state) const

DotType	dot (const ElemPointArg &elem_point, const StateArg &state) const

DotType	dot (const NodeArg &node, const StateArg &state) const

DotType	dot (const ElemArg &elem, const StateArg &state) const

DotType	dot (const FaceArg &face, const StateArg &state) const

DotType	dot (const ElemQpArg &qp, const StateArg &state) const

DotType	dot (const ElemSideQpArg &qp, const StateArg &state) const

DotType	dot (const ElemPointArg &elem_point, const StateArg &state) const

DotType	dot (const NodeArg &node, const StateArg &state) const

DotType	dot (const ElemArg &elem, const StateArg &state) const

DotType	dot (const FaceArg &face, const StateArg &state) const

DotType	dot (const ElemQpArg &qp, const StateArg &state) const

DotType	dot (const ElemSideQpArg &qp, const StateArg &state) const

DotType	dot (const ElemPointArg &elem_point, const StateArg &state) const

DotType	dot (const NodeArg &node, const StateArg &state) const

GradientType	gradDot (const ElemArg &elem, const StateArg &state) const

GradientType	gradDot (const FaceArg &face, const StateArg &state) const

GradientType	gradDot (const ElemQpArg &qp, const StateArg &state) const

GradientType	gradDot (const ElemSideQpArg &qp, const StateArg &state) const

GradientType	gradDot (const ElemPointArg &elem_point, const StateArg &state) const

GradientType	gradDot (const NodeArg &node, const StateArg &state) const

GradientType	gradDot (const ElemArg &elem, const StateArg &state) const

GradientType	gradDot (const FaceArg &face, const StateArg &state) const

GradientType	gradDot (const ElemQpArg &qp, const StateArg &state) const

GradientType	gradDot (const ElemSideQpArg &qp, const StateArg &state) const

GradientType	gradDot (const ElemPointArg &elem_point, const StateArg &state) const

GradientType	gradDot (const NodeArg &node, const StateArg &state) const

GradientType	gradDot (const ElemArg &elem, const StateArg &state) const

GradientType	gradDot (const FaceArg &face, const StateArg &state) const

GradientType	gradDot (const ElemQpArg &qp, const StateArg &state) const

GradientType	gradDot (const ElemSideQpArg &qp, const StateArg &state) const

GradientType	gradDot (const ElemPointArg &elem_point, const StateArg &state) const

GradientType	gradDot (const NodeArg &node, const StateArg &state) const

const Parallel::Communicator &	comm () const

processor_id_type	n_processors () const

processor_id_type	processor_id () const

virtual unsigned int	getElementIDIndex (const std::string &id_parameter_name, unsigned int comp=0) const

virtual unsigned int	getElementIDIndexByName (const std::string &id_name) const

virtual const dof_id_type &	getElementID (const std::string &id_parameter_name, unsigned int comp=0) const

dof_id_type	getElementID (const Elem *elem, unsigned int elem_id_index) const

virtual const dof_id_type &	getElementIDNeighbor (const std::string &id_parameter_name, unsigned int comp=0) const

virtual const dof_id_type &	getElementIDByName (const std::string &id_name) const

virtual const dof_id_type &	getElementIDNeighborByName (const std::string &id_name) const

bool	hasElementID (const std::string &id_name) const

dof_id_type	maxElementID (unsigned int elem_id_index) const

dof_id_type	minElementID (unsigned int elem_id_index) const

bool	areElemIDsIdentical (const std::string &id_name1, const std::string &id_name2) const

std::unordered_map< dof_id_type, std::set< dof_id_type > >	getElemIDMapping (const std::string &id_name1, const std::string &id_name2) const

std::set< dof_id_type >	getAllElemIDs (unsigned int elem_id_index) const

std::set< dof_id_type >	getElemIDsOnBlocks (unsigned int elem_id_index, const std::set< SubdomainID > &blks) 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	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	flagInvalidSolutionInternal (const InvalidSolutionID invalid_solution_id) const

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

virtual void	addPostprocessorDependencyHelper (const PostprocessorName &) const

virtual void	addUserObjectDependencyHelper (const UserObjectBase &) const

T &	declareRestartableData (const std::string &data_name, Args &&... args)

ManagedValue< T >	declareManagedRestartableDataWithContext (const std::string &data_name, void *context, Args &&... args)

const T &	getRestartableData (const std::string &data_name) const

T &	declareRestartableDataWithContext (const std::string &data_name, void *context, Args &&... args)

T &	declareRecoverableData (const std::string &data_name, Args &&... args)

T &	declareRestartableDataWithObjectName (const std::string &data_name, const std::string &object_name, Args &&... args)

T &	declareRestartableDataWithObjectNameWithContext (const std::string &data_name, const std::string &object_name, void *context, Args &&... args)

std::string	restartableName (const std::string &data_name) const

bool	isCoupledScalar (const std::string &var_name, unsigned int i=0) const

unsigned int	coupledScalarComponents (const std::string &var_name) const

unsigned int	coupledScalar (const std::string &var_name, unsigned int comp=0) const

libMesh::Order	coupledScalarOrder (const std::string &var_name, unsigned int comp=0) const

const VariableValue &	coupledScalarValue (const std::string &var_name, unsigned int comp=0) const

const ADVariableValue &	adCoupledScalarValue (const std::string &var_name, unsigned int comp=0) const

const GenericVariableValue< is_ad > &	coupledGenericScalarValue (const std::string &var_name, unsigned int comp=0) const

const GenericVariableValue< false > &	coupledGenericScalarValue (const std::string &var_name, const unsigned int comp) const

const GenericVariableValue< true > &	coupledGenericScalarValue (const std::string &var_name, const unsigned int comp) const

const VariableValue &	coupledVectorTagScalarValue (const std::string &var_name, TagID tag, unsigned int comp=0) const

const VariableValue &	coupledMatrixTagScalarValue (const std::string &var_name, TagID tag, unsigned int comp=0) const

const VariableValue &	coupledScalarValueOld (const std::string &var_name, unsigned int comp=0) const

const VariableValue &	coupledScalarValueOlder (const std::string &var_name, unsigned int comp=0) const

const VariableValue &	coupledScalarDot (const std::string &var_name, unsigned int comp=0) const

const ADVariableValue &	adCoupledScalarDot (const std::string &var_name, unsigned int comp=0) const

const VariableValue &	coupledScalarDotDot (const std::string &var_name, unsigned int comp=0) const

const VariableValue &	coupledScalarDotOld (const std::string &var_name, unsigned int comp=0) const

const VariableValue &	coupledScalarDotDotOld (const std::string &var_name, unsigned int comp=0) const

const VariableValue &	coupledScalarDotDu (const std::string &var_name, unsigned int comp=0) const

const VariableValue &	coupledScalarDotDotDu (const std::string &var_name, unsigned int comp=0) const

const MooseVariableScalar *	getScalarVar (const std::string &var_name, unsigned int comp) const

virtual GradientType	evaluateGradDot (const ElemArg &, const StateArg &) const

virtual GradientType	evaluateGradDot (const FaceArg &, const StateArg &) const

virtual GradientType	evaluateGradDot (const ElemQpArg &, const StateArg &) const

virtual GradientType	evaluateGradDot (const ElemSideQpArg &, const StateArg &) const

virtual GradientType	evaluateGradDot (const ElemPointArg &, const StateArg &) const

virtual GradientType	evaluateGradDot (const NodeArg &, const StateArg &) const

virtual GradientType	evaluateGradDot (const ElemArg &, const StateArg &) const

virtual GradientType	evaluateGradDot (const FaceArg &, const StateArg &) const

virtual GradientType	evaluateGradDot (const ElemQpArg &, const StateArg &) const

virtual GradientType	evaluateGradDot (const ElemSideQpArg &, const StateArg &) const

virtual GradientType	evaluateGradDot (const ElemPointArg &, const StateArg &) const

virtual GradientType	evaluateGradDot (const NodeArg &, const StateArg &) const

virtual GradientType	evaluateGradDot (const ElemArg &, const StateArg &) const

virtual GradientType	evaluateGradDot (const FaceArg &, const StateArg &) const

virtual GradientType	evaluateGradDot (const ElemQpArg &, const StateArg &) const

virtual GradientType	evaluateGradDot (const ElemSideQpArg &, const StateArg &) const

virtual GradientType	evaluateGradDot (const ElemPointArg &, const StateArg &) const

virtual GradientType	evaluateGradDot (const NodeArg &, const StateArg &) 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

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

Protected Attributes
const MeshGeneratorName	_mesh_generator
	Name of the mesh generator to get MeshMetaData from.

const std::vector< Real >	_angular_speeds
	Vector of angular speeds of control drums.

const std::vector< Real >	_start_angles
	Vector of initial starting angles of control drums.

const std::vector< Real >	_angle_ranges
	Vector of angular ranges of control drums.

const Real	_rotation_start_time
	Start time of control drums rotation.

const Real	_rotation_end_time
	End time of control drums rotation.

const bool	_use_control_drum_id
	Whether extra element id user_control_drum_id is used.

const dof_id_type &	_control_drum_id
	ExtraElementID: control drum ExtraElementID.

const std::vector< Point > &	_control_drum_positions
	MeshMetaData: positions of control drums.

const std::vector< std::vector< Real > > &	_control_drums_azimuthal_meta
	MeshMetaData: vector of azimuthal angles of all nodes of each control drum.

const bool &	_enabled

MooseApp &	_app

Factory &	_factory

ActionFactory &	_action_factory

const std::string &	_type

const std::string &	_name

const InputParameters &	_pars

const ExecFlagEnum &	_execute_enum

const ExecFlagType &	_current_execute_flag

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

MooseApp &	_restartable_app

const std::string	_restartable_system_name

const THREAD_ID	_restartable_tid

const bool	_restartable_read_only

FEProblemBase &	_mci_feproblem

FEProblemBase &	_sc_fe_problem

const THREAD_ID	_sc_tid

const Real &	_real_zero

const VariableValue &	_scalar_zero

const Point &	_point_zero

const Parallel::Communicator &	_communicator

Private Types
typedef Moose::ElemArg	ElemArg

typedef Moose::ElemQpArg	ElemQpArg

typedef Moose::ElemSideQpArg	ElemSideQpArg

typedef Moose::FaceArg	FaceArg

typedef Moose::ElemPointArg	ElemPointArg

typedef Moose::NodeArg	NodeArg

Private Member Functions
ValueType	evaluateHelper (const R &r, const Moose::StateArg &state) const

ValueType	evaluate (const ElemArg &elem, const Moose::StateArg &state) const override final

ValueType	evaluate (const FaceArg &face, const Moose::StateArg &state) const override final

ValueType	evaluate (const ElemQpArg &qp, const Moose::StateArg &state) const override final

ValueType	evaluate (const ElemSideQpArg &elem_side_qp, const Moose::StateArg &state) const override final

ValueType	evaluate (const ElemPointArg &elem_point, const Moose::StateArg &state) const override final

ValueType	evaluate (const NodeArg &node, const Moose::StateArg &state) const override final

GradientType	evaluateGradientHelper (const R &r, const Moose::StateArg &state) const

GradientType	evaluateGradient (const ElemArg &elem, const Moose::StateArg &state) const override final

GradientType	evaluateGradient (const FaceArg &face, const Moose::StateArg &state) const override final

GradientType	evaluateGradient (const ElemQpArg &qp, const Moose::StateArg &state) const override final

GradientType	evaluateGradient (const ElemSideQpArg &elem_side_qp, const Moose::StateArg &state) const override final

GradientType	evaluateGradient (const ElemPointArg &elem_point, const Moose::StateArg &state) const override final

GradientType	evaluateGradient (const NodeArg &node, const Moose::StateArg &state) const override final

DotType	evaluateDotHelper (const R &r, const Moose::StateArg &state) const

DotType	evaluateDot (const ElemArg &elem, const Moose::StateArg &state) const override final

DotType	evaluateDot (const FaceArg &face, const Moose::StateArg &state) const override final

DotType	evaluateDot (const ElemQpArg &qp, const Moose::StateArg &state) const override final

DotType	evaluateDot (const ElemSideQpArg &elem_side_qp, const Moose::StateArg &state) const override final

DotType	evaluateDot (const ElemPointArg &elem_point, const Moose::StateArg &state) const override final

DotType	evaluateDot (const NodeArg &node, const Moose::StateArg &state) const override final

const PostprocessorName &	getPostprocessorNameInternal (const std::string &param_name, const unsigned int index, const bool allow_default_value=true) const

bool	isDefaultPostprocessorValueByName (const PostprocessorName &name) const

PostprocessorValue	getDefaultPostprocessorValueByName (const PostprocessorName &name) const

void	checkParam (const std::string &param_name, const unsigned int index=std::numeric_limits< unsigned int >::max()) const

bool	postprocessorsAdded () const

const UserObjectBase &	getUserObjectFromFEProblem (const UserObjectName &object_name, const THREAD_ID tid=0) const

const T &	castUserObject (const UserObjectBase &uo_base, const std::string &param_name="") const

void	mooseObjectError (const std::string &param_name, std::stringstream &oss) const

const std::string &	userObjectType (const UserObjectBase &uo) const

const std::string &	userObjectName (const UserObjectBase &uo) const

RestartableDataValue &	registerRestartableDataOnApp (std::unique_ptr< RestartableDataValue > data, THREAD_ID tid) const

void	registerRestartableNameWithFilterOnApp (const std::string &name, Moose::RESTARTABLE_FILTER filter)

RestartableData< T > &	declareRestartableDataHelper (const std::string &data_name, void *context, Args &&... args) const

const VariableValue *	getDefaultValue (const std::string &var_name) const

const ADVariableValue *	getADDefaultValue (const std::string &var_name) const

void	checkVar (const std::string &var_name) const

void	validateExecutionerType (const std::string &name, const std::string &fn_name) const

void	clearCacheData ()

ValueType	queryQpCache (unsigned int qp, const libMesh::QBase &qrule, std::vector< std::pair< bool, Real > > &qp_cache_data, const SpaceArg &space, const StateArg &state) const

ValueType	queryFVArgCache (std::map< SpaceArg, ValueType > &cache_data, const SpaceArg &space) const

const PostprocessorValue &	getPostprocessorValueInternal (const std::string &param_name, unsigned int index, std::size_t t_index) const

const PostprocessorValue &	getPostprocessorValueInternal (const std::string &param_name, unsigned int index, std::size_t t_index) const

const PostprocessorValue &	getPostprocessorValueByNameInternal (const PostprocessorName &name, std::size_t t_index) const

const PostprocessorValue &	getPostprocessorValueByNameInternal (const PostprocessorName &name, std::size_t t_index) const

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

const MooseBase &	_si_moose_base

const FEProblemBase *	_si_problem

ExecFlagEnum	_empty_execute_enum

const std::string	_ti_name

const MooseObject &	_ppi_moose_object

const InputParameters &	_ppi_params

const FEProblemBase &	_ppi_feproblem

std::map< PostprocessorName, std::unique_ptr< PostprocessorValue > >	_default_values

const MooseObject &	_uoi_moose_object

const FEProblemBase &	_uoi_feproblem

const THREAD_ID	_uoi_tid

const RestartableDataMapName	_metaname

std::string	_restartable_name

const InputParameters &	_sc_parameters

const std::string &	_sc_name

const bool	_sc_is_implicit

std::unordered_map< std::string, std::vector< MooseVariableScalar * > >	_coupled_scalar_vars

std::unordered_map< std::string, std::unique_ptr< VariableValue > >	_default_value

std::unordered_map< std::string, std::unique_ptr< ADVariableValue > >	_dual_default_value

std::vector< MooseVariableScalar * >	_coupled_moose_scalar_vars

std::unordered_map< std::string, std::vector< MooseVariableFieldBase * > >	_sc_coupled_vars

std::set< TagID >	_sc_coupleable_vector_tags

std::set< TagID >	_sc_coupleable_matrix_tags

std::set< ExecFlagType >	_clearance_schedule

bool	_always_evaluate

dof_id_type	_current_qp_map_key

std::vector< std::pair< bool, ValueType > > *	_current_qp_map_value

std::unordered_map< dof_id_type, std::vector< std::pair< bool, ValueType > > >	_qp_to_value

dof_id_type	_current_side_qp_map_key

std::vector< std::vector< std::pair< bool, ValueType > > > *	_current_side_qp_map_value

std::unordered_map< dof_id_type, std::vector< std::vector< std::pair< bool, ValueType > > > >	_side_qp_to_value

std::map< ElemArg, ValueType >	_elem_arg_to_value

std::map< FaceArg, ValueType >	_face_arg_to_value

std::map< NodeArg, ValueType >	_node_arg_to_value

MooseFunctorName	_functor_name

MooseApp &	_meta_data_app

const MooseObject *const	_meta_data_object

const InputParameters &	_obj_parameters

std::shared_ptr< MooseMesh > &	_id_mesh

const std::string &	_ei_name

Detailed Description

A function that returns an absorber fraction for multiple control drums application.

Definition at line 19 of file MultiControlDrumFunction.h.

Constructor & Destructor Documentation

◆ MultiControlDrumFunction()

MultiControlDrumFunction::MultiControlDrumFunction ( const InputParameters & parameters )

Definition at line 42 of file MultiControlDrumFunction.C.

  : Function(parameters),
    MeshMetaDataInterface(this),
    ElementIDInterface(this),
    _mesh_generator(getParam<MeshGeneratorName>("mesh_generator")),
    _angular_speeds(getParam<std::vector<Real>>("angular_speeds")),
    _start_angles(getParam<std::vector<Real>>("start_angles")),
    _angle_ranges(getParam<std::vector<Real>>("angle_ranges")),
    _rotation_start_time(getParam<Real>("rotation_start_time")),
    _rotation_end_time(getParam<Real>("rotation_end_time")),
    _use_control_drum_id(getParam<bool>("use_control_drum_id")),
    _control_drum_id(_use_control_drum_id ? getElementIDByName("control_drum_id")
                                          : DofObject::invalid_id),
    _control_drum_positions(
        getMeshProperty<std::vector<Point>>("control_drum_positions", _mesh_generator)),
    _control_drums_azimuthal_meta(getMeshProperty<std::vector<std::vector<Real>>>(
        "control_drums_azimuthal_meta", _mesh_generator))
{
  if (_angular_speeds.size() != _start_angles.size())
    paramError("start_angles",
               "the size of 'start_angles' must be identical to the size of 'angular_speeds'");
  if (_angular_speeds.size() != _angle_ranges.size())
    paramError("angle_ranges",
               "the size of 'angle_ranges' must be identical to the size of 'angular_speeds'");
  if (_angular_speeds.size() != _control_drum_positions.size())
    paramError("angular_speeds",
               "the size of this parameter must be identical to the control drum number recorded "
               "in the MeshMetaData.");
  if (_rotation_end_time <= _rotation_start_time)
    paramError("rotation_end_time", "this parameter must be larger than rotation_start_time.");
}

Member Function Documentation

◆ validParams()

InputParameters MultiControlDrumFunction::validParams ( )

static

Definition at line 15 of file MultiControlDrumFunction.C.

{
  InputParameters params = Function::validParams();
  params.addClassDescription(
      "A function that returns an absorber fraction for multiple control drums application.");
  params.addRequiredParam<MeshGeneratorName>(
      "mesh_generator",
      "Name of the mesh generator to be used to retrieve control drums information.");
  params.addRequiredParam<std::vector<Real>>(
      "angular_speeds", "Vector of angular rotation speeds of the control drum.");
  params.addRequiredParam<std::vector<Real>>(
      "start_angles",
      "Vector of initial angular positions of the beginning of the absorber components.");
  params.addRequiredParam<std::vector<Real>>(
      "angle_ranges", "Vector of angular ranges of the beginning of the absorber components.");
  params.addParam<Real>(
      "rotation_start_time", 0.0, "The time point at which the control drums start rotating.");
  params.addParam<Real>("rotation_end_time",
                        std::numeric_limits<Real>::max(),
                        "The time point at which the control drums stop rotating.");
  params.addParam<bool>(
      "use_control_drum_id", true, "Whether extra element id user_control_drum_id is used.");
  params.addParamNamesToGroup("use_control_drum_id", "Advanced");
 
  return params;
}

◆ value() [1/9]

virtual ADReal Function::value	(	const ADReal &	t,
		const ADPoint &	p
	)		const

virtual

Reimplemented from Function.

◆ value() [2/9]

ChainedReal Function::value ( const ChainedReal & t ) const

◆ value() [3/9]

ChainedReal Function::value ( const ChainedReal & t ) const

◆ value() [4/9]

auto Function::value ( const U & t ) const

◆ value() [5/9]

auto Function::value ( const U & t ) const

◆ value() [6/9]

auto Function::value	(	const U &	t,
		const U &	x,
		const U &	y = `0`,
		const U &	z = `0`
	)		const

◆ value() [7/9]

auto Function::value	(	const U &	t,
		const U &	x,
		const U &	y = `0`,
		const U &	z = `0`
	)		const

◆ value() [8/9]

virtual Real Function::value	(	Real	t,
		const Point &	p
	)		const

virtual

Reimplemented from Function.

◆ value() [9/9]

Real MultiControlDrumFunction::value	(	Real	t,
		const Point &	p
	)		const

overridevirtual

Reimplemented from Function.

Definition at line 75 of file MultiControlDrumFunction.C.

{
  // Calculate the effective rotation time
  const Real t_eff = t < _rotation_start_time
                         ? 0.0
                         : (t > _rotation_end_time ? (_rotation_end_time - _rotation_start_time)
                                                   : t - _rotation_start_time);
  // Find the closest control drum for a given Point p; only needed if control drum id is not used.
  std::vector<std::pair<Real, unsigned int>> meshcontrol_drum_dist_vec;
  if (!_use_control_drum_id)
  {
    for (unsigned int i = 0; i < _control_drum_positions.size(); i++)
    {
      Real cd_dist = std::sqrt(Utility::pow<2>(p(0) - _control_drum_positions[i](0)) +
                               Utility::pow<2>(p(1) - _control_drum_positions[i](1)));
      meshcontrol_drum_dist_vec.push_back(std::make_pair(cd_dist, i));
    }
    std::sort(meshcontrol_drum_dist_vec.begin(), meshcontrol_drum_dist_vec.end());
  }
  const unsigned int cd_id = _use_control_drum_id
                                 ? (_control_drum_id > 0 ? _control_drum_id - 1 : 0)
                                 : meshcontrol_drum_dist_vec.front().second;
  const auto & cd_pos = _control_drum_positions[cd_id];
 
  Real dynamic_start_angle = (_angular_speeds[cd_id] * t_eff + _start_angles[cd_id]) / 180.0 * M_PI;
  Real dynamic_end_angle = dynamic_start_angle + _angle_ranges[cd_id] / 180.0 * M_PI;
 
  dynamic_start_angle = atan2(std::sin(dynamic_start_angle),
                              std::cos(dynamic_start_angle)) /
                        M_PI * 180.0; // quick way to move to -M_PI to M_PI
  dynamic_end_angle = atan2(std::sin(dynamic_end_angle),
                            std::cos(dynamic_end_angle)) /
                      M_PI * 180.0; // quick way to move to -M_PI to M_PI
 
  // Locate the first mesh azimuthal angle that is greater than dynamic_start_angle
  auto start_bound = std::upper_bound(_control_drums_azimuthal_meta[cd_id].begin(),
                                      _control_drums_azimuthal_meta[cd_id].end(),
                                      dynamic_start_angle);
  // Locate the first mesh azimuthal angle that is greater than dynamic_end_angle
  auto end_bound = std::upper_bound(_control_drums_azimuthal_meta[cd_id].begin(),
                                    _control_drums_azimuthal_meta[cd_id].end(),
                                    dynamic_end_angle);
 
  // Locate the elements that contain the start/end angles.
  // This part seems long; but it only solves one simple issue -> transition from M_PI to -M_PI
 
  // The two azimuthal ends of the element that the start angle intercepts;
  // and the two azimuthal ends of the element that the end angle intercepts;
  Real start_low, start_high, end_low, end_high;
  // This means that the dynamic_start_angle is greater than the lowest mesh azimuthal angle and
  // lower than the greatest mesh azimuthal angle. Namely, dynamic_start_angle does not cause the
  // "transition from M_PI to -M_PI" issue.
  if (start_bound != _control_drums_azimuthal_meta[cd_id].begin() &&
      start_bound != _control_drums_azimuthal_meta[cd_id].end())
  {
    start_low = *(start_bound - 1);
    start_high = *start_bound;
  }
  // On the contrary, this means the dynamic_start_angle intercepts an element across the
  // M_PI(-M_PI) azimuthal angle. Namely, start_high is actually lower than start_low because of
  // this transition.
  else
  {
    start_high = _control_drums_azimuthal_meta[cd_id].front();
    start_low = _control_drums_azimuthal_meta[cd_id].back();
  }
 
  // This means that dynamic_end_angle is greater than the lowest mesh azimuthal angle and lower
  // than the greatest mesh azimuthal angle. Namely, dynamic_end_angle does not cause the
  // "transition from M_PI to -M_PI" issue.
  if (end_bound != _control_drums_azimuthal_meta[cd_id].begin() &&
      end_bound != _control_drums_azimuthal_meta[cd_id].end())
  {
    end_low = *(end_bound - 1);
    end_high = *end_bound;
  }
  // On the contrary, this means the dynamic_end_angle intercepts an element across the
  // M_PI(-M_PI) azimuthal angle. Namely, end_high is actually lower than end_low because of
  // this transition.
  else
  {
    end_high = _control_drums_azimuthal_meta[cd_id].front();
    end_low = _control_drums_azimuthal_meta[cd_id].back();
  }
 
  // azimuthal_p is the azimuthal angle of the point whose functon value needs to be calculated.
  Real azimuthal_p = atan2(p(1) - cd_pos(1), p(0) - cd_pos(0)) / M_PI * 180;
 
  // If there is not periodical transition from M_PI to -M_PI, we always have:
  // start_low < start_high < end_low < end_high
  // In the presence of "transition from M_PI to -M_PI", the relation above is compromised.
  // Based on how the relation is compromised, we can tell where the transition occurs.
 
  // Most trivial scenario -> no transition from M_PI to -M_PI is involved (it happens to a pure
  // reflector element)
  if (end_high >= start_low)
  {
    // the point is located in an element that is purely absorber.
    if (azimuthal_p >= start_high && azimuthal_p <= end_low)
      return 100.0;
    // the point is located in an element that is purely reflector.
    else if (azimuthal_p <= start_low || azimuthal_p >= end_high)
      return 0.0;
    // the point is located in a mixed element intercepted by dynamic_start_angle so that volume
    // fraction is calculated.
    else if (azimuthal_p < start_high && azimuthal_p > start_low)
    {
      Real start_interval = start_high - start_low;
      Real stab_interval = start_high - dynamic_start_angle;
      return stab_interval / start_interval * 100.0;
    }
    // the point is located in a mixed element intercepted by dynamic_end_angle so that volume
    // fraction is calculated.
    else
    {
      Real end_interval = end_high - end_low;
      Real endab_interval = dynamic_end_angle - end_low;
      return endab_interval / end_interval * 100.0;
    }
  }
  // The element intercepted by dynamic_end_angle has the "transition from M_PI to -M_PI" issue.
  // This is still relatively simple because only one of the mixed element is affected.
  else if (end_low >= end_high)
  {
    // (Not affected) the point is located in an element that is purely absorber.
    if (azimuthal_p >= start_high && azimuthal_p <= end_low)
      return 100.0;
    // (Affected) the point is located in an element that is purely reflector.
    else if (azimuthal_p <= start_low && azimuthal_p >= end_high)
      return 0.0;
    // (Not affected) the point is located in a mixed element intercepted by dynamic_start_angle so
    // that volume fraction is calculated.
    else if (azimuthal_p < start_high && azimuthal_p > start_low)
    {
      Real start_interval = start_high - start_low;
      Real stab_interval = start_high - dynamic_start_angle;
      return stab_interval / start_interval * 100.0;
    }
    // (Affected) the point is located in a mixed element intercepted by dynamic_end_angle so that
    // volume fraction is calculated. As this element is also intercepted by azimuthal_angle = M_PI
    // (-M_PI), an extra 2 * M_PI (360 degrees) shift is used to correct this transition effect.
    else
    {
      Real end_interval = end_high - end_low + 360.0;
      Real endab_interval = (dynamic_end_angle - end_low >= 0.0)
                                ? (dynamic_end_angle - end_low)
                                : (dynamic_end_angle - end_low + 360.0);
      return endab_interval / end_interval * 100.0;
    }
  }
  // The "transition from M_PI to -M_PI" happens to an pure absorber element
  else if (start_high >= end_low)
  {
    // (Affected) the point is located in an element that is purely absorber.
    if (azimuthal_p >= start_high || azimuthal_p <= end_low)
      return 100.0;
    // (Affected) the point is located in an element that is purely reflector.
    else if (azimuthal_p >= end_high && azimuthal_p <= start_low)
      return 0.0;
    // (Not affected) the point is located in a mixed element intercepted by dynamic_start_angle so
    // that volume fraction is calculated.
    else if (azimuthal_p < start_high && azimuthal_p > start_low)
    {
      Real start_interval = start_high - start_low;
      Real stab_interval = start_high - dynamic_start_angle;
      return stab_interval / start_interval * 100.0;
    }
    // (Not affected) the point is located in a mixed element intercepted by dynamic_end_angle so
    // that volume fraction is calculated.
    else
    {
      Real end_interval = end_high - end_low;
      Real endab_interval = dynamic_end_angle - end_low;
      return endab_interval / end_interval * 100.0;
    }
  }
  // The element intercepted by dynamic_start_angle has the "transition from M_PI to -M_PI" issue.
  // This is still relatively simple because only one of the mixed element is affected.
  else
  {
    // (Not affected) the point is located in an element that is purely absorber.
    if (azimuthal_p >= start_high && azimuthal_p <= end_low)
      return 100.0;
    // (Affected) the point is located in an element that is purely reflector.
    else if (azimuthal_p >= end_high && azimuthal_p <= start_low)
      return 0.0;
    // (Affected) the point is located in a mixed element intercepted by dynamic_start_angle so that
    // volume fraction is calculated. As this element is also intercepted by azimuthal_angle = M_PI
    // (-M_PI), an extra 2 * M_PI (360 degrees) shift is used to correct this transition effect.
    else if (azimuthal_p > start_low || azimuthal_p < start_high)
    {
      Real start_interval = start_high - start_low + 360.0;
      Real stab_interval = (start_high - dynamic_start_angle >= 0.0)
                               ? (start_high - dynamic_start_angle)
                               : (start_high - dynamic_start_angle + 360.0);
      return stab_interval / start_interval * 100.0;
    }
    // (Not affected) the point is located in a mixed element intercepted by dynamic_end_angle so
    // that volume fraction is calculated.
    else
    {
      Real end_interval = end_high - end_low;
      Real endab_interval = dynamic_end_angle - end_low;
      return endab_interval / end_interval * 100.0;
    }
  }
}

Member Data Documentation

◆ _angle_ranges

const std::vector<Real> MultiControlDrumFunction::_angle_ranges

protected

Vector of angular ranges of control drums.

Definition at line 39 of file MultiControlDrumFunction.h.

Referenced by MultiControlDrumFunction(), and value().

◆ _angular_speeds

const std::vector<Real> MultiControlDrumFunction::_angular_speeds

protected

Vector of angular speeds of control drums.

Definition at line 35 of file MultiControlDrumFunction.h.

Referenced by MultiControlDrumFunction(), and value().

◆ _control_drum_id

const dof_id_type& MultiControlDrumFunction::_control_drum_id

protected

ExtraElementID: control drum ExtraElementID.

Definition at line 47 of file MultiControlDrumFunction.h.

Referenced by value().

◆ _control_drum_positions

const std::vector<Point>& MultiControlDrumFunction::_control_drum_positions

protected

MeshMetaData: positions of control drums.

Definition at line 49 of file MultiControlDrumFunction.h.

Referenced by MultiControlDrumFunction(), and value().

◆ _control_drums_azimuthal_meta

const std::vector<std::vector<Real> >& MultiControlDrumFunction::_control_drums_azimuthal_meta

protected

MeshMetaData: vector of azimuthal angles of all nodes of each control drum.

Definition at line 51 of file MultiControlDrumFunction.h.

Referenced by value().

◆ _mesh_generator

const MeshGeneratorName MultiControlDrumFunction::_mesh_generator

protected

Name of the mesh generator to get MeshMetaData from.

Definition at line 33 of file MultiControlDrumFunction.h.

◆ _rotation_end_time

const Real MultiControlDrumFunction::_rotation_end_time

protected

End time of control drums rotation.

Definition at line 43 of file MultiControlDrumFunction.h.

Referenced by MultiControlDrumFunction(), and value().

◆ _rotation_start_time

const Real MultiControlDrumFunction::_rotation_start_time

protected

Start time of control drums rotation.

Definition at line 41 of file MultiControlDrumFunction.h.

Referenced by MultiControlDrumFunction(), and value().

◆ _start_angles

const std::vector<Real> MultiControlDrumFunction::_start_angles

protected

Vector of initial starting angles of control drums.

Definition at line 37 of file MultiControlDrumFunction.h.

Referenced by MultiControlDrumFunction(), and value().

◆ _use_control_drum_id

const bool MultiControlDrumFunction::_use_control_drum_id

protected

Whether extra element id user_control_drum_id is used.

Definition at line 45 of file MultiControlDrumFunction.h.

Referenced by value().

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

reactor/include/functions/MultiControlDrumFunction.h
reactor/src/functions/MultiControlDrumFunction.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 Types

Private Member Functions

Static Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ MultiControlDrumFunction()

Member Function Documentation

◆ validParams()

◆ value() [1/9]

◆ value() [2/9]

◆ value() [3/9]

◆ value() [4/9]

◆ value() [5/9]

◆ value() [6/9]

◆ value() [7/9]

◆ value() [8/9]

◆ value() [9/9]

Member Data Documentation

◆ _angle_ranges

◆ _angular_speeds

◆ _control_drum_id

◆ _control_drum_positions

◆ _control_drums_azimuthal_meta

◆ _mesh_generator

◆ _rotation_end_time

◆ _rotation_start_time

◆ _start_angles

◆ _use_control_drum_id