https://mooseframework.inl.gov
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 Member Functions | Private Attributes | List of all members
SobolReporter Class Reference

Computes Sobol sensitivity indices, see SobolCalculators. More...

#include <SobolReporter.h>

Inheritance diagram for SobolReporter:
[legend]

Public Types

typedef DataFileName DataFileParameterType
 

Public Member Functions

 SobolReporter (const InputParameters &parameters)
 
virtual void initialSetup () override
 
virtual void initialize () override
 
virtual void execute () override
 
virtual void finalize () override
 
virtual void store (nlohmann::json &json) const override
 
void threadJoin (const UserObject &) final
 
bool shouldStore () const override 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 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 declareLateValues ()
 
void buildOutputHideVariableList (std::set< std::string > variable_names)
 
const std::set< OutputName > & getOutputs ()
 
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
 

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 ()
 
T & declareUnusedValue (Args &&... args)
 
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)
 
T & declareValue (const std::string &param_name, Args &&... args)
 
T & declareValue (const std::string &param_name, ReporterMode mode, Args &&... args)
 
T & declareValue (const std::string &param_name, Args &&... args)
 
T & declareValue (const std::string &param_name, ReporterMode mode, Args &&... args)
 
T & declareValue (const std::string &param_name, Args &&... args)
 
T & declareValue (const std::string &param_name, ReporterMode mode, Args &&... args)
 
T & declareValue (const std::string &param_name, Args &&... args)
 
T & declareValue (const std::string &param_name, ReporterMode mode, Args &&... args)
 
T & declareValueByName (const ReporterValueName &value_name, Args &&... args)
 
T & declareValueByName (const ReporterValueName &value_name, ReporterMode mode, Args &&... args)
 
T & declareValueByName (const ReporterValueName &value_name, Args &&... args)
 
T & declareValueByName (const ReporterValueName &value_name, ReporterMode mode, Args &&... args)
 
T & declareValueByName (const ReporterValueName &value_name, Args &&... args)
 
T & declareValueByName (const ReporterValueName &value_name, ReporterMode mode, Args &&... args)
 
T & declareValueByName (const ReporterValueName &value_name, Args &&... args)
 
T & declareValueByName (const ReporterValueName &value_name, ReporterMode mode, Args &&... args)
 

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
 

Static Protected Attributes

static const std::string _interpolated_old
 
static const std::string _interpolated_older
 

Private Member Functions

template<typename InType >
void declareValueHelper (const ReporterName &r_name)
 Helper for adding Sobol reporter values. More...
 

Private Attributes

const SobolSampler & _sobol_sampler
 The sampler that generated the samples that produced results for the _results_vectors. More...
 
const std::vector< Real > & _ci_levels
 CI levels to be computed. More...
 
const unsigned int & _ci_replicates
 Number of CI replicates to use in Bootstrap methods. More...
 
const unsigned int & _ci_seed
 Random seed for producing CI replicates. More...
 
bool _initialized
 Whether or not initialize() has been called for reporter value declaration. More...
 

Detailed Description

Computes Sobol sensitivity indices, see SobolCalculators.

Definition at line 23 of file SobolReporter.h.

Constructor & Destructor Documentation

◆ SobolReporter()

SobolReporter::SobolReporter ( const InputParameters &  parameters)

Definition at line 56 of file SobolReporter.C.

