carputils.model.mechanics

Functions

get(*args, **kwargs) Get a class from its key string from keys()
grid_id() Return mechanics grid ID
keys() Return a list of string keys to be used with get()
summary([indent, ncolumns, padding]) Return a string summarizing the models and their parameters

Classes

AnisotropicMaterial(*args, **kwargs) Describes the “Simple anisotropic material” mechanics material
CompressibleMooneyRivlinMaterial(*args, **kwargs) Describes the “Compressible Mooney-Rivlin material” mechanics material
CompressibleNeoHookeanMaterial(*args, **kwargs) Describes the “Compressible neo-Hooke material” mechanics material
DemirayMaterial(*args, **kwargs) Describes the “Demiray material” mechanics material
DispersionArterialMaterial(*args, **kwargs) Describes the “Gasser et al.
FullHolzapfelOgdenMaterial(*args, **kwargs) Describes the “Full Holzapfel-Ogden material” mechanics material
GuccioneMaterial(*args, **kwargs) Describes the “Guccione et al.
HolzapfelArterialMaterial(*args, **kwargs) Describes the “Holzapfel et al.
HolzapfelOgdenMaterial(*args, **kwargs) Describes the “Holzapfel-Ogden material” mechanics material
LinearMaterial(*args, **kwargs) Describes the “Linear material” mechanics material
ModifiedMooneyRivlinMaterial(*args, **kwargs) Describes the “Modified Mooney-Rivlin material” mechanics material
MooneyRivlinMaterial(*args, **kwargs) Describes the “Mooney-Rivlin material” mechanics material
NeoHookeanMaterial(*args, **kwargs) Describes the “Neo-Hooke material” mechanics material
ReducedHolzapfelOgdenDispersionMaterial(…) Describes the “Reduced Holzapfel-Ogden material with dispersion” mechanics material
ReducedHolzapfelOgdenMaterial(*args, **kwargs) Describes the “Reduced Holzapfel-Ogden material” mechanics material
StVenantKirchhoffMaterial(*args, **kwargs) Describes the “St.
UsykMaterial(*args, **kwargs) Describes the “Usyk et al.
class carputils.model.mechanics.AnisotropicMaterial(*args, **kwargs)

Describes the “Simple anisotropic material” mechanics material

IDs : list of int
The element IDs to be included in this material region
name : str
The name of the model material region
a_f : float, optional
Value of a_f, defaults to 18.535
b_f : float, optional
Value of b_f, defaults to 2.564
c : float, optional
Value of c, defaults to 33.345
kappa : float, optional
Value of the incompressibility penalty, defaults to 1000.0
class carputils.model.mechanics.CompressibleMooneyRivlinMaterial(*args, **kwargs)

Describes the “Compressible Mooney-Rivlin material” mechanics material

IDs : list of int
The element IDs to be included in this material region
name : str
The name of the model material region
c_1 : float, optional
Value of c_1, defaults to 30.0
c_2 : float, optional
Value of c_2, defaults to 20.0
lmbda : float, optional
Value of lmbda, defaults to 100.0
class carputils.model.mechanics.CompressibleNeoHookeanMaterial(*args, **kwargs)

Describes the “Compressible neo-Hooke material” mechanics material

IDs : list of int
The element IDs to be included in this material region
name : str
The name of the model material region
lmbda : float, optional
Value of lmbda, defaults to 100.0
mu : float, optional
Value of mu, defaults to 33.345
class carputils.model.mechanics.DemirayMaterial(*args, **kwargs)

Describes the “Demiray material” mechanics material

IDs : list of int
The element IDs to be included in this material region
name : str
The name of the model material region
a : float, optional
Value of a, defaults to 33.345
b : float, optional
Value of b, defaults to 9.242
kappa : float, optional
Value of the incompressibility penalty, defaults to 1000.0
class carputils.model.mechanics.DispersionArterialMaterial(*args, **kwargs)

Describes the “Gasser et al. (2006) artery material with dispersion” mechanics material

