A user object which takes a surrogate (or just user supplied values) to determine coordinates in a latent space and uses those coordinates to create approximations of full solution values for given variables. More...

#include <InverseMapping.h>

Inheritance diagram for InverseMapping:

[legend]

Public Types
typedef DataFileName	DataFileParameterType

Public Member Functions
	InverseMapping (const InputParameters &params)

void	execute () override

void	initialize () override

void	finalize () override

void	initialSetup () override

SubProblem &	getSubProblem () const

bool	shouldDuplicateInitialExecution () const

virtual Real	spatialValue (const Point &) const

virtual const std::vector< Point >	spatialPoints () const

void	gatherSum (T &value)

void	gatherMax (T &value)

void	gatherMin (T &value)

void	gatherProxyValueMax (T1 &proxy, T2 &value)

void	gatherProxyValueMin (T1 &proxy, T2 &value)

void	setPrimaryThreadCopy (UserObject *primary)

UserObject *	primaryThreadCopy ()

std::set< UserObjectName >	getDependObjects () const

virtual bool	needThreadedCopy () const

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

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

unsigned int	systemNumber () const

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 &	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	timestepSetup ()

virtual void	jacobianSetup ()

virtual void	residualSetup ()

virtual void	customSetup (const ExecFlagType &)

const ExecFlagEnum &	getExecuteOnEnum () 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

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

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

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

const GenericMaterialProperty< T, is_ad > &	getGenericMaterialProperty (const std::string &name, MaterialData &material_data, const unsigned int state=0)

const GenericMaterialProperty< T, is_ad > &	getGenericMaterialProperty (const std::string &name, const unsigned int state=0)

const GenericMaterialProperty< T, is_ad > &	getGenericMaterialProperty (const std::string &name, const unsigned int state=0)

const MaterialProperty< T > &	getMaterialProperty (const std::string &name, MaterialData &material_data, const unsigned int state=0)

const MaterialProperty< T > &	getMaterialProperty (const std::string &name, const unsigned int state=0)

const MaterialProperty< T > &	getMaterialProperty (const std::string &name, const unsigned int state=0)

const ADMaterialProperty< T > &	getADMaterialProperty (const std::string &name, MaterialData &material_data)

const ADMaterialProperty< T > &	getADMaterialProperty (const std::string &name)

const ADMaterialProperty< T > &	getADMaterialProperty (const std::string &name)

const MaterialProperty< T > &	getMaterialPropertyOld (const std::string &name, MaterialData &material_data)

const MaterialProperty< T > &	getMaterialPropertyOld (const std::string &name)

const MaterialProperty< T > &	getMaterialPropertyOld (const std::string &name)

const MaterialProperty< T > &	getMaterialPropertyOlder (const std::string &name, MaterialData &material_data)

const MaterialProperty< T > &	getMaterialPropertyOlder (const std::string &name)

const MaterialProperty< T > &	getMaterialPropertyOlder (const std::string &name)

const GenericMaterialProperty< T, is_ad > &	getGenericMaterialPropertyByName (const MaterialPropertyName &name, MaterialData &material_data, const unsigned int state)

const GenericMaterialProperty< T, is_ad > &	getGenericMaterialPropertyByName (const MaterialPropertyName &name, const unsigned int state=0)

const GenericMaterialProperty< T, is_ad > &	getGenericMaterialPropertyByName (const MaterialPropertyName &name, const unsigned int state=0)

const MaterialProperty< T > &	getMaterialPropertyByName (const MaterialPropertyName &name, MaterialData &material_data, const unsigned int state=0)

const MaterialProperty< T > &	getMaterialPropertyByName (const MaterialPropertyName &name, const unsigned int state=0)

const MaterialProperty< T > &	getMaterialPropertyByName (const MaterialPropertyName &name, const unsigned int state=0)

const ADMaterialProperty< T > &	getADMaterialPropertyByName (const MaterialPropertyName &name, MaterialData &material_data)

const ADMaterialProperty< T > &	getADMaterialPropertyByName (const MaterialPropertyName &name)

const ADMaterialProperty< T > &	getADMaterialPropertyByName (const MaterialPropertyName &name)

const MaterialProperty< T > &	getMaterialPropertyOldByName (const MaterialPropertyName &name, MaterialData &material_data)

const MaterialProperty< T > &	getMaterialPropertyOldByName (const MaterialPropertyName &name)

