Optimization reporter that interfaces with TAO. More...

#include <GeneralOptimization.h>

Inheritance diagram for GeneralOptimization:

Public Types
typedef DataFileName	DataFileParameterType

Public Member Functions
	GeneralOptimization (const InputParameters &parameters)

virtual Real	computeObjective () override
	Function to compute objective.

virtual void	initialize () override

virtual void	execute () override

virtual void	finalize () override

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

void	setInitialCondition (libMesh::PetscVector< Number > &param)
	Function to initialize petsc vectors from vpp data.

Real	getUpperBound (dof_id_type i) const
	Upper and lower bounds for each parameter being controlled.

Real	getLowerBound (dof_id_type i) const

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

virtual void	computeInequalityConstraints (libMesh::PetscVector< Number > &ineqs_constraints) const
	Function to compute the inequality constraints.

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.

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.

dof_id_type	getNumEqCons () const
	Function to get the total number of equalities.

dof_id_type	getNumInEqCons () const
	Function to get the total number of inequalities.

void	threadJoin (const UserObject &) final

bool	shouldStore () const override final

virtual Real	spatialValue (const Point &) const

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

void	setPrimaryThreadCopy (UserObject *primary)

UserObject *	primaryThreadCopy ()

SubProblem &	getSubProblem () const

bool	shouldDuplicateInitialExecution () 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)

std::set< UserObjectName >	getDependObjects () const

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

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

unsigned int	systemNumber () const

virtual bool	needThreadedCopy () const

virtual bool	enabled () const

std::shared_ptr< MooseObject >	getSharedPtr ()

std::shared_ptr< const MooseObject >	getSharedPtr () const

bool	isKokkosObject () const

MooseApp &	getMooseApp () const

const std::string &	type () const

const std::string &	name () const

std::string	typeAndName () const

MooseObjectParameterName	uniqueParameterName (const std::string &parameter_name) const

MooseObjectName	uniqueName () const

const InputParameters &	parameters () const

const hit::Node *	getHitNode () const

bool	hasBase () const

const std::string &	getBase () 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 &name) const

void	connectControllableParams (const std::string &parameter, const std::string &object_type, const std::string &object_name, const std::string &object_parameter) const

void	paramError (const std::string &param, Args... args) const

void	paramWarning (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

std::string	messagePrefix (const bool hit_prefix=true) const

std::string	errorPrefix (const std::string &) const

void	mooseError (Args &&... args) const

void	mooseDocumentedError (const std::string &repo_name, const unsigned int issue_num, Args &&... args) const

void	mooseErrorNonPrefixed (Args &&... args) const

void	mooseWarning (Args &&... args) const

void	mooseWarning (Args &&... args) const

void	mooseWarningNonPrefixed (Args &&... args) const

void	mooseWarningNonPrefixed (Args &&... args) const

void	mooseDeprecated (Args &&... args) const

void	mooseDeprecated (Args &&... args) const

void	mooseDeprecatedNoTrace (Args &&... args) const

void	mooseInfo (Args &&... args) const

void	callMooseError (std::string msg, const bool with_prefix, const hit::Node *node=nullptr, const bool show_trace=true) 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 UserObjectBase &	getUserObjectBase (const std::string &param_name, bool is_dependency=true) const

const UserObjectBase &	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)

Moose::Kokkos::MaterialProperty< T, dimension >	getKokkosMaterialPropertyByName (const std::string &prop_name_in)

Moose::Kokkos::MaterialProperty< T, dimension >	getKokkosMaterialPropertyOldByName (const std::string &prop_name)

Moose::Kokkos::MaterialProperty< T, dimension >	getKokkosMaterialPropertyOlderByName (const std::string &prop_name)

Moose::Kokkos::MaterialProperty< T, dimension >	getKokkosMaterialProperty (const std::string &name)

Moose::Kokkos::MaterialProperty< T, dimension >	getKokkosMaterialPropertyOld (const std::string &name)

Moose::Kokkos::MaterialProperty< T, dimension >	getKokkosMaterialPropertyOlder (const std::string &name)

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

