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 | List of all members
ParameterMeshOptimization Class Reference

Mesh-based parameter optimization. More...

#include <ParameterMeshOptimization.h>

Inheritance diagram for ParameterMeshOptimization:
[legend]

Public Types

typedef DataFileName DataFileParameterType
 

Public Member Functions

 ParameterMeshOptimization (const InputParameters &parameters)
 
virtual Real computeObjective () override
 Function to compute objective. More...
 
virtual void initialize () override
 
virtual void execute () override
 
virtual void finalize () override
 
virtual void computeGradient (libMesh::PetscVector< Number > &gradient) const
 Function to compute gradient. More...
 
void setInitialCondition (libMesh::PetscVector< Number > &param)
 Function to initialize petsc vectors from vpp data. More...
 
virtual void setMisfitToSimulatedValues ()
 Function to override misfit values with the simulated values from the matrix free hessian forward solve. More...
 
Real getUpperBound (dof_id_type i) const
 Upper and lower bounds for each parameter being controlled. More...
 
Real getLowerBound (dof_id_type i) const
 
virtual void computeEqualityConstraints (libMesh::PetscVector< Number > &eqs_constraints) const
 Function to compute the equality constraints. More...
 
virtual void computeInequalityConstraints (libMesh::PetscVector< Number > &ineqs_constraints) const
 Function to compute the inequality constraints. More...
 
virtual void computeEqualityGradient (libMesh::PetscMatrix< Number > &gradient) const
 Function to compute the gradient of the equality constraints/ This is the last call of the equality constraint gradient routine. More...
 
virtual void computeInequalityGradient (libMesh::PetscMatrix< Number > &gradient) const
 Function to compute the gradient of the inequality constraints/ This is the last call of the inequality constraint gradient routine. More...
 
dof_id_type getNumEqCons () const
 Function to get the total number of equalities. More...
 
dof_id_type getNumInEqCons () const
 Function to get the total number of inequalities. More...
 
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 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 store (nlohmann::json &json) 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 setICsandBounds () override
 Sets the initial conditions and bounds right before it is needed. More...
 
virtual dof_id_type getNumParams () const override
 Function to get the total number of parameters. More...
 
virtual void updateParameters (const libMesh::PetscVector< Number > &x)
 Function to set parameters. More...
 
std::vector< Real > parseInputData (std::string type, Real default_value, unsigned int param_id) const
 Function to to parse bounds and initial conditions from input file. More...
 
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

Real & _objective_val
 Reporter that will hold the objective value. More...
 
std::vector< dof_id_type > * _num_values_reporter
 
const std::vector< ReporterValueName > & _parameter_names
 Parameter names. More...
 
const unsigned int _nparams
 Number of parameter vectors. More...
 
std::vector< std::vector< Real > * > _parameters
 Parameter values declared as reporter data. More...
 
std::vector< std::vector< Real > * > _gradients
 Gradient values declared as reporter data. More...
 
const Real _tikhonov_coeff
 Tikhonov Coefficient for regularization. More...
 
const std::vector< ReporterValueName > * _equality_names
 Equality constraint names. More...
 
const unsigned int _n_eq_cons
 Number of equality constraint names. More...
 
std::vector< std::vector< Real > * > _eq_constraints
 Equality values declared as reporter data. More...
 
std::vector< std::vector< Real > * > _eq_gradients
 Gradient values declared as reporter data. More...
 
const std::vector< ReporterValueName > * _inequality_names
 Inequality constraint names. More...
 
const unsigned int _n_ineq_cons
 Number of inequality constraint names. More...
 
std::vector< std::vector< Real > * > _ineq_constraints
 Inequality values declared as reporter data. More...
 
std::vector< std::vector< Real > * > _ineq_gradients
 Gradient values declared as reporter data. More...
 
std::vector< Real > _lower_bounds
 Bounds of the parameters. More...
 
std::vector< Real > _upper_bounds
 
std::vector< dof_id_type > _nvalues
 Number of values for each parameter. More...
 
dof_id_type _ndof
 Total number of parameters. More...
 
SubProblem & _subproblem
 
FEProblemBase & _fe_problem
 
SystemBase & _sys
 
const THREAD_ID _tid
 
Assembly & _assembly
 
const Moose::CoordinateSystemType & _coord_sys
 
const bool _duplicate_initial_execution
 
std::set< std::string > _depend_uo
 
const bool & _enabled
 
MooseApp & _app
 
const std::string _type
 
const std::string _name
 
const InputParameters & _pars
 
Factory & _factory
 
ActionFactory & _action_factory
 
const ExecFlagEnum & _execute_enum
 
const ExecFlagType & _current_execute_flag
 
MooseApp & _restartable_app
 
const std::string _restartable_system_name
 
const THREAD_ID _restartable_tid
 
const bool _restartable_read_only
 
FEProblemBase & _mci_feproblem
 
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

std::vector< Real > parseExodusData (const std::vector< unsigned int > &exodus_timestep, const ParameterMesh &pmesh, const std::string &mesh_var_name, unsigned int ntimes) const
 Read initialization data off of parameter mesh and error check. More...
 

Detailed Description

Mesh-based parameter optimization.

Definition at line 19 of file ParameterMeshOptimization.h.

Constructor & Destructor Documentation

◆ ParameterMeshOptimization()

ParameterMeshOptimization::ParameterMeshOptimization ( const InputParameters &  parameters)

Definition at line 72 of file ParameterMeshOptimization.C.

73  : GeneralOptimization(parameters)
74 {
75 }
GeneralOptimization::GeneralOptimization
GeneralOptimization(const InputParameters &parameters)
Definition: GeneralOptimization.C:53
GeneralReporter::parameters
const InputParameters & parameters() const

Member Function Documentation

