This form function represents a constrained quadratic objective function: minimize f(x) = val + {i=1}^N (x_i - a_i)^2 Subject to the equality constraint: c_e(x) = {i=1}^N x_i - c_{total} = 0 where val is the input objective value, a_i is the input solution, and c_total is the equality sum constant. More...

#include <QuadraticMinimizeConstrained.h>

Inheritance diagram for QuadraticMinimizeConstrained:

[legend]

Public Types
typedef DataFileName	DataFileParameterType

Public Member Functions
	QuadraticMinimizeConstrained (const InputParameters &parameters)

virtual Real	computeObjective () override
	Function to compute objective. More...

virtual void	computeGradient (libMesh::PetscVector< Number > &gradient) const override
	Function to compute gradient. More...

virtual void	computeEqualityConstraints (libMesh::PetscVector< Number > &eqs_constraints) const override
	Function to compute the equality constraints. More...

virtual void	computeEqualityGradient (libMesh::PetscMatrix< Number > &gradient) const override
	Function to compute the gradient of the equality constraints/ This is the last call of the equality constraint gradient routine. More...

virtual void	setMisfitToSimulatedValues () override
	Function to override misfit values with the simulated values from the matrix free hessian forward solve. More...

virtual void	initialize () override

virtual void	execute () override

virtual void	finalize () override

void	computeMisfit ()
	Compute misfit vectors from the simulations and measurement values. More...

Real	computeMisfitValue ()
	Compute half the sum of the misfit (squared) values. More...

void	setInitialCondition (libMesh::PetscVector< Number > &param)
	Function to initialize petsc vectors from vpp data. 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 dof_id_type	getNumParams () const
	Function to get the total number of parameters. More...

virtual void	computeInequalityConstraints (libMesh::PetscVector< Number > &ineqs_constraints) const
	Function to compute the inequality constraints. 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 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
std::vector< Real > &	_simulation_values
	simulated values at measurement xyzt More...

std::vector< Real > &	_misfit_values
	difference between simulation and measurement values at measurement xyzt More...

Real &	_objective_val
	Reporter value that will hold the objective value. More...

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


std::vector< Real > &	_measurement_xcoord

std::vector< Real > &	_measurement_ycoord

std::vector< Real > &	_measurement_zcoord

std::vector< Real > &	_measurement_time

std::vector< Real > &	_measurement_values

Static Protected Attributes
static const std::string	_interpolated_old

static const std::string	_interpolated_older

Private Attributes
const Real &	_result
	Input objective function value. More...

const std::vector< Real > &	_solution
	Desired solution to optimize to. More...

const Real	_eq_constraint

Detailed Description

This form function represents a constrained quadratic objective function: minimize f(x) = val + {i=1}^N (x_i - a_i)^2 Subject to the equality constraint: c_e(x) = {i=1}^N x_i - c_{total} = 0 where val is the input objective value, a_i is the input solution, and c_total is the equality sum constant.

Definition at line 22 of file QuadraticMinimizeConstrained.h.

Constructor & Destructor Documentation

◆ QuadraticMinimizeConstrained()

QuadraticMinimizeConstrained::QuadraticMinimizeConstrained ( const InputParameters & parameters )

Definition at line 24 of file QuadraticMinimizeConstrained.C.

   : QuadraticMinimize(parameters),
     _result(getParam<Real>("objective")),
     _solution(getParam<std::vector<Real>>("solution")),
     _eq_constraint(getParam<Real>("solution_sum_equality"))
 {
 }

Member Function Documentation

◆ computeEqualityConstraints()

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

overridevirtual

Function to compute the equality constraints.

This is the last call of the equality function routine.

Reimplemented from OptimizationReporterBase.

Definition at line 60 of file QuadraticMinimizeConstrained.C.

 {
 
   unsigned int i = 0;
   for (const auto & param : _parameters)
   {
     const Real equality_constraint = std::accumulate(param->begin(), param->end(), 0.0);
     eqs_constraints.set(i++, equality_constraint - _eq_constraint);
   }
   eqs_constraints.close();
 }

◆ computeEqualityGradient()

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

overridevirtual

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

Reimplemented from OptimizationReporterBase.

Definition at line 73 of file QuadraticMinimizeConstrained.C.

 {
   gradient.zero();
   for (const auto i : make_range(_n_eq_cons))
     for (const auto j : index_range(*_parameters[0]))
       gradient.set(i, j, 1);
 
   gradient.close();
 }

◆ computeGradient()

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