std::pair< Moose::Kokkos::MaterialProperty< T, dimension >, std::set< SubdomainID > >	getKokkosBlockMaterialProperty (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)

virtual 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	hasKokkosMaterialProperty (const std::string &name)

bool	hasKokkosMaterialProperty (const std::string &name)

bool	hasKokkosMaterialPropertyByName (const std::string &name)

bool	hasKokkosMaterialPropertyByName (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

Moose::Kokkos::Function	getKokkosFunction (const std::string &name) const

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

Moose::Kokkos::Function	getKokkosFunctionByName (const FunctionName &name) const

const T &	getKokkosFunctionByName (const FunctionName &name) const

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

bool	hasKokkosFunctionByName (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	callMooseError (MooseApp const app, const InputParameters &params, std::string msg, const bool with_prefix, const hit::Node node, const bool show_trace=true)

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, NameFunc &&name_func)

static void	cyclicDependencyError (CyclicDependencyException< T2 > &e, const std::string &header)

Public Attributes
	usingCombinedWarningSolutionWarnings

const ConsoleStream	_console

Static Public Attributes
static const std::string	type_param

static const std::string	name_param

static const std::string	unique_name_param

static const std::string	app_param

static const std::string	moose_base_param

static const std::string	kokkos_object_param

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 dof_id_type	getNumParams () const override
	Function to get the total number of parameters.

virtual void	setICsandBounds () override
	Sets the initial conditions and bounds right before it is needed.

virtual void	updateParameters (const libMesh::PetscVector< Number > &x)
	Function to set parameters.

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.

virtual void	addPostprocessorDependencyHelper (const PostprocessorName &name) const override

virtual void	addVectorPostprocessorDependencyHelper (const VectorPostprocessorName &name) const override

virtual void	addUserObjectDependencyHelper (const UserObjectBase &uo) const override

void	addReporterDependencyHelper (const ReporterName &reporter_name) override

void	flagInvalidSolutionInternal (const InvalidSolutionID invalid_solution_id) const

InvalidSolutionID	registerInvalidSolutionInternal (const std::string &message, const bool warning) const

const ReporterContextBase &	getReporterContextBaseByName (const ReporterName &reporter_name) const

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, const std::string &tag_param_name, unsigned int comp=0) const