◆ computeEqualityConstraints()

void OptimizationReporterBase::computeEqualityConstraints ( libMesh::PetscVector< Number > &  eqs_constraints) const
virtualinherited

Function to compute the equality constraints.

This is the last call of the equality function routine.

Reimplemented in QuadraticMinimizeConstrained.

Definition at line 159 of file OptimizationReporterBase.C.

Referenced by OptimizeSolve::equalityFunctionWrapper().

161 {
162  OptUtils::copyReporterIntoPetscVector(_eq_constraints, eqs_constraints);
163 }
OptimizationReporterBase::_eq_constraints
std::vector< std::vector< Real > * > _eq_constraints
Equality values declared as reporter data.
Definition: OptimizationReporterBase.h:142
OptUtils::copyReporterIntoPetscVector
void copyReporterIntoPetscVector(const std::vector< std::vector< Real > *> reporterVectors, libMesh::PetscVector< Number > &x)
Definition: OptUtils.C:21

◆ computeEqualityGradient()

void OptimizationReporterBase::computeEqualityGradient ( libMesh::PetscMatrix< Number > &  gradient) const
virtualinherited

Function to compute the gradient of the equality constraints/ This is the last call of the equality constraint gradient routine.

Reimplemented in QuadraticMinimizeConstrained.

Definition at line 173 of file OptimizationReporterBase.C.

Referenced by OptimizeSolve::equalityGradientFunctionWrapper().

174 {
175  for (const auto & p : make_range(_n_eq_cons))
176  if (_eq_gradients[p]->size() != _ndof)
177  mooseError("The equality jacobian for parameter ",
178  _parameter_names[p],
179  " has changed, expected ",
180  _ndof,
181  " versus ",
182  _eq_gradients[p]->size(),
183  ".");
184  OptUtils::copyReporterIntoPetscMatrix(_eq_gradients, jacobian);
185 }
OptimizationReporterBase::_parameter_names
const std::vector< ReporterValueName > & _parameter_names
Parameter names.
Definition: OptimizationReporterBase.h:122
OptimizationReporterBase::_ndof
dof_id_type _ndof
Total number of parameters.
Definition: OptimizationReporterBase.h:162
OptimizationReporterBase::_eq_gradients
std::vector< std::vector< Real > * > _eq_gradients
Gradient values declared as reporter data.
Definition: OptimizationReporterBase.h:144
OptimizationReporterBase::_n_eq_cons
const unsigned int _n_eq_cons
Number of equality constraint names.
Definition: OptimizationReporterBase.h:140
make_range
IntRange< T > make_range(T beg, T end)
GeneralReporter::mooseError
void mooseError(Args &&... args) const
OptUtils::copyReporterIntoPetscMatrix
void copyReporterIntoPetscMatrix(const std::vector< std::vector< Real > *> reporterVectors, libMesh::PetscMatrix< Number > &x)
Definition: OptUtils.C:42

◆ computeGradient()

void OptimizationReporterBase::computeGradient ( libMesh::PetscVector< Number > &  gradient) const
virtualinherited

Function to compute gradient.

This is the last call of the gradient routine.

Reimplemented in QuadraticMinimizeConstrained, and QuadraticMinimize.

Definition at line 72 of file OptimizationReporterBase.C.

Referenced by OptimizeSolve::applyHessian(), and OptimizeSolve::gradientFunction().

73 {
74  for (const auto & param_group_id : make_range(_nparams))
75  {
76  if (_gradients[param_group_id]->size() != _nvalues[param_group_id])
77  mooseError("The gradient for parameter ",
78  _parameter_names[param_group_id],
79  " has changed, expected ",
80  _nvalues[param_group_id],
81  " versus ",
82  _gradients[param_group_id]->size(),
83  ".");
84 
85  if (_tikhonov_coeff > 0.0)
86  {
87  auto params = _parameters[param_group_id];
88  auto grads = _gradients[param_group_id];
89  for (const auto & param_id : make_range(_nvalues[param_group_id]))
90  (*grads)[param_id] += (*params)[param_id] * _tikhonov_coeff;
91  }
92  }
93 
94  OptUtils::copyReporterIntoPetscVector(_gradients, gradient);
95 }
OptimizationReporterBase::_parameter_names
const std::vector< ReporterValueName > & _parameter_names
Parameter names.
Definition: OptimizationReporterBase.h:122
OptimizationReporterBase::_nparams
const unsigned int _nparams
Number of parameter vectors.
Definition: OptimizationReporterBase.h:127
OptimizationReporterBase::_nvalues
std::vector< dof_id_type > _nvalues
Number of values for each parameter.
Definition: OptimizationReporterBase.h:160
OptimizationReporterBase::_parameters
std::vector< std::vector< Real > * > _parameters
Parameter values declared as reporter data.
Definition: OptimizationReporterBase.h:130
OptUtils::copyReporterIntoPetscVector
void copyReporterIntoPetscVector(const std::vector< std::vector< Real > *> reporterVectors, libMesh::PetscVector< Number > &x)
Definition: OptUtils.C:21
OptimizationReporterBase::_gradients
std::vector< std::vector< Real > * > _gradients
Gradient values declared as reporter data.
Definition: OptimizationReporterBase.h:132
make_range
IntRange< T > make_range(T beg, T end)
GeneralReporter::mooseError
void mooseError(Args &&... args) const
OptimizationReporterBase::_tikhonov_coeff
const Real _tikhonov_coeff
Tikhonov Coefficient for regularization.
Definition: OptimizationReporterBase.h:135

◆ computeInequalityConstraints()

void OptimizationReporterBase::computeInequalityConstraints ( libMesh::PetscVector< Number > &  ineqs_constraints) const
virtualinherited

Function to compute the inequality constraints.