overridevirtual

Function to compute gradient.

This is the last call of the gradient routine.

Reimplemented from QuadraticMinimize.

Definition at line 48 of file QuadraticMinimizeConstrained.C.

 {
   unsigned int i = 0;
   for (const auto & param : _parameters)
     for (const auto & val : *param)
     {
       gradient.set(i, 2.0 * (val - _solution[i]));
       i++;
     }
   gradient.close();
 }

◆ 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().

 {
   OptUtils::copyReporterIntoPetscVector(_ineq_constraints, ineqs_constraints);
 }

◆ 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().

 {
   for (const auto & p : make_range(_n_ineq_cons))
     if (_ineq_gradients[p]->size() != _ndof)
       mooseError("The inequality jacobian for parameter ",
                  _parameter_names[p],
                  " has changed, expected ",
                  _ndof,
                  " versus ",
                  _ineq_gradients[p]->size(),
                  ".");
   OptUtils::copyReporterIntoPetscMatrix(_ineq_gradients, jacobian);
 }

◆ computeMisfit()

void OptimizationDataTempl< OptimizationReporterBase >::computeMisfit ( )

inherited

Compute misfit vectors from the simulations and measurement values.

Definition at line 143 of file OptimizationData.C.

 {
   if (_var_vec.empty())
     return;
 
   // FIXME: This is basically copied from PointValue.
   // Implementation can be improved using the functionality in PointSamplerBase,
   // but this will require changes in MOOSE to work for reporters.
 
   const std::size_t nvals = _measurement_values.size();
   _simulation_values.resize(nvals, 0.0);
   _misfit_values.resize(nvals);
 
   errorCheckDataSize();
   for (const auto var_index : make_range(_var_vec.size()))
   {
     const auto & sys = _var_vec[var_index]->sys().system();
     const auto vnum = _var_vec[var_index]->number();
     // A weight reporter is not automatically created and for those cases, we
     // set the weight to 1.
     std::vector<Real> weights(_variable_weights.empty()
                                   ? std::vector<Real>(_measurement_xcoord.size(), 1)
                                   : (*_variable_weights[var_index]));
     for (const auto & i : make_range(nvals))
     {
       if (MooseUtils::absoluteFuzzyEqual(this->_t, _measurement_time[i]))
       {
         const Point point(_measurement_xcoord[i], _measurement_ycoord[i], _measurement_zcoord[i]);
         const Real val = sys.point_value(vnum, point, false);
 
         _simulation_values[i] += weights[i] * val;
         _misfit_values[i] = _simulation_values[i] - _measurement_values[i];
       }
     }
   }
 }

◆ computeMisfitValue()

Real OptimizationDataTempl< OptimizationReporterBase >::computeMisfitValue ( )

inherited

Compute half the sum of the misfit (squared) values.

Returns: 1/2 of the sum of the misfit values.

Definition at line 327 of file OptimizationData.C.

 {
   Real val = 0.0;
   for (auto & misfit : _misfit_values)
     val += misfit * misfit;
 
   return val * 0.5;
 }

◆ computeObjective()

Real QuadraticMinimizeConstrained::computeObjective ( )

overridevirtual

Function to compute objective.

This is the last function called in objective routine

Reimplemented from QuadraticMinimize.

Definition at line 33 of file QuadraticMinimizeConstrained.C.

 {
   Real obj = _result;
   unsigned int i = 0;
   for (const auto & param : _parameters)
     for (const auto & val : *param)
     {
       Real tmp = val - _solution[i++];
       obj += tmp * tmp;
     }
 
   return obj;
 }

◆ execute()

void OptimizationDataTempl< OptimizationReporterBase >::execute ( )

overridevirtualinherited

Reimplemented from OptimizationReporterBase.

Definition at line 135 of file OptimizationData.C.

 {
   computeMisfit();
   _objective_val = computeMisfitValue();
 }

◆ finalize()

virtual void OptimizationDataTempl< OptimizationReporterBase >::finalize ( )

inlineoverridevirtualinherited

Reimplemented from OptimizationReporterBase.

Definition at line 40 of file OptimizationData.h.

40 {}

◆ 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().

 {
   return _lower_bounds[i];
 }

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

virtual dof_id_type OptimizationReporterBase::getNumParams ( ) const

inlinevirtualinherited

Function to get the total number of parameters.

Returns: total number of parameters

Reimplemented in GeneralOptimization.

Definition at line 70 of file OptimizationReporterBase.h.

