standardized_constraint.StandardizedConstraint Class Reference

Standardized constraint response function. More...

Inheritance diagram for standardized_constraint.StandardizedConstraint:

Collaboration diagram for standardized_constraint.StandardizedConstraint:

Public Member Functions
def	__init__ (self, Kratos.Parameters parameters, MasterControl master_control, OptimizationProblem optimization_problem, int required_buffer_size=2)
str	IsEqualityType (self)
float	GetStandardizedReferenceValue (self)
float	CalculateStandardizedValue (self, KratosOA.CollectiveExpression control_field, bool save_value=True)
KratosOA.CollectiveExpression	CalculateStandardizedGradient (self, bool save_field=True)
float	GetValue (self, int step_index=0)
float	GetStandardizedValue (self, int step_index=0)
float	GetScaledViolationValue (self, int step_index=0)
float	GetAbsoluteViolation (self, int step_index=0)
float	GetRelativeViolation (self, int step_index=0)
float	GetRelativeChange (self)
float	GetAbsoluteChange (self)
dict	GetInfo (self)

Detailed Description

Standardized constraint response function.

This class creates instances to standardize any response function for the specified type of the contraint.
Supported contraint types:
    "=",
    "<",
    "<=,
    ">",
    ">="

The reference value for the constraint either can be the "initial_value" or a specified value.

Constructor & Destructor Documentation

__init__()

def standardized_constraint.StandardizedConstraint.__init__	(		self,
		Kratos.Parameters	parameters,
		MasterControl	master_control,
		OptimizationProblem	optimization_problem,
		int	required_buffer_size = 2
	)

Member Function Documentation

CalculateStandardizedGradient()

KratosOA.CollectiveExpression standardized_constraint.StandardizedConstraint.CalculateStandardizedGradient	(		self,
		bool	save_field = True
	)

CalculateStandardizedValue()

float standardized_constraint.StandardizedConstraint.CalculateStandardizedValue	(		self,
		KratosOA.CollectiveExpression	control_field,
		bool	save_value = True
	)

GetAbsoluteChange()

float standardized_constraint.StandardizedConstraint.GetAbsoluteChange

(

self

)

GetAbsoluteViolation()

float standardized_constraint.StandardizedConstraint.GetAbsoluteViolation	(		self,
		int	step_index = 0
	)

GetInfo()

dict standardized_constraint.StandardizedConstraint.GetInfo

(

self

)

GetRelativeChange()

float standardized_constraint.StandardizedConstraint.GetRelativeChange

(

self

)

GetRelativeViolation()

float standardized_constraint.StandardizedConstraint.GetRelativeViolation	(		self,
		int	step_index = 0
	)

GetScaledViolationValue()

float standardized_constraint.StandardizedConstraint.GetScaledViolationValue	(		self,
		int	step_index = 0
	)

GetStandardizedReferenceValue()

float standardized_constraint.StandardizedConstraint.GetStandardizedReferenceValue

(

self

)

GetStandardizedValue()

float standardized_constraint.StandardizedConstraint.GetStandardizedValue	(		self,
		int	step_index = 0
	)

GetValue()

float standardized_constraint.StandardizedConstraint.GetValue	(		self,
		int	step_index = 0
	)

IsEqualityType()

str standardized_constraint.StandardizedConstraint.IsEqualityType

(

self

)

---

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

• /home/runner/work/Documentation/Documentation/master/applications/OptimizationApplication/python_scripts/algorithms/standardized_constraint.py