<!– generated by PeriLab.generateparameterdocs; do not edit –>

Input Models

Quantities name what a value measures; PeriLab has no fixed units, use them in your consistent unit system. A key described "only with Key: a, b" is read only if the key next to it has one of these values ("solver": the solver of the step).

Material Models

Each entry names its model in Material Model.

Shared keys

Material model of the blocks that use this entry: elastic constants, symmetry and options shared by all material models

YAML key	Type	Required	Default	Range	Quantity	Description
Symmetry	text	optional	—	one of: isotropic, isotropic plane stress, isotropic plane strain, orthotropic, orthotropic plane stress, orthotropic plane strain, transverse isotropic, transverse isotropic plane stress, transverse isotropic plane strain, anisotropic, anisotropic plane stress, anisotropic plane strain		Material symmetry and 2D assumption (plane stress or plane strain); selects which elastic constants are needed. Isotropic if not given
Young's Modulus	number	required: two of Young's Modulus, Poisson's Ratio, Bulk Modulus, Shear Modulus (isotropic, not bond-based); required: one of Young's Modulus, Bulk Modulus, Shear Modulus (isotropic, bond-based)	—	≥ 0	stress	Isotropic elastic constant; give two of Young's modulus, Poisson's ratio, bulk modulus and shear modulus, the others are computed (bond-based models fix Poisson's ratio and need one of the others); a text mesh column (e.g. Bulk_Modulus) gives it per node; only with Symmetry: isotropic, isotropic plane stress, isotropic plane strain
Poisson's Ratio	number	required: two of Young's Modulus, Poisson's Ratio, Bulk Modulus, Shear Modulus (isotropic, not bond-based)	—	-1 … 0.5		Isotropic elastic constant; give two of Young's modulus, Poisson's ratio, bulk modulus and shear modulus, the others are computed (bond-based models fix Poisson's ratio and need one of the others); a text mesh column (e.g. Bulk_Modulus) gives it per node; only with Symmetry: isotropic, isotropic plane stress, isotropic plane strain
Bulk Modulus	number	required: two of Young's Modulus, Poisson's Ratio, Bulk Modulus, Shear Modulus (isotropic, not bond-based); required: one of Young's Modulus, Bulk Modulus, Shear Modulus (isotropic, bond-based)	—	≥ 0	stress	Isotropic elastic constant; give two of Young's modulus, Poisson's ratio, bulk modulus and shear modulus, the others are computed (bond-based models fix Poisson's ratio and need one of the others); a text mesh column (e.g. Bulk_Modulus) gives it per node; only with Symmetry: isotropic, isotropic plane stress, isotropic plane strain
Shear Modulus	number	required: two of Young's Modulus, Poisson's Ratio, Bulk Modulus, Shear Modulus (isotropic, not bond-based); required: one of Young's Modulus, Bulk Modulus, Shear Modulus (isotropic, bond-based)	—	≥ 0	stress	Isotropic elastic constant; give two of Young's modulus, Poisson's ratio, bulk modulus and shear modulus, the others are computed (bond-based models fix Poisson's ratio and need one of the others); a text mesh column (e.g. Bulk_Modulus) gives it per node; only with Symmetry: isotropic, isotropic plane stress, isotropic plane strain
Young's Modulus X	number or data file	optional	—	≥ 0	stress	Young's modulus along the material x axis; a number or a table over a node field; only with Symmetry: orthotropic, orthotropic plane stress, orthotropic plane strain, transverse isotropic, transverse isotropic plane stress, transverse isotropic plane strain
Young's Modulus Y	number or data file	optional	—	≥ 0	stress	Young's modulus along the material y axis; a number or a table over a node field; only with Symmetry: orthotropic, orthotropic plane stress, orthotropic plane strain, transverse isotropic, transverse isotropic plane stress, transverse isotropic plane strain
Young's Modulus Z	number or data file	optional	—	≥ 0	stress	Young's modulus along the material z axis; a number or a table over a node field; only with Symmetry: orthotropic, orthotropic plane stress, orthotropic plane strain
Poisson's Ratio XY	number or data file	optional	—			Poisson's ratio in the material xy plane; a number or a table over a node field; only with Symmetry: orthotropic, orthotropic plane stress, orthotropic plane strain, transverse isotropic, transverse isotropic plane stress, transverse isotropic plane strain
Poisson's Ratio YZ	number or data file	optional	—			Poisson's ratio in the material yz plane; a number or a table over a node field; only with Symmetry: orthotropic, orthotropic plane stress, orthotropic plane strain, transverse isotropic, transverse isotropic plane strain
Poisson's Ratio XZ	number or data file	optional	—			Poisson's ratio in the material xz plane; a number or a table over a node field; only with Symmetry: orthotropic, orthotropic plane stress, orthotropic plane strain
Shear Modulus XY	number or data file	optional	—	≥ 0	stress	Shear modulus in the material xy plane; a number or a table over a node field; only with Symmetry: orthotropic, orthotropic plane stress, orthotropic plane strain, transverse isotropic, transverse isotropic plane stress, transverse isotropic plane strain
Shear Modulus YZ	number or data file	optional	—	≥ 0	stress	Shear modulus in the material yz plane; a number or a table over a node field; only with Symmetry: orthotropic, orthotropic plane stress, orthotropic plane strain, transverse isotropic
Shear Modulus XZ	number or data file	optional	—	≥ 0	stress	Shear modulus in the material xz plane; a number or a table over a node field; only with Symmetry: orthotropic, orthotropic plane stress, orthotropic plane strain
C11	number	optional	—		stress	Entry 11 of the stiffness matrix in Voigt notation; only with Symmetry: anisotropic, anisotropic plane stress, anisotropic plane strain
C12	number	optional	—		stress	Entry 12 of the stiffness matrix in Voigt notation; only with Symmetry: anisotropic, anisotropic plane stress, anisotropic plane strain
C13	number	optional	—		stress	Entry 13 of the stiffness matrix in Voigt notation; only with Symmetry: anisotropic, anisotropic plane stress, anisotropic plane strain
C14	number	optional	—		stress	Entry 14 of the stiffness matrix in Voigt notation; only with Symmetry: anisotropic, anisotropic plane stress, anisotropic plane strain
C15	number	optional	—		stress	Entry 15 of the stiffness matrix in Voigt notation; only with Symmetry: anisotropic, anisotropic plane stress, anisotropic plane strain
C16	number	optional	—		stress	Entry 16 of the stiffness matrix in Voigt notation; only with Symmetry: anisotropic, anisotropic plane stress, anisotropic plane strain
C22	number	optional	—		stress	Entry 22 of the stiffness matrix in Voigt notation; only with Symmetry: anisotropic, anisotropic plane stress, anisotropic plane strain
C23	number	optional	—		stress	Entry 23 of the stiffness matrix in Voigt notation; only with Symmetry: anisotropic, anisotropic plane stress, anisotropic plane strain
C24	number	optional	—		stress	Entry 24 of the stiffness matrix in Voigt notation; only with Symmetry: anisotropic, anisotropic plane stress, anisotropic plane strain
C25	number	optional	—		stress	Entry 25 of the stiffness matrix in Voigt notation; only with Symmetry: anisotropic, anisotropic plane stress, anisotropic plane strain
C26	number	optional	—		stress	Entry 26 of the stiffness matrix in Voigt notation; only with Symmetry: anisotropic, anisotropic plane stress, anisotropic plane strain
C33	number	optional	—		stress	Entry 33 of the stiffness matrix in Voigt notation; only with Symmetry: anisotropic, anisotropic plane stress, anisotropic plane strain
C34	number	optional	—		stress	Entry 34 of the stiffness matrix in Voigt notation; only with Symmetry: anisotropic, anisotropic plane stress, anisotropic plane strain
C35	number	optional	—		stress	Entry 35 of the stiffness matrix in Voigt notation; only with Symmetry: anisotropic, anisotropic plane stress, anisotropic plane strain
C36	number	optional	—		stress	Entry 36 of the stiffness matrix in Voigt notation; only with Symmetry: anisotropic, anisotropic plane stress, anisotropic plane strain
C44	number	optional	—		stress	Entry 44 of the stiffness matrix in Voigt notation; only with Symmetry: anisotropic, anisotropic plane stress, anisotropic plane strain
C45	number	optional	—		stress	Entry 45 of the stiffness matrix in Voigt notation; only with Symmetry: anisotropic, anisotropic plane stress, anisotropic plane strain
C46	number	optional	—		stress	Entry 46 of the stiffness matrix in Voigt notation; only with Symmetry: anisotropic, anisotropic plane stress, anisotropic plane strain
C55	number	optional	—		stress	Entry 55 of the stiffness matrix in Voigt notation; only with Symmetry: anisotropic, anisotropic plane stress, anisotropic plane strain
C56	number	optional	—		stress	Entry 56 of the stiffness matrix in Voigt notation; only with Symmetry: anisotropic, anisotropic plane stress, anisotropic plane strain
C66	number	optional	—		stress	Entry 66 of the stiffness matrix in Voigt notation; only with Symmetry: anisotropic, anisotropic plane stress, anisotropic plane strain
State Factor ID	integer	optional	—	≥ 1		Column of the state variables that scales the isotropic elastic constants node by node, e.g. for a degradation computed in a UMAT
Accuracy Order	integer	optional	—	≥ 1		Polynomial order of the bond-associated correspondence formulation
Zero Energy Control	text	optional	—			Stabilization against zero-energy modes of correspondence materials, e.g. "Global"
Bond Associated	true/false	optional	false			Uses the bond-associated correspondence formulation, which evaluates the deformation gradient per bond instead of per node
Linear Strain	true/false	optional	false			Uses the small-strain tensor instead of the Green-Lagrange strain in correspondence materials
Flaw Function	section	optional	—

