#include <PolynomialChaosTrainer.h>

Inheritance diagram for PolynomialChaosTrainer:

Public Types
typedef DataFileName	DataFileParameterType

Public Member Functions
	PolynomialChaosTrainer (const InputParameters &parameters)

virtual void	preTrain () override

virtual void	train () override

virtual void	postTrain () override

virtual void	initialize () final

virtual void	execute () final

virtual void	finalize () final

virtual void	threadJoin (const UserObject &) final

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 *	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	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

virtual 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	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 ()

virtual void	meshDisplaced ()

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

const std::string &	modelMetaDataName () const
	Accessor for the name of the model meta data. More...

const FileName &	getModelDataFileName () const
	Get the associated filename. More...

bool	hasModelData () const
	Check if we need to load model data (if the filename parameter is used) 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 , typename... Args>
T &	declareModelData (const std::string &data_name, Args &&... args)
	Declare model data for loading from file as well as restart. More...


template<typename T , typename... Args>
const T &	getModelData (const std::string &data_name, Args &&... args) const
	Retrieve model data from the interface. More...


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
template<typename T >
const T &	getTrainingData (const ReporterName &rname)

const std::vector< Real > &	getSamplerData () const

const std::vector< Real > &	getPredictorData () const

unsigned int	getCurrentSampleSize () const

unsigned int	getLocalSampleSize () const

virtual std::vector< Real >	evaluateModelError (const SurrogateModel &surr)

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

FEProblemBase &	_mdi_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


Sampler &	_sampler

dof_id_type	_row
	During training loop, this is the row index of the data. More...

dof_id_type	_local_row
	During training loop, this is the local row index of the data. More...

const Real *	_rval
	Response value. More...

const std::vector< Real > *	_rvecval
	Vector response value. More...

std::vector< const Real * >	_pvals
	Predictor values from reporters. More...

std::vector< unsigned int >	_pcols
	Columns from sampler for predictors. More...

unsigned int	_n_dims
	Dimension of predictor data - either _sampler.getNumberOfCols() or _pvals.size() + _pcols.size(). More...

unsigned int &	_n_outputs
	The number of outputs. More...

Static Protected Attributes
static const std::string	_interpolated_old

static const std::string	_interpolated_older

Private Attributes
const std::vector< Real > &	_predictor_row
	Predictor values. More...

const unsigned int &	_order
	Maximum polynomial order. The sum of 1D polynomial orders does not go above this value. More...

unsigned int &	_ndim
	Total number of parameters/dimensions. More...

std::vector< std::vector< unsigned int > > &	_tuple
	A _ndim-by-_ncoeff matrix containing the appropriate one-dimensional polynomial order. More...

std::size_t &	_ncoeff
	Total number of coefficient (defined by size of _tuple) More...

std::vector< Real > &	_coeff
	These are the coefficients we are after in the PC expansion. More...

std::vector< std::unique_ptr< const PolynomialQuadrature::Polynomial > > &	_poly
	The distributions used for sampling. More...

unsigned int	_rtype
	The method in which to perform the regression (0=integration, 1=OLS) More...

const Real &	_ridge_penalty
	The penalty parameter for Ridge regularization. More...

QuadratureSampler *	_quad_sampler
	QuadratureSampler pointer, necessary for applying quadrature weights. More...

std::vector< std::unique_ptr< RealCalculator > >	_calculators
	Calculators used for standardization in linear regression. More...

Real	_r_sum


DenseMatrix< Real >	_matrix

DenseVector< Real >	_rhs

Detailed Description

Definition at line 22 of file PolynomialChaosTrainer.h.

Constructor & Destructor Documentation

◆ PolynomialChaosTrainer()

PolynomialChaosTrainer::PolynomialChaosTrainer ( const InputParameters & parameters )