This is the last call of the inequality function routine.

Definition at line 166 of file OptimizationReporterBase.C.

Referenced by OptimizeSolve::inequalityFunctionWrapper().

168 {
169  OptUtils::copyReporterIntoPetscVector(_ineq_constraints, ineqs_constraints);
170 }
OptimizationReporterBase::_ineq_constraints
std::vector< std::vector< Real > * > _ineq_constraints
Inequality values declared as reporter data.
Definition: OptimizationReporterBase.h:151
OptUtils::copyReporterIntoPetscVector
void copyReporterIntoPetscVector(const std::vector< std::vector< Real > *> reporterVectors, libMesh::PetscVector< Number > &x)
Definition: OptUtils.C:21

◆ computeInequalityGradient()

void OptimizationReporterBase::computeInequalityGradient ( libMesh::PetscMatrix< Number > &  gradient) const
virtualinherited

Function to compute the gradient of the inequality constraints/ This is the last call of the inequality constraint gradient routine.

Definition at line 188 of file OptimizationReporterBase.C.

Referenced by OptimizeSolve::inequalityGradientFunctionWrapper().

189 {
190  for (const auto & p : make_range(_n_ineq_cons))
191  if (_ineq_gradients[p]->size() != _ndof)
192  mooseError("The inequality jacobian for parameter ",
193  _parameter_names[p],
194  " has changed, expected ",
195  _ndof,
196  " versus ",
197  _ineq_gradients[p]->size(),
198  ".");
199  OptUtils::copyReporterIntoPetscMatrix(_ineq_gradients, jacobian);
200 }
OptimizationReporterBase::_parameter_names
const std::vector< ReporterValueName > & _parameter_names
Parameter names.
Definition: OptimizationReporterBase.h:122
OptimizationReporterBase::_n_ineq_cons
const unsigned int _n_ineq_cons
Number of inequality constraint names.
Definition: OptimizationReporterBase.h:149
OptimizationReporterBase::_ineq_gradients
std::vector< std::vector< Real > * > _ineq_gradients
Gradient values declared as reporter data.
Definition: OptimizationReporterBase.h:153
OptimizationReporterBase::_ndof
dof_id_type _ndof
Total number of parameters.
Definition: OptimizationReporterBase.h:162
make_range
IntRange< T > make_range(T beg, T end)
GeneralReporter::mooseError
void mooseError(Args &&... args) const
OptUtils::copyReporterIntoPetscMatrix
void copyReporterIntoPetscMatrix(const std::vector< std::vector< Real > *> reporterVectors, libMesh::PetscMatrix< Number > &x)
Definition: OptUtils.C:42

◆ computeObjective()

Real GeneralOptimization::computeObjective ( )
overridevirtualinherited

Function to compute objective.

This is the last function called in objective routine

Implements OptimizationReporterBase.

Definition at line 66 of file GeneralOptimization.C.

67 {
68  Real val = 0;
69  if (_tikhonov_coeff > 0.0)
70  {
71  Real param_norm_sqr = 0;
72  for (const auto & data : _parameters)
73  for (const auto & param_val : *data)
74  param_norm_sqr += param_val * param_val;
75  // We multiply by 0.5 to maintain backwards compatibility.
76  val += 0.5 * _tikhonov_coeff * param_norm_sqr;
77  }
78  return _objective_val + val;
79 }
GeneralOptimization::_objective_val
Real & _objective_val
Reporter that will hold the objective value.
Definition: GeneralOptimization.h:30
OptimizationReporterBase::_parameters
std::vector< std::vector< Real > * > _parameters
Parameter values declared as reporter data.
Definition: OptimizationReporterBase.h:130
Real
DIE A HORRIBLE DEATH HERE typedef LIBMESH_DEFAULT_SCALAR_TYPE Real
OptimizationReporterBase::_tikhonov_coeff
const Real _tikhonov_coeff
Tikhonov Coefficient for regularization.
Definition: OptimizationReporterBase.h:135

◆ execute()

virtual void OptimizationReporterBase::execute ( )
inlineoverridevirtualinherited

Implements GeneralReporter.

Reimplemented in OptimizationDataTempl< OptimizationReporterBase >.

Definition at line 32 of file OptimizationReporterBase.h.

32 {}

◆ finalize()

virtual void OptimizationReporterBase::finalize ( )
inlineoverridevirtualinherited

Implements GeneralReporter.

Reimplemented in OptimizationDataTempl< OptimizationReporterBase >.

Definition at line 33 of file OptimizationReporterBase.h.

33 {}

◆ getLowerBound()

Real OptimizationReporterBase::getLowerBound ( dof_id_type  i) const
inherited

Definition at line 112 of file OptimizationReporterBase.C.

Referenced by OptimizationReporterTest::initialSetup(), and OptimizeSolve::variableBounds().

113 {
114  return _lower_bounds[i];
115 }
OptimizationReporterBase::_lower_bounds
std::vector< Real > _lower_bounds
Bounds of the parameters.
Definition: OptimizationReporterBase.h:156

◆ getNumEqCons()

dof_id_type OptimizationReporterBase::getNumEqCons ( ) const
inlineinherited

Function to get the total number of equalities.

Returns
total number of equality constraints

Definition at line 100 of file OptimizationReporterBase.h.

Referenced by OptimizeSolve::taoALCreate(), and OptimizeSolve::taoALDestroy().

100 { return _n_eq_cons; }
OptimizationReporterBase::_n_eq_cons
const unsigned int _n_eq_cons
Number of equality constraint names.
Definition: OptimizationReporterBase.h:140

◆ getNumInEqCons()

dof_id_type OptimizationReporterBase::getNumInEqCons ( ) const
inlineinherited

Function to get the total number of inequalities.