const VariableValue &	coupledMatrixTagScalarValue (const std::string &var_name, const std::string &tag_param_name, 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

Moose::Kokkos::VariableValue	kokkosCoupledVectorTagScalarValueByName (const std::string &var_name, const std::string &tag_name, unsigned int comp=0) const

Moose::Kokkos::VariableValue	kokkosCoupledVectorTagScalarValue (const std::string &var_name, const std::string &tag_param_name, unsigned int comp=0) const

Moose::Kokkos::VariableValue	kokkosCoupledScalarValue (const std::string &var_name, unsigned int comp=0) const

Moose::Kokkos::VariableValue	kokkosCoupledScalarValueOld (const std::string &var_name, unsigned int comp=0) const

Moose::Kokkos::VariableValue	kokkosCoupledScalarValueOlder (const std::string &var_name, unsigned int comp=0) const

Moose::Kokkos::VariableValue	kokkosCoupledScalarDot (const std::string &var_name, unsigned int comp=0) const

Moose::Kokkos::Scalar< const Real >	kokkosCoupledScalarDotDu (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)

virtual void	getKokkosMaterialPropertyHook (const std::string &, const unsigned int)

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.

std::vector< dof_id_type > *	_num_values_reporter

const std::vector< ReporterValueName > &	_parameter_names
	Parameter names.

const unsigned int	_nparams
	Number of parameter vectors.

std::vector< std::vector< Real > * >	_parameters
	Parameter values declared as reporter data.

std::vector< std::vector< Real > * >	_gradients
	Gradient values declared as reporter data.

const Real	_tikhonov_coeff
	Tikhonov Coefficient for regularization.

const std::vector< ReporterValueName > *	_equality_names
	Equality constraint names.

const unsigned int	_n_eq_cons
	Number of equality constraint names.

std::vector< std::vector< Real > * >	_eq_constraints
	Equality values declared as reporter data.

std::vector< std::vector< Real > * >	_eq_gradients
	Gradient values declared as reporter data.

const std::vector< ReporterValueName > *	_inequality_names
	Inequality constraint names.

const unsigned int	_n_ineq_cons
	Number of inequality constraint names.

std::vector< std::vector< Real > * >	_ineq_constraints
	Inequality values declared as reporter data.

std::vector< std::vector< Real > * >	_ineq_gradients
	Gradient values declared as reporter data.

std::vector< Real >	_lower_bounds
	Bounds of the parameters.

std::vector< Real >	_upper_bounds

std::vector< dof_id_type >	_nvalues
	Number of values for each parameter.

dof_id_type	_ndof
	Total number of parameters.

const Moose::CoordinateSystemType &	_coord_sys

const THREAD_ID	_tid

SubProblem &	_subproblem

FEProblemBase &	_fe_problem

SystemBase &	_sys

Assembly &	_assembly

const bool	_duplicate_initial_execution

std::set< std::string >	_depend_uo

const bool &	_enabled

MooseApp &	_app

Factory &	_factory

ActionFactory &	_action_factory

const std::string &	_type

const std::string &	_name

const InputParameters &	_pars

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

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
const Moose::FunctionBase *	getKokkosFunctionByNameHelper (const FunctionName &name) const

const UserObjectBase &	getUserObjectFromFEProblem (const UserObjectName &object_name, const THREAD_ID tid=0) const

const T &	castUserObject (const UserObjectBase &uo_base, const std::string &param_name="") const

void	mooseObjectError (const std::string &param_name, std::stringstream &oss) const

const std::string &	userObjectType (const UserObjectBase &uo) const

const std::string &	userObjectName (const UserObjectBase &uo) const

const PostprocessorName &	getPostprocessorNameInternal (const std::string &param_name, const unsigned int index, const bool allow_default_value=true) const

bool	isDefaultPostprocessorValueByName (const PostprocessorName &name) const

PostprocessorValue	getDefaultPostprocessorValueByName (const PostprocessorName &name) const

void	checkParam (const std::string &param_name, const unsigned int index=std::numeric_limits< unsigned int >::max()) const

bool	postprocessorsAdded () const

const VectorPostprocessorValue &	getVectorPostprocessorByNameHelper (const VectorPostprocessorName &name, const std::string &vector_name, bool broadcast, std::size_t t_index) const

const VectorPostprocessorContext< VectorPostprocessorValue > &	getVectorPostprocessorContextByNameHelper (const VectorPostprocessorName &name, const std::string &vector_name) const

bool	vectorPostprocessorsAdded () const

bool	reportersAdded () const

void	possiblyCheckHasReporter (const ReporterName &reporter_name, const std::string &param_name="") const

RestartableDataValue &	registerRestartableDataOnApp (std::unique_ptr< RestartableDataValue > data, THREAD_ID tid) const

void	registerRestartableNameWithFilterOnApp (const std::string &name, Moose::RESTARTABLE_FILTER filter)

RestartableData< T > &	declareRestartableDataHelper (const std::string &data_name, void *context, Args &&... args) const

virtual std::string	meshPropertyPrefix (const std::string &data_name) const

const RestartableDataValue &	getMeshPropertyInternal (const std::string &data_name, const std::string &prefix) const

void	mooseErrorInternal (Args &&... args) const

const VariableValue *	getDefaultValue (const std::string &var_name) const

const ADVariableValue *	getADDefaultValue (const std::string &var_name) const

void	checkVar (const std::string &var_name) const

void	validateExecutionerType (const std::string &name, const std::string &fn_name) const

Moose::Kokkos::Variable	kokkosCoupledVectorTagScalarVariable (const std::string &var_name, const std::string &tag_name, unsigned int comp) const

Moose::MaterialDataType	getMaterialDataType (const std::set< BoundaryID > &boundary_ids) const

unsigned int	getMaxQps () const

void	addConsumedPropertyName (const MooseObjectName &obj_name, const std::string &prop_name)

const ReporterValueName &	getReporterValueName (const std::string &param_name) const

const PostprocessorValue &	getPostprocessorValueInternal (const std::string &param_name, unsigned int index, std::size_t t_index) const

const PostprocessorValue &	getPostprocessorValueInternal (const std::string &param_name, unsigned int index, std::size_t t_index) const

const PostprocessorValue &	getPostprocessorValueByNameInternal (const PostprocessorName &name, std::size_t t_index) const

const PostprocessorValue &	getPostprocessorValueByNameInternal (const PostprocessorName &name, std::size_t t_index) const

void	possiblyCheckHasVectorPostprocessor (const std::string &param_name, const std::string &vector_name) const

void	possiblyCheckHasVectorPostprocessor (const std::string &param_name, const std::string &vector_name) const

void	possiblyCheckHasVectorPostprocessorByName (const VectorPostprocessorName &name, const std::string &vector_name) const

void	possiblyCheckHasVectorPostprocessorByName (const VectorPostprocessorName &name, const std::string &vector_name) const

Static Private Member Functions
static const hit::Node *	getHitNode (const InputParameters &params)

static std::string	messagePrefix (const InputParameters &params, const bool hit_prefix)

Private Attributes
const bool	_always_store

UserObject *	_primary_thread_copy

std::set< std::string >	_supplied_uo

const ParallelParamObject &	_parent

const MooseBase &	_si_moose_base

const FEProblemBase *	_si_problem

ExecFlagEnum	_empty_execute_enum

const MooseObject &	_fni_object

const InputParameters &	_fni_params

FEProblemBase &	_fni_feproblem

const THREAD_ID	_fni_tid

const MooseObject &	_uoi_moose_object

const FEProblemBase &	_uoi_feproblem

const THREAD_ID	_uoi_tid

const MooseObject &	_ppi_moose_object

const InputParameters &	_ppi_params

const FEProblemBase &	_ppi_feproblem

std::map< PostprocessorName, std::unique_ptr< PostprocessorValue > >	_default_values

const bool	_broadcast_by_default

const MooseObject &	_vpi_moose_object

const FEProblemBase &	_vpi_feproblem

const THREAD_ID	_vpi_tid

const InputParameters &	_ri_params

FEProblemBase &	_ri_fe_problem_base

const ReporterData &	_ri_reporter_data

const MooseObject &	_ri_moose_object

const InputParameters &	_dni_params

FEProblemBase &	_dni_feproblem

const MooseObject *const	_dni_moose_object_ptr

const InputParameters &	_si_params

FEProblemBase &	_si_feproblem

THREAD_ID	_si_tid

const RestartableDataMapName	_metaname

std::string	_restartable_name

MooseApp &	_meta_data_app

const MooseObject *const	_meta_data_object

const InputParameters &	_sc_parameters

const std::string &	_sc_name

const bool	_sc_is_implicit

std::unordered_map< std::string, std::vector< MooseVariableScalar * > >	_coupled_scalar_vars

std::unordered_map< std::string, std::unique_ptr< VariableValue > >	_default_value

std::unordered_map< std::string, std::unique_ptr< ADVariableValue > >	_dual_default_value

std::vector< MooseVariableScalar * >	_coupled_moose_scalar_vars

std::unordered_map< std::string, std::vector< MooseVariableFieldBase * > >	_sc_coupled_vars

std::set< TagID >	_sc_coupleable_vector_tags

std::set< TagID >	_sc_coupleable_matrix_tags

const MooseObject &	_mi_moose_object

const bool	_mi_boundary_restricted

const std::set< SubdomainID > &	_mi_block_ids

const std::set< BoundaryID > &	_mi_boundary_ids

std::vector< std::unique_ptr< OptionalMaterialPropertyProxyBase< MaterialPropertyInterface > > >	_optional_property_proxies

const std::string	_ti_name

const MooseObject &	_reporter_moose_object

const InputParameters &	_reporter_params

const std::string &	_reporter_name

FEProblemBase &	_reporter_fe_problem

ReporterData &	_reporter_data

std::vector< std::unique_ptr< UnusedWrapperBase > >	_unused_values

MooseApp &	_oi_moose_app

OutputWarehouse &	_oi_output_warehouse

std::set< OutputName >	_oi_outputs

Detailed Description

Optimization reporter that interfaces with TAO.

Objective value, gradients, and constraints need to calculated in the subapps.

Definition at line 20 of file GeneralOptimization.h.

Constructor & Destructor Documentation

◆ GeneralOptimization()

GeneralOptimization::GeneralOptimization ( const InputParameters & parameters )

Definition at line 53 of file GeneralOptimization.C.

  : OptimizationReporterBase(parameters),
    _objective_val(declareValueByName<Real>(getParam<ReporterValueName>("objective_name"),
                                            REPORTER_MODE_REPLICATED)),
    _num_values_reporter(
        isParamValid("num_values_name")
            ? &declareValueByName<std::vector<dof_id_type>>(
                  getParam<ReporterValueName>("num_values_name"), REPORTER_MODE_REPLICATED)
            : nullptr)
{
}

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.

{
  OptUtils::copyReporterIntoPetscVector(_eq_constraints, eqs_constraints);
}

Referenced by OptimizeSolve::equalityFunctionWrapper().

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

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

Referenced by OptimizeSolve::equalityGradientFunctionWrapper().

◆ 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 ParameterMeshOptimization, QuadraticMinimize, and QuadraticMinimizeConstrained.

Definition at line 72 of file OptimizationReporterBase.C.

{
  for (const auto & param_group_id : make_range(_nparams))
  {
    if (_gradients[param_group_id]->size() != _nvalues[param_group_id])
      mooseError("The gradient for parameter ",
                 _parameter_names[param_group_id],
                 " has changed, expected ",
                 _nvalues[param_group_id],
                 " versus ",
                 _gradients[param_group_id]->size(),
                 ".");
 
    if (_tikhonov_coeff > 0.0)
    {
      auto params = _parameters[param_group_id];
      auto grads = _gradients[param_group_id];
      for (const auto & param_id : make_range(_nvalues[param_group_id]))
        (*grads)[param_id] += (*params)[param_id] * _tikhonov_coeff;
    }
  }
 
  OptUtils::copyReporterIntoPetscVector(_gradients, gradient);
}

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

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

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

Referenced by OptimizeSolve::inequalityFunctionWrapper().

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

{
  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);
}