Definition at line 35 of file PolynomialChaosTrainer.C.

   : SurrogateTrainer(parameters),
     _predictor_row(getPredictorData()),
     _order(declareModelData<unsigned int>("_order", getParam<unsigned int>("order"))),
     _ndim(declareModelData<unsigned int>("_ndim", _sampler.getNumberOfCols())),
     _tuple(declareModelData<std::vector<std::vector<unsigned int>>>(
         "_tuple", StochasticTools::MultiDimPolynomialGenerator::generateTuple(_ndim, _order))),
     _ncoeff(declareModelData<std::size_t>("_ncoeff", _tuple.size())),
     _coeff(declareModelData<std::vector<Real>>("_coeff")),
     _poly(declareModelData<std::vector<std::unique_ptr<const PolynomialQuadrature::Polynomial>>>(
         "_poly")),
     _ridge_penalty(getParam<Real>("penalty")),
     _quad_sampler(dynamic_cast<QuadratureSampler *>(&_sampler))
 {
   // Check if number of distributions is correct
   if (_ndim != _sampler.getNumberOfCols())
     paramError("distributions",
                "Sampler number of columns does not match number of inputted distributions.");
 
   auto rtype_enum = getParam<MooseEnum>("regression_type");
   if (rtype_enum == "auto")
     _rtype = _quad_sampler ? 0 : 1;
   else
     _rtype = rtype_enum == "integration" ? 0 : 1;
 
   if (_rtype == 0 && _quad_sampler &&
       (!_pvals.empty() || _pcols.size() != _sampler.getNumberOfCols()))
     paramError("sampler",
                "QuadratureSampler must use all Sampler columns for training, and cannot be"
                " used with other Reporters - otherwise, quadrature integration does not work.");
   if (_rtype == 0 && _ridge_penalty != 0.0)
     paramError("penalty",
                "Ridge regularization penalty is only relevant if 'regression_type = ols'.");
 
   // Make polynomials
   for (const auto & nm : getParam<std::vector<DistributionName>>("distributions"))
     _poly.push_back(PolynomialQuadrature::makePolynomial(&getDistributionByName(nm)));
 
   // Create calculators for standardization
   if (_rtype == 1)
   {
     _calculators.resize(_ncoeff * 3);
     for (const auto & term : make_range(_ncoeff))
     {
       _calculators[3 * term] = StochasticTools::makeCalculator(MooseEnumItem("mean"), *this);
       _calculators[3 * term + 1] = StochasticTools::makeCalculator(MooseEnumItem("stddev"), *this);
       _calculators[3 * term + 2] = StochasticTools::makeCalculator(MooseEnumItem("sum"), *this);
     }
   }
 }

Member Function Documentation

◆ declareModelData()

template<typename T , typename... Args>

T & RestartableModelInterface::declareModelData	(	const std::string &	data_name,
		Args &&...	args
	)

inherited

Declare model data for loading from file as well as restart.

Definition at line 78 of file RestartableModelInterface.h.

 {
   return _model_restartable.declareRestartableData<T>(data_name, std::forward<Args>(args)...);
 }

◆ evaluateModelError()

std::vector< Real > SurrogateTrainer::evaluateModelError ( const SurrogateModel & surr )

protectedvirtualinherited

Definition at line 347 of file SurrogateTrainer.C.

Referenced by SurrogateTrainer::crossValidate().

 {
   std::vector<Real> error(1, 0.0);
 
   if (_rval)
   {
     Real model_eval = surr.evaluate(_predictor_data);
     error[0] = MathUtils::pow(model_eval - (*_rval), 2);
   }
   else if (_rvecval)
   {
     error.resize(_rvecval->size());
 
     // Evaluate for vector response.
     std::vector<Real> model_eval(error.size());
     surr.evaluate(_predictor_data, model_eval);
     for (auto r : make_range(_rvecval->size()))
       error[r] = MathUtils::pow(model_eval[r] - (*_rvecval)[r], 2);
   }
 
   return error;
 }

◆ execute()

void SurrogateTrainer::execute ( )

finalvirtualinherited

Implements GeneralUserObject.

