response_functions.plane_based_packaging.PlaneBasedPackaging Class Reference

A class that defines the response function for plane-based packaging. More...

Inheritance diagram for response_functions.plane_based_packaging.PlaneBasedPackaging:

Collaboration diagram for response_functions.plane_based_packaging.PlaneBasedPackaging:

Public Member Functions
def	__init__ (self, identifier, response_settings, model)
def	GetDefaultParameters (cls)
Public Member Functions inherited from response_functions.packaging_response_base.PackagingResponseBase
def	Initialize (self)
def	InitializeSolutionStep (self)
def	CalculateValue (self)
def	CalculateGradient (self)
def	GetValue (self)
def	GetNodalGradient (self, variable)

Public Attributes
	plane_origin
	plane_normal
	signed_distances
	directions
Public Attributes inherited from response_functions.packaging_response_base.PackagingResponseBase
	identifier
	response_settings
	model
	model_part
	signed_distances
	directions
	value
	gradient
	feasible_in_normal_direction
	exponent

Detailed Description

A class that defines the response function for plane-based packaging.

The plane is defined by an origin point and a normal vector. By default the normal of the plane indicates the feasible side of the plane (see setting 'feasible_in_normal_direction')

Constructor & Destructor Documentation

__init__()

def response_functions.plane_based_packaging.PlaneBasedPackaging.__init__	(		self,
			identifier,
			response_settings,
			model
	)

Reimplemented from response_functions.packaging_response_base.PackagingResponseBase.

Member Function Documentation

GetDefaultParameters()

def response_functions.plane_based_packaging.PlaneBasedPackaging.GetDefaultParameters

(

cls

)

Reimplemented from response_functions.packaging_response_base.PackagingResponseBase.

Member Data Documentation

directions

response_functions.plane_based_packaging.PlaneBasedPackaging.directions

plane_normal

response_functions.plane_based_packaging.PlaneBasedPackaging.plane_normal

plane_origin

response_functions.plane_based_packaging.PlaneBasedPackaging.plane_origin

signed_distances

response_functions.plane_based_packaging.PlaneBasedPackaging.signed_distances

---

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

• /home/runner/work/Documentation/Documentation/master/applications/ShapeOptimizationApplication/python_scripts/response_functions/plane_based_packaging.py