Sets a value of a scalar variable based on a surrogate model. More...

#include <SurrogateModelScalarAux.h>

Inheritance diagram for SurrogateModelScalarAux:

Public Types
typedef DataFileName	DataFileParameterType

Public Member Functions
	SurrogateModelScalarAux (const InputParameters &parameters)

void	initialSetup () override

virtual void	compute ()

MooseVariableScalar &	variable ()

SubProblem &	subProblem ()

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

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

virtual bool	isActive ()

virtual bool	enabled () const

std::shared_ptr< MooseObject >	getSharedPtr ()

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

bool	isKokkosObject (IsKokkosObjectKey &&) 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	mooseInfo (Args &&... args) const

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

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

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

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

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

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

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

virtual void	timestepSetup ()

virtual void	jacobianSetup ()

virtual void	residualSetup ()

virtual void	subdomainSetup ()

virtual void	customSetup (const ExecFlagType &)

const ExecFlagEnum &	getExecuteOnEnum () const

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

const Function &	getFunctionByName (const FunctionName &name) const

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

bool	hasFunctionByName (const FunctionName &name) const

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

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

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

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

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

bool	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

bool	isImplicit ()

Moose::StateArg	determineState () const

virtual void	meshChanged ()

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

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

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

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

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

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

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

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

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

const PostprocessorValue &	getPostprocessorValueOldByName (const PostprocessorName &name) const

const PostprocessorValue &	getPostprocessorValueOldByName (const PostprocessorName &name) const

const PostprocessorValue &	getPostprocessorValueOlderByName (const PostprocessorName &name) const

const PostprocessorValue &	getPostprocessorValueOlderByName (const PostprocessorName &name) const

const 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)

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

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

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

Public Attributes
	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
virtual Real	computeValue () override

const VariableValue &	uOld () const

void	flagInvalidSolutionInternal (const InvalidSolutionID invalid_solution_id) const

InvalidSolutionID	registerInvalidSolutionInternal (const std::string &message, const bool warning) 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 void	addUserObjectDependencyHelper (const UserObject &) const

virtual void	addPostprocessorDependencyHelper (const PostprocessorName &) const

Protected Attributes
const SurrogateModel &	_model
	Pointers to surrogate model. More...

unsigned int	_n_params
	number of parameters More...

SubProblem &	_subproblem

SystemBase &	_sys

THREAD_ID	_tid

Assembly &	_assembly

MooseVariableScalar &	_var

MooseMesh &	_mesh

unsigned int	_i

const VariableValue &	_u

std::set< std::string >	_depend_vars

std::set< std::string >	_supplied_vars

const bool &	_enabled

MooseApp &	_app

Factory &	_factory

ActionFactory &	_action_factory

const std::string &	_type

const std::string &	_name

const InputParameters &	_pars

FEProblemBase &	_sc_fe_problem

const THREAD_ID	_sc_tid

const Real &	_real_zero

const VariableValue &	_scalar_zero

const Point &	_point_zero

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

FEProblemBase &	_mci_feproblem

const Parallel::Communicator &	_communicator


std::vector< const Real * >	_scalar_var_params
	the real parameters that _model is evaluated at More...

std::vector< unsigned int >	_scalar_var_indices

unsigned int	_n_scalar


std::vector< const PostprocessorValue * >	_pp_params
	the pp parameters that _model is evaluated at More...

std::vector< unsigned int >	_pp_indices

unsigned int	_n_pp


std::vector< Real >	_real_params
	the real parameters that _model is evaluated at More...

std::vector< unsigned int >	_real_indices

unsigned int	_n_real

Private Member Functions
template<>
SurrogateModel &	getSurrogateModel (const std::string &name) const

template<>
SurrogateTrainerBase &	getSurrogateTrainer (const std::string &name) const

template<>
SurrogateModel &	getSurrogateModelByName (const UserObjectName &name) const