Definition at line 176 of file SurrogateTrainer.C.

 {
   if (_doing_cv)
     for (const auto & trial : make_range(_cv_n_trials))
     {
       std::vector<Real> trial_score = crossValidate();
 
       // Expand _cv_trial_scores with more columns if necessary, then insert values.
       for (unsigned int r = _cv_trial_scores.size(); r < trial_score.size(); ++r)
         _cv_trial_scores.push_back(std::vector<Real>(_cv_n_trials, 0.0));
       for (auto r : make_range(trial_score.size()))
         _cv_trial_scores[r][trial] = trial_score[r];
     }
 
   _current_sample_size = _sampler.getNumberOfRows();
   _local_sample_size = _sampler.getNumberOfLocalRows();
   executeTraining();
 }

◆ finalize()

virtual void SurrogateTrainer::finalize ( )

inlinefinalvirtualinherited

Reimplemented from SurrogateTrainerBase.

Definition at line 63 of file SurrogateTrainer.h.

63 {}

◆ getCurrentSampleSize()

unsigned int SurrogateTrainer::getCurrentSampleSize ( ) const

inlineprotectedinherited

Definition at line 102 of file SurrogateTrainer.h.

Referenced by postTrain(), and preTrain().

102 { return _current_sample_size; };

SurrogateTrainer::_current_sample_size

unsigned int _current_sample_size

Number of samples used to train the model.

Definition: SurrogateTrainer.h:173

◆ getLocalSampleSize()

unsigned int SurrogateTrainer::getLocalSampleSize ( ) const

inlineprotectedinherited

Definition at line 107 of file SurrogateTrainer.h.

Referenced by NearestPointTrainer::preTrain(), GaussianProcessTrainer::preTrain(), and LibtorchANNTrainer::preTrain().

107 { return _local_sample_size; };

SurrogateTrainer::_local_sample_size

unsigned int _local_sample_size

Number of samples (locally) used to train the model.

Definition: SurrogateTrainer.h:176

◆ getModelData()

template<typename T , typename... Args>

const T & RestartableModelInterface::getModelData	(	const std::string &	data_name,
		Args &&...	args
	)		const

inherited

Retrieve model data from the interface.

Definition at line 85 of file RestartableModelInterface.h.

 {
   return _model_restartable.getRestartableData<T>(data_name, std::forward<Args>(args)...);
 }

◆ getModelDataFileName()

const FileName & RestartableModelInterface::getModelDataFileName ( ) const

inherited

Get the associated filename.

Definition at line 33 of file RestartableModelInterface.C.

 {
   return _model_object.getParam<FileName>("filename");
 }

◆ getPredictorData()

const std::vector<Real>& SurrogateTrainer::getPredictorData ( ) const

inlineprotectedinherited

Definition at line 97 of file SurrogateTrainer.h.

97 { return _predictor_data; };

SurrogateTrainer::_predictor_data

std::vector< Real > _predictor_data

Predictor data for current row - can be combination of Sampler and Reporter values.

Definition: SurrogateTrainer.h:164

◆ getSamplerData()

const std::vector<Real>& SurrogateTrainer::getSamplerData ( ) const

inlineprotectedinherited

Definition at line 92 of file SurrogateTrainer.h.

92 { return _row_data; };

SurrogateTrainer::_row_data

std::vector< Real > _row_data

Sampler data for the current row.

Definition: SurrogateTrainer.h:161

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

◆ getTrainingData()

template<typename T >

const T & SurrogateTrainer::getTrainingData ( const ReporterName & rname )

protectedinherited

Definition at line 208 of file SurrogateTrainer.h.

 {
   auto it = _training_data.find(rname);
   if (it != _training_data.end())
   {
     auto data = std::dynamic_pointer_cast<TrainingData<T>>(it->second);
     if (!data)
       mooseError("Reporter value ", rname, " already exists but is of different type.");
     return data->get();
   }
   else
   {
     const std::vector<T> & rval = getReporterValueByName<std::vector<T>>(rname);
     _training_data[rname] = std::make_shared<TrainingData<T>>(rval);
     return std::dynamic_pointer_cast<TrainingData<T>>(_training_data[rname])->get();
   }
 }

◆ hasModelData()

bool RestartableModelInterface::hasModelData ( ) const

inherited

Check if we need to load model data (if the filename parameter is used)