Referenced by OptimizeSolve::inequalityGradientFunctionWrapper().

◆ computeObjective()

Real GeneralOptimization::computeObjective ( )

overridevirtual

Function to compute objective.

This is the last function called in objective routine

Implements OptimizationReporterBase.

Reimplemented in ParameterMeshOptimization, QuadraticMinimize, and QuadraticMinimizeConstrained.

Definition at line 66 of file GeneralOptimization.C.

{
  Real val = 0;
  if (_tikhonov_coeff > 0.0)
  {
    Real param_norm_sqr = 0;
    for (const auto & data : _parameters)
      for (const auto & param_val : *data)
        param_norm_sqr += param_val * param_val;
    // We multiply by 0.5 to maintain  backwards compatibility.
    val += 0.5 * _tikhonov_coeff * param_norm_sqr;
  }
  return _objective_val + val;
}

Referenced by ParameterMeshOptimization::computeObjective().

◆ execute()

virtual void OptimizationReporterBase::execute ( )

inlineoverridevirtualinherited

Implements GeneralReporter.

Definition at line 32 of file OptimizationReporterBase.h.

32{}

◆ finalize()

virtual void OptimizationReporterBase::finalize ( )

inlineoverridevirtualinherited

Implements GeneralReporter.

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.

{
  return _lower_bounds[i];
}

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