const MaterialProperty< T > &	getMaterialPropertyOldByName (const MaterialPropertyName &name)

const MaterialProperty< T > &	getMaterialPropertyOlderByName (const MaterialPropertyName &name, MaterialData &material_data)

const MaterialProperty< T > &	getMaterialPropertyOlderByName (const MaterialPropertyName &name)

const MaterialProperty< T > &	getMaterialPropertyOlderByName (const MaterialPropertyName &name)

std::pair< const MaterialProperty< T > *, std::set< SubdomainID > >	getBlockMaterialProperty (const MaterialPropertyName &name)

const GenericMaterialProperty< T, is_ad > &	getGenericZeroMaterialProperty (const std::string &name)

const GenericMaterialProperty< T, is_ad > &	getGenericZeroMaterialProperty ()

const GenericMaterialProperty< T, is_ad > &	getGenericZeroMaterialPropertyByName (const std::string &prop_name)

const MaterialProperty< T > &	getZeroMaterialProperty (Ts... args)

std::set< SubdomainID >	getMaterialPropertyBlocks (const std::string &name)

std::vector< SubdomainName >	getMaterialPropertyBlockNames (const std::string &name)

std::set< BoundaryID >	getMaterialPropertyBoundaryIDs (const std::string &name)

std::vector< BoundaryName >	getMaterialPropertyBoundaryNames (const std::string &name)

void	checkBlockAndBoundaryCompatibility (std::shared_ptr< MaterialBase > discrete)

std::unordered_map< SubdomainID, std::vector< MaterialBase *> >	buildRequiredMaterials (bool allow_stateful=true)

void	statefulPropertiesAllowed (bool)

bool	getMaterialPropertyCalled () const

const std::unordered_set< unsigned int > &	getMatPropDependencies () const

virtual void	resolveOptionalProperties ()

const GenericMaterialProperty< T, is_ad > &	getPossiblyConstantGenericMaterialPropertyByName (const MaterialPropertyName &prop_name, MaterialData &material_data, const unsigned int state)

bool	isImplicit ()

Moose::StateArg	determineState () const

virtual void	threadJoin (const UserObject &) override

virtual void	threadJoin (const UserObject &) override

virtual void	subdomainSetup () override

virtual void	subdomainSetup () override

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 GenericOptionalMaterialProperty< T, is_ad > &	getGenericOptionalMaterialProperty (const std::string &name, const unsigned int state=0)

const GenericOptionalMaterialProperty< T, is_ad > &	getGenericOptionalMaterialProperty (const std::string &name, const unsigned int state=0)

const OptionalMaterialProperty< T > &	getOptionalMaterialProperty (const std::string &name, const unsigned int state=0)

const OptionalMaterialProperty< T > &	getOptionalMaterialProperty (const std::string &name, const unsigned int state=0)

const OptionalADMaterialProperty< T > &	getOptionalADMaterialProperty (const std::string &name)

const OptionalADMaterialProperty< T > &	getOptionalADMaterialProperty (const std::string &name)

const OptionalMaterialProperty< T > &	getOptionalMaterialPropertyOld (const std::string &name)

const OptionalMaterialProperty< T > &	getOptionalMaterialPropertyOld (const std::string &name)

const OptionalMaterialProperty< T > &	getOptionalMaterialPropertyOlder (const std::string &name)

const OptionalMaterialProperty< T > &	getOptionalMaterialPropertyOlder (const std::string &name)

MaterialBase &	getMaterial (const std::string &name)

MaterialBase &	getMaterial (const std::string &name)

MaterialBase &	getMaterialByName (const std::string &name, bool no_warn=false)

MaterialBase &	getMaterialByName (const std::string &name, bool no_warn=false)

bool	hasMaterialProperty (const std::string &name)

bool	hasMaterialProperty (const std::string &name)

bool	hasMaterialPropertyByName (const std::string &name)

bool	hasMaterialPropertyByName (const std::string &name)

bool	hasADMaterialProperty (const std::string &name)

bool	hasADMaterialProperty (const std::string &name)

bool	hasADMaterialPropertyByName (const std::string &name)

bool	hasADMaterialPropertyByName (const std::string &name)

bool	hasGenericMaterialProperty (const std::string &name)

bool	hasGenericMaterialProperty (const std::string &name)

bool	hasGenericMaterialPropertyByName (const std::string &name)