Shared keys → Flaw Function

Lowers the yield stress around a point to seed localization (Correspondence Plastic)

YAML key	Type	Required	Default	Range	Quantity	Description
Active	true/false	required				Switches the flaw on
Function	text	required		one of: Pre-defined		Shape of the flaw: a Gaussian dip of the yield stress
Flaw Size	number	optional	—	≥ 0	length	Width of the Gaussian dip around the flaw location
Flaw Magnitude	number	optional	—	0 … 1		Relative reduction of the yield stress at the flaw location
Flaw Location X	number	optional	—			x coordinate of the flaw center
Flaw Location Y	number	optional	—			y coordinate of the flaw center
Flaw Location Z	number	optional	—			z coordinate of the flaw center (3D); 0 if not given

1D Bond-based Elastic

One-dimensional bond-based elastic test model that removes the bond between two given nodes

YAML key	Type	Required	Default	Range	Quantity	Description
Id1	integer	required		≥ 1		First node of the removed bond (single core only)
Id2	integer	required		≥ 1		Second node of the removed bond (single core only)

Bond-based Elastic

Linear elastic bond-based material; the Poisson's ratio is fixed by the formulation

| YAML key | Type | Required | Default | Range | Quantity | Description | |–-|–-|–-|–-|–-|–-|–-|

