carputils
Doxygen code documentation for the python framework controlling openCARP
Classes | Functions
carputils.model.general Namespace Reference

Classes

class  AbstractIonicModel
 
class  AbstractMechanicsMaterial
 
class  AbstractModelComponent
 Describes an abstract model component. More...
 
class  AbstractPlugin
 
class  AddModifier
 Describes a parameter add modifier. More...
 
class  ExternalIonicModel
 Describes the passive ionic model configuration. More...
 
class  ModelMixin
 More concrete version of the ParameterSetMixin for ep/mechanics models. More...
 
class  Modifier
 Describes a parameter assigment modifier. More...
 
class  MultModifier
 Describes a parameter multiply modifier. More...
 
class  NoPlugin
 Placeholder representing no plugin to be used. More...
 
class  ParameterSet
 Describes a set of parameters that can be generated into a single string. More...
 
class  ParameterSetMixin
 A mixin to add a parameter set field to a model component class. More...
 
class  RegionMixin
 A mixin to add region fields to a model component class. More...
 
class  SingleIDRegionMixin
 A mixin to add fields for a single-ID region to a model component class. More...
 

Functions

def ensure_set (obj, attributes)
 Check that the named attributes are not None on an object. More...
 
def optionlist (components)
 Generate a list of command line options from the specified components. More...
 
def convert_param_dict (params)
 convert parameter dict to comma separated string list More...
 

Function Documentation

◆ convert_param_dict()

def carputils.model.general.convert_param_dict (   params)

convert parameter dict to comma separated string list

◆ ensure_set()

def carputils.model.general.ensure_set (   obj,
  attributes 
)

Check that the named attributes are not None on an object.

◆ optionlist()

def carputils.model.general.optionlist (   components)

Generate a list of command line options from the specified components.