57  : GeneralReporter(parameters),
58  _sobol_sampler(getSampler<SobolSampler>("sampler")),
59  _ci_levels(getParam<std::vector<Real>>("ci_levels")),
60  _ci_replicates(getParam<unsigned int>("ci_replicates")),
61  _ci_seed(getParam<unsigned int>("ci_seed")),
62  _initialized(false)
63 {
64  // CI levels error checking
65  if (!_ci_levels.empty())
66  {
67  if (*std::min_element(_ci_levels.begin(), _ci_levels.end()) <= 0)
68  paramError("ci_levels", "The supplied levels must be greater than zero.");
69  else if (*std::max_element(_ci_levels.begin(), _ci_levels.end()) >= 1)
70  paramError("ci_levels", "The supplied levels must be less than 1.0");
71  }
72 
73  if ((!isParamValid("reporters") && !isParamValid("vectorpostprocessors")) ||
74  (getParam<std::vector<ReporterName>>("reporters").empty() &&
75  getParam<std::vector<VectorPostprocessorName>>("vectorpostprocessors").empty()))
76  mooseError(
77  "The 'vectorpostprocessors' and/or 'reporters' parameters must be defined and non-empty.");
78 }
SobolReporter::_sobol_sampler
const SobolSampler & _sobol_sampler
The sampler that generated the samples that produced results for the _results_vectors.
Definition: SobolReporter.h:46
SobolReporter::_ci_levels
const std::vector< Real > & _ci_levels
CI levels to be computed.
Definition: SobolReporter.h:49
GeneralReporter::isParamValid
bool isParamValid(const std::string &name) const
SobolReporter::_ci_seed
const unsigned int & _ci_seed
Random seed for producing CI replicates.
Definition: SobolReporter.h:55
GeneralReporter::getParam
const T & getParam(const std::string &name) const
SobolReporter::_initialized
bool _initialized
Whether or not initialize() has been called for reporter value declaration.
Definition: SobolReporter.h:58
GeneralReporter::paramError
void paramError(const std::string &param, Args... args) const
GeneralReporter::GeneralReporter
GeneralReporter(const InputParameters &parameters)
SobolReporter::_ci_replicates
const unsigned int & _ci_replicates
Number of CI replicates to use in Bootstrap methods.
Definition: SobolReporter.h:52
GeneralReporter::mooseError
void mooseError(Args &&... args) const
GeneralReporter::parameters
const InputParameters & parameters() const

Member Function Documentation

◆ declareValueHelper()

template<typename T >
template void SobolReporter::declareValueHelper< Real > ( const ReporterName &  r_name)
private

Helper for adding Sobol reporter values.

Parameters
r_nameReporterName of the data from which the statistics will be computed

Definition at line 147 of file SobolReporter.C.

Referenced by initialize().

148 {
149  const auto & mode = _fe_problem.getReporterData().getReporterMode(r_name);
150  const auto & data = getReporterValueByName<std::vector<T>>(r_name);
151  const std::string s_name = r_name.getObjectName() + "_" + r_name.getValueName();
152  if (!_ci_levels.empty())
153  declareValueByName<SobolState<T>, SobolReporterContext<std::vector<T>, T>>(
154  s_name,
155  REPORTER_MODE_ROOT,
156  data,
157  mode,
158  _sobol_sampler,
159  MooseEnum("percentile", "percentile"),
160  _ci_levels,
161  _ci_replicates,
162  _ci_seed);
163  else
164  declareValueByName<SobolState<T>, SobolReporterContext<std::vector<T>, T>>(
165  s_name, REPORTER_MODE_ROOT, data, mode, _sobol_sampler);
166 }
GeneralReporter::declareValueByName
T & declareValueByName(const ReporterValueName &value_name, Args &&... args)
SobolReporter::_sobol_sampler
const SobolSampler & _sobol_sampler
The sampler that generated the samples that produced results for the _results_vectors.
Definition: SobolReporter.h:46
REPORTER_MODE_ROOT
const ReporterMode REPORTER_MODE_ROOT
SobolReporter::_ci_levels
const std::vector< Real > & _ci_levels
CI levels to be computed.
Definition: SobolReporter.h:49
FEProblemBase::getReporterData
const ReporterData & getReporterData() const
SobolReporter::_ci_seed
const unsigned int & _ci_seed
Random seed for producing CI replicates.
Definition: SobolReporter.h:55
SobolState
std::pair< std::vector< OutType >, std::vector< std::vector< OutType > >> SobolState
Definition: SobolReporter.h:62
ReporterName::getObjectName
const std::string & getObjectName() const
SobolReporter::_ci_replicates
const unsigned int & _ci_replicates
Number of CI replicates to use in Bootstrap methods.
Definition: SobolReporter.h:52
ReporterData::getReporterMode
const ReporterProducerEnum & getReporterMode(const ReporterName &reporter_name) const
GeneralReporter::_fe_problem
FEProblemBase & _fe_problem
ReporterName::getValueName
const std::string & getValueName() const