IDs : list of int
The element IDs to be included in this material region
name : str
The name of the model material region
c : float, optional
Value of c, defaults to 33.345
delta_f : float, optional
Value of delta_f, defaults to 0.314
k_1 : float, optional
Value of k_1, defaults to 180.0
k_2 : float, optional
Value of k_2, defaults to 100.0
kappa : float, optional
Value of the incompressibility penalty, defaults to 1000.0
class carputils.model.mechanics.FullHolzapfelOgdenMaterial(*args, **kwargs)

Describes the “Full Holzapfel-Ogden material” mechanics material

IDs : list of int
The element IDs to be included in this material region
name : str
The name of the model material region
a : float, optional
Value of a, defaults to 33.345
a_f : float, optional
Value of a_f, defaults to 18.535
a_fn : float, optional
Value of a_fn, defaults to 0.0
a_fs : float, optional
Value of a_fs, defaults to 0.417
a_n : float, optional
Value of a_n, defaults to 0.0
a_ns : float, optional
Value of a_ns, defaults to 0.0
a_s : float, optional
Value of a_s, defaults to 2.564
b : float, optional
Value of b, defaults to 9.242
b_f : float, optional
Value of b_f, defaults to 15.972
b_fn : float, optional
Value of b_fn, defaults to 0.0
b_fs : float, optional
Value of b_fs, defaults to 11.602
b_n : float, optional
Value of b_n, defaults to 0.0
b_ns : float, optional
Value of b_ns, defaults to 0.0
b_s : float, optional
Value of b_s, defaults to 10.446
delta_f : float, optional
Value of delta_f, defaults to 0.0
delta_n : float, optional
Value of delta_n, defaults to 0.0
delta_s : float, optional
Value of delta_s, defaults to 0.0
h_k : float, optional
Value of h_k, defaults to 0.0
kappa : float, optional
Value of the incompressibility penalty, defaults to 1000.0
class carputils.model.mechanics.GuccioneMaterial(*args, **kwargs)

Describes the “Guccione et al. (1995) material” mechanics material

IDs : list of int
The element IDs to be included in this material region
name : str
The name of the model material region
a : float, optional
Value of a, defaults to 0.876
b_f : float, optional
Value of b_f, defaults to 18.48
b_fs : float, optional
Value of b_fs, defaults to 1.627
b_t : float, optional
Value of b_t, defaults to 3.58
kappa : float, optional
Value of the incompressibility penalty, defaults to 1000.0
class carputils.model.mechanics.HolzapfelArterialMaterial(*args, **kwargs)

Describes the “Holzapfel et al. (2000) artery material” mechanics material

IDs : list of int
The element IDs to be included in this material region
name : str
The name of the model material region
c : float, optional
Value of c, defaults to 33.345
k_1 : float, optional
Value of k_1, defaults to 2.3632
k_2 : float, optional
Value of k_2, defaults to 0.8393
kappa : float, optional
Value of the incompressibility penalty, defaults to 1000.0
class carputils.model.mechanics.HolzapfelOgdenMaterial(*args, **kwargs)

Describes the “Holzapfel-Ogden material” mechanics material

IDs : list of int
The element IDs to be included in this material region
name : str
The name of the model material region
a : float, optional
Value of a, defaults to 33.345
a_f : float, optional
Value of a_f, defaults to 18.535
a_fs : float, optional
Value of a_fs, defaults to 0.417
a_s : float, optional
Value of a_s, defaults to 2.564
b : float, optional
Value of b, defaults to 9.242
b_f : float, optional
Value of b_f, defaults to 15.972
b_fs : float, optional
Value of b_fs, defaults to 11.602
b_s : float, optional
Value of b_s, defaults to 10.446
kappa : float, optional
Value of the incompressibility penalty, defaults to 1000.0
class carputils.model.mechanics.LinearMaterial(*args, **kwargs)

Describes the “Linear material” mechanics material

IDs : list of int
The element IDs to be included in this material region
name : str
The name of the model material region
E : float, optional
Value of E, defaults to 100.0
lmbda : float, optional
Value of lmbda, defaults to 100.0
nu : float, optional
Value of nu, defaults to 0.33
class carputils.model.mechanics.ModifiedMooneyRivlinMaterial(*args, **kwargs)