Returns
total number of inequalities constraints

Definition at line 106 of file OptimizationReporterBase.h.

Referenced by OptimizeSolve::taoALCreate(), and OptimizeSolve::taoALDestroy().

106 { return _n_ineq_cons; }
OptimizationReporterBase::_n_ineq_cons
const unsigned int _n_ineq_cons
Number of inequality constraint names.
Definition: OptimizationReporterBase.h:149

◆ getNumParams()

dof_id_type GeneralOptimization::getNumParams ( ) const
overrideprotectedvirtualinherited

Function to get the total number of parameters.

Returns
total number of parameters

Reimplemented from OptimizationReporterBase.

Definition at line 82 of file GeneralOptimization.C.

83 {
84  if (_ndof == 0)
85  mooseError(
86  "The number of parameters you have is zero and this shouldn't happen. Make sure you are "
87  "running your forward problem on \'INITIAL\' if you are using a reporter transfer to "
88  "supply "
89  "that information.");
90 
91  return _ndof;
92 }
OptimizationReporterBase::_ndof
dof_id_type _ndof
Total number of parameters.
Definition: OptimizationReporterBase.h:162
GeneralReporter::mooseError
void mooseError(Args &&... args) const

◆ getUpperBound()

Real OptimizationReporterBase::getUpperBound ( dof_id_type  i) const
inherited

Upper and lower bounds for each parameter being controlled.

Parameters
iParameter index
Returns
The upper/lower bound for parameter i

Definition at line 118 of file OptimizationReporterBase.C.

Referenced by OptimizationReporterTest::initialSetup(), and OptimizeSolve::variableBounds().

119 {
120  return _upper_bounds[i];
121 }

◆ initialize()

virtual void OptimizationReporterBase::initialize ( )
inlineoverridevirtualinherited

Implements GeneralReporter.

Reimplemented in OptimizationDataTempl< OptimizationReporterBase >.

Definition at line 31 of file OptimizationReporterBase.h.

31 {}

◆ parseExodusData()

std::vector< Real > ParameterMeshOptimization::parseExodusData ( const std::vector< unsigned int > &  exodus_timestep,
const ParameterMesh &  pmesh,
const std::string &  mesh_var_name,
unsigned int  ntimes 
) const
private

Read initialization data off of parameter mesh and error check.

Returns
values read from mesh

Definition at line 78 of file ParameterMeshOptimization.C.

Referenced by setICsandBounds().

82 {
83  unsigned int num_cont_params = pmesh.size() * ntimes;
84  std::vector<Real> parsed_data;
85  // read from mesh
86 
87  for (auto const & step : exodus_timestep)
88  {
89  std::vector<Real> data = pmesh.getParameterValues(mesh_var_name, step);
90  parsed_data.insert(parsed_data.end(), data.begin(), data.end());
91  }
92  if (parsed_data.size() != num_cont_params)
93  mooseError("Number of parameters assigned by ",
94  mesh_var_name,
95  " is not equal to the number of parameters on the mesh. Mesh contains ",
96  num_cont_params,
97  " parameters and ",
98  mesh_var_name,
99  " assigned ",
100  parsed_data.size(),
101  " parameters.");
102 
103  return parsed_data;
104 }
ParameterMesh::size
dof_id_type size() const
Definition: ParameterMesh.h:54
GeneralReporter::mooseError
void mooseError(Args &&... args) const
ParameterMesh::getParameterValues
std::vector< Real > getParameterValues(std::string var_name, unsigned int timestep) const
Initializes parameter data and sets bounds in the main optmiization application getParameterValues is...
Definition: ParameterMesh.C:211

◆ parseInputData()

std::vector< Real > OptimizationReporterBase::parseInputData ( std::string  type,
Real  default_value,
unsigned int  param_id 
) const
protectedinherited

Function to to parse bounds and initial conditions from input file.

Definition at line 124 of file OptimizationReporterBase.C.

Referenced by setICsandBounds(), OptimizationReporter::setICsandBounds(), and GeneralOptimization::setICsandBounds().

127 {
128  // fill with default values
129  std::vector<Real> parsed_data_id(_nvalues[param_id], default_value);
130  if (isParamValid(type))
131  {
132  std::vector<std::vector<Real>> parsed_data(getParam<std::vector<std::vector<Real>>>(type));
133  parsed_data_id.assign(parsed_data[param_id].begin(), parsed_data[param_id].end());
134  if (parsed_data.size() != _nvalues.size())
135  paramError(type,
136  "There must be a vector of ",
137  type,
138  " per parameter group. The ",
139  type,
140  " input format is std::vector<std::vector<Real>> so each vector should be "
141  "seperated by \";\" even if it is a single value per group for a constant ",
142  type,
143  ".");
144  // The case when the initial condition is constant for each parameter group
145  if (parsed_data[param_id].size() == 1)
146  parsed_data_id.assign(_nvalues[param_id], parsed_data[param_id][0]);
147  else if (parsed_data[param_id].size() != _nvalues[param_id])
148  paramError(type,
149  "When ",
150  type,
151  " are given in input file, there must either be a single value per parameter "
152  "group or a value for every parameter in the group.");
153  }
154 
155  return parsed_data_id;
156 }
GeneralReporter::isParamValid
bool isParamValid(const std::string &name) const
OptimizationReporterBase::_nvalues
std::vector< dof_id_type > _nvalues
Number of values for each parameter.
Definition: OptimizationReporterBase.h:160
GeneralReporter::type
const std::string & type() const
GeneralReporter::getParam
const T & getParam(const std::string &name) const
GeneralReporter::paramError
void paramError(const std::string &param, Args... args) const

◆ setICsandBounds()

void ParameterMeshOptimization::setICsandBounds ( )
overrideprotectedvirtual

