A mixin to add region fields to a model component class. More...
Inheritance diagram for carputils.model.general.RegionMixin:
Public Member Functions | |
| def | __init__ (self, IDs=[], name=None, emi=False, *args, **kwargs) |
| def | opts (self) |
| Generator that yields field name - value pairs for the command line. More... | |
Detailed Description
A mixin to add region fields to a model component class.
When this mixin is used, the first two arguments may be positional and will specify a list of region IDs and a name for the model component.
Constructor & Destructor Documentation
◆ __init__()
| def carputils.model.general.RegionMixin.__init__ | ( | self, | |
IDs = [], |
|||
name = None, |
|||
emi = False, |
|||
| * | args, | ||
| ** | kwargs | ||
| ) |
Member Function Documentation
◆ opts()
| def carputils.model.general.RegionMixin.opts | ( | self | ) |
Generator that yields field name - value pairs for the command line.
Reimplemented in carputils.model.general.AbstractIonicModel, carputils.model.conductivity.ConductivityRegionEMI, and carputils.model.conductivity.ConductivityRegion.
The documentation for this class was generated from the following file:
- carputils/model/general.py
