carputils
Doxygen code documentation for the python framework controlling openCARP
Functions
carputils.mesh.fibres Namespace Reference

Functions

def linear_fibre_rule (endo, epi, unit='degrees')
 Generate a linear fibre rule in the format expected by :class:carputils.mesh.Ring and :class:carputils.mesh.Ellipsoid. More...
 

Function Documentation

◆ linear_fibre_rule()

def carputils.mesh.fibres.linear_fibre_rule (   endo,
  epi,
  unit = 'degrees' 
)

Generate a linear fibre rule in the format expected by :class:carputils.mesh.Ring and :class:carputils.mesh.Ellipsoid.

For example, for a +60/-60 fibre rule:

>>> rule = linear_fibre_rule(60, -60)
>>> geom = Ring(5, fibre_rule=rule)

For more details on mesh generation and definition of fibres, see :ref:generating_fibres.

Parameters
endofloat Fibre helix angle on the endocardium
epifloat Fibre helix angle on the epicardium
unitstr, optional One of ['degrees', 'radians'], the type of units endo and epi are specified in, defaults to degrees