Reference overview

Detailed documentation of the types and functions exposed by MuesliMaterials.jl.

How the pieces fit together

  • Tensor types — the fixed-size vector and tensor classes that every other call takes and returns.
  • Materials — the parameter carriers. One per material model, plus the MuesliMaterials.MaterialProperties map used to construct them.
  • Material points — the state carriers, and the stress, tangent and energy queries that make up the bulk of the interface.

A note on exports

Only the tensor types and a handful of material types are exported:

using MuesliMaterialssort(string.(names(MuesliMaterials)))
27-element Vector{String}:
 "ElasticIsotropicMP"
 "ElasticIsotropicMaterial"
 "FbarMP"
 "FbeamMP"
 "FplaneMP"
 "FshellMP"
 "Istensor"
 "Itensor"
 "Itensor4"
 "Ivector"
 ⋮
 "SbeamMP"
 "SplaneMP"
 "SshellMP"
 "ViscoplasticNLMP"
 "ViscoplasticNLMaterial"
 "YeohMP"
 "YeohMaterial"
 "ZerilliArmstrongMP"
 "ZerilliArmstrongMaterial"

Everything else is reached through the module (MuesliMaterials.stress!) or imported explicitly (using MuesliMaterials: stress!). The full list of registered names is considerably longer:

length(filter(n -> !startswith(string(n), "#"), names(MuesliMaterials; all = true)))
504