Sets the initial conditions and bounds right before it is needed.

Reimplemented from GeneralOptimization.

Definition at line 107 of file ParameterMeshOptimization.C.

108 {
109  if ((isParamValid("num_values_name") || isParamValid("num_values")))
110  paramError("num_values_name or num_values should not be used with ParameterMeshOptimization. "
111  "Instead the number of dofs is set by the parameter meshes.");
112 
113  _nvalues.resize(_nparams, 0);
114  // Fill the mesh information
115  const auto & meshes = getParam<std::vector<FileName>>("parameter_meshes");
116  const auto & families = getParam<MultiMooseEnum>("parameter_families");
117  const auto & orders = getParam<MultiMooseEnum>("parameter_orders");
118  const auto & ntimes = getParam<unsigned int>("num_parameter_times");
119 
120  // Fill exodus parameter bounds and IC information
121  std::vector<std::string> initial_condition_mesh_variable;
122  std::vector<std::string> lower_bound_mesh_variable;
123  std::vector<std::string> upper_bound_mesh_variable;
124  if (isParamValid("initial_condition_mesh_variable"))
125  initial_condition_mesh_variable =
126  getParam<std::vector<std::string>>("initial_condition_mesh_variable");
127  if (isParamValid("lower_bound_mesh_variable"))
128  lower_bound_mesh_variable = getParam<std::vector<std::string>>("lower_bound_mesh_variable");
129  if (isParamValid("upper_bound_mesh_variable"))
130  upper_bound_mesh_variable = getParam<std::vector<std::string>>("upper_bound_mesh_variable");
131 
132  std::vector<unsigned int> exodus_timestep;
133  if (isParamValid("exodus_timesteps_for_parameter_mesh_variable"))
134  exodus_timestep =
135  getParam<std::vector<unsigned int>>("exodus_timesteps_for_parameter_mesh_variable");
136  else // get last timestep in file
137  exodus_timestep = {std::numeric_limits<unsigned int>::max()};
138 
139  // now do a bunch of error checking
140  // Size checks for data
141  if (meshes.size() != _nparams)
142  paramError("parameter_meshes",
143  "There must be a mesh associated with each group of parameters.");
144  if (families.size() > 1 && families.size() != _nparams)
145  paramError("parameter_families",
146  "There must be a family associated with each group of parameters.");
147  if (orders.size() > 1 && orders.size() != _nparams)
148  paramError("parameter_orders",
149  "There must be an order associated with each group of parameters.");
150 
151  // error checking that initial conditions and bounds are only read from a single location
152  if (isParamValid("initial_condition_mesh_variable") && isParamValid("initial_condition"))
153  paramError("initial_condition_mesh_variable",
154  "Initial conditions for all parameter groups can only be defined by "
155  "initial_condition_mesh_variable or "
156  "initial_condition but not both.");
157  else if (isParamValid("lower_bound_mesh_variable") && isParamValid("lower_bounds"))
158  paramError(
159  "lower_bound_mesh_variable",
160  "Lower bounds for all parameter groups can only be defined by lower_bound_mesh_variable or "
161  "lower_bounds but not both.");
162  else if (isParamValid("upper_bound_mesh_variable") && isParamValid("upper_bounds"))
163  paramError(
164  "upper_bound_mesh_variable",
165  "Upper bounds for all parameter groups can only be defined by upper_bound_mesh_variable or "
166  "upper_bounds but not both.");
167 
168  // Make sure they did not specify too many timesteps
169  if (isParamValid("exodus_timesteps_for_parameter_mesh_variable") &&
170  (!isParamValid("lower_bound_mesh_variable") + !isParamValid("upper_bound_mesh_variable") +
171  !isParamValid("initial_condition_mesh_variable") ==
172  3))
173  paramError("\"exodus_timesteps_for_parameter_mesh_variable\" should only be specified if "
174  "reading values from a mesh.");
175  else if (exodus_timestep.size() != ntimes && exodus_timestep.size() != 1)
176  paramError("exodus_timesteps_for_parameter_mesh_variable",
177  "Number of timesteps to read mesh data specified by "
178  "\"exodus_timesteps_for_parameter_mesh_variable\" incorrect. "
179  "\"exodus_timesteps_for_parameter_mesh_variable\" can specify a single timestep or "
180  "\"num_parameter_times\" timesteps.");
181 
182  _ndof = 0;
183  for (const auto & param_id : make_range(_nparams))
184  {
185  // store off all the variable names that you might want to read from the mesh
186  std::vector<std::string> var_names;
187  if (isParamValid("initial_condition_mesh_variable"))
188  var_names.push_back(initial_condition_mesh_variable[param_id]);
189  if (isParamValid("lower_bound_mesh_variable"))
190  var_names.push_back(lower_bound_mesh_variable[param_id]);
191  if (isParamValid("upper_bound_mesh_variable"))
192  var_names.push_back(upper_bound_mesh_variable[param_id]);
193 
194  const std::string family = families.size() > 1 ? families[param_id] : families[0];
195  const std::string order = orders.size() > 1 ? orders[param_id] : orders[0];
196  const FEType fetype(Utility::string_to_enum<Order>(order),
197  Utility::string_to_enum<FEFamily>(family));
198 
199  ParameterMesh pmesh(fetype, meshes[param_id], var_names);
200  _nvalues[param_id] = pmesh.size() * ntimes;
201  _ndof += _nvalues[param_id];
202 
203  // read and assign initial conditions
204  std::vector<Real> initial_condition;
205  if (isParamValid("initial_condition_mesh_variable"))
206  initial_condition = parseExodusData(
207  exodus_timestep, pmesh, initial_condition_mesh_variable[param_id], ntimes);
208  else
209  initial_condition = parseInputData("initial_condition", 0, param_id);
210 
211  _parameters[param_id]->assign(initial_condition.begin(), initial_condition.end());
212 
213  // read and assign lower bound
214  std::vector<Real> lower_bound;
215  if (isParamValid("lower_bound_mesh_variable"))
216  lower_bound =
217  parseExodusData(exodus_timestep, pmesh, lower_bound_mesh_variable[param_id], ntimes);
218  else
219  lower_bound = parseInputData("lower_bounds", std::numeric_limits<Real>::lowest(), param_id);
220 
221  _lower_bounds.insert(_lower_bounds.end(), lower_bound.begin(), lower_bound.end());
222 
223  // read and assign upper bound
224  std::vector<Real> upper_bound;
225  if (isParamValid("upper_bound_mesh_variable"))
226  upper_bound =
227  parseExodusData(exodus_timestep, pmesh, upper_bound_mesh_variable[param_id], ntimes);
228  else
229  upper_bound = parseInputData("upper_bounds", std::numeric_limits<Real>::max(), param_id);
230 
231  _upper_bounds.insert(_upper_bounds.end(), upper_bound.begin(), upper_bound.end());
232 
233  // resize gradient vector to be filled later
234  _gradients[param_id]->resize(_nvalues[param_id]);
235  }
236 }
ParameterMeshOptimization::parseExodusData
std::vector< Real > parseExodusData(const std::vector< unsigned int > &exodus_timestep, const ParameterMesh &pmesh, const std::string &mesh_var_name, unsigned int ntimes) const
Read initialization data off of parameter mesh and error check.
Definition: ParameterMeshOptimization.C:78
ParameterMesh
Utility class to use an Exodus mesh to define controllable parameters for optimization problems This ...
Definition: ParameterMesh.h:42
OptimizationReporterBase::_ndof
dof_id_type _ndof
Total number of parameters.
Definition: OptimizationReporterBase.h:162
OptimizationReporterBase::_nparams
const unsigned int _nparams
Number of parameter vectors.
Definition: OptimizationReporterBase.h:127
GeneralReporter::isParamValid
bool isParamValid(const std::string &name) const
OptimizationReporterBase::_nvalues
std::vector< dof_id_type > _nvalues
Number of values for each parameter.
Definition: OptimizationReporterBase.h:160
initial_condition
Number initial_condition(const Point &p, const Parameters &parameters, const std::string &, const std::string &)
GeneralReporter::getParam
const T & getParam(const std::string &name) const
OptimizationReporterBase::parseInputData
std::vector< Real > parseInputData(std::string type, Real default_value, unsigned int param_id) const
Function to to parse bounds and initial conditions from input file.
Definition: OptimizationReporterBase.C:124
OptimizationReporterBase::_lower_bounds
std::vector< Real > _lower_bounds
Bounds of the parameters.
Definition: OptimizationReporterBase.h:156
GeneralReporter::paramError
void paramError(const std::string &param, Args... args) const
OptimizationReporterBase::_parameters
std::vector< std::vector< Real > * > _parameters
Parameter values declared as reporter data.
Definition: OptimizationReporterBase.h:130
OptimizationReporterBase::_gradients
std::vector< std::vector< Real > * > _gradients
Gradient values declared as reporter data.
Definition: OptimizationReporterBase.h:132
make_range
IntRange< T > make_range(T beg, T end)

