carputils.model.general.AbstractIonicModel Class Reference

Inheritance diagram for carputils.model.general.AbstractIonicModel:

Public Member Functions
def	__init__ (self, args, kwargs)
def	set_stress (self, stress)
def	opts (self)
Public Member Functions inherited from carputils.model.general.RegionMixin
def	__init__ (self, IDs=[], name=None, args, kwargs)
def	opts (self)
	Generator that yields field name - value pairs for the command line. More...
Public Member Functions inherited from carputils.model.general.ModelMixin
def	__init__ (self, args, kwargs)
def	opts (self)
	Generator that yields field name - value pairs for the command line. More...
def	slug (self)
	Generate a descriptive short name. More...
Public Member Functions inherited from carputils.model.general.ParameterSetMixin
def	__init__ (self, args, kwargs)
def	opts (self)
	Generator that yields field name - value pairs for the command line. More...
Public Member Functions inherited from carputils.model.general.AbstractModelComponent
def	__init__ (self, fields)
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...

Static Public Attributes
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 = []

Constructor & Destructor Documentation

__init__()

def carputils.model.general.AbstractIonicModel.__init__	(		self,
			args,
			kwargs
	)

Member Function Documentation

opts()

def carputils.model.general.AbstractIonicModel.opts

(

self

)

set_stress()

def carputils.model.general.AbstractIonicModel.set_stress	(		self,
			stress
	)

Member Data Documentation

FIELDS

list carputils.model.general.AbstractIonicModel.FIELDS

static

Initial value:

=  ['cellSurfVolRatio',
              'volFrac',
              'im_sv_dumps',
              'im_sv_init']

MODELFIELD

string carputils.model.general.AbstractIonicModel.MODELFIELD = 'im'

static

PARAMSET_FIELD

string carputils.model.general.AbstractIonicModel.PARAMSET_FIELD = 'im_param'

static

PRM_ARRAY

string carputils.model.general.AbstractIonicModel.PRM_ARRAY = 'imp_region'

static

PRM_LENGTH

string carputils.model.general.AbstractIonicModel.PRM_LENGTH = 'num_imp_regions'

static

---

The documentation for this class was generated from the following file:

• carputils/model/general.py