◆ 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 94 of file OptimizationReporterBase.h.

94{ return _n_eq_cons; }

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

◆ 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 100 of file OptimizationReporterBase.h.

100{ return _n_ineq_cons; }

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

◆ getNumParams()

dof_id_type GeneralOptimization::getNumParams ( ) const

overrideprotectedvirtual

Function to get the total number of parameters.

Returns: total number of parameters

Reimplemented from OptimizationReporterBase.

Definition at line 82 of file GeneralOptimization.C.

{
  if (_ndof == 0)
    mooseError(
        "The number of parameters you have is zero and this shouldn't happen. Make sure you are "
        "running your forward problem on \'INITIAL\' if you are using a reporter transfer to "
        "supply "
        "that information.");
 
  return _ndof;
}

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

{
  return _upper_bounds[i];
}

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

◆ initialize()

virtual void OptimizationReporterBase::initialize ( )

inlineoverridevirtualinherited

Implements GeneralReporter.

Definition at line 31 of file OptimizationReporterBase.h.

31{}

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

{
  // 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;
}

Referenced by setICsandBounds(), and ParameterMeshOptimization::setICsandBounds().

◆ setICsandBounds()

void GeneralOptimization::setICsandBounds ( )

overrideprotectedvirtual

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

Reimplemented from OptimizationReporterBase.

