andes.core.service.RefFlatten

class andes.core.service.RefFlatten(ref, **kwargs)

A service type for flattening andes.core.service.BackRef into a 1-D list.

Examples

This class is used when one wants to pass BackRef values as indexer.

andes.models.coi.COI collects referencing andes.models.group.SynGen with

self.SynGen = BackRef(info='SynGen idx lists', export=False)

After collecting BackRefs, self.SynGen.v will become a two-level list of indices, where the first level correspond to each COI and the second level correspond to generators of the COI.

Convert self.SynGen into 1-d as self.SynGenIdx, which can be passed as indexer for retrieving other parameters and variables

self.SynGenIdx = RefFlatten(ref=self.SynGen)

self.M = ExtParam(model='SynGen', src='M',
                  indexer=self.SynGenIdx, export=False,
                  )

__init__(ref, **kwargs)

Methods

assign_memory(n)	Assign memory for self.v and set the array to zero.
get_names()	Return name in a list

Attributes

class_name	Return the class name
n	Return the count of values in self.v.
v	Return values stored in self._v.