#include <ParameterMeshFunction.h>

Inheritance diagram for ParameterMeshFunction:

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
	ParameterMeshFunction (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 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

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

bool	isParamValid (const std::string &name) const

bool	isParamSetByUser (const std::string &name) const

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

void	callMooseError (std::string msg, const bool with_prefix, const hit::Node *node=nullptr, const bool show_trace=true) const

std::string	getDataFileName (const std::string &param) const

std::string	getDataFileNameByName (const std::string &relative_path) const

std::string	getDataFilePath (const std::string &relative_path) const

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

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
std::array< std::pair< std::size_t, Real >, 2 >	interpolateTime (Real t, bool derivative=false) const
	This function is used to compute the weights for time interpolation. More...

void	checkSize () const
	Used to make sure DoFs in '_parameter_mesh' matches number of values in '_values'. More...

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

virtual ValueType	evaluate (const ElemArg &elem, const StateArg &state) const =0

virtual ValueType	evaluate (const FaceArg &face, const StateArg &state) const =0

virtual ValueType	evaluate (const ElemQpArg &qp, const StateArg &state) const =0

virtual ValueType	evaluate (const ElemSideQpArg &side_qp, const StateArg &state) const =0

virtual ValueType	evaluate (const ElemPointArg &elem_point, const StateArg &state) const =0

virtual ValueType	evaluate (const NodeArg &node, const StateArg &state) const =0

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

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

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

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

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

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

virtual DotType	evaluateDot (const ElemArg &, const StateArg &) const

virtual DotType	evaluateDot (const FaceArg &, const StateArg &) const

virtual DotType	evaluateDot (const ElemQpArg &, const StateArg &) const

virtual DotType	evaluateDot (const ElemSideQpArg &, const StateArg &) const

virtual DotType	evaluateDot (const ElemPointArg &, const StateArg &) const

virtual DotType	evaluateDot (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 ParameterMesh	_parameter_mesh
	Parameter mesh. More...

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

const std::vector< Real > &	_coordt
	Time coordinates from reporter. More...

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 Attributes
const std::vector< Real >	_empty_vec = {}

Detailed Description

Definition at line 20 of file ParameterMeshFunction.h.

Constructor & Destructor Documentation

◆ ParameterMeshFunction()

ParameterMeshFunction::ParameterMeshFunction ( const InputParameters & parameters )

Definition at line 46 of file ParameterMeshFunction.C.

   : OptimizationFunction(parameters),
     ReporterInterface(this),
     _parameter_mesh(AddVariableAction::feType(parameters),
                     getParam<FileName>("exodus_mesh"),
                     getParam<bool>("project_points"),
                     getParam<unsigned int>("kdtree_candidates")),
     _values(getReporterValue<std::vector<Real>>("parameter_name")),
     _coordt(isParamValid("time_name") ? getReporterValue<std::vector<Real>>("time_name")
                                       : _empty_vec)
 {
 }

Member Function Documentation

◆ checkSize()

void ParameterMeshFunction::checkSize ( ) const

protected

Used to make sure DoFs in '_parameter_mesh' matches number of values in '_values'.

Definition at line 184 of file ParameterMeshFunction.C.

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

 {
   dof_id_type sz = _parameter_mesh.size();
   if (!_coordt.empty())
     sz *= _coordt.size();
   if (sz != _values.size())
     paramError("parameter_name",
                "Size of parameter vector (",
                _values.size(),
                ") does not match number of degrees of freedom in mesh (",
                sz,
                ").");
 }

◆ gradient()

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

overridevirtual

Reimplemented from Function.

Definition at line 82 of file ParameterMeshFunction.C.

 {
   checkSize();
 
   const auto ti = interpolateTime(t);
   const dof_id_type offset0 = ti[0].first * _parameter_mesh.size();
   const dof_id_type offset1 = ti[1].first * _parameter_mesh.size();
 
   std::vector<dof_id_type> dof_indices;
   std::vector<RealGradient> weights;
   _parameter_mesh.getIndexAndWeight(p, dof_indices, weights);
 
   RealGradient val(0, 0, 0);
   for (const auto & i : index_range(dof_indices))
     val += (_values[dof_indices[i] + offset0] * ti[0].second +
             _values[dof_indices[i] + offset1] * ti[1].second) *
            weights[i];
   return val;
 }

◆ interpolateTime()

std::array< std::pair< std::size_t, Real >, 2 > ParameterMeshFunction::interpolateTime	(	Real	t,
		bool	derivative = `false`
	)		const

protected

This function is used to compute the weights for time interpolation.

See also: value for an example of how to use the return data

Parameters

t	Time to interpolate to
derivate	Set to true to compute time derivative

Returns: std::array<std::pair<Real, std::size_t>, 2> Usage: const auto ti = interpolateTime(t); return v[ti[0].first] * ti[0].second + v[ti[1].first] * ti.[1].second;

Definition at line 149 of file ParameterMeshFunction.C.

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

 {
   std::array<std::pair<std::size_t, Real>, 2> ti;
   if (_coordt.size() <= 1 || MooseUtils::absoluteFuzzyLessEqual(t, _coordt[0]))
   {
     ti[0] = {0, 0.5};
     ti[1] = {0, 0.5};
   }
   else if (MooseUtils::absoluteFuzzyGreaterEqual(t, _coordt.back()))
   {
     ti[0] = {_coordt.size() - 1, 0.5};
     ti[1] = {_coordt.size() - 1, 0.5};
   }
   else
     for (std::size_t i = 1; i < _coordt.size(); ++i)
       if (MooseUtils::absoluteFuzzyGreaterEqual(_coordt[i], t))
       {
         const Real dt = _coordt[i] - _coordt[i - 1];
         if (derivative)
         {
           ti[0] = {i - 1, -1.0 / dt};
           ti[1] = {i, 1.0 / dt};
         }
         else
         {
           ti[0] = {i - 1, (_coordt[i] - t) / dt};
           ti[1] = {i, (t - _coordt[i - 1]) / dt};
         }
         break;
       }
 
   return ti;
 }

◆ parameterGradient()

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

overridevirtual

Implements OptimizationFunction.

Definition at line 126 of file ParameterMeshFunction.C.

 {
   const auto ti = interpolateTime(t);
   const dof_id_type offset0 = ti[0].first * _parameter_mesh.size();
   const dof_id_type offset1 = ti[1].first * _parameter_mesh.size();
 
   std::vector<dof_id_type> dof_indices;
   std::vector<Real> weights;
   _parameter_mesh.getIndexAndWeight(p, dof_indices, weights);
 
   dof_id_type sz = _parameter_mesh.size();
   if (!_coordt.empty())
     sz *= _coordt.size();
   std::vector<Real> pg(sz, 0.0);
   for (const auto & i : index_range(dof_indices))
   {
     pg[dof_indices[i] + offset0] += weights[i] * ti[0].second;
     pg[dof_indices[i] + offset1] += weights[i] * ti[1].second;
   }
   return pg;
 }

◆ timeDerivative()

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

overridevirtual

Reimplemented from Function.

Definition at line 103 of file ParameterMeshFunction.C.

 {
   checkSize();
 
   const auto ti = interpolateTime(t, true);
   if (ti[0].first == ti[1].first)
     return 0.0;
   const dof_id_type offset0 = ti[0].first * _parameter_mesh.size();
   const dof_id_type offset1 = ti[1].first * _parameter_mesh.size();
 
   std::vector<dof_id_type> dof_indices;
   std::vector<Real> weights;
   _parameter_mesh.getIndexAndWeight(p, dof_indices, weights);
 
   Real val = 0;
   for (const auto & i : index_range(dof_indices))
     val += (_values[dof_indices[i] + offset0] * ti[0].second +
             _values[dof_indices[i] + offset1] * ti[1].second) *
            weights[i];
   return val;
 }

◆ validParams()

InputParameters ParameterMeshFunction::validParams ( )

static

Definition at line 17 of file ParameterMeshFunction.C.

 {
   InputParameters params = OptimizationFunction::validParams();
   params.addClassDescription("Optimization function with parameters represented by a mesh and "
                              "finite-element shape functions.");
 
   params.addRequiredParam<FileName>("exodus_mesh", "File containing parameter mesh.");
   params.addParam<MooseEnum>("family",
                              AddVariableAction::getNonlinearVariableFamilies(),
                              "Family of FE shape functions for parameter.");
   params.addParam<MooseEnum>("order",
                              AddVariableAction::getNonlinearVariableOrders(),
                              "Order of FE shape functions for parameter.");
 
   params.addRequiredParam<ReporterName>(
       "parameter_name", "Reporter or VectorPostprocessor vector containing parameter values.");
   params.addParam<ReporterName>("time_name",
                                 "Name of vector-postprocessor or reporter vector containing time, "
                                 "default assumes time independence.");
   params.addParam<bool>(
       "project_points", false, "Whether to find the closest point on parameter mesh.");
   params.addParam<unsigned int>(
       "kdtree_candidates",
       5,
       "Number of nearest node candidates to consider when projecting points to parameter mesh.");
 
   return params;
 }

◆ value() [1/9]

auto Function::value

◆ value() [2/9]

auto Function::value

◆ value() [3/9]

auto Function::value

◆ value() [4/9]

auto Function::value

◆ value() [5/9]

ChainedReal Function::value

◆ value() [6/9]

virtual ADReal Function::value

◆ value() [7/9]

virtual Real Function::value

◆ value() [8/9]

ChainedReal Function::value

◆ value() [9/9]

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

overridevirtual

Reimplemented from Function.

Definition at line 60 of file ParameterMeshFunction.C.

 {
   checkSize();
 
   const auto ti = interpolateTime(t);
   const dof_id_type offset0 = ti[0].first * _parameter_mesh.size();
   const dof_id_type offset1 = ti[1].first * _parameter_mesh.size();
 
   std::vector<dof_id_type> dof_indices;
   std::vector<Real> weights;
 
   _parameter_mesh.getIndexAndWeight(p, dof_indices, weights);
 
   Real val = 0;
   for (const auto & i : index_range(dof_indices))
     val += (_values[dof_indices[i] + offset0] * ti[0].second +
             _values[dof_indices[i] + offset1] * ti[1].second) *
            weights[i];
   return val;
 }

Member Data Documentation

◆ _coordt

const std::vector<Real>& ParameterMeshFunction::_coordt

protected

Time coordinates from reporter.

Definition at line 55 of file ParameterMeshFunction.h.

Referenced by checkSize(), interpolateTime(), and parameterGradient().

◆ _empty_vec

const std::vector<Real> ParameterMeshFunction::_empty_vec = {}

private

Definition at line 58 of file ParameterMeshFunction.h.

◆ _parameter_mesh

const ParameterMesh ParameterMeshFunction::_parameter_mesh

protected

Parameter mesh.

Definition at line 51 of file ParameterMeshFunction.h.

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

◆ _values

const std::vector<Real>& ParameterMeshFunction::_values

protected

values from reporter

Definition at line 53 of file ParameterMeshFunction.h.

Referenced by checkSize(), gradient(), timeDerivative(), and value().

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

optimization/include/functions/ParameterMeshFunction.h
optimization/src/functions/ParameterMeshFunction.C

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ParameterMeshFunction()

Member Function Documentation

◆ checkSize()

◆ gradient()

◆ interpolateTime()

◆ parameterGradient()

◆ timeDerivative()

◆ 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

◆ _coordt

◆ _empty_vec

◆ _parameter_mesh

◆ _values