 |
KratosMultiphysics
KRATOS Multiphysics (Kratos) is a framework for building parallel, multi-disciplinary simulation software, aiming at modularity, extensibility, and high performance. Kratos is written in C++, and counts with an extensive Python interface.
|
Base abstract control class. More...
Public Member Functions | |
| None | __init__ (self, str control_name) |
| str | GetName (self) |
| None | Initialize (self) |
| Initializes the control. More... | |
| None | Check (self) |
| Checks the control. More... | |
| None | Finalize (self) |
| Finalizes the control. More... | |
| 'list[SupportedSensitivityFieldVariableTypes]' | GetPhysicalKratosVariables (self) |
| Returns list of physical control variables controlled by this control. More... | |
| ContainerExpressionTypes | GetEmptyField (self) |
| Returns a new empty data field holder with correct dimensionality information. More... | |
| ContainerExpressionTypes | GetControlField (self) |
| Returns the current control field of the control. More... | |
| ContainerExpressionTypes | MapGradient (self, 'dict[SupportedSensitivityFieldVariableTypes, ContainerExpressionTypes]' physical_gradient_variable_container_expression_map) |
| Maps physical space gradients to the control space. More... | |
| bool | Update (self, ContainerExpressionTypes control_field) |
| Modifies the current control with the given control field. More... | |
Base abstract control class.
The base abstract control class has the following responsibilities.
1. Initalizes and finalizes the control.
2. Maps physical space gradients to control space gradients, if needed. Otherwise, it passes.
2. Updating the controlled parts of the model part with new given design.
3. Retrieve control field.
4. Retrieve physical space kratos variables (If more than one physical space kratos variables are controlled by the given control field.)
This control should only work on one model part and one kratos control variable. Hence, if multiple model parts required then,
a single model part should be created using Kratos.ModelPartOperationUtilities.
| None control.Control.__init__ | ( | self, | |
| str | control_name | ||
| ) |
| None control.Control.Check | ( | self | ) |
Checks the control.
This method checks the control. This is only called once in the whole optimization process.
| None control.Control.Finalize | ( | self | ) |
Finalizes the control.
This method finalizes the control. This is only called once in the whole optimization process.
| ContainerExpressionTypes control.Control.GetControlField | ( | self | ) |
Returns the current control field of the control.
This method returns the control field of the current design.
Returns:
ContainerExpressionTypes: Current designs control field.
| ContainerExpressionTypes control.Control.GetEmptyField | ( | self | ) |
Returns a new empty data field holder with correct dimensionality information.
This returns a new empty data field holder to give information about on which model part's container
this model part is acting on. This has O(1) complexity, hence has the least cost because it does not read
any data from respective model part's container.
Dimensionality information is provided by calling a ContainerExpression::SetData(value). This creates a single
memory allocation for whole container with the dimensions of the variable. This operation is cheap in memory and
consumes least time.
Eg:
1. If the control field is a scalar, then container_expression.SetData(0.0)
2. If the control field is a array3, then container_expression.SetData(Kratos.Array3(0.0))
Returns:
ContainerExpressionTypes: Returns a new empty ContainerExpression corresponding to control's model part's respective container.
| str control.Control.GetName | ( | self | ) |
| 'list[SupportedSensitivityFieldVariableTypes]' control.Control.GetPhysicalKratosVariables | ( | self | ) |
Returns list of physical control variables controlled by this control.
This method returns list of physical variable which are controlled by the control. In most of the cases, there is only one
control variable per control. But in some rare cases, there may be the requirement to control two physical variables. Anyhow,
the control space should only have one variable per control in the control space, but they can have multiple physical variables
in their design space.
Returns:
list[SupportedSensitivityFieldVariableTypes]: List of physical control variables.
| None control.Control.Initialize | ( | self | ) |
Initializes the control.
This method initializes the control. This is only called once in the whole optimization process.
| ContainerExpressionTypes control.Control.MapGradient | ( | self, | |
| 'dict[SupportedSensitivityFieldVariableTypes, ContainerExpressionTypes]' | physical_gradient_variable_container_expression_map | ||
| ) |
Maps physical space gradients to the control space.
This method is used to map the given physical space gradients to the control space. The input should be as in the following example:
physical_gradient_variable_container_expression_map = {
Kratos.YOUNG_MODULUS: Kratos.ContainerExpressions.NodalNonHistoricalContainer,
Kratos.DENSITY : Kratos.ContainerExpressions.ElementNonHistoricalContainer,
Kratos.SHAPE : Kratos.ContainerExpressions.ElementNonHistoricalContainer
}
All the gradients w.r.t. @see GetPhysicalKratosVariables() variables will be given in @ref physical_gradient_variable_container_expression_map.
If the response does not depend on some of them or all, then container expressions with ContainerExpression::SetDataToZero() performed will be passed.
[ContainerExpression::SetDataToZero() will make the container expression to zero, but will only allocate one double value for the
whole container, hence it is cheap in memory and execution.]
Args:
physical_gradient_variable_container_expression_map (dict[SupportedSensitivityFieldVariableTypes, ContainerExpressionTypes]): Map of physical space variable and ContainerExpression with sensitivities.
Returns:
ContainerExpressionTypes: Gradients mapped in to control space.
| bool control.Control.Update | ( | self, | |
| ContainerExpressionTypes | control_field | ||
| ) |
Modifies the current control with the given control field.
Args:
control_field (ContainerExpressionTypes): The control field in control space.
Returns:
bool: True if the control field was applied to obtain a new design, otherwise False
1.9.1