Definition at line 39 of file RestartableModelInterface.C.

 {
   return _model_object.isParamValid("filename");
 }

◆ initialize()

void SurrogateTrainer::initialize ( )

finalvirtualinherited

Reimplemented from SurrogateTrainerBase.

Definition at line 153 of file SurrogateTrainer.C.

 {
   // Figure out if data is distributed
   for (auto & pair : _training_data)
   {
     const ReporterName & name = pair.first;
     TrainingDataBase & data = *pair.second;
 
     const auto & mode = _fe_problem.getReporterData().getReporterMode(name);
     if (mode == REPORTER_MODE_DISTRIBUTED || (mode == REPORTER_MODE_ROOT && processor_id() != 0))
       data.isDistributed() = true;
     else if (mode == REPORTER_MODE_REPLICATED ||
              (mode == REPORTER_MODE_ROOT && processor_id() == 0))
       data.isDistributed() = false;
     else
       mooseError("Predictor reporter value ", name, " is not of supported mode.");
   }
 
   if (_doing_cv)
     _cv_surrogate = &getSurrogateModel("cv_surrogate");
 }

◆ modelMetaDataName()

const std::string& RestartableModelInterface::modelMetaDataName ( ) const

inlineinherited

Accessor for the name of the model meta data.

Definition at line 47 of file RestartableModelInterface.h.

Referenced by SurrogateTrainerOutput::output(), and MappingOutput::output().

47 { return _model_meta_data_name; }

RestartableModelInterface::_model_meta_data_name

const std::string _model_meta_data_name

The model meta data name.

Definition: RestartableModelInterface.h:61

◆ postTrain()

void PolynomialChaosTrainer::postTrain ( )

overridevirtual

Reimplemented from SurrogateTrainer.

Definition at line 153 of file PolynomialChaosTrainer.C.

 {
   if (_rtype == 0)
   {
     gatherSum(_coeff);
     if (!_quad_sampler)
       for (std::size_t i = 0; i < _ncoeff; ++i)
         _coeff[i] /= getCurrentSampleSize();
   }
   else
   {
     gatherSum(_matrix.get_values());
     gatherSum(_rhs.get_values());
     for (auto & calc : _calculators)
       calc->finalizeCalculator(true);
     gatherSum(_r_sum);
 
     std::vector<Real> mu(_ncoeff);
     std::vector<Real> sig(_ncoeff);
     std::vector<Real> sum_pf(_ncoeff);
     for (const auto i : make_range(_ncoeff))
     {
       mu[i] = i > 0 ? _calculators[3 * i]->getValue() : 0.0;
       sig[i] = i > 0 ? _calculators[3 * i + 1]->getValue() : 1.0;
       sum_pf[i] = _calculators[3 * i + 2]->getValue();
     }
 
     const Real n = getCurrentSampleSize();
     for (const auto i : make_range(_ncoeff))
     {
       for (const auto j : make_range(i + 1))
       {
         _matrix(i, j) -= (mu[j] * sum_pf[i] + mu[i] * sum_pf[j]);
         _matrix(i, j) += n * mu[i] * mu[j];
         _matrix(i, j) /= (sig[i] * sig[j]);
         _matrix(j, i) = _matrix(i, j);
       }
       _rhs(i) = (_rhs(i) - mu[i] * _r_sum) / sig[i];
     }
 
     DenseVector<Real> sol;
     _matrix.lu_solve(_rhs, sol);
     _coeff = sol.get_values();
 
     for (unsigned int i = 1; i < _ncoeff; ++i)
     {
       _coeff[i] /= sig[i];
       _coeff[0] -= _coeff[i] * mu[i];
     }
   }
 }

◆ preTrain()

void PolynomialChaosTrainer::preTrain ( )

overridevirtual

Reimplemented from SurrogateTrainer.