◆ setInitialCondition()

void OptimizationReporterBase::setInitialCondition ( libMesh::PetscVector< Number > &  param)
inherited

Function to initialize petsc vectors from vpp data.

Definition at line 98 of file OptimizationReporterBase.C.

Referenced by OptimizationReporterTest::initialSetup(), and OptimizeSolve::solve().

99 {
100  setICsandBounds();
101  x.init(getNumParams());
102  OptUtils::copyReporterIntoPetscVector(_parameters, x);
103 }
OptimizationReporterBase::setICsandBounds
virtual void setICsandBounds()
Sets the initial conditions and bounds right before it is needed.
Definition: OptimizationReporterBase.h:122
OptimizationReporterBase::getNumParams
virtual dof_id_type getNumParams() const
Function to get the total number of parameters.
Definition: OptimizationReporterBase.h:70
x
const std::vector< double > x
Definition: EquilibriumConstantFitTest.C:17
OptimizationReporterBase::_parameters
std::vector< std::vector< Real > * > _parameters
Parameter values declared as reporter data.
Definition: OptimizationReporterBase.h:130
OptUtils::copyReporterIntoPetscVector
void copyReporterIntoPetscVector(const std::vector< std::vector< Real > *> reporterVectors, libMesh::PetscVector< Number > &x)
Definition: OptUtils.C:21

◆ setMisfitToSimulatedValues()

virtual void OptimizationReporterBase::setMisfitToSimulatedValues ( )
inlinevirtualinherited

Function to override misfit values with the simulated values from the matrix free hessian forward solve.

Reimplemented in OptimizationReporter.

Definition at line 55 of file OptimizationReporterBase.h.

Referenced by OptimizeSolve::applyHessian().

55 {};

◆ updateParameters()

void OptimizationReporterBase::updateParameters ( const libMesh::PetscVector< Number > &  x)
protectedvirtualinherited

Function to set parameters.

This is the first function called in objective/gradient/hessian routine

Definition at line 106 of file OptimizationReporterBase.C.

Referenced by OptimizeSolve::applyHessian(), OptimizationReporterTest::execute(), OptimizeSolve::gradientFunction(), and OptimizeSolve::objectiveFunction().

