optimization_problem.OptimizationProblem Class Reference

This is the main data holder for optimization problems. More...

Collaboration diagram for optimization_problem.OptimizationProblem:

Public Member Functions
None	__init__ (self, int echo_level=0)
	Creates an instance of Optimization info. More...
Any	GetComponentType (self, Union[ExecutionPolicy, ResponseFunction, Control] component)
str	GetComponentName (self, Union[ExecutionPolicy, ResponseFunction, Control] component)
None	AddComponent (self, Union[ExecutionPolicy, ResponseFunction, Control] component)
ResponseFunction	GetResponse (self, str name)
'list[ResponseFunction]'	GetListOfResponses (self)
None	RemoveResponse (self, str name)
ExecutionPolicy	GetExecutionPolicy (self, str name)
'list[ExecutionPolicy]'	GetListOfExecutionPolicies (self)
None	RemoveExecutionPolicy (self, str name)
Control	GetControl (self, str name)
'list[Control]'	GetListOfControls (self)
None	RemoveControl (self, str name)
None	AddProcessType (self, str process_type)
None	AddProcess (self, str process_type, Kratos.Process process)
'list[str]'	GetAvailableProcessTypes (self)
'list[Kratos.Process]'	GetListOfProcesses (self, str process_type)
int	GetStep (self)
	Gets the current step of the optimization info. More...
None	AdvanceStep (self)
	Advances the problem data by one step. More...
BufferedDict	GetProblemDataContainer (self)
	Gets the global problem data container. More...
'dict[Any, dict[str, Any]]'	GetComponentContainer (self)
Any	GetComponent (self, str name, Any component_type)
None	RemoveComponent (self, str name, Any component_type)

Detailed Description

This is the main data holder for optimization problems.

This class holds one private @ref BufferedDict container
which is used to hold components of the optimization problem being solved,
and the problem data generated while solving the optimization problem.

Constructor & Destructor Documentation

__init__()

None optimization_problem.OptimizationProblem.__init__	(		self,
		int	echo_level = 0
	)

Creates an instance of Optimization info.

    Creates an instance of optimization info with most basic structure
    for the BufferedDict container and components container.

Member Function Documentation

AddComponent()

None optimization_problem.OptimizationProblem.AddComponent	(		self,
		Union[ExecutionPolicy, ResponseFunction, Control]	component
	)

AddProcess()

None optimization_problem.OptimizationProblem.AddProcess	(		self,
		str	process_type,
		Kratos.Process	process
	)

AddProcessType()

None optimization_problem.OptimizationProblem.AddProcessType	(		self,
		str	process_type
	)

AdvanceStep()

None optimization_problem.OptimizationProblem.AdvanceStep

(

self

)

Advances the problem data by one step.

    This method advances problem data by one step and
    clears all the data in the advanced step.

GetAvailableProcessTypes()

'list[str]' optimization_problem.OptimizationProblem.GetAvailableProcessTypes

(

self

)

GetComponent()

Any optimization_problem.OptimizationProblem.GetComponent	(		self,
		str	name,
		Any	component_type
	)

GetComponentContainer()

'dict[Any, dict[str, Any]]' optimization_problem.OptimizationProblem.GetComponentContainer

(

self

)

GetComponentName()

str optimization_problem.OptimizationProblem.GetComponentName	(		self,
		Union[ExecutionPolicy, ResponseFunction, Control]	component
	)

GetComponentType()

Any optimization_problem.OptimizationProblem.GetComponentType	(		self,
		Union[ExecutionPolicy, ResponseFunction, Control]	component
	)

GetControl()

Control optimization_problem.OptimizationProblem.GetControl	(		self,
		str	name
	)

GetExecutionPolicy()

ExecutionPolicy optimization_problem.OptimizationProblem.GetExecutionPolicy	(		self,
		str	name
	)

GetListOfControls()

'list[Control]' optimization_problem.OptimizationProblem.GetListOfControls

(

self

)

GetListOfExecutionPolicies()

'list[ExecutionPolicy]' optimization_problem.OptimizationProblem.GetListOfExecutionPolicies

(

self

)

GetListOfProcesses()

'list[Kratos.Process]' optimization_problem.OptimizationProblem.GetListOfProcesses	(		self,
		str	process_type
	)

GetListOfResponses()

'list[ResponseFunction]' optimization_problem.OptimizationProblem.GetListOfResponses

(

self

)

GetProblemDataContainer()

BufferedDict optimization_problem.OptimizationProblem.GetProblemDataContainer

(

self

)

Gets the global problem data container.

    Returns:
        BufferedDict: Global problem data container.

GetResponse()

ResponseFunction optimization_problem.OptimizationProblem.GetResponse	(		self,
		str	name
	)

GetStep()

int optimization_problem.OptimizationProblem.GetStep

(

self

)

Gets the current step of the optimization info.

    Returns:
        int: Current step of the optimization info.

RemoveComponent()

None optimization_problem.OptimizationProblem.RemoveComponent	(		self,
		str	name,
		Any	component_type
	)

RemoveControl()

None optimization_problem.OptimizationProblem.RemoveControl	(		self,
		str	name
	)

RemoveExecutionPolicy()

None optimization_problem.OptimizationProblem.RemoveExecutionPolicy	(		self,
		str	name
	)

RemoveResponse()

None optimization_problem.OptimizationProblem.RemoveResponse	(		self,
		str	name
	)

---

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

• /home/runner/work/Documentation/Documentation/master/applications/OptimizationApplication/python_scripts/utilities/optimization_problem.py