bool	hasGenericMaterialPropertyByName (const std::string &name)

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

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

const VectorPostprocessorValue &	getVectorPostprocessorValue (const std::string &param_name, const std::string &vector_name) const

const VectorPostprocessorValue &	getVectorPostprocessorValue (const std::string &param_name, const std::string &vector_name, bool needs_broadcast) const

const VectorPostprocessorValue &	getVectorPostprocessorValueByName (const VectorPostprocessorName &name, const std::string &vector_name) const

const VectorPostprocessorValue &	getVectorPostprocessorValueByName (const VectorPostprocessorName &name, const std::string &vector_name, bool needs_broadcast) const

const VectorPostprocessorValue &	getVectorPostprocessorValueOld (const std::string &param_name, const std::string &vector_name) const

const VectorPostprocessorValue &	getVectorPostprocessorValueOld (const std::string &param_name, const std::string &vector_name, bool needs_broadcast) const

const VectorPostprocessorValue &	getVectorPostprocessorValueOldByName (const VectorPostprocessorName &name, const std::string &vector_name) const

const VectorPostprocessorValue &	getVectorPostprocessorValueOldByName (const VectorPostprocessorName &name, const std::string &vector_name, bool needs_broadcast) const

const ScatterVectorPostprocessorValue &	getScatterVectorPostprocessorValue (const std::string &param_name, const std::string &vector_name) const

const ScatterVectorPostprocessorValue &	getScatterVectorPostprocessorValueByName (const VectorPostprocessorName &name, const std::string &vector_name) const

const ScatterVectorPostprocessorValue &	getScatterVectorPostprocessorValueOld (const std::string &param_name, const std::string &vector_name) const

const ScatterVectorPostprocessorValue &	getScatterVectorPostprocessorValueOldByName (const VectorPostprocessorName &name, const std::string &vector_name) const

bool	hasVectorPostprocessor (const std::string &param_name, const std::string &vector_name) const

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

bool	hasVectorPostprocessorByName (const VectorPostprocessorName &name, const std::string &vector_name) const

bool	hasVectorPostprocessorByName (const VectorPostprocessorName &name) const

const VectorPostprocessorName &	getVectorPostprocessorName (const std::string &param_name) const

T &	getSampler (const std::string &name)

Sampler &	getSampler (const std::string &name)

T &	getSamplerByName (const SamplerName &name)

Sampler &	getSamplerByName (const SamplerName &name)

virtual void	meshChanged ()

PerfGraph &	perfGraph ()

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	isVectorPostprocessorDistributed (const std::string &param_name) const

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

bool	isVectorPostprocessorDistributedByName (const VectorPostprocessorName &name) const

bool	isVectorPostprocessorDistributedByName (const VectorPostprocessorName &name) const

const Distribution &	getDistribution (const std::string &name) const

const T &	getDistribution (const std::string &name) const

const Distribution &	getDistribution (const std::string &name) const

const T &	getDistribution (const std::string &name) const

const Distribution &	getDistributionByName (const DistributionName &name) const

const T &	getDistributionByName (const std::string &name) const

const Distribution &	getDistributionByName (const DistributionName &name) const

const T &	getDistributionByName (const std::string &name) const

const Parallel::Communicator &	comm () const

processor_id_type	n_processors () const

processor_id_type	processor_id () const

VariableMappingBase &	getMapping (const std::string &name) const
	Get the mapping using the parameters of the moose object. More...

VariableMappingBase &	getMappingByName (const UserObjectName &name) const
	Get the mapping by supplying the name of the object in the warehouse. More...

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

Static Public Member Functions
static InputParameters	validParams ()

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
const ConsoleStream	_console

Static Public Attributes
static constexpr PropertyValue::id_type	default_property_id

static constexpr PropertyValue::id_type	zero_property_id

static constexpr auto	SYSTEM

static constexpr auto	NAME

Protected Member Functions
virtual void	addPostprocessorDependencyHelper (const PostprocessorName &name) const override

virtual void	addVectorPostprocessorDependencyHelper (const VectorPostprocessorName &name) const override

virtual void	addUserObjectDependencyHelper (const UserObject &uo) const override

void	addReporterDependencyHelper (const ReporterName &reporter_name) override

const ReporterName &	getReporterName (const std::string &param_name) 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

const T &	getMeshProperty (const std::string &data_name, const std::string &prefix)

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

