lbaf.Model.lbsObject.Object class

A class representing an object with load and communicator

Constructor arguments: :arg seq_id: small int identifier, commonly the task index, defaults to None :arg packed_id: alt identifier (generated by vt as a bitpacked value), defaults to None :arg r_id: rank ID, defaults to None :arg load: the computational time, also known as load, defaults to 0.0 :arg size: the size, defaults to 0.0 :arg comm: the communicator, defaults to None :arg user_defined: user defined data dict, defaults to None :arg subphases: list of subphases, defaults to None :arg collection_id: collection id (required for migratable objects) :arg index: the n-dimensional index for an object that belongs to a collection

Methods

def _Object__get_qoi_name(self, ftn_name) -> str
Return the QOI name from the given QOI getter function
def _Object__get_qois_of_type(self, qoi_type: str) -> list
Returns a dict of all qois with the specified qoi_type (either 'qoi' or 'entity_property'.)
def get_collection_id(*args, **kwargs)
def get_communicator(self) -> lbsObjectCommunicator.ObjectCommunicator
Return the communication graph for this object.
def get_id(*args, **kwargs)
def get_index(*args, **kwargs)
def get_load(*args, **kwargs)
def get_max_volume(*args, **kwargs)
def get_overhead(*args, **kwargs)
def get_packed_id(*args, **kwargs)
def get_qois(self, qoi_type = None)
Get all methods with specified 'qoi_type' decorator.
def get_rank_id(*args, **kwargs)
def get_received(self) -> dict
Return communications received by object from other objects.
def get_received_volume(*args, **kwargs)
def get_sent(self) -> dict
Return communications sent by object to other objects.
def get_sent_volume(*args, **kwargs)
def get_seq_id(*args, **kwargs)
def get_shared_block(self) -> typing.Optional[lbsBlock.Block]
Return shared memory block assigned to object.
def get_shared_id(*args, **kwargs)
def get_size(*args, **kwargs)
def get_subphases(self) -> list
Return subphases of this object.
def get_unused_params(self) -> dict
Return all current unused parameters.
def get_user_defined(self) -> dict
Return optionally defined fields
def has_communicator(self) -> bool
Return whether the object has communication graph data.
def set_collection_id(self, collection_id: typing.Optional[int])
Set object collection ID (required for migratable objects).
def set_communicator(self, c) -> None
Assign the communication graph for this object.
def set_index(self, index: typing.Optional[list])
Set an object's index.
def set_load(self, load: float)
Set object load.
def set_rank_id(self, r_id: int) -> None
Assign object to rank ID
def set_shared_block(self, b: typing.Optional[lbsBlock.Block]) -> None
Assign shared memory block when necessary.
def set_unused_params(self, unused_params: dict)
Assign any extraneous parameters.

Special methods

def __init__(self, seq_id: typing.Optional[int] = None, packed_id: typing.Optional[int] = None, r_id: typing.Optional[int] = None, load: float = 0.0, size: float = 0.0, comm: typing.Optional[lbsObjectCommunicator.ObjectCommunicator] = None, user_defined: dict = None, subphases: list = None, collection_id: typing.Optional[int] = None, index: typing.Optional[list] = None)
def __repr__(self)

Method documentation

def lbaf.Model.lbsObject.Object.get_qois(self, qoi_type = None)

Get all methods with specified 'qoi_type' decorator.

Params: - qoi_type: None (default) returns all decorated functions. "entity_property" returns all entity properties "qoi" returns all derived quantities of interest