Correspondence Elastic

Linear elastic correspondence material based on the deformation gradient

| YAML key | Type | Required | Default | Range | Quantity | Description | |–-|–-|–-|–-|–-|–-|–-|

Correspondence Plastic

Elastic-plastic correspondence material with von Mises yield criterion

YAML key	Type	Required	Default	Range	Quantity	Description
Yield Stress	number or data file	required		≥ 0	stress	Von Mises stress at which the material yields; a number or a table over a node field

Correspondence UMAT

Correspondence material defined by an Abaqus UMAT subroutine; its properties are given as Property1 … PropertyN

YAML key	Type	Required	Default	Range	Description
File	text	required			UMAT library, relative to the input deck
Number of Properties	integer	required		≥ 1	Number of Property_N values passed to the UMAT
Number of State Variables	integer	optional	—	≥ 0	Size of the state variable field passed to the UMAT
Predefined Field Names	text	optional	—		Node fields passed to the UMAT as predefined fields, separated by spaces
UMAT Material Name	text	optional	—		Material name passed to the UMAT (at most 80 characters)

Correspondence VUMAT

Correspondence material defined by an Abaqus VUMAT subroutine; its properties are given as Property1 … PropertyN

YAML key	Type	Required	Default	Range	Description
File	text	required			VUMAT library, relative to the input deck
Number of Properties	integer	required		≥ 1	Number of Property_N values passed to the VUMAT
Number of State Variables	integer	optional	—	≥ 0	Size of the state variable field passed to the VUMAT
VUMAT Material Name	text	optional	—		Material name passed to the VUMAT (at most 80 characters)