bool	hasMeshProperty (const std::string &data_name, const std::string &prefix) const

bool	hasMeshProperty (const std::string &data_name, const std::string &prefix) const

bool	hasMeshProperty (const std::string &data_name) const

bool	hasMeshProperty (const std::string &data_name) const

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

PerfID	registerTimedSection (const std::string &section_name, const unsigned int level) const

PerfID	registerTimedSection (const std::string &section_name, const unsigned int level, const std::string &live_message, const bool print_dots=true) const

std::string	timedSectionName (const std::string &section_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 void	checkMaterialProperty (const std::string &name, const unsigned int state)

void	markMatPropRequested (const std::string &)

MaterialPropertyName	getMaterialPropertyName (const std::string &name) const

void	checkExecutionStage ()

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

const GenericMaterialProperty< T, is_ad > *	defaultGenericMaterialProperty (const std::string &name)

const GenericMaterialProperty< T, is_ad > *	defaultGenericMaterialProperty (const std::string &name)

const MaterialProperty< T > *	defaultMaterialProperty (const std::string &name)

const MaterialProperty< T > *	defaultMaterialProperty (const std::string &name)

const ADMaterialProperty< T > *	defaultADMaterialProperty (const std::string &name)

const ADMaterialProperty< T > *	defaultADMaterialProperty (const std::string &name)

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

Protected Attributes
const std::vector< VariableName > &	_var_names_to_fill
	The names of the variables which serve as a container for the reconstructed solution. More...

const std::vector< VariableName > &	_var_names_to_reconstruct
	The names of the variables in the nonlinear system whose reconstruction we are working on. More...

const std::vector< UserObjectName > &	_surrogate_model_names
	The names of the surrogate models for each variable. More...

std::vector< MooseVariableFieldBase * >	_variable_to_fill
	Links to the MooseVariables of the requested variables. More...

std::vector< MooseVariableFieldBase * >	_variable_to_reconstruct
	Links to the MooseVariables from the nonlinear system whose dof numbering we need to populate the variables in (variables_to_fill) More...

VariableMappingBase *	_mapping
	Link to the mapping object which provides the inverse mapping function. More...

std::vector< SurrogateModel * >	_surrogate_models
	Links to the surrogate models which provide functions to determine the coordinates in the latent space. More...

const std::vector< Real > &	_input_parameters
	Input parameters for the surrogate models. More...

SubProblem &	_subproblem

FEProblemBase &	_fe_problem

SystemBase &	_sys

const THREAD_ID	_tid

Assembly &	_assembly

const Moose::CoordinateSystemType &	_coord_sys

const bool	_duplicate_initial_execution

std::set< std::string >	_depend_uo

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

MooseApp &	_restartable_app

const std::string	_restartable_system_name

const THREAD_ID	_restartable_tid

const bool	_restartable_read_only

FEProblemBase &	_mci_feproblem

MooseApp &	_pg_moose_app

const std::string	_prefix

FEProblemBase &	_sc_fe_problem

const THREAD_ID	_sc_tid

const Real &	_real_zero

const VariableValue &	_scalar_zero

const Point &	_point_zero

const InputParameters &	_mi_params

const std::string	_mi_name

const MooseObjectName	_mi_moose_object_name

FEProblemBase &	_mi_feproblem

SubProblem &	_mi_subproblem

const THREAD_ID	_mi_tid

const Moose::MaterialDataType	_material_data_type

MaterialData &	_material_data

bool	_stateful_allowed

bool	_get_material_property_called

std::vector< std::unique_ptr< PropertyValue > >	_default_properties

std::unordered_set< unsigned int >	_material_property_dependencies

const MaterialPropertyName	_get_suffix

const bool	_use_interpolated_state

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

const Parallel::Communicator &	_communicator

Static Protected Attributes
static const std::string	_interpolated_old

static const std::string	_interpolated_older

Detailed Description

A user object which takes a surrogate (or just user supplied values) to determine coordinates in a latent space and uses those coordinates to create approximations of full solution values for given variables.

Definition at line 23 of file InverseMapping.h.

Constructor & Destructor Documentation

◆ InverseMapping()

InverseMapping::InverseMapping ( const InputParameters & params )

Definition at line 47 of file InverseMapping.C.

   : GeneralUserObject(parameters),
     MappingInterface(this),
     SurrogateModelInterface(this),
     _var_names_to_fill(getParam<std::vector<VariableName>>("variable_to_fill")),
     _var_names_to_reconstruct(getParam<std::vector<VariableName>>("variable_to_reconstruct")),
     _surrogate_model_names(getParam<std::vector<UserObjectName>>("surrogate")),
     _input_parameters(getParam<std::vector<Real>>("parameters"))
 {
   if (_var_names_to_fill.size() != _var_names_to_reconstruct.size())
     paramError("variable_to_fill",
                "The number of variables to fill should be the same as the number of entries in "
                "`variable_to_reconstruct`");
   if (_surrogate_model_names.size())
   {
     if (_var_names_to_fill.size() != _surrogate_model_names.size())
       paramError("surrogate",
                  "The number of surrogates should match the number of variables which need to be "
                  "reconstructed!");
   }
 }

Member Function Documentation

◆ execute()

void InverseMapping::execute ( )

overridevirtual

Implements GeneralUserObject.

Definition at line 111 of file InverseMapping.C.

 {
   for (auto var_i : index_range(_var_names_to_reconstruct))
   {
     MooseVariableFieldBase & var_to_fill = *_variable_to_fill[var_i];
     MooseVariableFieldBase & var_to_reconstruct = *_variable_to_reconstruct[var_i];
 
     // We create a temporary solution vector that will store the reconstructed solution.
     std::unique_ptr<NumericVector<Number>> temporary_vector =
         var_to_reconstruct.sys().solution().zero_clone();
 
     std::vector<Real> reduced_coefficients;
     if (_surrogate_models.size())
       _surrogate_models[var_i]->evaluate(_input_parameters, reduced_coefficients);
     else
       reduced_coefficients = _input_parameters;
 
     // The sanity check on the size of reduced_coefficients is happening in the inverse mapping
     // function
     DenseVector<Real> reconstructed_solution;
     _mapping->inverse_map(
         _var_names_to_reconstruct[var_i], reduced_coefficients, reconstructed_solution);
 
     // We set the global DoF indices of the requested variable. The underlying assumption here is
     // that we are reconstructing the solution in an application which has the same ordering in the
     // extracted `dofs` vector as the one which was used to serialize the solution vectors in
     // `SerializedSolutionTransfer`.
     var_to_reconstruct.sys().setVariableGlobalDoFs(_var_names_to_reconstruct[var_i]);
 
     // Get the DoF indices
     const auto & dofs = var_to_reconstruct.sys().getVariableGlobalDoFs();
 
     // Get the dof map to be able to determine the local dofs easily
     const auto & dof_map = var_to_reconstruct.sys().system().get_dof_map();
     dof_id_type local_dof_begin = dof_map.first_dof();
     dof_id_type local_dof_end = dof_map.end_dof();
 
     // Populate the temporary vector with the reconstructed solution
     for (const auto & dof_i : index_range(dofs))
       if (dofs[dof_i] >= local_dof_begin && dofs[dof_i] < local_dof_end)
         temporary_vector->set(dofs[dof_i], reconstructed_solution(dof_i));
 
     // Get the system and variable numbers for the dof objects
     unsigned int to_sys_num = _variable_to_fill[var_i]->sys().system().number();
     unsigned int to_var_num = var_to_fill.sys().system().variable_number(_var_names_to_fill[var_i]);
 
     unsigned int from_sys_num = var_to_reconstruct.sys().system().number();
     unsigned int from_var_num =
         var_to_reconstruct.sys().system().variable_number(_var_names_to_reconstruct[var_i]);
 
     // Get a link to the mesh for the loops over dof objects
     const MeshBase & to_mesh = _fe_problem.mesh().getMesh();
 
     // First, we cover nodal degrees of freedom.
     for (const auto & node : to_mesh.local_node_ptr_range())
     {
       const auto n_dofs = node->n_dofs(to_sys_num, to_var_num);
       // We have nothing to do if we don't have dofs at this node
       if (n_dofs < 1)
         continue;
 
       // For special cases we might have multiple dofs for the same node (hierarchic types)
       for (auto dof_i : make_range(n_dofs))
       {
         // Get the dof ids for the from/to variables
         const auto & to_dof_id = node->dof_number(to_sys_num, to_var_num, dof_i);
         const auto & from_dof_id = node->dof_number(from_sys_num, from_var_num, dof_i);
 
         // Fill the dof of the variable using the dof of the temporary variable
         var_to_fill.sys().solution().set(to_dof_id, (*temporary_vector)(from_dof_id));
       }
     }
 
     // Then we move on to element-based degrees of freedom. Considering that we don't
     // support scalar variables at the moment, this should take care of every remaining
     // local entry. Of course, we'll only need this part if the variable is not nodal.
     if (!_variable_to_reconstruct[var_i]->isNodal())
       for (auto & elem : as_range(to_mesh.local_elements_begin(), to_mesh.local_elements_end()))
       {
         // Check how many dofs we have on the current element, if none we have nothing to do
         const auto n_dofs = elem->n_dofs(to_sys_num, to_var_num);
         if (n_dofs < 1)
           continue;
 
         // Loop over the dofs and populate the variable
         for (auto dof_i : make_range(n_dofs))
         {
           // Get the dof for the from/to variables
           const auto & to_dof_id = elem->dof_number(to_sys_num, to_var_num, dof_i);
           const auto & from_dof_id = elem->dof_number(from_sys_num, from_var_num, dof_i);
 
           var_to_fill.sys().solution().set(to_dof_id, (*temporary_vector)(from_dof_id));
         }
       }
 
     // Close the solution to make sure we can output the variable
     var_to_fill.sys().solution().close();
   }
 }

◆ finalize()

void InverseMapping::finalize ( )

inlineoverridevirtual

Implements GeneralUserObject.

Definition at line 34 of file InverseMapping.h.

34 {}

◆ getMapping()

VariableMappingBase & MappingInterface::getMapping ( const std::string & name ) const

inherited

Get the mapping using the parameters of the moose object.

Parameters

name	The parameter name

Definition at line 40 of file MappingInterface.C.

Referenced by SingularTripletReporter::initialSetup(), and initialSetup().

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

◆ getMappingByName()

VariableMappingBase & MappingInterface::getMappingByName ( const UserObjectName & name ) const

inherited

Get the mapping by supplying the name of the object in the warehouse.

Parameters

name	The name of the mapping object

Definition at line 26 of file MappingInterface.C.

Referenced by MappingInterface::getMapping(), MappingReporter::initialSetup(), and MappingOutput::output().

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

◆ 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 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;
 }

