pymloc.model.multilevel_object

Classes

LocalObjectFactory()

Class for maintaining mappings between global multilevel and localized objects.

MultiLevelObject(lower_level_variables, …)

BaseObject for all classes that describe problems, with multiple variable levels.
class pymloc.model.multilevel_object.LocalObjectFactory

Bases: object

Class for maintaining mappings between global multilevel and localized objects.

get_localized_object(global_object, *args, **kwargs)

Get an instance of the localized version of the multilevel object.

Parameters

global_object (pymloc.model.multilevel_object.MultiLevelObject) –

register_localizer(global_object, localizer_object)

Registers a localizer_object as the class to be instantiated when a multilevel object is being localized.

Parameters

global_object (Type[pymloc.model.multilevel_object.MultiLevelObject]) –

class pymloc.model.multilevel_object.MultiLevelObject(lower_level_variables, higher_level_variables, local_level_variables)

Bases: abc.ABC

BaseObject for all classes that describe problems, with multiple variable levels.

Parameters
get_localized_object(**kwargs)
Return type

Any

property higher_level_variables
ll_sens_selector_shape: Union[Tuple[int], None]

lower_level_variables: Container for all variables of lower level higher_level_variables: Container for all variables of higher level current_level_variables: Container for all variables of the current level

property local_level_variables
property local_object_class
localize_method(method: None) → None
localize_method(method: Callable[[numpy.ndarray, float], numpy.ndarray]) → Callable[[float], numpy.ndarray]
localize_method(method: Callable[[numpy.ndarray], numpy.ndarray]) → numpy.ndarray

Localizes given method, by inserting the fixed value of current level variables.

property lower_level_variables
solve(*args, **kwargs)
Return type

Optional[pymloc.solvers.base_solver.Solution]