PD Solid Elastic

Linear elastic ordinary state-based material

| YAML key | Type | Required | Default | Range | Quantity | Description | |–-|–-|–-|–-|–-|–-|–-|

PD Solid Plastic

Elastic-plastic ordinary state-based material with von Mises yield criterion

YAML key	Type	Required	Default	Range	Quantity	Description
Yield Stress	number or data file	required		≥ 0	stress	Von Mises stress at which the material yields; a number or a table over a node field

Rigid

Rigid body: no internal forces and no deformation

| YAML key | Type | Required | Default | Range | Quantity | Description | |–-|–-|–-|–-|–-|–-|–-|

Unified Bond-based Elastic

Unified bond-based elastic material after Guan et al. (2024), simplified: no rigid body rotation and no surface correction

| YAML key | Type | Required | Default | Range | Quantity | Description | |–-|–-|–-|–-|–-|–-|–-|

Damage Models

Each entry names its model in Damage Model.

Shared keys

Damage model of the blocks that use this entry: the failure limit of a bond and options shared by all damage models

YAML key	Type	Required	Default	Range	Description
Critical Value	number or data file	required		≥ 0	Failure limit of a bond: the critical stretch or the critical energy release rate, depending on the model; a number or a table over a node field
Interblock Damage	named entries of number	optional	—		Critical values of bonds between two blocks, as "Interblock Critical Value i_j" entries for bonds from block i to block j
Anisotropic Damage	section	optional	—
Local Damping	section	optional	—

Shared keys → Anisotropic Damage

Direction-dependent critical values for Critical Energy Anisotropic, along the material axes

YAML key	Type	Required	Default	Description
Critical Value X	number	required		Critical bond energy for the bond share along the material x axis
Critical Value Y	number	required		Critical bond energy for the bond share along the material y axis
Critical Value Z	number	optional	—	Critical bond energy for the bond share along the material z axis (3D); the y value if not given

Shared keys → Local Damping

Damps the waves released when bonds break (local damping after Silling)

YAML key	Type	Required	Default	Range	Quantity	Description
Representative Young's modulus	number	required		≥ 0	stress	Young's modulus that sets the wave speed of the damping
Damping coefficient	number	required		≥ 0		Strength of the damping; 0 switches it off

Critical Energy

Breaks a bond once its energy exceeds the critical energy release rate

YAML key	Type	Required	Default	Range	Quantity	Description
Only Tension	true/false	optional	true			Breaks bonds only under tension, not under compression
Thickness	number	optional	1	≥ 0	length	Out-of-plane thickness of a 2D model, used to convert the energy release rate to a bond energy

Critical Energy Anisotropic

Critical energy release rate with different critical values along the material axes (Anisotropic Damage)

YAML key	Type	Required	Default	Range	Quantity	Description
Only Tension	true/false	optional	false			Breaks bonds only under tension, not under compression
Thickness	number	optional	1	≥ 0	length	Out-of-plane thickness of a 2D model, used to convert the energy release rate to a bond energy

Critical Stretch

Breaks a bond once its stretch exceeds the critical value

YAML key	Type	Required	Default	Range	Quantity	Description
Only Tension	true/false	optional	true			Breaks bonds only under tension, not under compression

Thermal Models

Each entry names its model in Thermal Model.

Shared keys

Thermal model of the blocks that use this entry, with the keys shared by all thermal models

YAML key	Type	Required	Default	Range	Quantity	Description
Thermal Conductivity	number	optional	—	≥ 0		Thermal conductivity of the material; required by Thermal Flow and used for the stable time step

HETVAL

User-defined heat generation from an Abaqus HETVAL subroutine