◆ initialize()

void InverseMapping::initialize ( )

inlineoverridevirtual

Implements GeneralUserObject.

Definition at line 33 of file InverseMapping.h.

33 {}

◆ initialSetup()

void InverseMapping::initialSetup ( )

overridevirtual

Reimplemented from GeneralUserObject.

Definition at line 70 of file InverseMapping.C.

 {
   _mapping = &getMapping("mapping");
 
   _surrogate_models.clear();
   for (const auto & name : _surrogate_model_names)
     _surrogate_models.push_back(&getSurrogateModelByName(name));
 
   _variable_to_fill.clear();
   _variable_to_reconstruct.clear();
 
   const auto & mapping_variable_names = _mapping->getVariableNames();
 
   // We query the links to the MooseVariables mentioned in the input parameters
   for (const auto & var_i : index_range(_var_names_to_reconstruct))
   {
     if (std::find(mapping_variable_names.begin(),
                   mapping_variable_names.end(),
                   _var_names_to_reconstruct[var_i]) == mapping_variable_names.end())
       paramError("variable_to_reconstruct",
                  "Couldn't find mapping for " + _var_names_to_reconstruct[var_i] +
                      "! Double check the training process and make sure that the mapping includes "
                      "the given variable!");
 
     _variable_to_fill.push_back(&_fe_problem.getVariable(_tid, _var_names_to_fill[var_i]));
     _variable_to_reconstruct.push_back(
         &_fe_problem.getVariable(_tid, _var_names_to_reconstruct[var_i]));
 
     auto & fe_type_reconstruct = _variable_to_reconstruct.back()->feType();
     auto & fe_type_fill = _variable_to_fill.back()->feType();
 
     if (fe_type_reconstruct != fe_type_fill)
       paramError("variable_to_fill",
                  "The FEtype should match the ones defined for `variable_to_reconstruct`");
 
     if (fe_type_reconstruct.family == SCALAR)
       paramError("variable_to_fill", "InverseMapping does not support SCALAR variables!");
   }
 }