template<>
SurrogateTrainerBase &	getSurrogateTrainerByName (const UserObjectName &name) const


template<typename T = SurrogateModel>
T &	getSurrogateModel (const std::string &name) const
	Get a SurrogateModel/Trainer with a given name. More...

template<typename T = SurrogateTrainerBase>
T &	getSurrogateTrainer (const std::string &name) const


template<typename T = SurrogateModel>
T &	getSurrogateModelByName (const UserObjectName &name) const
	Get a sampler with a given name. More...

template<typename T = SurrogateTrainerBase>
T &	getSurrogateTrainerByName (const UserObjectName &name) const

Detailed Description

Sets a value of a scalar variable based on a surrogate model.

Definition at line 18 of file SurrogateModelScalarAux.h.

Constructor & Destructor Documentation

◆ SurrogateModelScalarAux()

SurrogateModelScalarAux::SurrogateModelScalarAux ( const InputParameters & parameters )

Definition at line 28 of file SurrogateModelScalarAux.C.

   : AuxScalarKernel(parameters), SurrogateModelInterface(this), _model(getSurrogateModel("model"))
 {
 }

Member Function Documentation

◆ computeValue()

Real SurrogateModelScalarAux::computeValue ( )

overrideprotectedvirtual

Implements AuxScalarKernel.

Definition at line 77 of file SurrogateModelScalarAux.C.

 {
   std::vector<Real> x(_n_params);
   // insert scalar variables
   for (unsigned int j = 0; j < _n_scalar; ++j)
     x[_scalar_var_indices[j]] = *_scalar_var_params[j];
   // insert postprocessors
   for (unsigned int j = 0; j < _n_pp; ++j)
     x[_pp_indices[j]] = *_pp_params[j];
   // insert real values
   for (unsigned int j = 0; j < _n_real; ++j)
     x[_real_indices[j]] = _real_params[j];
   return _model.evaluate(x);
 }

◆ getSurrogateModel() [1/2]

template<>

SurrogateModel& SurrogateModelInterface::getSurrogateModel ( const std::string & name ) const

inherited

Definition at line 46 of file SurrogateModelInterface.C.

 {
   return getSurrogateModelByName<SurrogateModel>(_smi_params.get<UserObjectName>(name));
 }

◆ getSurrogateModel() [2/2]

template<typename T >

T & SurrogateModelInterface::getSurrogateModel ( const std::string & name ) const

inherited

Get a SurrogateModel/Trainer with a given name.

Parameters

name	The name of the parameter key of the sampler to retrieve

Returns: The sampler with name associated with the parameter 'name'

Definition at line 81 of file SurrogateModelInterface.h.

Referenced by SurrogateTrainer::initialize().

 {
   return getSurrogateModelByName<T>(_smi_params.get<UserObjectName>(name));
 }

◆ getSurrogateModelByName() [1/2]

template<>

SurrogateModel& SurrogateModelInterface::getSurrogateModelByName ( const UserObjectName & name ) const

inherited

Definition at line 31 of file SurrogateModelInterface.C.

 {
   std::vector<SurrogateModel *> models;
   _smi_feproblem.theWarehouse()
       .query()
       .condition<AttribName>(name)
       .condition<AttribSystem>("SurrogateModel")
       .queryInto(models);
   if (models.empty())
     mooseError("Unable to find a SurrogateModel object with the name '" + name + "'");
   return *(models[0]);
 }

◆ getSurrogateModelByName() [2/2]

template<typename T >

T & SurrogateModelInterface::getSurrogateModelByName ( const UserObjectName & name ) const

inherited

Get a sampler with a given name.

Parameters

name	The name of the sampler to retrieve

Returns: The sampler with name 'name'

Definition at line 88 of file SurrogateModelInterface.h.

