Function based on the nearest point to coordinates and values defined by a vector of values, interpolates linearly in time with transient data. More...

#include <NearestReporterCoordinatesFunction.h>

Inheritance diagram for NearestReporterCoordinatesFunction:

[legend]

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
	NearestReporterCoordinatesFunction (const InputParameters &parameters)

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

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

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

virtual std::vector< Real >	parameterGradient (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

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

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

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

Protected Member Functions
void	buildCoordinateMapping () const
	Builds _coord_mapping object with coordinates from input vectors.

std::array< std::pair< Real, std::size_t >, 2 >	findNearestPoint (Real t, const Point &p) const
	With an input time and point, gets the closest point and two closest times in _coord_mapping.

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 ReporterContextBase &	getReporterContextBaseByName (const ReporterName &reporter_name) const

const ReporterName &	getReporterName (const std::string &param_name) const

virtual void	addReporterDependencyHelper (const ReporterName &)

const T &	getReporterValue (const std::string &param_name, const std::size_t time_index=0)

const T &	getReporterValue (const std::string &param_name, ReporterMode mode, const std::size_t time_index=0)

const T &	getReporterValue (const std::string &param_name, const std::size_t time_index=0)

const T &	getReporterValue (const std::string &param_name, ReporterMode mode, const std::size_t time_index=0)

const T &	getReporterValueByName (const ReporterName &reporter_name, const std::size_t time_index=0)

const T &	getReporterValueByName (const ReporterName &reporter_name, ReporterMode mode, const std::size_t time_index=0)

const T &	getReporterValueByName (const ReporterName &reporter_name, const std::size_t time_index=0)

const T &	getReporterValueByName (const ReporterName &reporter_name, ReporterMode mode, const std::size_t time_index=0)

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

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

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

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

bool	hasReporterValueByName (const ReporterName &reporter_name) const

bool	hasReporterValueByName (const ReporterName &reporter_name) const

bool	hasReporterValueByName (const ReporterName &reporter_name) const

bool	hasReporterValueByName (const ReporterName &reporter_name) const

Protected Attributes
const std::vector< Real > &	_coordx
	x-coordinates from reporter

const std::vector< Real > &	_coordy
	y-coordinates from reporter

const std::vector< Real > &	_coordz
	z-coordinates from reporter

const std::vector< Real > &	_coordt
	time-coordinates from reporter

const std::vector< Real > &	_values
	values from reporter

std::size_t	_nval
	Number of values from coordinate vectors.

std::map< Point, std::vector< std::pair< Real, std::size_t > > >	_coord_mapping
	Data structure for all current data.

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

bool	reportersAdded () const

void	possiblyCheckHasReporter (const ReporterName &reporter_name, const std::string &param_name="") 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 std::vector< Real >	_empty_vec = {}

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

const InputParameters &	_ri_params

FEProblemBase &	_ri_fe_problem_base

const ReporterData &	_ri_reporter_data

const MooseObject &	_ri_moose_object

Detailed Description

Function based on the nearest point to coordinates and values defined by a vector of values, interpolates linearly in time with transient data.

Definition at line 18 of file NearestReporterCoordinatesFunction.h.

Constructor & Destructor Documentation

◆ NearestReporterCoordinatesFunction()

NearestReporterCoordinatesFunction::NearestReporterCoordinatesFunction ( const InputParameters & parameters )

Definition at line 40 of file NearestReporterCoordinatesFunction.C.

  : OptimizationFunction(parameters),
    ReporterInterface(this),
    _coordx(isParamValid("x_coord_name") ? getReporterValue<std::vector<Real>>("x_coord_name")
                                         : _empty_vec),
    _coordy(isParamValid("y_coord_name") ? getReporterValue<std::vector<Real>>("y_coord_name")
                                         : _empty_vec),
    _coordz(isParamValid("z_coord_name") ? getReporterValue<std::vector<Real>>("z_coord_name")
                                         : _empty_vec),
    _coordt(isParamValid("time_name") ? getReporterValue<std::vector<Real>>("time_name")
                                      : _empty_vec),
    _values(getReporterValue<std::vector<Real>>("value_name"))
{
}

Member Function Documentation

◆ buildCoordinateMapping()

void NearestReporterCoordinatesFunction::buildCoordinateMapping ( ) const

protected

Builds _coord_mapping object with coordinates from input vectors.

Definition at line 114 of file NearestReporterCoordinatesFunction.C.

{
  // Do some size checks
  _nval = std::max({_coordx.size(), _coordy.size(), _coordz.size(), _coordt.size()});
  if (_nval == 0)
    paramError("value", "At least one coordinate vector must not be empty.");
  else if (!_coordx.empty() && _coordx.size() != _nval)
    paramError("x_coord_name",
               "Number of x coordinates (",
               _coordx.size(),
               ") does not match number of values (",
               _nval,
               ").");
  else if (!_coordy.empty() && _coordy.size() != _nval)
    paramError("y_coord_name",
               "Number of y coordinates (",
               _coordy.size(),
               ") does not match number of values (",
               _nval,
               ").");
  else if (!_coordz.empty() && _coordz.size() != _nval)
    paramError("z_coord_name",
               "Number of z coordinates (",
               _coordz.size(),
               ") does not match number of values (",
               _nval,
               ").");
  else if (!_coordt.empty() && _coordt.size() != _nval)
    paramError("time_name",
               "Number of times (",
               _coordt.size(),
               ") does not match number of values (",
               _nval,
               ").");
 
  // Find times for each unique coordinate
  _coord_mapping.clear();
  for (const auto & i : make_range(_nval))
  {
    Point pt;
    pt(0) = _coordx.empty() ? 0.0 : _coordx[i];
    pt(1) = _coordy.empty() ? 0.0 : _coordy[i];
    pt(2) = _coordz.empty() ? 0.0 : _coordz[i];
    const Real time = _coordt.empty() ? 0.0 : _coordt[i];
 
    std::vector<std::pair<Real, std::size_t>> * vec = nullptr;
    for (auto & it : _coord_mapping)
      if (pt.absolute_fuzzy_equals(it.first))
      {
        vec = &it.second;
        break;
      }
    if (!vec)
      vec = &_coord_mapping[pt];
 
    vec->emplace_back(time, i);
    std::sort(vec->begin(),
              vec->end(),
              [](const std::pair<Real, Real> & a, const std::pair<Real, Real> & b)
              { return a.first < b.first; });
  }
}

Referenced by findNearestPoint().

◆ findNearestPoint()

std::array< std::pair< Real, std::size_t >, 2 > NearestReporterCoordinatesFunction::findNearestPoint	(	Real	t,
		const Point &	p
	)		const

protected

With an input time and point, gets the closest point and two closest times in _coord_mapping.

See value on how the return value is used.

Parameters

t	Requested time to interpolate
p	Requrested point to find the closest one in the supplied data

Returns: Two pairs indicating the two closest time points and the corresponding index in _values. The pairs will be equal if

Parameters

t	is less than the smallest value or greater than the largest value in _coord_mapping for the found nearest point.

Definition at line 178 of file NearestReporterCoordinatesFunction.C.

{
  if (_coord_mapping.empty())
    buildCoordinateMapping();
 
  // Make sure values is correct size
  if (_values.size() != _nval)
    paramError("value_name",
               "Size of value vector (",
               _values.size(),
               ") does not match number of coordinates specified (",
               _nval,
               ").");
 
  const auto & tval =
      std::min_element(_coord_mapping.begin(),
                       _coord_mapping.end(),
                       [&p](const std::pair<Point, std::vector<std::pair<Real, std::size_t>>> & p1,
                            const std::pair<Point, std::vector<std::pair<Real, std::size_t>>> & p2)
                       { return (p - p1.first).norm_sq() < (p - p2.first).norm_sq(); })
          ->second;
 
  if (tval.size() == 1 || MooseUtils::absoluteFuzzyLessEqual(t, tval[0].first))
    return {tval[0], tval[0]};
  else if (MooseUtils::absoluteFuzzyGreaterEqual(t, tval.back().first))
    return {tval.back(), tval.back()};
  else
    for (std::size_t ti = 1; ti < tval.size(); ++ti)
      if (MooseUtils::absoluteFuzzyGreaterEqual(tval[ti].first, t))
        return {tval[ti - 1], tval[ti]};
 
  mooseError("Internal error: unable to find nearest point.");
  return std::array<std::pair<Real, std::size_t>, 2>();
}

Referenced by parameterGradient(), timeDerivative(), and value().

◆ gradient()

RealGradient NearestReporterCoordinatesFunction::gradient	(	Real	t,
		const Point &	p
	)		const

overridevirtual

Reimplemented from Function.

Definition at line 75 of file NearestReporterCoordinatesFunction.C.

{
  return RealGradient(0, 0, 0);
}

◆ parameterGradient()

std::vector< Real > NearestReporterCoordinatesFunction::parameterGradient	(	Real	t,
		const Point &	p
	)		const

overridevirtual

Implements OptimizationFunction.

Definition at line 96 of file NearestReporterCoordinatesFunction.C.

{
  const std::array<std::pair<Real, std::size_t>, 2> tv = findNearestPoint(t, p);
  std::vector<Real> param_grad(_nval, 0.0);
 
  if (tv[0].second == tv[1].second)
    param_grad[tv[0].second] = 1;
  else
  {
    const Real told = tv[0].first;
    const Real tnew = tv[1].first;
    param_grad[tv[0].second] = (tnew - t) / (tnew - told);
    param_grad[tv[1].second] = (t - told) / (tnew - told);
  }
  return param_grad;
}

◆ timeDerivative()

Real NearestReporterCoordinatesFunction::timeDerivative	(	Real	t,
		const Point &	p
	)		const

overridevirtual

Reimplemented from Function.

Definition at line 81 of file NearestReporterCoordinatesFunction.C.

{
  const std::array<std::pair<Real, std::size_t>, 2> tv = findNearestPoint(t, p);
 
  if (tv[0].second == tv[1].second)
    return 0.0;
 
  const Real told = tv[0].first;
  const Real tnew = tv[1].first;
  const Real vold = _values[tv[0].second];
  const Real vnew = _values[tv[1].second];
  return (vnew - vold) / (tnew - told);
}

◆ validParams()

InputParameters NearestReporterCoordinatesFunction::validParams ( )

static

Definition at line 15 of file NearestReporterCoordinatesFunction.C.

{
  InputParameters params = OptimizationFunction::validParams();
  params.addClassDescription(
      "This Function finds the nearest point in the specified vectors of coordinates and returns "
      "the values specified in the vector of values at the index of the nearest point.  All the "
      "vectors must be specified using either vector postprocessors or reporter vectors. This "
      "function interpolates linearly in time with transient data.");
  params.addParam<ReporterName>("x_coord_name",
                                "Name of vector-postprocessor or reporter vector containing "
                                "x-coordinate of points, default is assumed to be all 0s.");
  params.addParam<ReporterName>("y_coord_name",
                                "Name of vector-postprocessor or reporter vector containing "
                                "y-coordinate of points, default is assumed to be all 0s.");
  params.addParam<ReporterName>("z_coord_name",
                                "Name of vector-postprocessor or reporter vector containing "
                                "z-coordinate of points, default is assumed to be all 0s.");
  params.addParam<ReporterName>("time_name",
                                "Name of vector-postprocessor or reporter vector containing time, "
                                "default is assumed to be all 0s.");
  params.addRequiredParam<ReporterName>(
      "value_name", "Name of vector-postprocessor or reporter vector containing value data.");
  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 NearestReporterCoordinatesFunction::value	(	Real	t,
		const Point &	p
	)		const

overridevirtual

Reimplemented from Function.

Definition at line 57 of file NearestReporterCoordinatesFunction.C.

{
  const std::array<std::pair<Real, std::size_t>, 2> tv = findNearestPoint(t, p);
 
  // If the indices are equal then t is either less than the minimum time in the data
  // or greater than the maximum time. In which case will extrapolate using a constant
  // value.
  if (tv[0].second == tv[1].second)
    return _values[tv[0].second];
 
  const Real told = tv[0].first;
  const Real tnew = tv[1].first;
  const Real vold = _values[tv[0].second];
  const Real vnew = _values[tv[1].second];
  return vold + (vnew - vold) * (t - told) / (tnew - told);
}