Describes the passive ionic model configuration. More...
Inheritance diagram for carputils.model.general.ExternalIonicModel:
Public Member Functions | |
| def | set_name (self, name) |
| def | set_parameters (self, params) |
 Public Member Functions inherited from carputils.model.general.AbstractIonicModel | |
| def | __init__ (self, *args, **kwargs) |
| def | set_stress (self, stress) |
| def | opts (self) |
| Generator that yields field name - value pairs for the command line. More... | |
| def | opts_formatted (self, index) |
| Return the command line options for this model component. More... | |
| Public Member Functions inherited from carputils.model.general.DreamMixin | |
| def | CVrest (self, psi=159.0, theta=137.0, kappa=53.0, rho=811.0) |
| Specify CV restitution properties for the eikonal model using the DREAM. More... | |
| def | Idiff (self, model=0, alpha_i="{149.5, 41.2,-192.2}", beta_i="{2.383,2.07,2.56}", gamma_i="{0.22,0.56,0.29}", A_F=0.91, tau_F=0.25, V_th=-30.) |
| Diffusion current approximation for RE+, RE-, and DREAM solution methods. More... | |
| def | dream_opts (self) |
| Generator yielding all defined DREAM options as (name, value) pairs. More... | |
| Public Member Functions inherited from carputils.model.general.RegionMixin | |
| def | __init__ (self, IDs=[], name=None, emi=False, *args, **kwargs) |
| Public Member Functions inherited from carputils.model.general.ModelMixin | |
| def | slug (self) |
| Generate a descriptive short name. More... | |
| Public Member Functions inherited from carputils.model.general.AbstractModelComponent | |
| def | __init__ (self, **fields) |
Public Attributes | |
| MODELID | |
| Public Attributes inherited from carputils.model.general.AbstractIonicModel | |
| PRM_ARRAY | |
Static Public Attributes | |
| string | SHORTNAME = 'external' |
| string | MODELID = 'EXTERNAL' |
| dictionary | PARAMETERS = {} |
| Static Public Attributes inherited from carputils.model.general.AbstractIonicModel | |
| string | PRM_ARRAY = 'imp_region' |
| string | PRM_LENGTH = 'num_imp_regions' |
| string | MODELFIELD = 'im' |
| string | PARAMSET_FIELD = 'im_param' |
| list | FIELDS |
| Static Public Attributes inherited from carputils.model.general.ModelMixin | |
| MODELFIELD = None | |
| MODELID = None | |
| SHORTNAME = None | |
| Static Public Attributes inherited from carputils.model.general.ParameterSetMixin | |
| PARAMETERS = None | |
| PARAMSET_FIELD = None | |
| Static Public Attributes inherited from carputils.model.general.AbstractModelComponent | |
| PRM_ARRAY = None | |
| PRM_LENGTH = None | |
| list | FIELDS = [] |
Detailed Description
Describes the passive ionic model configuration.
Parameters
IDs list of int The element IDs to be included in this material region name str The name of the model material region
Member Function Documentation
◆ set_name()
| def carputils.model.general.ExternalIonicModel.set_name | ( | self, | |
| name | |||
| ) |
◆ set_parameters()
| def carputils.model.general.ExternalIonicModel.set_parameters | ( | self, | |
| params | |||
| ) |
Member Data Documentation
◆ MODELID [1/2]
|
static |
◆ MODELID [2/2]
| carputils.model.general.ExternalIonicModel.MODELID |
◆ PARAMETERS
|
static |
◆ SHORTNAME
|
static |
The documentation for this class was generated from the following file:
- carputils/model/general.py