Definition at line 87 of file PolynomialChaosTrainer.C.

 {
   _coeff.assign(_ncoeff, 0.0);
 
   if (_rtype == 1)
   {
     if (getCurrentSampleSize() < _ncoeff)
       paramError("order",
                  "Number of data points (",
                  getCurrentSampleSize(),
                  ") must be greater than the number of terms in the polynomial (",
                  _ncoeff,
                  ").");
     _matrix.resize(_ncoeff, _ncoeff);
     _rhs.resize(_ncoeff);
     for (auto & calc : _calculators)
       calc->initializeCalculator();
     _r_sum = 0.0;
   }
 }

◆ threadJoin()

virtual void SurrogateTrainerBase::threadJoin ( const UserObject & )

inlinefinalvirtualinherited

Reimplemented from GeneralUserObject.

Definition at line 40 of file SurrogateTrainer.h.

40 {} // GeneralUserObjects are not threaded

◆ train()

void PolynomialChaosTrainer::train ( )

overridevirtual

Reimplemented from SurrogateTrainer.

Definition at line 109 of file PolynomialChaosTrainer.C.

 {
   // Evaluate polynomials to avoid duplication
   DenseMatrix<Real> poly_val(_ndim, _order);
   for (unsigned int d = 0; d < _ndim; ++d)
     for (unsigned int i = 0; i < _order; ++i)
       poly_val(d, i) = _poly[d]->compute(i, _predictor_row[d], /*normalize=*/_rtype == 0);
 
   // Evaluate multi-dimensional polynomials
   std::vector<Real> basis(_ncoeff, 1.0);
   for (const auto i : make_range(_ncoeff))
     for (const auto d : make_range(_ndim))
       basis[i] *= poly_val(d, _tuple[i][d]);
 
   // For integration
   if (_rtype == 0)
   {
     const Real fact = (*_rval) * (_quad_sampler ? _quad_sampler->getQuadratureWeight(_row) : 1.0);
     for (const auto i : make_range(_ncoeff))
       _coeff[i] += fact * basis[i];
   }
   // For least-squares
   else
   {
     // Loop over coefficients
     for (const auto i : make_range(_ncoeff))
     {
       // Matrix is symmetric, so we'll add the upper diagonal later
       for (const auto j : make_range(i + 1))
         _matrix(i, j) += basis[i] * basis[j];
       _rhs(i) += basis[i] * (*_rval);
 
       for (unsigned int c = i * 3; c < (i + 1) * 3; ++c)
         _calculators[c]->updateCalculator(basis[i]);
     }
     _r_sum += (*_rval);
 
     if (_ridge_penalty != 0.0)
       for (const auto i : make_range(_ncoeff))
         _matrix(i, i) += _ridge_penalty;
   }
 }

◆ validParams()

InputParameters PolynomialChaosTrainer::validParams ( )

static

Definition at line 17 of file PolynomialChaosTrainer.C.

 {
   InputParameters params = SurrogateTrainer::validParams();
   params.addClassDescription("Computes and evaluates polynomial chaos surrogate model.");
   params.addRequiredParam<unsigned int>("order", "Maximum polynomial order.");
   params.addRequiredParam<std::vector<DistributionName>>(
       "distributions", "Names of the distributions samples were taken from.");
   MooseEnum rtype("integration ols auto", "auto");
   params.addParam<MooseEnum>(
       "regression_type",
       rtype,
       "The type of regression to perform for finding polynomial coefficents.");
   params.addParam<Real>("penalty", 0.0, "Ridge regularization penalty factor for OLS regression.");
 
   params.suppressParameter<MooseEnum>("response_type");
   return params;
 }

Member Data Documentation

◆ _calculators

std::vector<std::unique_ptr<RealCalculator> > PolynomialChaosTrainer::_calculators

private

Calculators used for standardization in linear regression.

Definition at line 63 of file PolynomialChaosTrainer.h.

Referenced by PolynomialChaosTrainer(), postTrain(), preTrain(), and train().

◆ _coeff

std::vector<Real>& PolynomialChaosTrainer::_coeff

private

These are the coefficients we are after in the PC expansion.

Definition at line 48 of file PolynomialChaosTrainer.h.

Referenced by postTrain(), preTrain(), and train().

◆ _local_row

dof_id_type SurrogateTrainer::_local_row

protectedinherited

During training loop, this is the local row index of the data.