Referenced by OptimizationReporterBase::setInitialCondition(), and OptimizeSolve::variableBounds().

70 { return _ndof; }

OptimizationReporterBase::_ndof

dof_id_type _ndof

Total number of parameters.

Definition: OptimizationReporterBase.h:162

◆ getUpperBound()

Real OptimizationReporterBase::getUpperBound ( dof_id_type i ) const

inherited

Upper and lower bounds for each parameter being controlled.

Parameters

i	Parameter index

Returns: The upper/lower bound for parameter i

Definition at line 118 of file OptimizationReporterBase.C.

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

 {
   return _upper_bounds[i];
 }

◆ initialize()

virtual void OptimizationDataTempl< OptimizationReporterBase >::initialize ( )

inlineoverridevirtualinherited

Reimplemented from OptimizationReporterBase.

Definition at line 38 of file OptimizationData.h.

38 {}

◆ 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 ParameterMeshOptimization::setICsandBounds(), OptimizationReporter::setICsandBounds(), and GeneralOptimization::setICsandBounds().

 {
   // fill with default values
   std::vector<Real> parsed_data_id(_nvalues[param_id], default_value);
   if (isParamValid(type))
   {
     std::vector<std::vector<Real>> parsed_data(getParam<std::vector<std::vector<Real>>>(type));
     parsed_data_id.assign(parsed_data[param_id].begin(), parsed_data[param_id].end());
     if (parsed_data.size() != _nvalues.size())
       paramError(type,
                  "There must be a vector of ",
                  type,
                  " per parameter group.  The ",
                  type,
                  " input format is std::vector<std::vector<Real>> so each vector should be "
                  "seperated by \";\" even if it is a single value per group for a constant ",
                  type,
                  ".");
     // The case when the initial condition is constant for each parameter group
     if (parsed_data[param_id].size() == 1)
       parsed_data_id.assign(_nvalues[param_id], parsed_data[param_id][0]);
     else if (parsed_data[param_id].size() != _nvalues[param_id])
       paramError(type,
                  "When ",
                  type,
                  " are given in input file, there must either be a single value per parameter "
                  "group or a value for every parameter in the group.");
   }
 
   return parsed_data_id;
 }

◆ setICsandBounds()

void OptimizationReporter::setICsandBounds ( )

overrideprotectedvirtualinherited

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

Reimplemented from OptimizationReporterBase.

Definition at line 52 of file OptimizationReporter.C.

Referenced by QuadraticMinimize::QuadraticMinimize().

 {
   _nvalues = getParam<std::vector<dof_id_type>>("num_values");
   _ndof = std::accumulate(_nvalues.begin(), _nvalues.end(), 0);
 
   // size checks
   if (_parameter_names.size() != _nvalues.size())
     paramError(
         "num_parameters",
         "There should be a number in \'num_parameters\' for each name in \'parameter_names\'.");
 
   for (const auto & param_id : make_range(_nparams))
   {
     _gradients[param_id]->resize(_nvalues[param_id]);
 
     std::vector<Real> ic(parseInputData("initial_condition", 0, param_id));
     std::vector<Real> lb(
         parseInputData("lower_bounds", std::numeric_limits<Real>::lowest(), param_id));
     std::vector<Real> ub(
         parseInputData("upper_bounds", std::numeric_limits<Real>::max(), param_id));
 
     _lower_bounds.insert(_lower_bounds.end(), lb.begin(), lb.end());
     _upper_bounds.insert(_upper_bounds.end(), ub.begin(), ub.end());
 
     _parameters[param_id]->assign(ic.begin(), ic.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().

 {
   setICsandBounds();
   x.init(getNumParams());
   OptUtils::copyReporterIntoPetscVector(_parameters, x);
 }

◆ setMisfitToSimulatedValues()

void OptimizationReporter::setMisfitToSimulatedValues ( )

overridevirtualinherited

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

Reimplemented from OptimizationReporterBase.

Definition at line 105 of file OptimizationReporter.C.

 {
   _misfit_values = _simulation_values;
 }

◆ 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().

 {
   OptUtils::copyPetscVectorIntoReporter(x, _parameters);
 }

◆ validParams()

InputParameters QuadraticMinimizeConstrained::validParams ( )

static

Definition at line 16 of file QuadraticMinimizeConstrained.C.

 {
   InputParameters params = QuadraticMinimize::validParams();
   params.addRequiredParam<Real>("solution_sum_equality",
                                 "Desired sum of the solution for constrained optimization.");
   return params;
 }