◆ validParams()

InputParameters InverseMapping::validParams ( )

static

Definition at line 20 of file InverseMapping.C.

 {
   InputParameters params = GeneralUserObject::validParams();
 
   params.addClassDescription("Evaluates surrogate models and maps the results back to a full "
                              "solution field for given variables.");
   params.addParam<std::vector<UserObjectName>>(
       "surrogate", std::vector<UserObjectName>(), "The names of the surrogates for each variable.");
   params.addRequiredParam<UserObjectName>(
       "mapping", "The name of the mapping object which provides the inverse mapping function.");
   params.addRequiredParam<std::vector<VariableName>>(
       "variable_to_fill",
       "The names of the variables that this object is supposed to populate with the "
       "reconstructed results.");
   params.addRequiredParam<std::vector<VariableName>>(
       "variable_to_reconstruct",
       "The names of the variables in the nonlinear system which we would like to approximate. This "
       "is important for DoF information.");
   params.addRequiredParam<std::vector<Real>>(
       "parameters",
       "The input parameters for the surrogate. If no surrogate is supplied these are assumed to be "
       "the coordinates in the latent space.");
   params.declareControllable("parameters");
 
   return params;
 }

Member Data Documentation

◆ _input_parameters

const std::vector<Real>& InverseMapping::_input_parameters