Definition at line 123 of file SurrogateTrainer.h.

Referenced by SurrogateTrainer::executeTraining().

◆ _matrix

DenseMatrix<Real> PolynomialChaosTrainer::_matrix

private

Matrix and rhs for the regression problem

Definition at line 68 of file PolynomialChaosTrainer.h.

Referenced by postTrain(), preTrain(), and train().

◆ _n_dims

unsigned int SurrogateTrainer::_n_dims

protectedinherited

Dimension of predictor data - either _sampler.getNumberOfCols() or _pvals.size() + _pcols.size().

Definition at line 133 of file SurrogateTrainer.h.

Referenced by NearestPointTrainer::NearestPointTrainer(), GaussianProcessTrainer::postTrain(), LibtorchANNTrainer::postTrain(), LibtorchANNTrainer::preTrain(), SurrogateTrainer::SurrogateTrainer(), NearestPointTrainer::train(), and PolynomialRegressionTrainer::train().

◆ _n_outputs

unsigned int& SurrogateTrainer::_n_outputs

protectedinherited

The number of outputs.

Definition at line 135 of file SurrogateTrainer.h.

Referenced by GaussianProcessTrainer::GaussianProcessTrainer(), GaussianProcessTrainer::postTrain(), and GaussianProcessTrainer::train().

◆ _ncoeff

std::size_t& PolynomialChaosTrainer::_ncoeff

private

Total number of coefficient (defined by size of _tuple)

Definition at line 45 of file PolynomialChaosTrainer.h.

Referenced by PolynomialChaosTrainer(), postTrain(), preTrain(), and train().

◆ _ndim

unsigned int& PolynomialChaosTrainer::_ndim

private

Total number of parameters/dimensions.

Definition at line 39 of file PolynomialChaosTrainer.h.

Referenced by PolynomialChaosTrainer(), and train().

◆ _order

const unsigned int& PolynomialChaosTrainer::_order

private

Maximum polynomial order. The sum of 1D polynomial orders does not go above this value.

Definition at line 36 of file PolynomialChaosTrainer.h.

Referenced by train().

◆ _pcols

std::vector<unsigned int> SurrogateTrainer::_pcols

protectedinherited

Columns from sampler for predictors.

Definition at line 131 of file SurrogateTrainer.h.

Referenced by PolynomialChaosTrainer(), SurrogateTrainer::SurrogateTrainer(), and SurrogateTrainer::updatePredictorRow().

◆ _poly

std::vector<std::unique_ptr<const PolynomialQuadrature::Polynomial> >& PolynomialChaosTrainer::_poly

private

The distributions used for sampling.

Definition at line 51 of file PolynomialChaosTrainer.h.

Referenced by PolynomialChaosTrainer(), and train().

◆ _predictor_row

const std::vector<Real>& PolynomialChaosTrainer::_predictor_row

private

Predictor values.

Definition at line 33 of file PolynomialChaosTrainer.h.

Referenced by train().

◆ _pvals

std::vector<const Real *> SurrogateTrainer::_pvals

protectedinherited

Predictor values from reporters.

Definition at line 129 of file SurrogateTrainer.h.

Referenced by PolynomialChaosTrainer(), SurrogateTrainer::SurrogateTrainer(), and SurrogateTrainer::updatePredictorRow().

◆ _quad_sampler

QuadratureSampler* PolynomialChaosTrainer::_quad_sampler

private

QuadratureSampler pointer, necessary for applying quadrature weights.

Definition at line 60 of file PolynomialChaosTrainer.h.

Referenced by PolynomialChaosTrainer(), postTrain(), and train().

◆ _r_sum

Real PolynomialChaosTrainer::_r_sum

private

Definition at line 64 of file PolynomialChaosTrainer.h.

Referenced by postTrain(), preTrain(), and train().

◆ _rhs

DenseVector<Real> PolynomialChaosTrainer::_rhs

private

Definition at line 69 of file PolynomialChaosTrainer.h.

Referenced by postTrain(), preTrain(), and train().

◆ _ridge_penalty