YAML key	Type	Required	Default	Range	Description
File	text	required			HETVAL library, relative to the input deck
Number of State Variables	integer	optional	1	≥ 1	Size of the state variable field passed to the HETVAL
HETVAL Material Name	text	optional	—		Material name passed to the HETVAL (at most 80 characters)
Predefined Field Names	text	optional	—		Node fields passed to the HETVAL as predefined fields, separated by spaces; Volume if not given

Heat Transfer

Heat exchange of surface nodes with the environment (convection) and with the build plate

YAML key	Type	Required	Default	Range	Description
Heat Transfer Coefficient	number	required		≥ 0	Heat flow per surface area and temperature difference between surface and environment
Environmental Temperature	number or text	required			Temperature of the surrounding medium: a number, or an expression in the time t
Allow Surface Change	true/false	optional	true		Recomputes the surface in every step, so cracks and added material exchange heat too
Bed Temperature	number or text	optional	—		Temperature of the build plate: a number, or an expression in the time t; without it, faces on the plate exchange heat with the environment
Bed Heat Transfer Coefficient	number	optional	—	≥ 0	Heat flow per contact area and temperature difference between node and build plate; Heat Transfer Coefficient if not given
Bed Thermal Conductivity	number	optional	—	≥ 0	Thermal conductivity of the contact to the build plate; the heat is conducted across half the node height, i.e. Bed Heat Transfer Coefficient = 2 Bed Thermal Conductivity / height
Bed Position	number	optional	0		Position of the build plate along the last coordinate axis (z in 3D, y in 2D)

Thermal Expansion

Thermal strain from the change of temperature

YAML key	Type	Required	Default	Range	Quantity	Description
Thermal Expansion Coefficient	number or list of numbers	required				Thermal strain per temperature change: one value, or one per direction
Reference Temperature	number	optional	—			Temperature without thermal strain; 0 if not given

Thermal Flow

Heat conduction between nodes

YAML key	Type	Required	Default	Range	Quantity	Description
Type	one of: BondBased, Correspondence	optional	BondBased			Formulation of the heat flow: per bond, or from the temperature gradient as in correspondence materials

Additive Models

Each entry names its model in Additive Model.

Degradation Models

Each entry names its model in Degradation Model.

Bond-based Corrosion

Bond-based corrosion model (not implemented yet: computes nothing)

| YAML key | Type | Required | Default | Range | Quantity | Description | |–-|–-|–-|–-|–-|–-|–-|

Thermal Decomposition

Removes nodes and their bonds once the temperature reaches the decomposition temperature

YAML key	Type	Required	Default	Range	Quantity	Description
Decomposition Temperature	number	required			temperature	Temperature at which a node decomposes

Contact

Each entry names its model in Type.

Shared keys

Contact model between pairs of blocks

YAML key	Type	Required	Default	Range	Quantity	Description
Contact Radius	number	required		≥ 0	length	Distance below which two nodes are in contact and repel each other
Contact Groups	named entries of section	required				Named pairs of blocks this contact model acts on
Symmetry	text	optional	3D			Selects the contact stiffness for "plane stress", "plane strain" or 3D (any other value)

Shared keys → Contact Groups

A pair of blocks that can come into contact

YAML key	Type	Required	Default	Range	Quantity	Description
Master Block ID	integer	required		≥ 1		Block id of the master side
Slave Block ID	integer	required		≥ 1		Block id of the slave side
Search Radius	number	required		≥ 0	length	Distance within which the global search collects candidate contact pairs; larger than the contact radius
Global Search Frequency	integer	optional	—	≥ 1		Steps between two global contact searches of this group; overrides the value in Contact Globals

Penalty Contact

Contact by a repulsive penalty force between nodes closer than the contact radius, with optional friction

YAML key	Type	Required	Default	Range	Quantity	Description
Contact Stiffness	number	optional	100000000	≥ 0		Factor on the penalty stiffness that pushes nodes in contact apart
Friction Coefficient	number	optional	0	≥ 0		Coulomb friction coefficient between the contact surfaces

Pre Calculation

Pre Calculation Global and each entry of Pre Calculation Models switch these on (true) or off (false):

Axis Symmetric
Bond Associated Correspondence
Deformation Gradient
Deformed Bond Geometry
Shape Tensor