https://mooseframework.inl.gov
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | List of all members
ParsedOptimizationFunction Class Referenceabstract

#include <ParsedOptimizationFunction.h>

Inheritance diagram for ParsedOptimizationFunction:
[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

 ParsedOptimizationFunction (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
 
MooseApp & getMooseApp () const
 
const std::string & type () const
 
virtual const std::string & name () const
 
std::string typeAndName () const
 
std::string errorPrefix (const std::string &error_type) const
 
void callMooseError (std::string msg, const bool with_prefix) const
 
MooseObjectParameterName uniqueParameterName (const std::string &parameter_name) const
 
const InputParameters & parameters () const
 
MooseObjectName uniqueName () const
 
const T & getParam (const std::string &name) const
 
std::vector< std::pair< T1, T2 > > getParam (const std::string &param1, const std::string &param2) const
 
const T * queryParam (const std::string &name) const
 
const T & getRenamedParam (const std::string &old_name, const std::string &new_name) const
 
T getCheckedPointerParam (const std::string &name, const std::string &error_string="") const
 
bool isParamValid (const std::string &name) const
 
bool isParamSetByUser (const std::string &nm) const
 
void paramError (const std::string &param, Args... args) const
 
void paramWarning (const std::string &param, Args... args) const
 
void paramInfo (const std::string &param, Args... args) const
 
void connectControllableParams (const std::string &parameter, const std::string &object_type, const std::string &object_name, const std::string &object_parameter) const
 
void mooseError (Args &&... args) const
 
void mooseErrorNonPrefixed (Args &&... args) const
 
void mooseDocumentedError (const std::string &repo_name, const unsigned int issue_num, Args &&... args) const
 
void mooseWarning (Args &&... args) const
 
void mooseWarningNonPrefixed (Args &&... args) const
 
void mooseDeprecated (Args &&... args) const
 
void mooseInfo (Args &&... args) const
 
std::string getDataFileName (const std::string &param) const
 
std::string getDataFileNameByName (const std::string &relative_path) const
 
std::string getDataFilePath (const std::string &relative_path) const
 
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 UserObject & getUserObjectBase (const std::string &param_name, bool is_dependency=true) const
 
const UserObject & 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 ()
 

Public Attributes

const ConsoleStream _console
 

Protected Member Functions

Real evaluateExpression (FunctionParserADBase< Real > &parser, Real t, const Point &p, std::string name="") const
 Function to evaluate an inputted parser. More...
 
virtual void addPostprocessorDependencyHelper (const PostprocessorName &) const
 
virtual void addUserObjectDependencyHelper (const UserObject &) 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 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::string & _expression
 Function expression passed to FParser. More...
 
const std::vector< std::string > & _param_names
 Parameters passed to FParser. More...
 
const std::vector< Real > & _params
 Vector containing parameter values. More...
 
const std::vector< std::string > & _symbol_names
 Variables passed to FParser. More...
 
const std::vector< Real > & _symbol_values
 Values passed by the user, they may be Reals for Postprocessors. More...
 
std::unique_ptr< FunctionParserADBase< Real > > _parser
 Pointer to parsed function object. More...
 
std::vector< std::unique_ptr< FunctionParserADBase< Real > > > _derivative_parsers
 Pointers to parsed function objects representing derivative (first four are xyzt) More...
 
const bool & _enabled
 
MooseApp & _app
 
const std::string _type
 
const std::string _name
 
const InputParameters & _pars
 
Factory & _factory
 
ActionFactory & _action_factory
 
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
 

Detailed Description

Definition at line 17 of file ParsedOptimizationFunction.h.

Constructor & Destructor Documentation

◆ ParsedOptimizationFunction()

ParsedOptimizationFunction::ParsedOptimizationFunction ( const InputParameters &  parameters)

Definition at line 40 of file ParsedOptimizationFunction.C.

41  : OptimizationFunction(parameters),
42  ReporterInterface(this),
43  _expression(getParam<std::string>("expression")),
44  _param_names(getParam<std::vector<std::string>>("param_symbol_names")),
45  _params(getReporterValue<std::vector<Real>>("param_vector_name")),
46  _symbol_names(getParam<std::vector<std::string>>("constant_symbol_names")),
47  _symbol_values(getParam<std::vector<Real>>("constant_symbol_values"))
48 {
49  if (_symbol_names.size() != _symbol_values.size())
50  paramError("symbol_names", "Number of vars must match the number of vals for a ", type(), "!");
51 
52  // Loop through the variables assigned by the user and give an error if x,y,z,t are used
53  std::string msg = "The variables \"x, y, z, and t\" in the ParsedFunction are pre-declared for "
54  "use and must not be declared.";
55  for (const auto & var : _param_names)
56  if (var.find_first_of("xyzt") != std::string::npos && var.size() == 1)
57  paramError("param_names", msg);
58  for (const auto & var : _symbol_names)
59  if (var.find_first_of("xyzt") != std::string::npos && var.size() == 1)
60  paramError("symbol_names", msg);
61 
62  // Create parser
63  _parser = std::make_unique<FunctionParserADBase<Real>>();
64 
65  // Add basic and user-defined constants
66  _parser->AddConstant("NaN", std::numeric_limits<Real>::quiet_NaN());
67  _parser->AddConstant("pi", libMesh::pi);
68  _parser->AddConstant("e", std::exp(1.0));
69  for (const auto & i : index_range(_symbol_names))
70  _parser->AddConstant(_symbol_names[i], _symbol_values[i]);
71 
72  // Join xyzt and parameters to give to FParser as variables
73  std::vector<std::string> all_vars = {"x", "y", "z", "t"};
74  all_vars.insert(all_vars.end(), _param_names.begin(), _param_names.end());
75 
76  // Parse expression and error if something goes wrong
77  if (_parser->Parse(_expression, MooseUtils::join(all_vars, ",")) != -1)
78  paramError("expression", "Unable to parse expression\n", _parser->ErrorMsg());
79  _parser->SetADFlags(FunctionParserADBase<Real>::ADAutoOptimize);
80  _parser->Optimize();
81 
82  // Add parsers for each derivative we are taking, including xyzt
83  _derivative_parsers.resize(all_vars.size());
84  for (const auto & i : index_range(all_vars))
85  {
86  _derivative_parsers[i] = std::make_unique<FunctionParserADBase<Real>>(*_parser);
87  if (_derivative_parsers[i]->AutoDiff(all_vars[i]) != -1)
88  paramError("expression",
89  "Unable to take derivative with respect to ",
90  all_vars[i],
91  "\n",
92  _derivative_parsers[i]->ErrorMsg());
93  }
94 }
MooseUtils::join
std::string join(Iterator begin, Iterator end, const std::string &delimiter)
ParsedOptimizationFunction::_derivative_parsers
std::vector< std::unique_ptr< FunctionParserADBase< Real > > > _derivative_parsers
Pointers to parsed function objects representing derivative (first four are xyzt) ...
Definition: ParsedOptimizationFunction.h:56
ParsedOptimizationFunction::_param_names
const std::vector< std::string > & _param_names
Parameters passed to FParser.
Definition: ParsedOptimizationFunction.h:41
ParsedOptimizationFunction::_symbol_values
const std::vector< Real > & _symbol_values
Values passed by the user, they may be Reals for Postprocessors.
Definition: ParsedOptimizationFunction.h:50
ParsedOptimizationFunction::_symbol_names
const std::vector< std::string > & _symbol_names
Variables passed to FParser.
Definition: ParsedOptimizationFunction.h:47
ParsedOptimizationFunction::_expression
const std::string & _expression
Function expression passed to FParser.
Definition: ParsedOptimizationFunction.h:38
ReporterInterface::getReporterValue
const T & getReporterValue(const std::string &param_name, const std::size_t time_index=0)
Function::type
const std::string & type() const
Function::getParam
const T & getParam(const std::string &name) const
ParsedOptimizationFunction::_parser
std::unique_ptr< FunctionParserADBase< Real > > _parser
Pointer to parsed function object.
Definition: ParsedOptimizationFunction.h:53
Function::paramError
void paramError(const std::string &param, Args... args) const
ReporterInterface::ReporterInterface
ReporterInterface(const MooseObject *moose_object)
OptimizationFunction::OptimizationFunction
OptimizationFunction(const InputParameters &parameters)
Definition: OptimizationFunction.C:19
Function::parameters
const InputParameters & parameters() const
ParsedOptimizationFunction::_params
const std::vector< Real > & _params
Vector containing parameter values.
Definition: ParsedOptimizationFunction.h:44
index_range
auto index_range(const T &sizable)
libMesh::pi
const Real pi

Member Function Documentation

◆ evaluateExpression()

Real ParsedOptimizationFunction::evaluateExpression ( FunctionParserADBase< Real > &  parser,
Real  t,
const Point &  p,
std::string  name = "" 
) const
protected

Function to evaluate an inputted parser.

Definition at line 129 of file ParsedOptimizationFunction.C.

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

133 {
134  if (_params.size() != _param_names.size())
135  paramError("param_vector_name",
136  "Size of vector (",
137  _params.size(),
138  ") does not match number of specified 'param_names' (",
139  _param_names.size(),
140  ").");
141 
142  std::vector<Real> parser_var_values(4 + _param_names.size());
143  parser_var_values[0] = p(0);
144  parser_var_values[1] = p(1);
145  parser_var_values[2] = p(2);
146  parser_var_values[3] = t;
147  for (const auto & i : index_range(_param_names))
148  parser_var_values[4 + i] = _params[i];
149 
150  Real result = parser.Eval(parser_var_values.data());
151 
152  auto err = parser.EvalError();
153  if (err)
154  {
155  std::string msg = "Error evaluating function " + name + "\n";
156  switch (err)
157  {
158  case 1:
159  msg += "Division by zero";
160  break;
161  case 2:
162  msg += "Square Root error (negative value)";
163  break;
164  case 3:
165  msg += "Log error (negative value)";
166  break;
167  case 4:
168  msg += "Trigonometric error (asin or acos of illegal value)";
169  break;
170  case 5:
171  msg += "Maximum recursion level reached";
172  break;
173  }
174 
175  paramError("expression", msg);
176  }
177 
178  return result;
179 }
err
OStreamProxy err
ParsedOptimizationFunction::_param_names
const std::vector< std::string > & _param_names
Parameters passed to FParser.
Definition: ParsedOptimizationFunction.h:41
Function::name
virtual const std::string & name() const
Function::paramError
void paramError(const std::string &param, Args... args) const
Real
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real
ParsedOptimizationFunction::_params
const std::vector< Real > & _params
Vector containing parameter values.
Definition: ParsedOptimizationFunction.h:44
index_range
auto index_range(const T &sizable)

◆ gradient()

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

Reimplemented from Function.

Definition at line 103 of file ParsedOptimizationFunction.C.

104 {
105  RealGradient result;
106  result(0) = evaluateExpression(*_derivative_parsers[0], t, p, "gradient");
107  result(1) = evaluateExpression(*_derivative_parsers[1], t, p, "gradient");
108  result(2) = evaluateExpression(*_derivative_parsers[2], t, p, "gradient");
109  return result;
110 }
ParsedOptimizationFunction::_derivative_parsers
std::vector< std::unique_ptr< FunctionParserADBase< Real > > > _derivative_parsers
Pointers to parsed function objects representing derivative (first four are xyzt) ...
Definition: ParsedOptimizationFunction.h:56
ParsedOptimizationFunction::evaluateExpression
Real evaluateExpression(FunctionParserADBase< Real > &parser, Real t, const Point &p, std::string name="") const
Function to evaluate an inputted parser.
Definition: ParsedOptimizationFunction.C:129

◆ parameterGradient()

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

Implements OptimizationFunction.

Definition at line 119 of file ParsedOptimizationFunction.C.

120 {
121  std::vector<Real> result(_param_names.size());
122  for (const auto & i : index_range(result))
123  result[i] =
124  evaluateExpression(*_derivative_parsers[4 + i], t, p, _param_names[i] + " derivative");
125  return result;
126 }
ParsedOptimizationFunction::_derivative_parsers
std::vector< std::unique_ptr< FunctionParserADBase< Real > > > _derivative_parsers
Pointers to parsed function objects representing derivative (first four are xyzt) ...
Definition: ParsedOptimizationFunction.h:56
ParsedOptimizationFunction::_param_names
const std::vector< std::string > & _param_names
Parameters passed to FParser.
Definition: ParsedOptimizationFunction.h:41
ParsedOptimizationFunction::evaluateExpression
Real evaluateExpression(FunctionParserADBase< Real > &parser, Real t, const Point &p, std::string name="") const
Function to evaluate an inputted parser.
Definition: ParsedOptimizationFunction.C:129
index_range
auto index_range(const T &sizable)

◆ timeDerivative()

Real ParsedOptimizationFunction::timeDerivative ( Real  t,
const Point &  p 
) const
overridevirtual

Reimplemented from Function.

Definition at line 113 of file ParsedOptimizationFunction.C.

114 {
115  return evaluateExpression(*_derivative_parsers[3], t, p, "time derivative");
116 }
ParsedOptimizationFunction::_derivative_parsers
std::vector< std::unique_ptr< FunctionParserADBase< Real > > > _derivative_parsers
Pointers to parsed function objects representing derivative (first four are xyzt) ...
Definition: ParsedOptimizationFunction.h:56
ParsedOptimizationFunction::evaluateExpression
Real evaluateExpression(FunctionParserADBase< Real > &parser, Real t, const Point &p, std::string name="") const
Function to evaluate an inputted parser.
Definition: ParsedOptimizationFunction.C:129

◆ validParams()

InputParameters ParsedOptimizationFunction::validParams ( )
static

Definition at line 18 of file ParsedOptimizationFunction.C.

19 {
20  InputParameters params = OptimizationFunction::validParams();
21  params.addClassDescription(
22  "Function used for optimization that uses a parsed expression with parameter dependence.");
23 
24  params.addRequiredCustomTypeParam<std::string>(
25  "expression", "FunctionExpression", "The user defined function.");
26  params.addRequiredParam<std::vector<std::string>>(
27  "param_symbol_names", "Names of parameters in 'expression' being optimized.");
28  params.addRequiredParam<ReporterName>(
29  "param_vector_name", "Reporter or VectorPostprocessor vector containing parameter values.");
30  params.addParam<std::vector<std::string>>(
31  "constant_symbol_names",
32  std::vector<std::string>(),
33  "Variables (excluding t,x,y,z) that are bound to the values provided by the corresponding "
34  "items in the symbol_values vector.");
35  params.addParam<std::vector<Real>>(
36  "constant_symbol_values", std::vector<Real>(), "Constant numeric values for vars.");
37  return params;
38 }
InputParameters::addParam
void addParam(const std::string &name, const std::initializer_list< typename T::value_type > &value, const std::string &doc_string)
InputParameters::addRequiredParam
void addRequiredParam(const std::string &name, const std::string &doc_string)
InputParameters::addRequiredCustomTypeParam
void addRequiredCustomTypeParam(const std::string &name, const std::string &custom_type, const std::string &doc_string)
InputParameters::addClassDescription
void addClassDescription(const std::string &doc_string)
OptimizationFunction::validParams
static InputParameters validParams()
Definition: OptimizationFunction.C:13

◆ value() [1/9]

auto Function::value

◆ value() [2/9]

auto Function::value

◆ value() [3/9]

virtual Real Function::value

◆ value() [4/9]

ChainedReal Function::value

◆ value() [5/9]

virtual ADReal Function::value

◆ value() [6/9]

ChainedReal Function::value

◆ value() [7/9]

auto Function::value

◆ value() [8/9]

auto Function::value

◆ value() [9/9]

Real ParsedOptimizationFunction::value ( Real  t,
const Point &  p 
) const
overridevirtual

Reimplemented from Function.

Definition at line 97 of file ParsedOptimizationFunction.C.

98 {
99  return evaluateExpression(*_parser, t, p);
100 }
ParsedOptimizationFunction::evaluateExpression
Real evaluateExpression(FunctionParserADBase< Real > &parser, Real t, const Point &p, std::string name="") const
Function to evaluate an inputted parser.
Definition: ParsedOptimizationFunction.C:129
ParsedOptimizationFunction::_parser
std::unique_ptr< FunctionParserADBase< Real > > _parser
Pointer to parsed function object.
Definition: ParsedOptimizationFunction.h:53

Member Data Documentation

◆ _derivative_parsers

std::vector<std::unique_ptr<FunctionParserADBase<Real> > > ParsedOptimizationFunction::_derivative_parsers
protected

Pointers to parsed function objects representing derivative (first four are xyzt)

Definition at line 56 of file ParsedOptimizationFunction.h.

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

◆ _expression

const std::string& ParsedOptimizationFunction::_expression
protected

Function expression passed to FParser.

Definition at line 38 of file ParsedOptimizationFunction.h.

Referenced by ParsedOptimizationFunction().

◆ _param_names

const std::vector<std::string>& ParsedOptimizationFunction::_param_names
protected

Parameters passed to FParser.

Definition at line 41 of file ParsedOptimizationFunction.h.

Referenced by evaluateExpression(), parameterGradient(), and ParsedOptimizationFunction().

◆ _params

const std::vector<Real>& ParsedOptimizationFunction::_params
protected

Vector containing parameter values.

Definition at line 44 of file ParsedOptimizationFunction.h.

Referenced by evaluateExpression().

◆ _parser

std::unique_ptr<FunctionParserADBase<Real> > ParsedOptimizationFunction::_parser
protected

Pointer to parsed function object.

Definition at line 53 of file ParsedOptimizationFunction.h.

Referenced by ParsedOptimizationFunction(), and value().

◆ _symbol_names

const std::vector<std::string>& ParsedOptimizationFunction::_symbol_names
protected

Variables passed to FParser.

Definition at line 47 of file ParsedOptimizationFunction.h.

Referenced by ParsedOptimizationFunction().

◆ _symbol_values

const std::vector<Real>& ParsedOptimizationFunction::_symbol_values
protected

Values passed by the user, they may be Reals for Postprocessors.

Definition at line 50 of file ParsedOptimizationFunction.h.

Referenced by ParsedOptimizationFunction().

The documentation for this class was generated from the following files:
Generated on Fri Jul 18 2025 13:49:31 for https://mooseframework.inl.gov by   doxygen 1.8.14