Describes the “Modified Mooney-Rivlin material” mechanics material

IDs : list of int
The element IDs to be included in this material region
name : str
The name of the model material region
c_1 : float, optional
Value of c_1, defaults to 30.0
c_2 : float, optional
Value of c_2, defaults to 20.0
lmbda : float, optional
Value of lmbda, defaults to 100.0
class carputils.model.mechanics.MooneyRivlinMaterial(*args, **kwargs)

Describes the “Mooney-Rivlin material” mechanics material

IDs : list of int
The element IDs to be included in this material region
name : str
The name of the model material region
c_1 : float, optional
Value of c_1, defaults to 30.0
c_2 : float, optional
Value of c_2, defaults to 20.0
kappa : float, optional
Value of the incompressibility penalty, defaults to 1000.0
class carputils.model.mechanics.NeoHookeanMaterial(*args, **kwargs)

Describes the “Neo-Hooke material” mechanics material

IDs : list of int
The element IDs to be included in this material region
name : str
The name of the model material region
c : float, optional
Value of c, defaults to 33.345
kappa : float, optional
Value of the incompressibility penalty, defaults to 1000.0
class carputils.model.mechanics.ReducedHolzapfelOgdenDispersionMaterial(*args, **kwargs)

Describes the “Reduced Holzapfel-Ogden material with dispersion” mechanics material

IDs : list of int
The element IDs to be included in this material region
name : str
The name of the model material region
a : float, optional
Value of a, defaults to 33.345
a_f : float, optional
Value of a_f, defaults to 18.535
b : float, optional
Value of b, defaults to 9.242
b_f : float, optional
Value of b_f, defaults to 15.972
delta_f : float, optional
Value of delta_f, defaults to 0.226
kappa : float, optional
Value of the incompressibility penalty, defaults to 1000.0
class carputils.model.mechanics.ReducedHolzapfelOgdenMaterial(*args, **kwargs)

Describes the “Reduced Holzapfel-Ogden material” mechanics material

IDs : list of int
The element IDs to be included in this material region
name : str
The name of the model material region
a : float, optional
Value of a, defaults to 33.345
a_f : float, optional
Value of a_f, defaults to 18.535
b : float, optional
Value of b, defaults to 9.242
b_f : float, optional
Value of b_f, defaults to 15.972
kappa : float, optional
Value of the incompressibility penalty, defaults to 1000.0
class carputils.model.mechanics.StVenantKirchhoffMaterial(*args, **kwargs)

Describes the “St. Venant-Kirchhoff material” mechanics material

IDs : list of int
The element IDs to be included in this material region
name : str
The name of the model material region
lmbda : float, optional
Value of lmbda, defaults to 100.0
mu : float, optional
Value of mu, defaults to 30.0
class carputils.model.mechanics.UsykMaterial(*args, **kwargs)

Describes the “Usyk et al. (2000) material” mechanics material

IDs : list of int
The element IDs to be included in this material region
name : str
The name of the model material region
a : float, optional
Value of a, defaults to 0.88
b_ff : float, optional
Value of b_ff, defaults to 5.0
b_fn : float, optional
Value of b_fn, defaults to 2.0
b_fs : float, optional
Value of b_fs, defaults to 10.0
b_nn : float, optional
Value of b_nn, defaults to 3.0
b_ns : float, optional
Value of b_ns, defaults to 2.0
b_ss : float, optional
Value of b_ss, defaults to 6.0
kappa : float, optional
Value of the incompressibility penalty, defaults to 1000.0
carputils.model.mechanics.get(*args, **kwargs)

Get a class from its key string from keys()

carputils.model.mechanics.grid_id()

Return mechanics grid ID

carputils.model.mechanics.keys()

Return a list of string keys to be used with get()

carputils.model.mechanics.summary(indent=2, ncolumns=4, padding=2)

Return a string summarizing the models and their parameters