carputils.model.general.DreamMixin Class Reference

A mixin to extend model components with DREAM-specific parameter fields. More...

Inheritance diagram for carputils.model.general.DreamMixin:

Public Member Functions
def	__init__ (self, *args, **kwargs)
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...

Detailed Description

A mixin to extend model components with DREAM-specific parameter fields.

This mixin allows fluent-style specification of DREAM submodels such as CVrest and Idiff by calling methods that record parameter values, which are then yielded as name-value pairs via the dream_opts() generator.

@par Methods

CVrest(psi=159.0, theta=137.0, kappa=53.0, rho=811.0)

Define DREAM CVrest parameters.

Idiff(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.)

Define DREAM Idiff parameters.

dream_opts()

Generator yielding DREAM options as (name, value) tuples, e.g.:

('dream.CVrest.rho', 811.0)

Constructor & Destructor Documentation

__init__()

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

Reimplemented in carputils.model.general.AbstractIonicModel.

Member Function Documentation

CVrest()

def carputils.model.general.DreamMixin.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.

Default parameters are set for healthy Courtemanche IMP model.

@par Parameters

psi float, optional theta float, optional kappa float, optional rho float, optional

@return

Returns

self allows chaining

dream_opts()

def carputils.model.general.DreamMixin.dream_opts

(

self

)

Generator yielding all defined DREAM options as (name, value) pairs.

@return

(str, any) : Tuple in the form ('dream.<submodel>.', value)

Idiff()

def carputils.model.general.DreamMixin.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.

@par Parameters

model short, optional (0 or 1) alpha_i str({float, float, float}), optional beta_i str({float, float, float}), optional gamma_i str({float, float, float}), optional A_F float, optional tau_F float, optional V_th float, optional

@return

Returns

self allows chaining

---

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

• carputils/model/general.py