Reimplemented in ParameterMeshOptimization.

Definition at line 95 of file GeneralOptimization.C.

{
  // Check that one and only one set of parameters are given.
  // Set here because some derived reporters use a different method of
  // determining numbers of dofs
  if (!(isParamValid("num_values_name") ^ isParamValid("num_values")))
    mooseError("Need to supply one and only one of 'num_values_name' or 'num_values'.");
 
  if (_num_values_reporter)
    _nvalues = *_num_values_reporter;
  else
    _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())
  {
    const std::string source = isParamValid("num_values_name") ? "num_values_name" : "num_values";
    paramError(source,
               "There should be a number in \'",
               source,
               "\' 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());
  }
}

Referenced by QuadraticMinimize::QuadraticMinimize().

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

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

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

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

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

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

◆ validParams()

InputParameters GeneralOptimization::validParams ( )

static

Definition at line 19 of file GeneralOptimization.C.

{
  InputParameters params = OptimizationReporterBase::validParams();
 
  params.addRequiredParam<ReporterValueName>(
      "objective_name", "Preferred name of reporter value defining the objective.");
  params.addParam<std::vector<dof_id_type>>(
      "num_values",
      "Number of parameter values associated with each parameter group in 'parameter_names'.");
  params.addParam<ReporterValueName>("num_values_name",
                                     "Reporter that holds the number of parameter values "
                                     "associated with each parameter group in 'parameter_names'.");
  params.addParam<std::vector<std::vector<Real>>>(
      "initial_condition",
      "Initial conditions for each parameter. A vector is given for each parameter group.  A "
      "single value can be given for each group and all parameters in that group will be set to "
      "that value.  The default value is 0.");
  params.addParam<std::vector<std::vector<Real>>>(
      "lower_bounds",
      "Lower bound for each parameter.  A vector is given for each parameter group.  A single "
      "value can be given for each group and all parameters in that group will be set to that "
      "value");
  params.addParam<std::vector<std::vector<Real>>>(
      "upper_bounds",
      "Upper bound for each parameter.  A vector is given for each parameter group.  A single "
      "value can be given for each group and all parameters in that group will be set to that "
      "value");
 
  params.addClassDescription("Reporter that provides TAO with the objective, gradient, and "
                             "constraint data, which are supplied by the reporters and "
                             "postprocessors from the forward and adjoint subapps.");
  return params;
}

Referenced by ParameterMeshOptimization::validParams(), and QuadraticMinimize::validParams().

Member Data Documentation

◆ _eq_constraints

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

protectedinherited

Equality values declared as reporter data.

Definition at line 136 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 138 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 132 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 126 of file OptimizationReporterBase.h.

Referenced by OptimizationReporterBase::computeGradient(), ParameterMeshOptimization::computeGradient(), OptimizationReporterBase::OptimizationReporterBase(), setICsandBounds(), and ParameterMeshOptimization::setICsandBounds().

