carputils
Doxygen code documentation for the python framework controlling openCARP
Public Member Functions | Static Public Attributes | List of all members
carputils.model.general.ModelMixin Class Reference

More concrete version of the ParameterSetMixin for ep/mechanics models. More...

Inheritance diagram for carputils.model.general.ModelMixin:
carputils.model.general.ParameterSetMixin carputils.model.general.AbstractIonicModel carputils.model.general.AbstractMechanicsMaterial carputils.model.general.ExternalIonicModel

Public Member Functions

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...
 

Static Public Attributes

 MODELFIELD = None
 
 MODELID = None
 
 SHORTNAME = None
 
- Static Public Attributes inherited from carputils.model.general.ParameterSetMixin
 PARAMETERS = None
 
 PARAMSET_FIELD = None
 

Detailed Description

More concrete version of the ParameterSetMixin for ep/mechanics models.

Constructor & Destructor Documentation

◆ __init__()

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

Member Function Documentation

◆ opts()

def carputils.model.general.ModelMixin.opts (   self)

Generator that yields field name - value pairs for the command line.

◆ slug()

def carputils.model.general.ModelMixin.slug (   self)

Generate a descriptive short name.

Member Data Documentation

◆ MODELFIELD

carputils.model.general.ModelMixin.MODELFIELD = None
static

◆ MODELID

carputils.model.general.ModelMixin.MODELID = None
static

◆ SHORTNAME

carputils.model.general.ModelMixin.SHORTNAME = None
static

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