Referenced by CrossValidationScores::CrossValidationScores(), EvaluateSurrogate::EvaluateSurrogate(), and InverseMapping::initialSetup().

 {
   std::vector<T *> models;
   _smi_feproblem.theWarehouse()
       .query()
       .condition<AttribName>(name)
       .condition<AttribSystem>("SurrogateModel")
       .queryInto(models);
   if (models.empty())
     mooseError("Unable to find a SurrogateModel object of type " + std::string(typeid(T).name()) +
                " with the name '" + name + "'");
   return *(models[0]);
 }

◆ getSurrogateTrainer() [1/2]

template<typename T >

T & SurrogateModelInterface::getSurrogateTrainer ( const std::string & name ) const

inherited

Definition at line 104 of file SurrogateModelInterface.h.

 {
   return getSurrogateTrainerByName<T>(_smi_params.get<UserObjectName>(name));
 }

◆ getSurrogateTrainer() [2/2]

template<>

SurrogateTrainerBase& SurrogateModelInterface::getSurrogateTrainer ( const std::string & name ) const

inherited

Definition at line 60 of file SurrogateModelInterface.C.

 {
   return getSurrogateTrainerByName<SurrogateTrainerBase>(_smi_params.get<UserObjectName>(name));
 }

◆ getSurrogateTrainerByName() [1/2]

template<>

SurrogateTrainerBase& SurrogateModelInterface::getSurrogateTrainerByName ( const UserObjectName & name ) const

inherited

Definition at line 53 of file SurrogateModelInterface.C.

 {
   return _smi_feproblem.getUserObject<SurrogateTrainerBase>(name);
 }

◆ getSurrogateTrainerByName() [2/2]

template<typename T >

T & SurrogateModelInterface::getSurrogateTrainerByName ( const UserObjectName & name ) const

inherited

Definition at line 111 of file SurrogateModelInterface.h.

Referenced by SurrogateTrainerOutput::output().

 {
   SurrogateTrainerBase * base_ptr =
       &_smi_feproblem.getUserObject<SurrogateTrainerBase>(name, _smi_tid);
   T * obj_ptr = dynamic_cast<T *>(base_ptr);
   if (!obj_ptr)
     mooseError("Failed to find a SurrogateTrainer object of type " + std::string(typeid(T).name()) +
                    " with the name '",
                name,
                "' for the desired type.");
   return *obj_ptr;
 }

◆ initialSetup()

void SurrogateModelScalarAux::initialSetup ( )

overridevirtual

Reimplemented from AuxScalarKernel.

Definition at line 34 of file SurrogateModelScalarAux.C.

 {
   const auto parameter_names = getParam<std::vector<std::string>>("parameters");
   _n_params = parameter_names.size();
   for (unsigned int j = 0; j < _n_params; ++j)
   {
     const auto name = parameter_names[j];
 
     // name can be a postprocessor, scalar var, or real number
     if (_sc_fe_problem.hasScalarVariable(name))
     {
       auto & scalar_val = _sc_fe_problem.getScalarVariable(_tid, name).sln()[0];
       _scalar_var_params.push_back(&scalar_val);
       _scalar_var_indices.push_back(j);
     }
     else if (_sc_fe_problem.hasPostprocessorValueByName(name))
     {
       _pp_indices.push_back(j);
       _pp_params.push_back(&getPostprocessorValueByName(name));
     }
     else
     {
       // first check if the entry is a real
       std::stringstream ss(name);
       Real v;
       ss >> v;
 
       if (ss.fail())
         paramError("parameters",
                    "Parameter ",
                    name,
                    " is not a scalar variable, postprocessor, or real number");
 
       _real_params.push_back(v);
       _real_indices.push_back(j);
     }
   }
   _n_scalar = _scalar_var_indices.size();
   _n_pp = _pp_indices.size();
   _n_real = _real_indices.size();
 }

◆ validParams()

InputParameters SurrogateModelScalarAux::validParams ( )

static