107 {
108  OptUtils::copyPetscVectorIntoReporter(x, _parameters);
109 }
OptUtils::copyPetscVectorIntoReporter
void copyPetscVectorIntoReporter(const libMesh::PetscVector< Number > &x, std::vector< std::vector< Real > *> reporterVectors)
Definition: OptUtils.C:33
x
const std::vector< double > x
Definition: EquilibriumConstantFitTest.C:17
OptimizationReporterBase::_parameters
std::vector< std::vector< Real > * > _parameters
Parameter values declared as reporter data.
Definition: OptimizationReporterBase.h:130

◆ validParams()

InputParameters ParameterMeshOptimization::validParams ( )
static

Definition at line 21 of file ParameterMeshOptimization.C.

22 {
23  InputParameters params = GeneralOptimization::validParams();
24 
25  params.addClassDescription(
26  "Computes objective function, gradient and contains reporters for communicating between "
27  "optimizeSolve and subapps using mesh-based parameter definition.");
28 
29  params.addRequiredParam<std::vector<FileName>>(
30  "parameter_meshes", "Exodus file containing meshes describing parameters.");
31 
32  const auto family = AddVariableAction::getNonlinearVariableFamilies();
33  MultiMooseEnum families(family.getRawNames(), "LAGRANGE");
34  params.addParam<MultiMooseEnum>(
35  "parameter_families",
36  families,
37  "Specifies the family of FE shape functions for each group of parameters. If a single value "
38  "is "
39  "specified, then that value is used for all groups of parameters.");
40  const auto order = AddVariableAction::getNonlinearVariableOrders();
41  MultiMooseEnum orders(order.getRawNames(), "FIRST");
42  params.addParam<MultiMooseEnum>(
43  "parameter_orders",
44  orders,
45  "Specifies the order of FE shape functions for each group of parameters. If a single value "
46  "is "
47  "specified, then that value is used for all groups of parameters.");
48 
49  params.addParam<unsigned int>(
50  "num_parameter_times", 1, "The number of time points the parameters represent.");
51 
52  params.addParam<std::vector<std::string>>(
53  "initial_condition_mesh_variable",
54  "Name of variable on parameter mesh to use as initial condition.");
55  params.addParam<std::vector<std::string>>(
56  "lower_bound_mesh_variable", "Name of variable on parameter mesh to use as lower bound.");
57  params.addParam<std::vector<std::string>>(
58  "upper_bound_mesh_variable", "Name of variable on parameter mesh to use as upper bound.");
59  params.addParam<std::vector<unsigned int>>(
60  "exodus_timesteps_for_parameter_mesh_variable",
61  "Timesteps to read all parameter group bounds and initial conditions from Exodus mesh. The "
62  "options are to give no timestep, a single timestep or \"num_parameter_times\" timesteps. "
63  "No timestep results in the final timestep from the mesh being used. A single timestep "
64  "results in values at that timestep being used for all timesteps. \"num_parameter_times\" "
65  "timesteps results in values from the mesh at those steps being used. The same timesteps "
66  "are used for all parameter groups and all meshes, the capability to define different "
67  "timesteps for different meshes is not supported.");
68 
69  return params;
70 }
InputParameters::addParam
void addParam(const std::string &name, const std::initializer_list< typename T::value_type > &value, const std::string &doc_string)
MultiMooseEnum::getRawNames
std::string getRawNames() const
InputParameters::addRequiredParam
void addRequiredParam(const std::string &name, const std::string &doc_string)
AddVariableAction::getNonlinearVariableFamilies
static MooseEnum getNonlinearVariableFamilies()
AddVariableAction::getNonlinearVariableOrders
static MooseEnum getNonlinearVariableOrders()
GeneralOptimization::validParams
static InputParameters validParams()
Definition: GeneralOptimization.C:19
InputParameters::addClassDescription
void addClassDescription(const std::string &doc_string)

Member Data Documentation

◆ _eq_constraints

std::vector<std::vector<Real> *> OptimizationReporterBase::_eq_constraints
protectedinherited

Equality values declared as reporter data.

Definition at line 142 of file OptimizationReporterBase.h.

Referenced by OptimizationReporterBase::computeEqualityConstraints(), and OptimizationReporterBase::OptimizationReporterBase().

◆ _eq_gradients

std::vector<std::vector<Real> *> OptimizationReporterBase::_eq_gradients
protectedinherited

Gradient values declared as reporter data.

Definition at line 144 of file OptimizationReporterBase.h.

Referenced by OptimizationReporterBase::computeEqualityGradient(), and OptimizationReporterBase::OptimizationReporterBase().

◆ _equality_names

const std::vector<ReporterValueName>* OptimizationReporterBase::_equality_names
protectedinherited

Equality constraint names.

Definition at line 138 of file OptimizationReporterBase.h.

Referenced by OptimizationReporterBase::OptimizationReporterBase().

◆ _gradients

std::vector<std::vector<Real> *> OptimizationReporterBase::_gradients
protectedinherited

Gradient values declared as reporter data.

Definition at line 132 of file OptimizationReporterBase.h.

Referenced by OptimizationReporterBase::computeGradient(), OptimizationReporterBase::OptimizationReporterBase(), setICsandBounds(), OptimizationReporter::setICsandBounds(), and GeneralOptimization::setICsandBounds().

◆ _ineq_constraints

std::vector<std::vector<Real> *> OptimizationReporterBase::_ineq_constraints
protectedinherited

Inequality values declared as reporter data.

Definition at line 151 of file OptimizationReporterBase.h.

Referenced by OptimizationReporterBase::computeInequalityConstraints(), and OptimizationReporterBase::OptimizationReporterBase().

◆ _ineq_gradients

std::vector<std::vector<Real> *> OptimizationReporterBase::_ineq_gradients
protectedinherited

Gradient values declared as reporter data.

Definition at line 153 of file OptimizationReporterBase.h.

