carputils.model.EikonalRegion

class carputils.model.EikonalRegion(ID, name=None, vel_f=0.6, vel_s=0.4, vel_n=0.2)

Defines an Eikonal model conduction velocity region.

Args:

ID : int

The ID of the conductivity region (not the element tags) this Eikonal region is to be built from

name : str, optional

A short descriptive name for this region

vel_f : float, optional

Conduction velocity in the fibre direction

vel_s : float, optional

Conduction velocity in the sheet direction

vel_n : float, optional

Conduction velocity in the sheet-normal direction

classmethod isotropic(ID, name=None, vel=0.4)

Define an isotropic conduction velocity Eikonal region.

Args:

ID : int

The ID of the conductivity region (not the element tags) this Eikonal region is to be built from

name : str, optional

A short descriptive name for this region

vel : float, optional

Conduction velocity

opts()

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

classmethod passive(ID, name=None)

Define a passive (non-conductive) Eikonal region.

Args:

ID : int

The ID of the conductivity region (not the element tags) this Eikonal region is to be built from

name : str, optional

A short descriptive name for this region