Definition at line 15 of file SurrogateModelScalarAux.C.

 {
   InputParameters params = AuxScalarKernel::validParams();
   params += SurrogateModelInterface::validParams();
   params.addClassDescription("Sets a value of a scalar variable based on a surrogate model.");
   params.addRequiredParam<UserObjectName>("model", "Name of surrogate models.");
   params.addRequiredParam<std::vector<std::string>>(
       "parameters",
       "Parameter values at which the surrogate is evaluated. Accepts scalar variables, "
       "postprocessors, and real numbers.");
   return params;
 }

Member Data Documentation

◆ _model

const SurrogateModel& SurrogateModelScalarAux::_model

protected

Pointers to surrogate model.

Definition at line 30 of file SurrogateModelScalarAux.h.

Referenced by computeValue().

◆ _n_params

unsigned int SurrogateModelScalarAux::_n_params

protected

number of parameters

Definition at line 33 of file SurrogateModelScalarAux.h.

Referenced by computeValue(), and initialSetup().

◆ _n_pp

unsigned int SurrogateModelScalarAux::_n_pp

protected

Definition at line 44 of file SurrogateModelScalarAux.h.

Referenced by computeValue(), and initialSetup().

◆ _n_real

unsigned int SurrogateModelScalarAux::_n_real

protected

Definition at line 50 of file SurrogateModelScalarAux.h.

Referenced by computeValue(), and initialSetup().

◆ _n_scalar

unsigned int SurrogateModelScalarAux::_n_scalar

protected

Definition at line 38 of file SurrogateModelScalarAux.h.

Referenced by computeValue(), and initialSetup().

◆ _pp_indices

std::vector<unsigned int> SurrogateModelScalarAux::_pp_indices

protected

Definition at line 43 of file SurrogateModelScalarAux.h.

Referenced by computeValue(), and initialSetup().

◆ _pp_params

std::vector<const PostprocessorValue *> SurrogateModelScalarAux::_pp_params

protected

the pp parameters that _model is evaluated at

Definition at line 42 of file SurrogateModelScalarAux.h.

Referenced by computeValue(), and initialSetup().

◆ _real_indices

std::vector<unsigned int> SurrogateModelScalarAux::_real_indices

protected

Definition at line 49 of file SurrogateModelScalarAux.h.

Referenced by computeValue(), and initialSetup().

◆ _real_params

std::vector<Real> SurrogateModelScalarAux::_real_params

protected

the real parameters that _model is evaluated at

Definition at line 48 of file SurrogateModelScalarAux.h.

Referenced by computeValue(), and initialSetup().

◆ _scalar_var_indices

std::vector<unsigned int> SurrogateModelScalarAux::_scalar_var_indices

protected

Definition at line 37 of file SurrogateModelScalarAux.h.

Referenced by computeValue(), and initialSetup().

◆ _scalar_var_params

std::vector<const Real *> SurrogateModelScalarAux::_scalar_var_params

protected

the real parameters that _model is evaluated at

Definition at line 36 of file SurrogateModelScalarAux.h.

Referenced by computeValue(), and initialSetup().

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

stochastic_tools/include/auxscalarkernels/SurrogateModelScalarAux.h
stochastic_tools/src/auxscalarkernels/SurrogateModelScalarAux.C

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Protected Attributes

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ SurrogateModelScalarAux()

Member Function Documentation

◆ computeValue()

◆ getSurrogateModel() [1/2]

◆ getSurrogateModel() [2/2]

◆ getSurrogateModelByName() [1/2]

◆ getSurrogateModelByName() [2/2]

◆ getSurrogateTrainer() [1/2]

◆ getSurrogateTrainer() [2/2]

◆ getSurrogateTrainerByName() [1/2]

◆ getSurrogateTrainerByName() [2/2]

◆ initialSetup()

◆ validParams()

Member Data Documentation

◆ _model

◆ _n_params

◆ _n_pp

◆ _n_real

◆ _n_scalar

◆ _pp_indices

◆ _pp_params

◆ _real_indices

◆ _real_params

◆ _scalar_var_indices

◆ _scalar_var_params