protected

Input parameters for the surrogate models.

If no surrogates are given, we assume that these are the coordinates in the latent space

Definition at line 66 of file InverseMapping.h.

Referenced by execute().

◆ _mapping

VariableMappingBase* InverseMapping::_mapping

protected

Link to the mapping object which provides the inverse mapping function.

Definition at line 58 of file InverseMapping.h.

Referenced by execute(), and initialSetup().

◆ _surrogate_model_names

const std::vector<UserObjectName>& InverseMapping::_surrogate_model_names

protected

The names of the surrogate models for each variable.

Definition at line 48 of file InverseMapping.h.

Referenced by initialSetup(), and InverseMapping().

◆ _surrogate_models

std::vector<SurrogateModel *> InverseMapping::_surrogate_models

protected

Links to the surrogate models which provide functions to determine the coordinates in the latent space.

Definition at line 62 of file InverseMapping.h.

Referenced by execute(), and initialSetup().

◆ _var_names_to_fill

const std::vector<VariableName>& InverseMapping::_var_names_to_fill

protected

The names of the variables which serve as a container for the reconstructed solution.

Definition at line 41 of file InverseMapping.h.

Referenced by execute(), initialSetup(), and InverseMapping().

◆ _var_names_to_reconstruct

const std::vector<VariableName>& InverseMapping::_var_names_to_reconstruct

protected

The names of the variables in the nonlinear system whose reconstruction we are working on.

Definition at line 45 of file InverseMapping.h.

Referenced by execute(), initialSetup(), and InverseMapping().

◆ _variable_to_fill

std::vector<MooseVariableFieldBase *> InverseMapping::_variable_to_fill

protected

Links to the MooseVariables of the requested variables.

Definition at line 51 of file InverseMapping.h.

Referenced by execute(), and initialSetup().

◆ _variable_to_reconstruct

std::vector<MooseVariableFieldBase *> InverseMapping::_variable_to_reconstruct

protected

Links to the MooseVariables from the nonlinear system whose dof numbering we need to populate the variables in (variables_to_fill)

Definition at line 55 of file InverseMapping.h.

Referenced by execute(), and initialSetup().

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

stochastic_tools/include/userobjects/InverseMapping.h
stochastic_tools/src/userobjects/InverseMapping.C

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ InverseMapping()

Member Function Documentation

◆ execute()

◆ finalize()

◆ getMapping()

◆ getMappingByName()

◆ getSurrogateModel() [1/2]

◆ getSurrogateModel() [2/2]

◆ getSurrogateModelByName() [1/2]

◆ getSurrogateModelByName() [2/2]

◆ getSurrogateTrainer() [1/2]

◆ getSurrogateTrainer() [2/2]

◆ getSurrogateTrainerByName() [1/2]

◆ getSurrogateTrainerByName() [2/2]

◆ initialize()

◆ initialSetup()

◆ validParams()

Member Data Documentation

◆ _input_parameters

◆ _mapping

◆ _surrogate_model_names

◆ _surrogate_models

◆ _var_names_to_fill

◆ _var_names_to_reconstruct

◆ _variable_to_fill

◆ _variable_to_reconstruct