◆ execute()

virtual void SobolReporter::execute ( )
inlineoverridevirtual

Implements GeneralReporter.

Definition at line 31 of file SobolReporter.h.

31 {}

◆ finalize()

virtual void SobolReporter::finalize ( )
inlineoverridevirtual

Implements GeneralReporter.

Definition at line 32 of file SobolReporter.h.

32 {}

◆ initialize()

void SobolReporter::initialize ( )
overridevirtual

Implements GeneralReporter.

Definition at line 81 of file SobolReporter.C.

82 {
83  if (_initialized)
84  return;
85 
86  // Stats for Reporters
87  if (isParamValid("reporters"))
88  {
89  std::vector<std::string> unsupported_types;
90  const auto & reporter_names = getParam<std::vector<ReporterName>>("reporters");
91  for (const auto & r_name : reporter_names)
92  {
93  if (hasReporterValueByName<std::vector<Real>>(r_name))
94  declareValueHelper<Real>(r_name);
95  else if (hasReporterValueByName<std::vector<std::vector<Real>>>(r_name))
96  declareValueHelper<std::vector<Real>>(r_name);
97  else
98  unsupported_types.emplace_back(r_name.getCombinedName());
99  }
100 
101  if (!unsupported_types.empty())
102  paramError("reporters",
103  "The following reporter value(s) do not have a type supported by the "
104  "StatisticsReporter:\n",
105  MooseUtils::join(unsupported_types, ", "));
106  }
107 
108  // Stats for VPP
109  if (isParamValid("vectorpostprocessors"))
110  {
111  const auto & vpp_names = getParam<std::vector<VectorPostprocessorName>>("vectorpostprocessors");
112  for (const auto & vpp_name : vpp_names)
113  {
114  const VectorPostprocessor & vpp_object =
115  _fe_problem.getVectorPostprocessorObjectByName(vpp_name);
116  const std::set<std::string> & vpp_vectors = vpp_object.getVectorNames();
117  for (const auto & vec_name : vpp_vectors)
118  {
119  ReporterName r_name(vpp_name, vec_name);
120  declareValueHelper<Real>(r_name);
121  }
122  }
123  }
124 
125  _initialized = true;
126 }
MooseUtils::join
std::string join(Iterator begin, Iterator end, const std::string &delimiter)
SobolReporter::declareValueHelper
void declareValueHelper(const ReporterName &r_name)
Helper for adding Sobol reporter values.
Definition: SobolReporter.C:147
GeneralReporter::isParamValid
bool isParamValid(const std::string &name) const
SobolReporter::_initialized
bool _initialized
Whether or not initialize() has been called for reporter value declaration.
Definition: SobolReporter.h:58
FEProblemBase::getVectorPostprocessorObjectByName
const VectorPostprocessor & getVectorPostprocessorObjectByName(const std::string &object_name, const THREAD_ID tid=0) const
GeneralReporter::paramError
void paramError(const std::string &param, Args... args) const
GeneralReporter::_fe_problem
FEProblemBase & _fe_problem
VectorPostprocessor::getVectorNames
const std::set< std::string > & getVectorNames() const
GeneralReporter::hasReporterValueByName
bool hasReporterValueByName(const ReporterName &reporter_name) const

◆ initialSetup()

virtual void SobolReporter::initialSetup ( )
inlineoverridevirtual

Reimplemented from GeneralReporter.

Definition at line 29 of file SobolReporter.h.

29 {}

◆ store()

void SobolReporter::store ( nlohmann::json &  json) const
overridevirtual

Reimplemented from GeneralReporter.

Definition at line 129 of file SobolReporter.C.