◆ _ineq_constraints

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

protectedinherited

Inequality values declared as reporter data.

Definition at line 145 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 147 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 141 of file OptimizationReporterBase.h.

Referenced by OptimizationReporterBase::OptimizationReporterBase().

◆ _lower_bounds

std::vector<Real> OptimizationReporterBase::_lower_bounds

protectedinherited

Bounds of the parameters.

Definition at line 150 of file OptimizationReporterBase.h.

Referenced by OptimizationReporterBase::getLowerBound(), setICsandBounds(), and ParameterMeshOptimization::setICsandBounds().

◆ _n_eq_cons

const unsigned int OptimizationReporterBase::_n_eq_cons

protectedinherited

Number of equality constraint names.

Definition at line 134 of file OptimizationReporterBase.h.

Referenced by OptimizationReporterBase::computeEqualityGradient(), QuadraticMinimizeConstrained::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 143 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 156 of file OptimizationReporterBase.h.

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

◆ _nparams

const unsigned int OptimizationReporterBase::_nparams

protectedinherited

Number of parameter vectors.

Definition at line 121 of file OptimizationReporterBase.h.

Referenced by OptimizationReporterBase::computeGradient(), ParameterMeshOptimization::computeGradient(), ParameterMeshOptimization::computeObjective(), OptimizationReporterBase::OptimizationReporterBase(), setICsandBounds(), and ParameterMeshOptimization::setICsandBounds().

◆ _num_values_reporter

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

protected

Definition at line 32 of file GeneralOptimization.h.

Referenced by setICsandBounds().

◆ _nvalues

std::vector<dof_id_type> OptimizationReporterBase::_nvalues

protectedinherited

Number of values for each parameter.

Definition at line 154 of file OptimizationReporterBase.h.

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

◆ _objective_val

Real& GeneralOptimization::_objective_val

protected

Reporter that will hold the objective value.

Definition at line 30 of file GeneralOptimization.h.

Referenced by computeObjective().

◆ _parameter_names

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

protectedinherited

Parameter names.

Definition at line 119 of file OptimizationReporterBase.h.

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

◆ _parameters

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

protectedinherited

Parameter values declared as reporter data.

Definition at line 124 of file OptimizationReporterBase.h.

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

◆ _tikhonov_coeff

const Real OptimizationReporterBase::_tikhonov_coeff

protectedinherited

Tikhonov Coefficient for regularization.

Definition at line 129 of file OptimizationReporterBase.h.

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

◆ _upper_bounds

std::vector<Real> OptimizationReporterBase::_upper_bounds

protectedinherited

Definition at line 151 of file OptimizationReporterBase.h.

Referenced by OptimizationReporterBase::getUpperBound(), setICsandBounds(), and ParameterMeshOptimization::setICsandBounds().

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

optimization/include/optimizationreporters/GeneralOptimization.h
optimization/src/optimizationreporters/GeneralOptimization.C

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Member Functions

Static Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ GeneralOptimization()

Member Function Documentation

◆ computeEqualityConstraints()

◆ computeEqualityGradient()

◆ computeGradient()

◆ computeInequalityConstraints()

◆ computeInequalityGradient()

◆ computeObjective()

◆ execute()

◆ finalize()

◆ getLowerBound()

◆ getNumEqCons()

◆ getNumInEqCons()

◆ getNumParams()

◆ getUpperBound()

◆ initialize()

◆ parseInputData()

◆ setICsandBounds()

◆ setInitialCondition()

◆ updateParameters()

◆ validParams()

Member Data Documentation

◆ _eq_constraints

◆ _eq_gradients

◆ _equality_names

◆ _gradients

◆ _ineq_constraints

◆ _ineq_gradients

◆ _inequality_names

◆ _lower_bounds

◆ _n_eq_cons

◆ _n_ineq_cons

◆ _ndof

◆ _nparams

◆ _num_values_reporter

◆ _nvalues

◆ _objective_val

◆ _parameter_names

◆ _parameters

◆ _tikhonov_coeff

◆ _upper_bounds