const Real& PolynomialChaosTrainer::_ridge_penalty

private

The penalty parameter for Ridge regularization.

Definition at line 57 of file PolynomialChaosTrainer.h.

Referenced by PolynomialChaosTrainer(), and train().

◆ _row

dof_id_type SurrogateTrainer::_row

protectedinherited

During training loop, this is the row index of the data.

Definition at line 121 of file SurrogateTrainer.h.

Referenced by SurrogateTrainer::executeTraining(), and train().

◆ _rtype

unsigned int PolynomialChaosTrainer::_rtype

private

The method in which to perform the regression (0=integration, 1=OLS)

Definition at line 54 of file PolynomialChaosTrainer.h.

Referenced by PolynomialChaosTrainer(), postTrain(), preTrain(), and train().

◆ _rval

const Real* SurrogateTrainer::_rval

protectedinherited

Response value.

Definition at line 125 of file SurrogateTrainer.h.

Referenced by SurrogateTrainer::evaluateModelError(), SurrogateTrainer::SurrogateTrainer(), NearestPointTrainer::train(), PolynomialRegressionTrainer::train(), GaussianProcessTrainer::train(), and LibtorchANNTrainer::train().

◆ _rvecval

const std::vector<Real>* SurrogateTrainer::_rvecval

protectedinherited

Vector response value.

Definition at line 127 of file SurrogateTrainer.h.

Referenced by SurrogateTrainer::evaluateModelError(), SurrogateTrainer::SurrogateTrainer(), NearestPointTrainer::train(), PolynomialRegressionTrainer::train(), and GaussianProcessTrainer::train().

◆ _sampler

Sampler& SurrogateTrainer::_sampler

protectedinherited

Sampler being used for training

Definition at line 119 of file SurrogateTrainer.h.

Referenced by SurrogateTrainer::checkIntegrity(), SurrogateTrainer::crossValidate(), SurrogateTrainer::execute(), SurrogateTrainer::executeTraining(), GaussianProcessTrainer::GaussianProcessTrainer(), PolynomialChaosTrainer(), PolynomialRegressionTrainer::PolynomialRegressionTrainer(), and SurrogateTrainer::SurrogateTrainer().

◆ _tuple

std::vector<std::vector<unsigned int> >& PolynomialChaosTrainer::_tuple

private

A _ndim-by-_ncoeff matrix containing the appropriate one-dimensional polynomial order.

Definition at line 42 of file PolynomialChaosTrainer.h.

Referenced by train().

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

stochastic_tools/include/trainers/PolynomialChaosTrainer.h
stochastic_tools/src/trainers/PolynomialChaosTrainer.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

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ PolynomialChaosTrainer()

Member Function Documentation

◆ declareModelData()

◆ evaluateModelError()

◆ execute()

◆ finalize()

◆ getCurrentSampleSize()

◆ getLocalSampleSize()

◆ getModelData()

◆ getModelDataFileName()

◆ getPredictorData()

◆ getSamplerData()

◆ getSurrogateModel() [1/2]

◆ getSurrogateModel() [2/2]

◆ getSurrogateModelByName() [1/2]

◆ getSurrogateModelByName() [2/2]

◆ getSurrogateTrainer() [1/2]

◆ getSurrogateTrainer() [2/2]

◆ getSurrogateTrainerByName() [1/2]

◆ getSurrogateTrainerByName() [2/2]

◆ getTrainingData()

◆ hasModelData()

◆ initialize()

◆ modelMetaDataName()

◆ postTrain()

◆ preTrain()

◆ threadJoin()

◆ train()

◆ validParams()

Member Data Documentation

◆ _calculators

◆ _coeff

◆ _local_row

◆ _matrix

◆ _n_dims

◆ _n_outputs

◆ _ncoeff

◆ _ndim

◆ _order

◆ _pcols

◆ _poly

◆ _predictor_row

◆ _pvals

◆ _quad_sampler

◆ _r_sum

◆ _rhs

◆ _ridge_penalty

◆ _row

◆ _rtype

◆ _rval

◆ _rvecval

◆ _sampler

◆ _tuple