130 {
131  Reporter::store(json);
132  if (!_ci_levels.empty())
133  json["confidence_intervals"] = {{"method", "percentile"},
134  {"levels", _ci_levels},
135  {"replicates", _ci_replicates},
136  {"seed", _ci_seed}};
137 
138  json["num_params"] = _sobol_sampler.getNumberOfCols();
139  json["indices"].push_back("FIRST_ORDER");
140  json["indices"].push_back("TOTAL");
141  if (_sobol_sampler.resample())
142  json["indices"].push_back("SECOND_ORDER");
143 }
SobolReporter::_sobol_sampler
const SobolSampler & _sobol_sampler
The sampler that generated the samples that produced results for the _results_vectors.
Definition: SobolReporter.h:46
SobolSampler::resample
bool resample() const
Resampling flag, see SobolStatistics.
Definition: SobolSampler.h:31
SobolReporter::_ci_levels
const std::vector< Real > & _ci_levels
CI levels to be computed.
Definition: SobolReporter.h:49
Reporter::store
virtual void store(nlohmann::json &json) const
SobolReporter::_ci_seed
const unsigned int & _ci_seed
Random seed for producing CI replicates.
Definition: SobolReporter.h:55
SobolReporter::_ci_replicates
const unsigned int & _ci_replicates
Number of CI replicates to use in Bootstrap methods.
Definition: SobolReporter.h:52
Sampler::getNumberOfCols
dof_id_type getNumberOfCols() const

◆ validParams()

InputParameters SobolReporter::validParams ( )
static

Definition at line 27 of file SobolReporter.C.

28 {
29  InputParameters params = GeneralReporter::validParams();
30  params.addClassDescription("Compute SOBOL statistics values of a given VectorPostprocessor or "
31  "Reporter objects and vectors.");
32  params.addParam<SamplerName>("sampler", "SobolSampler object.");
33 
34  params.addParam<std::vector<VectorPostprocessorName>>(
35  "vectorpostprocessors",
36  "List of VectorPostprocessor(s) to utilized for statistic computations.");
37 
38  params.addParam<std::vector<ReporterName>>(
39  "reporters", {}, "List of Reporter values to utilized for statistic computations.");
40 
41  params.addParam<std::vector<Real>>(
42  "ci_levels",
43  std::vector<Real>(),
44  "A vector of confidence levels to consider, values must be in (0, 1).");
45  params.addParam<unsigned int>(
46  "ci_replicates",
47  10000,
48  "The number of replicates to use when computing confidence level intervals.");
49  params.addParam<unsigned int>("ci_seed",
50  1,
51  "The random number generator seed used for creating replicates "
52  "while computing confidence level intervals.");
53  return params;
54 }
InputParameters::addParam
void addParam(const std::string &name, const std::initializer_list< typename T::value_type > &value, const std::string &doc_string)
GeneralReporter::validParams
static InputParameters validParams()
InputParameters::addClassDescription
void addClassDescription(const std::string &doc_string)

Member Data Documentation

◆ _ci_levels

const std::vector<Real>& SobolReporter::_ci_levels
private

CI levels to be computed.

Definition at line 49 of file SobolReporter.h.

Referenced by declareValueHelper(), SobolReporter(), and store().

◆ _ci_replicates

const unsigned int& SobolReporter::_ci_replicates
private

Number of CI replicates to use in Bootstrap methods.

Definition at line 52 of file SobolReporter.h.

Referenced by declareValueHelper(), and store().

◆ _ci_seed

const unsigned int& SobolReporter::_ci_seed
private

Random seed for producing CI replicates.

Definition at line 55 of file SobolReporter.h.

Referenced by declareValueHelper(), and store().

◆ _initialized

bool SobolReporter::_initialized
private

Whether or not initialize() has been called for reporter value declaration.

Definition at line 58 of file SobolReporter.h.

Referenced by initialize().

◆ _sobol_sampler

const SobolSampler& SobolReporter::_sobol_sampler
private

The sampler that generated the samples that produced results for the _results_vectors.

Definition at line 46 of file SobolReporter.h.

Referenced by declareValueHelper(), and store().

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