Referenced by OptimizationReporterBase::computeInequalityGradient(), and OptimizationReporterBase::OptimizationReporterBase().

◆ _inequality_names

const std::vector<ReporterValueName>* OptimizationReporterBase::_inequality_names
protectedinherited

Inequality constraint names.

Definition at line 147 of file OptimizationReporterBase.h.

Referenced by OptimizationReporterBase::OptimizationReporterBase().

◆ _lower_bounds

std::vector<Real> OptimizationReporterBase::_lower_bounds
protectedinherited

Bounds of the parameters.

Definition at line 156 of file OptimizationReporterBase.h.

Referenced by OptimizationReporterBase::getLowerBound(), setICsandBounds(), OptimizationReporter::setICsandBounds(), and GeneralOptimization::setICsandBounds().

◆ _n_eq_cons

const unsigned int OptimizationReporterBase::_n_eq_cons
protectedinherited

Number of equality constraint names.

Definition at line 140 of file OptimizationReporterBase.h.

Referenced by QuadraticMinimizeConstrained::computeEqualityGradient(), OptimizationReporterBase::computeEqualityGradient(), OptimizationReporterBase::getNumEqCons(), and OptimizationReporterBase::OptimizationReporterBase().

◆ _n_ineq_cons

const unsigned int OptimizationReporterBase::_n_ineq_cons
protectedinherited

Number of inequality constraint names.

Definition at line 149 of file OptimizationReporterBase.h.

Referenced by OptimizationReporterBase::computeInequalityGradient(), OptimizationReporterBase::getNumInEqCons(), and OptimizationReporterBase::OptimizationReporterBase().

◆ _ndof

dof_id_type OptimizationReporterBase::_ndof
protectedinherited

Total number of parameters.

Definition at line 162 of file OptimizationReporterBase.h.

Referenced by OptimizationReporterBase::computeEqualityGradient(), OptimizationReporterBase::computeInequalityGradient(), GeneralOptimization::getNumParams(), OptimizationReporterBase::getNumParams(), QuadraticMinimize::QuadraticMinimize(), setICsandBounds(), OptimizationReporter::setICsandBounds(), and GeneralOptimization::setICsandBounds().

◆ _nparams

const unsigned int OptimizationReporterBase::_nparams
protectedinherited

Number of parameter vectors.

Definition at line 127 of file OptimizationReporterBase.h.

Referenced by OptimizationReporterBase::computeGradient(), OptimizationReporterBase::OptimizationReporterBase(), setICsandBounds(), OptimizationReporter::setICsandBounds(), and GeneralOptimization::setICsandBounds().

◆ _num_values_reporter

std::vector<dof_id_type>* GeneralOptimization::_num_values_reporter
protectedinherited

Definition at line 32 of file GeneralOptimization.h.

Referenced by GeneralOptimization::setICsandBounds().

◆ _nvalues

std::vector<dof_id_type> OptimizationReporterBase::_nvalues
protectedinherited

Number of values for each parameter.

Definition at line 160 of file OptimizationReporterBase.h.

Referenced by OptimizationReporterBase::computeGradient(), OptimizationReporterBase::parseInputData(), setICsandBounds(), OptimizationReporter::setICsandBounds(), and GeneralOptimization::setICsandBounds().

◆ _objective_val

Real& GeneralOptimization::_objective_val
protectedinherited

Reporter that will hold the objective value.

Definition at line 30 of file GeneralOptimization.h.

Referenced by GeneralOptimization::computeObjective().

◆ _parameter_names

const std::vector<ReporterValueName>& OptimizationReporterBase::_parameter_names
protectedinherited

Parameter names.

Definition at line 122 of file OptimizationReporterBase.h.

Referenced by OptimizationReporterBase::computeEqualityGradient(), OptimizationReporterBase::computeGradient(), OptimizationReporterBase::computeInequalityGradient(), OptimizationReporterBase::OptimizationReporterBase(), OptimizationReporter::setICsandBounds(), and GeneralOptimization::setICsandBounds().

◆ _parameters

std::vector<std::vector<Real> *> OptimizationReporterBase::_parameters
protectedinherited

Parameter values declared as reporter data.

Definition at line 130 of file OptimizationReporterBase.h.

Referenced by QuadraticMinimizeConstrained::computeEqualityConstraints(), QuadraticMinimizeConstrained::computeEqualityGradient(), QuadraticMinimize::computeGradient(), QuadraticMinimizeConstrained::computeGradient(), OptimizationReporterBase::computeGradient(), QuadraticMinimize::computeObjective(), OptimizationReporter::computeObjective(), GeneralOptimization::computeObjective(), QuadraticMinimizeConstrained::computeObjective(), OptimizationReporterBase::OptimizationReporterBase(), setICsandBounds(), OptimizationReporter::setICsandBounds(), GeneralOptimization::setICsandBounds(), OptimizationReporterBase::setInitialCondition(), and OptimizationReporterBase::updateParameters().

◆ _tikhonov_coeff

const Real OptimizationReporterBase::_tikhonov_coeff
protectedinherited

Tikhonov Coefficient for regularization.

Definition at line 135 of file OptimizationReporterBase.h.

Referenced by OptimizationReporterBase::computeGradient(), OptimizationReporter::computeObjective(), and GeneralOptimization::computeObjective().

◆ _upper_bounds

std::vector<Real> OptimizationReporterBase::_upper_bounds
protectedinherited

Definition at line 157 of file OptimizationReporterBase.h.

Referenced by OptimizationReporterBase::getUpperBound(), setICsandBounds(), OptimizationReporter::setICsandBounds(), and GeneralOptimization::setICsandBounds().

The documentation for this class was generated from the following files:
Generated on Thu Jul 17 2025 01:49:58 for https://mooseframework.inl.gov by   doxygen 1.8.14