--- title: "Get the simulation run spec" method: GET path: "/projects/{projectId}/simulations/{simulationId}/runs/{runId}/spec" tags: ["Simulation Runs"] --- # Get the simulation run spec `GET /projects/{projectId}/simulations/{simulationId}/runs/{runId}/spec` ## Response `200` Successful operation. - SimulationSpec - `simulationId` string, uuid - `name` string, required - `version` string, required — The schema version of the simulation spec. This can be either the external version like `30.0`, or the internal version like `internal:549`. - `createdAt` string, date-time - `modifiedAt` string, date-time - `cadId` string, uuid, required — The ID of CAD input to the simulation. - `stateId` string, uuid, required — The ID of CAD state input to the simulation. - `meshId` string, uuid — The generated mesh ID which is to be used in the simulation. This field should be left empty for analysis types that do not require a generated mesh like 'INCOMPRESSIBLE_PACEFISH', 'WIND_COMFORT', and 'SIMERICS_ANALYSIS'. - `model` union, required - SimulationStaticAnalysis - `type` string, required — Schema name: StaticAnalysis - `nonLinearAnalysis` boolean —

Choose if your analysis should feature any kind of nonlinearity like physical contacts, nonlinear materials as hyperelasticity or plasticity or large rotations and large deformations, temperature dependant material properties or temperature dependant boundary conditions. For a linear analysis none of those nonlinearities are available.

- `connectionGroups` SimulationOneOfStaticAnalysisConnectionGroups[] - union - SimulationContact - `type` string, required — Schema name: Contact - `nodeMergingBonded` boolean —

Allow node merging for bonded contacts where possible to increase contact accuracy and solution efficiency. For contact pairs where nodes cannot be merged, linear relations will be used with the defined position tolerance.

- `connections` SimulationOneOfContactConnections[] - … - SimulationPhysicalContact - `type` string, required — Schema name: PhysicalContact - `settings` SimulationConnectionSettingsV36 - … - `connections` SimulationOneOfPhysicalContactConnections[] - … - `connectors` SimulationOneOfStaticAnalysisConnectors[] - union - SimulationPinConnector —

Connect multiple bodies via a virtual pin

Usage:

Define a separate pin connector item for each virtual pin
Assign only cylindrical surfaces

Behavior:

Option to connect bodies to bodies or bodies to the ground via virtual pins
Bodies freely rotate relative to one another about the virtual pin axis
Users have full control over axial translation and rotation of the connection with the ability to define torsional and axial spring stiffness

- `type` string, required —

Connect multiple bodies via a virtual pin

Usage:

Define a separate pin connector item for each virtual pin
Assign only cylindrical surfaces

Behavior:

Option to connect bodies to bodies or bodies to the ground via virtual pins
Bodies freely rotate relative to one another about the virtual pin axis
Users have full control over axial translation and rotation of the connection with the ability to define torsional and axial spring stiffness

Schema name: PinConnector - `name` string - `interaction` 'BODY_TO_BODY' | 'BODY_TO_GROUND' —

Select an interaction option

Body to body - Two or more bodies may be connected to each other via a single virtual pin. The pin will move with the bodies.
Body to ground - Two or more bodies may be connected to the ground via a single virtual pin. The pin remains stationary.

- `kinematicBehavior` SimulationPinKinematicBehavior - … - `advancedPinSettings` SimulationAdvancedConnectorSettings - … - `topologicalReference` SimulationTopologicalReference - … - SimulationBoltConnector —

Connect multiple bodies via a virtual bolt

Usage:

Define a separate bolt connector item for each virtual bolt
Assign entities must be coaxial

Behavior:

Bolt connectors mimic physical bolts using beam formulations. Relative translations and rotations of the connected entities are computed based on the defined bolt mechanical properties
Ability to apply preload

- `type` string, required —

Connect multiple bodies via a virtual bolt

Usage:

Define a separate bolt connector item for each virtual bolt
Assign entities must be coaxial

Behavior:

Bolt connectors mimic physical bolts using beam formulations. Relative translations and rotations of the connected entities are computed based on the defined bolt mechanical properties
Ability to apply preload

Schema name: BoltConnector - `name` string - `boltType` 'BOLT_AND_NUT' | 'SCREW' —

Select your desired type of fastener

Bolt and nut - a virtual connection between a bolt head and nut location
Screw - a virtual connection between a screw head location and a cylindrical surface representing a threaded section

- `shankDiameter` SimulationDimensionalLength - … - `mechanicalProperties` SimulationBoltMechanicalProperties - … - `enableBoltPreload` boolean — Enable the definition of pretension within the virtual bolt. - `preload` SimulationForcePreload - … - `advancedBoltSettings` SimulationAdvancedConnectorSettings - … - `masterTopologicalReference` SimulationTopologicalReference - … - `slaveTopologicalReference` SimulationTopologicalReference - … - `elementTechnology` SimulationSolidElementTechnology - `elementTechnology3D` SimulationElementTechnology - `definitionMethod` union - SimulationAutomaticElementDefinitionMethod - … - SimulationCustomElementDefinitionMethod - … - `model` SimulationSolidModel - `geometricBehavior` 'LINEAR' | 'NONLINEAR' - `magnitude` SimulationDimensionalFunctionAcceleration - `value` union - SimulationConstantFunction - … - SimulationExpressionFunction - … - SimulationPolynomialFunction - … - SimulationTableDefinedFunction - … - `unit` 'm/s²' | 'in/s²' | 'G', required - `e` SimulationDimensionalVectorLength - `value` SimulationDecimalVector - `x` number - `y` number - `z` number - `unit` 'm' | 'in' | 'mm' | 'cm' | 'ft' | 'yd', required - `materials` SimulationSolidMaterial[] - `name` string - `materialBehavior` union - object —

Choose the material behavior for your problem.

Important remarks:

Choose Linear elastic if the stress-strain relationship of your material is linear.
Choose Elasto-plastic if the stress-strain relationship of your material is non-linear after some point e.g. yielding point.
Choose Hyperelastic if your material responds elastically even at higher deformations.

- `type` string, required —

Choose the material behavior for your problem.

Important remarks:

Choose Linear elastic if the stress-strain relationship of your material is linear.
Choose Elasto-plastic if the stress-strain relationship of your material is non-linear after some point e.g. yielding point.
Choose Hyperelastic if your material responds elastically even at higher deformations.

Schema name: LinearElasticMaterialBehavior - `directionalDependency` union —

Choose the directional dependency for this property:

Isotropic material: all the material properties are the same in all directions
Orthotropic material: different material properties in different orthogonal directions (e.g. glass-reinforced plastic, or wood)

- … - `damping` union - … - `creepFormulation` union —
Define the Creep formulation. Three different formulations are available: Norton, Strain Hardening or Time Hardening.
They are based on the Power Law:
ε̇ = m*A*σⁿ*t^m-1
- … - object —
Choose the material behavior for your problem.

Important remarks:

Choose Linear elastic if the stress-strain relationship of your material is linear.
Choose Elasto-plastic if the stress-strain relationship of your material is non-linear after some point e.g. yielding point.
Choose Hyperelastic if your material responds elastically even at higher deformations.
- `type` string, required —
Choose the material behavior for your problem.

Important remarks:

Choose Linear elastic if the stress-strain relationship of your material is linear.
Choose Elasto-plastic if the stress-strain relationship of your material is non-linear after some point e.g. yielding point.
Choose Hyperelastic if your material responds elastically even at higher deformations.
Schema name: HyperElasticMaterialBehavior - `hyperElasticModel` union —
Choose the hyperelastic material model that should be used. All models derive the stress-strain relation from a strain energy function defined by the material model parameters.
- … - object —
Choose the material behavior for your problem.

Important remarks:

Choose Linear elastic if the stress-strain relationship of your material is linear.
Choose Elasto-plastic if the stress-strain relationship of your material is non-linear after some point e.g. yielding point.
Choose Hyperelastic if your material responds elastically even at higher deformations.
- `type` string, required —
Choose the material behavior for your problem.

Important remarks:

Choose Linear elastic if the stress-strain relationship of your material is linear.
Choose Elasto-plastic if the stress-strain relationship of your material is non-linear after some point e.g. yielding point.
Choose Hyperelastic if your material responds elastically even at higher deformations.
Schema name: PlasticMaterialBehavior - `elastoPlasticModel` union — Choose the Elasto-plastic model for your problem.

Important remarks:
Choose Bilinear if the material response is a combination of linear elastic and plastic behavior and is defined by the elastic modulus, yield strength, and, tangent modulus.
Choose Multilinear if the material response is a combination of linear elastic-plastic behavior and is defined by the elastic modulus, yield strength, and, multiple tangent moduli.
Choose Johnson-Cook if the material response includes strain hardening, strain rate hardening, and thermal softening effects, and is defined by parameters such as yield stress, hardening coefficient, hardening exponent, strain rate hardening coefficient, and thermal softening exponent.
Learn more - … - `density` SimulationDimensionalFunctionDensity - `value` union - SimulationConstantFunction - … - SimulationExpressionFunction - … - SimulationPolynomialFunction - … - SimulationTableDefinedFunction - … - `unit` 'kg/m³' | 'lb/in³' | 'g/mm³' | 'g/cm³' | 't/mm³' | 'lb/ft³', required - `expansion` SimulationIsotropicExpansion —
Define the directional dependency of this property. Isotropic means directionally independent.
- `type` string, required —
Define the directional dependency of this property. Isotropic means directionally independent.
Schema name: IsotropicExpansion - `expansionCoefficient` SimulationDimensionalFunctionThermalExpansionRate - `value` union - … - `unit` '1/K' | '1/°F', required - `referenceTemperature` SimulationDimensionalTemperature - `value` number - `unit` '°C' | '°F' | 'K', required - `conductivity` union - object —
Define the directional dependency of this property. Isotropic means directionally independent. Orthotropic means directionally dependent.
- `type` string, required —
Define the directional dependency of this property. Isotropic means directionally independent. Orthotropic means directionally dependent.
Schema name: IsotropicConductivity - `thermalConductivity` SimulationDimensionalFunctionThermalConductivity - … - `thermalConductivityFunction` SimulationDimensionalFunctionThermalConductivity - … - object —
Define the directional dependency of this property. Isotropic means directionally independent. Orthotropic means directionally dependent.
- `type` string, required —
Define the directional dependency of this property. Isotropic means directionally independent. Orthotropic means directionally dependent.
Schema name: OrthotropicConductivity - `thermalConductivityX` SimulationDimensionalFunctionThermalConductivity - … - `thermalConductivityY` SimulationDimensionalFunctionThermalConductivity - … - `thermalConductivityZ` SimulationDimensionalFunctionThermalConductivity - … - `specificHeat` SimulationDimensionalFunctionSpecificHeat - `value` union - SimulationConstantFunction - … - SimulationExpressionFunction - … - SimulationPolynomialFunction - … - SimulationTableDefinedFunction - … - `unit` 'J/(kg·K)' | 'Btu/(lb·°F)', required - `topologicalReference` SimulationTopologicalReference - `entities` string[] - `sets` string[] - `builtInMaterial` string - `materialLibraryReference` SimulationMaterialLibraryReference - `materialGroupId` string - `materialId` string - `interpolationParameters` object - `initialConditions` SimulationSolidInitialConditions - `displacement` SimulationDimensionalVectorFunctionInitialConditionWithDomainsLength - `global` SimulationDimensionalVectorFunctionLength - `value` union - … - `unit` 'm' | 'in' | 'mm' | 'cm' | 'ft' | 'yd', required - `subdomains` SimulationSubdomainBasedDimensionalVectorFunctionInitialConditionLength[] - `name` string - `subdomainValue` SimulationDimensionalVectorFunctionLength - … - `topologicalReference` SimulationTopologicalReference - … - `velocity` SimulationDimensionalVectorFunctionInitialConditionWithDomainsSpeed - `global` SimulationDimensionalVectorFunctionSpeed - `value` union - … - `unit` 'm/s' | 'in/s' | 'm/min' | 'm/h' | 'mm/s' | 'mm/min' | 'mm/h' | 'cm/s' | 'cm/min' | 'cm/h' | 'km/h' | 'ft/s' | 'ft/min' | 'ft/h' | 'in/min' | 'in/h' | 'mph' | 'kn', required - `subdomains` SimulationSubdomainBasedDimensionalVectorFunctionInitialConditionSpeed[] - `name` string - `subdomainValue` SimulationDimensionalVectorFunctionSpeed - … - `topologicalReference` SimulationTopologicalReference - … - `acceleration` SimulationDimensionalVectorFunctionInitialConditionWithDomainsAcceleration - `global` SimulationDimensionalVectorFunctionAcceleration - `value` union - … - `unit` 'm/s²' | 'in/s²' | 'G', required - `subdomains` SimulationSubdomainBasedDimensionalVectorFunctionInitialConditionAcceleration[] - `name` string - `subdomainValue` SimulationDimensionalVectorFunctionAcceleration - … - `topologicalReference` SimulationTopologicalReference - … - `stress` SimulationStressInitialConditionDomains - `global` SimulationStressTensorPressure - `sigmaXX` union - … - `sigmaYY` union - … - `sigmaZZ` union - … - `sigmaYZ` union - … - `sigmaXZ` union - … - `sigmaXY` union - … - `unit` 'Pa' | 'lbf/in²' | 'hPa' | 'kPa' | 'MPa' | 'atm' | 'mbar' | 'bar' | 'mH2O' | 'mmH2O' | 'mmHg' | 'dyne/cm²' | 'inH2O' | 'ftH2O' | 'inHg' | 'psf', required - `subdomains` SimulationSubdomainStressInitialCondition[] - `name` string - `subdomainValue` SimulationStressTensorPressure - … - `topologicalReference` SimulationTopologicalReference - … - `temperature` SimulationDimensionalFunctionInitialConditionDomainsTemperature - `global` SimulationDimensionalFunctionTemperature - `value` union - … - `unit` '°C' | '°F' | 'K', required - `subdomains` SimulationSubdomainDimensionalFunctionInitialConditionTemperature[] - `name` string - `subdomainValue` SimulationDimensionalFunctionTemperature - … - `topologicalReference` SimulationTopologicalReference - … - `boundaryConditions` SimulationOneOfStaticAnalysisBoundaryConditions[] - union - SimulationBoltPreloadBC — Bolt preload boundary condition helps to model pre-stressed bolts in a CAD geometry for structural analysis. Enter a preload force to be assigned to cylindrical faces representing the shank of the bolt.
Note:
These faces should be continuous and not be assigned to contact definitions.
Each bolt gets only one load, if multiple faces for the same bolt are assigned, they get ignored.
The applied load does not get distributed if multiple bolts are assigned.
Learn more. - `type` string, required — Bolt preload boundary condition helps to model pre-stressed bolts in a CAD geometry for structural analysis. Enter a preload force to be assigned to cylindrical faces representing the shank of the bolt.
Note:
These faces should be continuous and not be assigned to contact definitions.
Each bolt gets only one load, if multiple faces for the same bolt are assigned, they get ignored.
The applied load does not get distributed if multiple bolts are assigned.
Learn more. Schema name: BoltPreloadBC - `name` string - `preload` SimulationForcePreload - … - `topologicalReference` SimulationTopologicalReference - … - SimulationElasticSupportBC —
The elastic support constraint can be used to model an elastic foundation between the assigned surfaces and the rigid ground. Additionally it can be used to prevent rigid body motions in a nonlinear analysis. The constraint acts on tension and compression forces and all stiffness values are expressed in the global coordinate system.
Learn more.
- `type` string, required —
The elastic support constraint can be used to model an elastic foundation between the assigned surfaces and the rigid ground. Additionally it can be used to prevent rigid body motions in a nonlinear analysis. The constraint acts on tension and compression forces and all stiffness values are expressed in the global coordinate system.
Learn more.
Schema name: ElasticSupportBC - `name` string - `springStiffness` union —
The stiffness can either be assumed equal in all directions by selecting isotropic or it can depend on the force direction by selecting orthotropic. For an orthotropic stiffness the stiffness value along each global coordinate direction can be given independently.
- … - `topologicalReference` SimulationTopologicalReference - … - SimulationFixedSupportBC —
If a fixed support boundary condition is used, all degrees of freedom of the selected entities are fixed at zero. This constraint is often used to model a fixation to the ground or an undeformable part.
Learn more.
- `type` string, required —
If a fixed support boundary condition is used, all degrees of freedom of the selected entities are fixed at zero. This constraint is often used to model a fixation to the ground or an undeformable part.
Learn more.
Schema name: FixedSupportBC - `name` string - `topologicalReference` SimulationTopologicalReference - … - SimulationFixedValueBC — This is a boundary condition for the displacement vector variable. You can define prescribed values for the displacement of the assigned groups in every coordinate direction (x,y,z) or leave it unconstrained in order to let the entity move freely.

Important remarks:
Choose 0 as value in order to fix your selection.
Do not constrain entities in directions where a load boundary condition is applied.
Do not constrain entities with multiple Dirichlet boundary conditions in one direction (overconstrained).
Do not constrain slave entities of Contact Constraints as they are constrained by the master in that direction (overconstrained).
Learn more. - `type` string, required — This is a boundary condition for the displacement vector variable. You can define prescribed values for the displacement of the assigned groups in every coordinate direction (x,y,z) or leave it unconstrained in order to let the entity move freely.

Important remarks:
Choose 0 as value in order to fix your selection.
Do not constrain entities in directions where a load boundary condition is applied.
Do not constrain entities with multiple Dirichlet boundary conditions in one direction (overconstrained).
Do not constrain slave entities of Contact Constraints as they are constrained by the master in that direction (overconstrained).
Learn more. Schema name: FixedValueBC - `name` string - `displacement` SimulationDimensionalPartialVectorFunctionLength - … - `topologicalReference` SimulationTopologicalReference - … - SimulationPointMassBC —
Define a Point mass boundary condition in order to insert an additional mass on a specific location of the active model.
- `type` string, required —
Define a Point mass boundary condition in order to insert an additional mass on a specific location of the active model.
Schema name: PointMassBC - `name` string - `mass` SimulationDimensionalMass - … - `massMomentOfInertia` SimulationDimensionalVectorMomentOfInertia - … - `externalPoint` SimulationDimensionalVectorLength - … - `deformationBehavior` 'DEFORMABLE' | 'UNDEFORMABLE' —
Choose the deformation behavior of the entity which the point mass is connected to. If deformable is selected, the entity is allowed to deform, selecting undeformable leads to a rigid entity.
- `enableSearchRadius` boolean - `searchRadius` SimulationDimensionalLength - … - `topologicalReference` SimulationTopologicalReference - … - SimulationDistributedMassBC —
Define a Distributed mass boundary condition in order to insert an additional mass on a specific face of the active model.
- `type` string, required —
Define a Distributed mass boundary condition in order to insert an additional mass on a specific face of the active model.
Schema name: DistributedMassBC - `name` string - `massDefinition` union — Define how the distributed mass is specified: either as a total mass that will be distributed across the selected surface, or as an area density that represents mass per unit area. - … - `topologicalReference` SimulationTopologicalReference - … - SimulationRemoteDisplacementLoadBC — This boundary condition restrains the displacement of a face or edge relative to a specified remote point. Therefore the assignment is connected to the remote point with RBE3 (deformable) or MPC (undeformable) conditions and the defined constraints are applied to the remote point.

Important remarks:
As the assignments are connected to the remote point, additional constraints on these nodes may lead to overconstrained systems.
If the number of nodes of the assigment is large (>1000), it is recommended to use the MUMPS or PETSC solver.
This boundary condition is only valid for small rotations. For large rotations, please use Rotating motion boundary conditions.
Learn more. - `type` string, required — This boundary condition restrains the displacement of a face or edge relative to a specified remote point. Therefore the assignment is connected to the remote point with RBE3 (deformable) or MPC (undeformable) conditions and the defined constraints are applied to the remote point.

Important remarks:
As the assignments are connected to the remote point, additional constraints on these nodes may lead to overconstrained systems.
If the number of nodes of the assigment is large (>1000), it is recommended to use the MUMPS or PETSC solver.
This boundary condition is only valid for small rotations. For large rotations, please use Rotating motion boundary conditions.
Learn more. Schema name: RemoteDisplacementLoadBC - `name` string - `displacement` SimulationDimensionalPartialVectorFunctionLength - … - `rotation` SimulationDimensionalPartialVectorFunctionAngle - … - `externalPoint` SimulationDimensionalVectorLength - … - `deformationBehavior` 'DEFORMABLE' | 'UNDEFORMABLE' —
Choose the deformation behavior of the assigned entity. If deformable is selected, the entity is allowed to deform, selecting undeformable leads to a rigid entity.
- `enableSearchRadius` boolean - `searchRadius` SimulationDimensionalLength - … - `topologicalReference` SimulationTopologicalReference - … - SimulationRotatingMotionBC —
The rotating motion constraint applies a predefined rigid body rotation to the assigned entities. The rotation axis, the base point, and the rotation angle needs to be specified. Each component can be defined with a formula or table input.

Important remarks:
If a component of the rotation axis is input via formula or table, then ensure that the length of the axis vector is always positive.
If a continuous, transient rotation is required, then the rotation angle has to be given either as a formula or table value.
Learn more. - `type` string, required —
The rotating motion constraint applies a predefined rigid body rotation to the assigned entities. The rotation axis, the base point, and the rotation angle needs to be specified. Each component can be defined with a formula or table input.

Important remarks:
If a component of the rotation axis is input via formula or table, then ensure that the length of the axis vector is always positive.
If a continuous, transient rotation is required, then the rotation angle has to be given either as a formula or table value.
Learn more. Schema name: RotatingMotionBC - `name` string - `rotationOrigin` SimulationDimensionalVectorFunctionLength - … - `rotationAxis` SimulationDimensionalVectorFunctionLength - … - `omega` SimulationDimensionalFunctionAngle - … - `topologicalReference` SimulationTopologicalReference - … - SimulationSymmetryPlaneBC — This boundary condition restrains the displacement of a face in its normal direction in order to represent a symmetry plane of the structure. Use this boundary condition to reduce the model size significantly if the geometry and the loading conditions are symmetric.

Important remarks:
The solver uses linear relations between all three DOFs to constrian the normal movement, thus overcontraint conditions may appear if the edges of the selected faces are constrained by other displacement boundary conditions.
If the assigned faces are orthogonal to a global coordinate axes, it is recommended to directly specifiy the symmetry conditions with a Fixed value boundary condition.
Learn more. - `type` string, required — This boundary condition restrains the displacement of a face in its normal direction in order to represent a symmetry plane of the structure. Use this boundary condition to reduce the model size significantly if the geometry and the loading conditions are symmetric.

Important remarks:
The solver uses linear relations between all three DOFs to constrian the normal movement, thus overcontraint conditions may appear if the edges of the selected faces are constrained by other displacement boundary conditions.
If the assigned faces are orthogonal to a global coordinate axes, it is recommended to directly specifiy the symmetry conditions with a Fixed value boundary condition.
Learn more. Schema name: SymmetryPlaneBC - `name` string - `topologicalReference` SimulationTopologicalReference - … - SimulationCyclicSymmetryBC —
The cyclic symmetry constraint enables to model only a sector of a 360° cyclic periodic structure and reduces the computation time and memory consumption considerably. The user defines the center and axis of the cyclic symmetry as well as the sector angle. The master and slave surfaces define the cyclic periodicity boundaries.

Important remarks:
All DOFs of the slave nodes will be constrained, adding an additional constraint on those nodes may lead to an overconstrained system.
This is a linear constraint, so no large rotations or large deformations are allowed in the proximity of cyclic symmetry boundaries.
Learn more.
- `type` string, required —
The cyclic symmetry constraint enables to model only a sector of a 360° cyclic periodic structure and reduces the computation time and memory consumption considerably. The user defines the center and axis of the cyclic symmetry as well as the sector angle. The master and slave surfaces define the cyclic periodicity boundaries.

Important remarks:
All DOFs of the slave nodes will be constrained, adding an additional constraint on those nodes may lead to an overconstrained system.
This is a linear constraint, so no large rotations or large deformations are allowed in the proximity of cyclic symmetry boundaries.
Learn more.
Schema name: CyclicSymmetryBC - `name` string - `enableHeatTransfer` 'YES' | 'NO' | 'HEAT_TRANSFER_ONLY' —
Define if heat transfer should be allowed across the contact. If yes is chosen a perfectly bonded heat contact is assumed whereas if no is selected no heat transfer across the contact is allowed. Mechanical contact stays with both options active. With the selection of heat transfer only no mechanical contact is activated but only a bonded heat contact.
- `axisOrigin` SimulationDimensionalVectorLength - … - `axisDirection` SimulationDimensionalVectorLength - … - `sectorAngle` SimulationDimensionalAngle - … - `masterTopologicalReference` SimulationTopologicalReference - … - `slaveTopologicalReference` SimulationTopologicalReference - … - SimulationCentrifugalForceBC —
This is a centrifugal force boundary condition. Each volume element of the selection is loaded with a centrifugal force which is calculated depending on its volume, the density of the assigned material, its distance from the axis of rotation and the defined rotational velocity.
Learn more.
- `type` string, required —
This is a centrifugal force boundary condition. Each volume element of the selection is loaded with a centrifugal force which is calculated depending on its volume, the density of the assigned material, its distance from the axis of rotation and the defined rotational velocity.
Learn more.
Schema name: CentrifugalForceBC - `name` string - `rotation` SimulationAngularRotation - … - `topologicalReference` SimulationTopologicalReference - … - SimulationFollowerPressureBC — In contrast to ordinary pressure, the follower pressure boundary condition is applied normal to the surface of all face elements in the deformed state. This is a nonlinear boundary condition as the update of the geometry is required. In a linear analysis it becomes a simple pressure boundary condition.

The following conditions are taken into account:
The current deformed state of the surface.
Any changes in the direction of the normals of assigned entities.
Changes in the surface area of the assigned faces.
Learn more. - `type` string, required — In contrast to ordinary pressure, the follower pressure boundary condition is applied normal to the surface of all face elements in the deformed state. This is a nonlinear boundary condition as the update of the geometry is required. In a linear analysis it becomes a simple pressure boundary condition.

The following conditions are taken into account:
The current deformed state of the surface.
Any changes in the direction of the normals of assigned entities.
Changes in the surface area of the assigned faces.
Learn more. Schema name: FollowerPressureBC - `name` string - `pressure` SimulationDimensionalFunctionPressure - … - `topologicalReference` SimulationTopologicalReference - … - SimulationForceLoadBC —
This is a force boundary condition representing a distributed force on the selection. The total force is defined in the global coordinate system and each element of the assignment is loaded with a surface traction depending on the area of the element.
Learn more.
- `type` string, required —
This is a force boundary condition representing a distributed force on the selection. The total force is defined in the global coordinate system and each element of the assignment is loaded with a surface traction depending on the area of the element.
Learn more.
Schema name: ForceLoadBC - `name` string - `force` SimulationDimensionalVectorFunctionForce - … - `scaling` SimulationDimensionalFunctionDimensionless - … - `phaseAngle` SimulationDimensionalAngle - … - `topologicalReference` SimulationTopologicalReference - … - SimulationNodalLoadBC — This is a force boundary condition representing an equal point force on each node of the assignment. The total force applied on the assignment is calculated as the user defined forces times the number of nodes in the assignment.

Important remarks:
Currently, it only works on uploaded meshes
As the total load is depending on the number of nodes, and thus the mesh fineness, it is recommended only for loads on single nodes.
In most cases point loads are unphysical and distributed loads should be used instead.
- `type` string, required — This is a force boundary condition representing an equal point force on each node of the assignment. The total force applied on the assignment is calculated as the user defined forces times the number of nodes in the assignment.

Important remarks:
Currently, it only works on uploaded meshes
As the total load is depending on the number of nodes, and thus the mesh fineness, it is recommended only for loads on single nodes.
In most cases point loads are unphysical and distributed loads should be used instead.
Schema name: NodalLoadBC - `name` string - `force` SimulationDimensionalVectorFunctionForce - … - `scaling` SimulationDimensionalFunctionDimensionless - … - `phaseAngle` SimulationDimensionalAngle - … - `topologicalReference` SimulationTopologicalReference - … - SimulationPressureBC — This is a pressure boundary condition representing a distributed load on the selection. It is applied normal to the surface of all face elements.

Important remarks:
The applied total force depends on the surface area of the selection.
The normal direction of the faces is computed only in the undeformed state and not updated for large deformations.
For transient analyses you may define a time dependent value by uploading a table (csv-file).
Learn more. - `type` string, required — This is a pressure boundary condition representing a distributed load on the selection. It is applied normal to the surface of all face elements.

Important remarks:
The applied total force depends on the surface area of the selection.
The normal direction of the faces is computed only in the undeformed state and not updated for large deformations.
For transient analyses you may define a time dependent value by uploading a table (csv-file).
Learn more. Schema name: PressureBC - `name` string - `pressure` SimulationDimensionalFunctionPressure - … - `phaseAngle` SimulationDimensionalAngle - … - `topologicalReference` SimulationTopologicalReference - … - SimulationRemoteForceLoadBC — This is a remote force boundary condition where the load is applied on the assignment via a remote point. Therefore the assignment is connected to the remote point with RBE3 (deformable) or MPC (undeformable) conditions and the defined force is applied to the remote point.

Important remarks:
The total force will be distributed on the selection.
As the assignments are connected to the remote point, additional constraints on these nodes may lead to overconstrained systems.
If the number of nodes of the assignment is large (>1000), it is recommended to use the MUMPS or PETSC solver.
This boundary condition is only valid for small rotations.
Learn more. - `type` string, required — This is a remote force boundary condition where the load is applied on the assignment via a remote point. Therefore the assignment is connected to the remote point with RBE3 (deformable) or MPC (undeformable) conditions and the defined force is applied to the remote point.

Important remarks:
The total force will be distributed on the selection.
As the assignments are connected to the remote point, additional constraints on these nodes may lead to overconstrained systems.
If the number of nodes of the assignment is large (>1000), it is recommended to use the MUMPS or PETSC solver.
This boundary condition is only valid for small rotations.
Learn more. Schema name: RemoteForceLoadBC - `name` string - `force` SimulationDimensionalVectorFunctionForce - … - `moment` SimulationDimensionalVectorFunctionTorque - … - `scaling` SimulationDimensionalFunctionDimensionless - … - `phaseAngle` SimulationDimensionalAngle - … - `remotePoint` SimulationDimensionalVectorLength - … - `deformationBehavior` 'DEFORMABLE' | 'UNDEFORMABLE' —
Choose the deformation behavior of the assigned entity. If deformable is selected, the entitiy is allowed to deform without applying additional stiffness, selecting undeformable leads to a rigid entity.
- `enableSearchRadius` boolean - `searchRadius` SimulationDimensionalLength - … - `topologicalReference` SimulationTopologicalReference - … - SimulationSurfaceLoadBC — This is a surface load boundary condition representing a distributed load on the selection. It is applied as surface traction in the global coordinate system.

Important remarks:
The applied total force depends on the surface area of the selection
Learn more. - `type` string, required — This is a surface load boundary condition representing a distributed load on the selection. It is applied as surface traction in the global coordinate system.

Important remarks:
The applied total force depends on the surface area of the selection
Learn more. Schema name: SurfaceLoadBC - `name` string - `load` SimulationDimensionalVectorFunctionPressure - … - `scaling` SimulationDimensionalFunctionDimensionless - … - `phaseAngle` SimulationDimensionalAngle - … - `topologicalReference` SimulationTopologicalReference - … - SimulationVolumeLoadBC — This is a volume load boundary condition representing a distributed load on the selected volumes applied in the global coordinate system and each element of the assignment is loaded with a volume force depending on the volume of the element.

Important remarks:
The applied total force depends on the volume of the selection.
Learn more. - `type` string, required — This is a volume load boundary condition representing a distributed load on the selected volumes applied in the global coordinate system and each element of the assignment is loaded with a volume force depending on the volume of the element.

Important remarks:
The applied total force depends on the volume of the selection.
Learn more. Schema name: VolumeLoadBC - `name` string - `load` SimulationDimensionalVectorFunctionVolumeForce - … - `scaling` SimulationDimensionalFunctionDimensionless - … - `phaseAngle` SimulationDimensionalAngle - … - `topologicalReference` SimulationTopologicalReference - … - SimulationHingeConstraintBC — Replicate the behaviour of a freely rotating hinge fixed to the ground. Note that only a single face assignment is allowed. The assigned surface is constrained such that only rotational motion around the hinge axis is free. SimScale can automatically detect the axis of the hinge based on an assigned cylindrical surface, but the boundary condition also allows for a user-defined input. - `type` string, required — Replicate the behaviour of a freely rotating hinge fixed to the ground. Note that only a single face assignment is allowed. The assigned surface is constrained such that only rotational motion around the hinge axis is free. SimScale can automatically detect the axis of the hinge based on an assigned cylindrical surface, but the boundary condition also allows for a user-defined input. Schema name: HingeConstraintBC - `name` string - `axisDefinition` union - … - `topologicalReference` SimulationTopologicalReference - … - `numerics` SimulationSolidNumerics - `harmonicSolutionMethod` 'MODAL_BASED' | 'DIRECT' — Select the basis for the computation of the harmonic analysis. - `solver` union - object - `type` string, required — Schema name: MUMPSSolver - `advancedMumpsSettings` SimulationAdvancedMUMPSSettings - … - object - `type` string, required — Schema name: MultifrontalSolver - `renumberingMethod` 'MDA' | 'MD' — Choose a renumbering method for the solution process.
For large models around and above 50000 degrees of freedom you should consider using MDA. - `forceSymmetric` boolean — Choose if you want to enforce a symmetric matrix. - `precisionSingularityDetection` integer — Define the precision value for the detection of a singular matrix. Positive values enable the check, with 9 being a good starting point. Smaller values make the check more strict. This is an advanced option that should only be used to debug a model. - `stopIfSingular` boolean — Choose if the calculation should be stopped if the problem turns out to be singular. - `eliminateLagrangeMultipliers` boolean — This option makes it possible to eliminate the Lagrange Multipliers which are introduced by generalized boundary conditions like bonded contact, remote boundary conditions and symmetry conditions. If activated, this option removes the Lagrange Multipliers which leads to a reduction of the total number of unknowns and can increase the robustness of iterative solvers. - object - `type` string, required — Schema name: PETSCSolver - `convergenceThreshold` number — Set the threshold value for convergence detection for the relative convergence criteria. - `maxIterations` integer — Set the maximum number of iterations for the iterative solver. If set to 0 PETSC sets an estimate of the maximum number of iterations. - `advancedPetscSettings` SimulationAdvancedPETSCSettings - … - object - `type` string, required — Schema name: ChronosSolver - `convergenceThreshold` number — Select the convergence tolerance. Can be smaller than with PETSc, and has a big impact on the newton convergence. It is recommended to start with a smaller value in case of convergence problems e.g. 1e-8 - 1e-10. - `maxIterations` integer — Maximum number of iterations for Chronos. Should be 1000 for AMG (max 3000), and 5000 with FSAI (max 10000). - `nonConvergenceAction` 'STOP' | 'SWITCH_TO_DIRECT_SOLVER' — Choose what happens if the linear solution with Chronos fails. Either stop the simulation, or rerun it with a direct solver (MUMPS) - `advancedSettings` SimulationAdvancedChronosSettings - … - `solveModel` SimulationSolverModel - `eigenSolver` union - object - `type` string, required — Schema name: IRAMSorensen - `precSoren` number - `nmaxIterSoren` integer - `subspaceSettings` union —
Specify the subspace used by the eigensolver. This setting should only be changed if the errors during the solution procedure occur that recommend to change it. In general, the more frequencies are computed, the larger the subspace should be.

Automatic: The solver selects an appropriate subspace itself based on the model and other inputs.
Dimension: Directly specify the subspace dimension. This should be only done after checking the error log, which gives hints on selecting this setting.
Coefficient: Multiplier for setting the subspace dimension proportional to the number of computed frequencies
- … - object - `type` string, required — Schema name: Lanczos - `precOrtho` number - `nmaxIterOrtho` integer - `precLanczos` number - `maxIterQR` integer - `modeRigid` boolean - `subspaceSettings` union —
Specify the subspace used by the eigensolver. This setting should only be changed if the errors during the solution procedure occur that recommend to change it. In general, the more frequencies are computed, the larger the subspace should be.

Automatic: The solver selects an appropriate subspace itself based on the model and other inputs.
Dimension: Directly specify the subspace dimension. This should be only done after checking the error log, which gives hints on selecting this setting.
Coefficient: Multiplier for setting the subspace dimension proportional to the number of computed frequencies
- … - object - `type` string, required — Schema name: BatheWilson - `precBathe` number - `nmaxIterBathe` integer - `precJacobi` number - `maxIterJacobi` integer - `subspaceSettings` union —
Specify the subspace used by the eigensolver. This setting should only be changed if the errors during the solution procedure occur that recommend to change it. In general, the more frequencies are computed, the larger the subspace should be.

Automatic: The solver selects an appropriate subspace itself based on the model and other inputs.
Dimension: Directly specify the subspace dimension. This should be only done after checking the error log, which gives hints on selecting this setting.
Coefficient: Multiplier for setting the subspace dimension proportional to the number of computed frequencies
- … - object - `type` string, required — Schema name: QZ - `typeQZ` 'QZ_SIMPLE' | 'QZ_EQUI' | 'QZ_QR' - `calculateFrequency` SimulationCalculateFrequency - `precShift` number - `maxIterShift` integer - `thresholdFrequency` number - `eigenMode` SimulationEigenModeVerification - `threshold` number - `precisionShift` number - `enhancedAccuracy` boolean — Further increase the accuracy of the results by running two simulations. The results of the first one will be used as input for the second one to fine-tune the setup. - `modalBase` SimulationModalSolver - `solver` union —
Choose a linear equation system solver for your calculation:
Multfront is a direct solver of the multifrontal type. It is easy to set up and behaves well for most problems.
MUMPS is a general purpose direct solver of the multifrontal type. It provides a lot of parameter settings to allow the best fitting to your problems needs.
- SimulationMUMPSSolver - … - SimulationMultifrontalSolver - … - `solverModel` SimulationSolverModel - `eigenSolver` union - SimulationIRAMSorensen - … - SimulationLanczos - … - SimulationBatheWilson - … - SimulationQZ - … - `calculateFrequency` SimulationCalculateFrequency - `precShift` number - `maxIterShift` integer - `thresholdFrequency` number - `eigenMode` SimulationEigenModeVerification - `threshold` number - `precisionShift` number - `enhancedAccuracy` boolean — Further increase the accuracy of the results by running two simulations. The results of the first one will be used as input for the second one to fine-tune the setup. - `harmonicResponse` SimulationHarmonicResponse - `solver` SimulationMUMPSSolver - `type` string, required — Schema name: MUMPSSolver - `advancedMumpsSettings` SimulationAdvancedMUMPSSettings - … - `mechanicalTimeIntegrationType` union - object —
Choose the time integration scheme type

Important remarks:
Choose implicit if the problem is static or dynamic but not so complex. Implicit analysis takes more solution time but can solve the problem easily with larger timesteps. Therefore, it is always recommended to use implicit time integration scheme.
Choose explicit if the problem is only dynamic and highly complex. Explicit analysis takes less solution time but also needs more refined (small) timesteps to solve the problem. Therefore, in most of the cases it's not recommended due to convergence problems.
- `type` string, required —
Choose the time integration scheme type

Important remarks:
Choose implicit if the problem is static or dynamic but not so complex. Implicit analysis takes more solution time but can solve the problem easily with larger timesteps. Therefore, it is always recommended to use implicit time integration scheme.
Choose explicit if the problem is only dynamic and highly complex. Explicit analysis takes less solution time but also needs more refined (small) timesteps to solve the problem. Therefore, in most of the cases it's not recommended due to convergence problems.
Schema name: ImplicitTimeIntegrationType - `scheme` union - … - `schemeFormulation` 'DISPLACEMENT' —
Choose the primary variable for the time integration scheme.
- `massMatrixShift` number —
This parameter c_K allows the shifting of the mass matrix with the stiffness matrix multiplied by c_K: M^'=M + c_K*K. This makes it possible to strongly improve convergence in dynamics with implicit time scheme by imposing a cut-off frequency inversely proportional to the value of c_K (at the cost of a light distortion of all the eigen frequencies of the system).
- object —
Choose the time integration scheme type

Important remarks:
Choose implicit if the problem is static or dynamic but not so complex. Implicit analysis takes more solution time but can solve the problem easily with larger timesteps. Therefore, it is always recommended to use implicit time integration scheme.
Choose explicit if the problem is only dynamic and highly complex. Explicit analysis takes less solution time but also needs more refined (small) timesteps to solve the problem. Therefore, in most of the cases it's not recommended due to convergence problems.
- `type` string, required —
Choose the time integration scheme type

Important remarks:
Choose implicit if the problem is static or dynamic but not so complex. Implicit analysis takes more solution time but can solve the problem easily with larger timesteps. Therefore, it is always recommended to use implicit time integration scheme.
Choose explicit if the problem is only dynamic and highly complex. Explicit analysis takes less solution time but also needs more refined (small) timesteps to solve the problem. Therefore, in most of the cases it's not recommended due to convergence problems.
Schema name: ExplicitTimeIntegrationType - `scheme` union - … - `schemeFormulation` 'ACCELERATION' —
Choose the primary variable for the time integration scheme.
- `stopOnCFLCriterion` boolean —
If activated the simulation run is stopped when at some point the Courant-Friedrichs-Lewy (CFL) condition is violated.
- `massMatrixShift` number —
This parameter c_K allows the shifting of the mass matrix with the stiffness matrix multiplied by c_K: M^'=M + c_K*K. This makes it possible to strongly improve convergence in dynamics with implicit time scheme by imposing a cut-off frequency inversely proportional to the value of c_K (at the cost of a light distortion of all the eigen frequencies of the system).
- `mechanicalResolutionType` union - object —
Choose how the nonlinearities are solved. Currently for direct solvers only the Newton-Raphson method is available via the selection Newton. For iterative solvers also an inexact version of the Newton-Raphson method is available via the selection Newton-Krylov.
- `type` string, required —
Choose how the nonlinearities are solved. Currently for direct solvers only the Newton-Raphson method is available via the selection Newton. For iterative solvers also an inexact version of the Newton-Raphson method is available via the selection Newton-Krylov.
Schema name: NewtonResolutionType - `convergenceCriteria` union — Select the convergence criterion for the nonlinear solution method.
Important remarks:
When Absolute is selected, the convergence is reached if the maximum absolute residual of a given Newton iteration is lower than the defined tolerance.
If Relative is chosen, then the maximum relative residual i.e. the maximum absolute residual divided by external loads and support reactions, is checked during the Newton iteration. Please note that using the Relative criterion leads to a failed convergence if no external load is present (e.g. two far objects coming into contact). In this case, the Adaptive criterion should be used.
By selecting the Adaptive option, a combination of both Relative and Absolute criteria is used. That is, in each Newton iteration the Relative is used by default unless the external loads and support reactions have vanished, at which point we check the Absolute one instead.
- … - `predictionMatrix` 'TANGENT' | 'ELASTIC' —
Select which stiffnes matrix should be used in the prediction phase of the Newton method. A good choice leads to a good starting point for the first Newton iteration and thus a faster convergence.
- `jacobianMatrix` union - … - object —
Choose how the nonlinearities are solved. Currently for direct solvers only the Newton-Raphson method is available via the selection Newton. For iterative solvers also an inexact version of the Newton-Raphson method is available via the selection Newton-Krylov.
- `type` string, required —
Choose how the nonlinearities are solved. Currently for direct solvers only the Newton-Raphson method is available via the selection Newton. For iterative solvers also an inexact version of the Newton-Raphson method is available via the selection Newton-Krylov.
Schema name: NewtonKrylovResolutionType - `convergenceCriteria` union — Select the convergence criterion for the nonlinear solution method.
Important remarks:
When Absolute is selected, the convergence is reached if the maximum absolute residual of a given Newton iteration is lower than the defined tolerance.
If Relative is chosen, then the maximum relative residual i.e. the maximum absolute residual divided by external loads and support reactions, is checked during the Newton iteration. Please note that using the Relative criterion leads to a failed convergence if no external load is present (e.g. two far objects coming into contact). In this case, the Adaptive criterion should be used.
By selecting the Adaptive option, a combination of both Relative and Absolute criteria is used. That is, in each Newton iteration the Relative is used by default unless the external loads and support reactions have vanished, at which point we check the Absolute one instead.
- … - `predictionMatrix` 'TANGENT' | 'ELASTIC' —
Select which stiffnes matrix should be used in the prediction phase of the Newton method. A good choice leads to a good starting point for the first Newton iteration and thus a faster convergence.
- `jacobianMatrix` union - … - `mechanicalLineSearch` union - object —
Line search can be used to improve convergence for nonlinear calculations with the Newton method.
- `type` string, required —
Line search can be used to improve convergence for nonlinear calculations with the Newton method.
Schema name: FalseLineSearch - object —
Line search can be used to improve convergence for nonlinear calculations with the Newton method.
- `type` string, required —
Line search can be used to improve convergence for nonlinear calculations with the Newton method.
Schema name: TrueLineSearch - `method` 'SECANT' | 'MIXED' —
Choose the method of the line search algorithm. The Secant method is a simple one dimensional search algorithm. The mixed method is a more elaborate algorithm that uses variable bounds.
- `residual` number —
Set the residual for the line search convergence
- `maxIterations` integer —
Set the maximum number for line search iterations. Typically a sinlge-digit number should be sufficient.
- `thermalTimeIntegrationType` SimulationThetaMethodTimeIntegrationType —
Choose the time integration scheme type
- `type` string, required —
Choose the time integration scheme type
Schema name: ThetaMethodTimeIntegrationType - `theta` number — The parameter θ must be ranging between 0.0 (explicit method) and 1.0 (completely implicit method). The standard value of θ = 0.57 is chosen a little higher than θ = 0.5 which would lead to the Crank-Nicolson scheme of order 2. - `thermalResolutionType` union - object —
Choose how the nonlinearities are solved. Currently for direct solvers only the Newton-Raphson method is available via the selection Newton. For iterative solvers also an inexact version of the Newton-Raphson method is available via the selection Newton-Krylov.
- `type` string, required —
Choose how the nonlinearities are solved. Currently for direct solvers only the Newton-Raphson method is available via the selection Newton. For iterative solvers also an inexact version of the Newton-Raphson method is available via the selection Newton-Krylov.
Schema name: NewtonResolutionType - `convergenceCriteria` union — Select the convergence criterion for the nonlinear solution method.
Important remarks:
When Absolute is selected, the convergence is reached if the maximum absolute residual of a given Newton iteration is lower than the defined tolerance.
If Relative is chosen, then the maximum relative residual i.e. the maximum absolute residual divided by external loads and support reactions, is checked during the Newton iteration. Please note that using the Relative criterion leads to a failed convergence if no external load is present (e.g. two far objects coming into contact). In this case, the Adaptive criterion should be used.
By selecting the Adaptive option, a combination of both Relative and Absolute criteria is used. That is, in each Newton iteration the Relative is used by default unless the external loads and support reactions have vanished, at which point we check the Absolute one instead.
- … - `predictionMatrix` 'TANGENT' | 'ELASTIC' —
Select which stiffnes matrix should be used in the prediction phase of the Newton method. A good choice leads to a good starting point for the first Newton iteration and thus a faster convergence.
- `jacobianMatrix` union - … - object —
Choose how the nonlinearities are solved. Currently for direct solvers only the Newton-Raphson method is available via the selection Newton. For iterative solvers also an inexact version of the Newton-Raphson method is available via the selection Newton-Krylov.
- `type` string, required —
Choose how the nonlinearities are solved. Currently for direct solvers only the Newton-Raphson method is available via the selection Newton. For iterative solvers also an inexact version of the Newton-Raphson method is available via the selection Newton-Krylov.
Schema name: NewtonKrylovResolutionType - `convergenceCriteria` union — Select the convergence criterion for the nonlinear solution method.
Important remarks:
When Absolute is selected, the convergence is reached if the maximum absolute residual of a given Newton iteration is lower than the defined tolerance.
If Relative is chosen, then the maximum relative residual i.e. the maximum absolute residual divided by external loads and support reactions, is checked during the Newton iteration. Please note that using the Relative criterion leads to a failed convergence if no external load is present (e.g. two far objects coming into contact). In this case, the Adaptive criterion should be used.
By selecting the Adaptive option, a combination of both Relative and Absolute criteria is used. That is, in each Newton iteration the Relative is used by default unless the external loads and support reactions have vanished, at which point we check the Absolute one instead.
- … - `predictionMatrix` 'TANGENT' | 'ELASTIC' —
Select which stiffnes matrix should be used in the prediction phase of the Newton method. A good choice leads to a good starting point for the first Newton iteration and thus a faster convergence.
- `jacobianMatrix` union - … - `thermalLineSearch` union - object —
Line search can be used to improve convergence for nonlinear calculations with the Newton method.
- `type` string, required —
Line search can be used to improve convergence for nonlinear calculations with the Newton method.
Schema name: FalseLineSearch - object —
Line search can be used to improve convergence for nonlinear calculations with the Newton method.
- `type` string, required —
Line search can be used to improve convergence for nonlinear calculations with the Newton method.
Schema name: TrueLineSearch - `method` 'SECANT' | 'MIXED' —
Choose the method of the line search algorithm. The Secant method is a simple one dimensional search algorithm. The mixed method is a more elaborate algorithm that uses variable bounds.
- `residual` number —
Set the residual for the line search convergence
- `maxIterations` integer —
Set the maximum number for line search iterations. Typically a sinlge-digit number should be sufficient.
- `remotePointStiffnessMultiplier` number - `simulationControl` SimulationSolidSimulationControl - `timestepDefinition` union - object - `type` string, required — Schema name: AutoTimestepDefinition - `simulationInterval` SimulationDimensionalTime - … - `maximumTimestepLength` SimulationRestrictedDimensionalFunctionTime - … - `minimumTimestepLength` SimulationDimensionalTime - … - `maximumResidual` number - `retimingEvent` union - … - object - `type` string, required — Schema name: ManualTimestepDefinition - `simulationInterval` SimulationDimensionalTime - … - `timestepLength` SimulationRestrictedDimensionalFunctionTime - … - `pseudoTimeStepping` union - object - `type` string, required — Schema name: SingleStepPseudoTimeStepping - `staticTimesteps` SimulationDimensionalTime - … - object - `type` string, required — Schema name: SteppingListPseudoTimeStepping - `simulationIntervals` SimulationDimensionalTime - … - `timestepLength` SimulationRestrictedDimensionalFunctionTime - … - `autoLoadRamping` boolean — Loads and enforced motions will be ramped linearly over the simulation interval to aid solution convergence. Automatic ramping will only be applied if all boundary conditions (including gravity) are applied with constant values and if no creep formulation has been defined for the materials. - `writeControlDefinition` union - object —
Define how frequently intermediate results should be saved. With the selection of initial time steps only the user defined time steps are stored in the result and by selecting all computed time steps also intermediate results that were created by the automatic time stepping are saved. With the selection of write interval a specific write frequency can be chosen which reduces the result size. Finally using user defined time steps there can either be a constant time increment for result storage given or a table with varying time intervals analogous to the time step length definition.
- `type` string, required —
Define how frequently intermediate results should be saved. With the selection of initial time steps only the user defined time steps are stored in the result and by selecting all computed time steps also intermediate results that were created by the automatic time stepping are saved. With the selection of write interval a specific write frequency can be chosen which reduces the result size. Finally using user defined time steps there can either be a constant time increment for result storage given or a table with varying time intervals analogous to the time step length definition.
Schema name: WriteIntervalWriteControl - `writeInterval` integer —
Define the write frequency of the intermediate results to the result file. Selecting a write interval of 2 means that every second computed time step is saved in the final result database, independently if it is a pre-defined user time step or an intermediate one that was added during automatic time stepping.
- object —
Define how frequently intermediate results should be saved. With the selection of initial time steps only the user defined time steps are stored in the result and by selecting all computed time steps also intermediate results that were created by the automatic time stepping are saved. With the selection of write interval a specific write frequency can be chosen which reduces the result size. Finally using user defined time steps there can either be a constant time increment for result storage given or a table with varying time intervals analogous to the time step length definition.
- `type` string, required —
Define how frequently intermediate results should be saved. With the selection of initial time steps only the user defined time steps are stored in the result and by selecting all computed time steps also intermediate results that were created by the automatic time stepping are saved. With the selection of write interval a specific write frequency can be chosen which reduces the result size. Finally using user defined time steps there can either be a constant time increment for result storage given or a table with varying time intervals analogous to the time step length definition.
Schema name: AllComputedWriteControl - object —
Define how frequently intermediate results should be saved. With the selection of initial time steps only the user defined time steps are stored in the result and by selecting all computed time steps also intermediate results that were created by the automatic time stepping are saved. With the selection of write interval a specific write frequency can be chosen which reduces the result size. Finally using user defined time steps there can either be a constant time increment for result storage given or a table with varying time intervals analogous to the time step length definition.
- `type` string, required —
Define how frequently intermediate results should be saved. With the selection of initial time steps only the user defined time steps are stored in the result and by selecting all computed time steps also intermediate results that were created by the automatic time stepping are saved. With the selection of write interval a specific write frequency can be chosen which reduces the result size. Finally using user defined time steps there can either be a constant time increment for result storage given or a table with varying time intervals analogous to the time step length definition.
Schema name: InitialTimestepsWriteControl - object —
Define how frequently intermediate results should be saved. With the selection of initial time steps only the user defined time steps are stored in the result and by selecting all computed time steps also intermediate results that were created by the automatic time stepping are saved. With the selection of write interval a specific write frequency can be chosen which reduces the result size. Finally using user defined time steps there can either be a constant time increment for result storage given or a table with varying time intervals analogous to the time step length definition.
- `type` string, required —
Define how frequently intermediate results should be saved. With the selection of initial time steps only the user defined time steps are stored in the result and by selecting all computed time steps also intermediate results that were created by the automatic time stepping are saved. With the selection of write interval a specific write frequency can be chosen which reduces the result size. Finally using user defined time steps there can either be a constant time increment for result storage given or a table with varying time intervals analogous to the time step length definition.
Schema name: UserDefinedWriteControl - `writeIncrement` SimulationRestrictedDimensionalFunctionTime - … - `excitationFrequencies` union —
Set the frequencies for the harmonic excitation. Setting it to single frequency will only compute harmonic excitation on that frequency. To have harmonic excitations on multiple frequencies, please choose frequency list.
- object - `type` string, required — Schema name: SingleFrequency - `frequency` SimulationDimensionalFrequency - … - object - `type` string, required — Schema name: FrequencyList - `startFrequency` SimulationDimensionalFrequency - … - `endFrequency` SimulationDimensionalFrequency - … - `frequencyStepping` SimulationRestrictedDimensionalFunctionFrequency - … - `eigenfrequencyScope` union —
Select how you want to control natural frequencies to be computed:

First modes: The first Number of modes will be searched and computed, in the order of low to high frequency.
Frequency range: All the modes within the range of frequencies will be searched and computed. The frequency range is specified by a Start frequency and an End frequency.
Center frequency: Compute the Number of modes closest to the frequency defined by Center frequency.
- object - `type` string, required — Schema name: FirstMode - `numberOfModes` integer —
Define the maximum number of eigenfrequencies/eigenmodes, that should be calculated.
- object - `type` string, required — Schema name: FrequencyRange - `startFrequency` SimulationDimensionalFrequency - … - `endFrequency` SimulationDimensionalFrequency - … - `numberOfSubBands` integer - `parallelizationLevel` 'COMPLETE' | 'PARTIAL' - object - `type` string, required — Schema name: CenterFrequency - `centerFrequency` SimulationDimensionalFrequency - … - `numberOfModes` integer —
Define the maximum number of eigenfrequencies/eigenmodes, that should be calculated.
- `modalBase` SimulationModalBaseControl - `eigenfrequencyScope` union —
Select the method to build the modal base, by controlling the search of the natural frequencies:

Twice the maximum loading frequency: From zero to twice the maximum excitation frequency defined under Harmonic response.
First modes: The first Number of modes will be searched and computed in the order of low to high frequency.
Frequency range: All the modes within the specified frequency range will be searched and computed. The frequency range is defined by a Start frequency and an End frequency.
Center frequency: Compute the Number of modes closest to the frequency defined by the Center frequency.
- SimulationTwiceMaxLoadingFrequency - … - SimulationFirstMode - … - SimulationFrequencyRange - … - SimulationCenterFrequency - … - `harmonicResponse` SimulationHarmonicResponseControl - `excitationFrequencies` union —
Frequencies at which the harmonic loads are to be applied and results are to be computed. Define excitation frequencies using one of the following options:

Single frequency : Harmonic loads are applied at one frequency only.
Frequency list: Harmonic loads are applied across a range of frequencies with either a constant frequency stepping interval or a variable interval defined via a table.
Cluster around modes: Harmonic loads are applied at frequencies clustered around eigenfrequencies.
Cover spectrum: Harmonic loads are applied at frequencies clustered around and in between eigenfrequencies to fully capture the entire spectrum.
- SimulationSingleFrequency - … - SimulationFrequencyList - … - SimulationClusterAroundModes - … - SimulationCoverSpectrum - … - `processors` SimulationComputingCore - `numOfProcessors` -1 | 1 | 2 | 4 | 8 | 16 | 32 | 48 | 64 | 96 | 128 | 192 —
Selecting more processor cores will speed up the simulation process. Choosing a smaller computation instance will save core hours. Learn more.
- `numOfComputingProcessors` integer —
Set the number of processors which shall be used for the parallel computation.
- `domainDecomposition` union - SimulationAutomaticDomainDecomposition - … - SimulationCentralizedDomainDecomposition - … - SimulationElementGroupsDomainDecomposition - … - SimulationCustomDomainDecomposition - … - `numOfThreads` integer - `partitionMesh` boolean - `maxRunTime` SimulationDimensionalTime - `value` number - `unit` 's', required - `resultControl` SimulationSolidResultControl - `solutionFields` SimulationOneOfSolidResultControlSolutionFields[] — Each mode is normalized using its largest component of displacement. - union - SimulationContactResultControlItem - … - SimulationDisplacementResultControlItem - … - SimulationHarmonicDisplacementResultControlItem - … - SimulationNormalizedDisplacementResultControlItem - … - SimulationForceResultControlItem - … - SimulationStrainResultControlItem - … - SimulationStressResultControlItem - … - SimulationVelocityResultControlItem - … - SimulationHarmonicVelocityResultControlItem - … - SimulationAccelerationResultControlItem - … - SimulationHarmonicAccelerationResultControlItem - … - SimulationTemperatureResultControlItem - … - SimulationHeatFluxResultControlItem - … - SimulationERPDensityResultControlItem - … - `edgeCalculation` SimulationOneOfSolidResultControlEdgeCalculation[] - union - SimulationMinMaxFieldsCalculationResultControlItem - … - SimulationAverageFieldsCalculationResultControlItem - … - SimulationSumFieldsCalculationResultControlItem - … - `areaCalculation` SimulationOneOfSolidResultControlAreaCalculation[] - union - SimulationMinMaxFieldsCalculationResultControlItem - … - SimulationAverageFieldsCalculationResultControlItem - … - SimulationSumFieldsCalculationResultControlItem - … - SimulationHeatFlowCalculationResultControlItem - … - SimulationERPCalculationResultControlItem - … - `volumeCalculation` SimulationOneOfSolidResultControlVolumeCalculation[] - union - SimulationMinMaxFieldsCalculationResultControlItem - … - SimulationAverageFieldsCalculationResultControlItem - … - SimulationSumFieldsCalculationResultControlItem - … - `pointData` SimulationOneOfSolidResultControlPointData[] - union - SimulationTemporalResponseResultControlItem - … - SimulationHarmonicResponseResultControlItem - … - `meshOrder` 'FIRST' | 'SECOND' | 'NONE' - SimulationDynamicAnalysis - `type` string, required — Schema name: DynamicAnalysis - `connectionGroups` SimulationOneOfDynamicAnalysisConnectionGroups[] - union - SimulationContact - `type` string, required — Schema name: Contact - `nodeMergingBonded` boolean —
Allow node merging for bonded contacts where possible to increase contact accuracy and solution efficiency. For contact pairs where nodes cannot be merged, linear relations will be used with the defined position tolerance.
- `connections` SimulationOneOfContactConnections[] - … - SimulationPhysicalContact - `type` string, required — Schema name: PhysicalContact - `settings` SimulationConnectionSettingsV36 - … - `connections` SimulationOneOfPhysicalContactConnections[] - … - `connectors` SimulationOneOfDynamicAnalysisConnectors[] - union - SimulationPinConnector —
Connect multiple bodies via a virtual pin

Usage:
Define a separate pin connector item for each virtual pin
Assign only cylindrical surfaces
Behavior:
Option to connect bodies to bodies or bodies to the ground via virtual pins
Bodies freely rotate relative to one another about the virtual pin axis
Users have full control over axial translation and rotation of the connection with the ability to define torsional and axial spring stiffness
- `type` string, required —
Connect multiple bodies via a virtual pin

Usage:
Define a separate pin connector item for each virtual pin
Assign only cylindrical surfaces
Behavior:
Option to connect bodies to bodies or bodies to the ground via virtual pins
Bodies freely rotate relative to one another about the virtual pin axis
Users have full control over axial translation and rotation of the connection with the ability to define torsional and axial spring stiffness
Schema name: PinConnector - `name` string - `interaction` 'BODY_TO_BODY' | 'BODY_TO_GROUND' —
Select an interaction option
Body to body - Two or more bodies may be connected to each other via a single virtual pin. The pin will move with the bodies.
Body to ground - Two or more bodies may be connected to the ground via a single virtual pin. The pin remains stationary.
- `kinematicBehavior` SimulationPinKinematicBehavior - … - `advancedPinSettings` SimulationAdvancedConnectorSettings - … - `topologicalReference` SimulationTopologicalReference - … - SimulationBoltConnector —
Connect multiple bodies via a virtual bolt

Usage:
Define a separate bolt connector item for each virtual bolt
Assign entities must be coaxial
Behavior:
Bolt connectors mimic physical bolts using beam formulations. Relative translations and rotations of the connected entities are computed based on the defined bolt mechanical properties
Ability to apply preload
- `type` string, required —
Connect multiple bodies via a virtual bolt

Usage:
Define a separate bolt connector item for each virtual bolt
Assign entities must be coaxial
Behavior:
Bolt connectors mimic physical bolts using beam formulations. Relative translations and rotations of the connected entities are computed based on the defined bolt mechanical properties
Ability to apply preload
Schema name: BoltConnector - `name` string - `boltType` 'BOLT_AND_NUT' | 'SCREW' —
Select your desired type of fastener

Bolt and nut - a virtual connection between a bolt head and nut location
Screw - a virtual connection between a screw head location and a cylindrical surface representing a threaded section
- `shankDiameter` SimulationDimensionalLength - … - `mechanicalProperties` SimulationBoltMechanicalProperties - … - `enableBoltPreload` boolean — Enable the definition of pretension within the virtual bolt. - `preload` SimulationForcePreload - … - `advancedBoltSettings` SimulationAdvancedConnectorSettings - … - `masterTopologicalReference` SimulationTopologicalReference - … - `slaveTopologicalReference` SimulationTopologicalReference - … - `elementTechnology` SimulationSolidElementTechnology - `elementTechnology3D` SimulationElementTechnology - `definitionMethod` union - SimulationAutomaticElementDefinitionMethod - … - SimulationCustomElementDefinitionMethod - … - `model` SimulationSolidModel - `geometricBehavior` 'LINEAR' | 'NONLINEAR' - `magnitude` SimulationDimensionalFunctionAcceleration - `value` union - SimulationConstantFunction - … - SimulationExpressionFunction - … - SimulationPolynomialFunction - … - SimulationTableDefinedFunction - … - `unit` 'm/s²' | 'in/s²' | 'G', required - `e` SimulationDimensionalVectorLength - `value` SimulationDecimalVector - `x` number - `y` number - `z` number - `unit` 'm' | 'in' | 'mm' | 'cm' | 'ft' | 'yd', required - `materials` SimulationSolidMaterial[] - `name` string - `materialBehavior` union - object —
Choose the material behavior for your problem.

Important remarks:

Choose Linear elastic if the stress-strain relationship of your material is linear.
Choose Elasto-plastic if the stress-strain relationship of your material is non-linear after some point e.g. yielding point.
Choose Hyperelastic if your material responds elastically even at higher deformations.
- `type` string, required —
Choose the material behavior for your problem.

Important remarks:

Choose Linear elastic if the stress-strain relationship of your material is linear.
Choose Elasto-plastic if the stress-strain relationship of your material is non-linear after some point e.g. yielding point.
Choose Hyperelastic if your material responds elastically even at higher deformations.
Schema name: LinearElasticMaterialBehavior - `directionalDependency` union —
Choose the directional dependency for this property:
Isotropic material: all the material properties are the same in all directions
Orthotropic material: different material properties in different orthogonal directions (e.g. glass-reinforced plastic, or wood)
- … - `damping` union - … - `creepFormulation` union —
Define the Creep formulation. Three different formulations are available: Norton, Strain Hardening or Time Hardening.
They are based on the Power Law:
ε̇ = m*A*σⁿ*t^m-1
- … - object —
Choose the material behavior for your problem.

Important remarks:

Choose Linear elastic if the stress-strain relationship of your material is linear.
Choose Elasto-plastic if the stress-strain relationship of your material is non-linear after some point e.g. yielding point.
Choose Hyperelastic if your material responds elastically even at higher deformations.
- `type` string, required —
Choose the material behavior for your problem.

Important remarks:

Choose Linear elastic if the stress-strain relationship of your material is linear.
Choose Elasto-plastic if the stress-strain relationship of your material is non-linear after some point e.g. yielding point.
Choose Hyperelastic if your material responds elastically even at higher deformations.
Schema name: HyperElasticMaterialBehavior - `hyperElasticModel` union —
Choose the hyperelastic material model that should be used. All models derive the stress-strain relation from a strain energy function defined by the material model parameters.
- … - object —
Choose the material behavior for your problem.

Important remarks:

Choose Linear elastic if the stress-strain relationship of your material is linear.
Choose Elasto-plastic if the stress-strain relationship of your material is non-linear after some point e.g. yielding point.
Choose Hyperelastic if your material responds elastically even at higher deformations.
- `type` string, required —
Choose the material behavior for your problem.

Important remarks:

Choose Linear elastic if the stress-strain relationship of your material is linear.
Choose Elasto-plastic if the stress-strain relationship of your material is non-linear after some point e.g. yielding point.
Choose Hyperelastic if your material responds elastically even at higher deformations.
Schema name: PlasticMaterialBehavior - `elastoPlasticModel` union — Choose the Elasto-plastic model for your problem.

Important remarks:
Choose Bilinear if the material response is a combination of linear elastic and plastic behavior and is defined by the elastic modulus, yield strength, and, tangent modulus.
Choose Multilinear if the material response is a combination of linear elastic-plastic behavior and is defined by the elastic modulus, yield strength, and, multiple tangent moduli.
Choose Johnson-Cook if the material response includes strain hardening, strain rate hardening, and thermal softening effects, and is defined by parameters such as yield stress, hardening coefficient, hardening exponent, strain rate hardening coefficient, and thermal softening exponent.
Learn more - … - `density` SimulationDimensionalFunctionDensity - `value` union - SimulationConstantFunction - … - SimulationExpressionFunction - … - SimulationPolynomialFunction - … - SimulationTableDefinedFunction - … - `unit` 'kg/m³' | 'lb/in³' | 'g/mm³' | 'g/cm³' | 't/mm³' | 'lb/ft³', required - `expansion` SimulationIsotropicExpansion —
Define the directional dependency of this property. Isotropic means directionally independent.
- `type` string, required —
Define the directional dependency of this property. Isotropic means directionally independent.
Schema name: IsotropicExpansion - `expansionCoefficient` SimulationDimensionalFunctionThermalExpansionRate - `value` union - … - `unit` '1/K' | '1/°F', required - `referenceTemperature` SimulationDimensionalTemperature - `value` number - `unit` '°C' | '°F' | 'K', required - `conductivity` union - object —
Define the directional dependency of this property. Isotropic means directionally independent. Orthotropic means directionally dependent.
- `type` string, required —
Define the directional dependency of this property. Isotropic means directionally independent. Orthotropic means directionally dependent.
Schema name: IsotropicConductivity - `thermalConductivity` SimulationDimensionalFunctionThermalConductivity - … - `thermalConductivityFunction` SimulationDimensionalFunctionThermalConductivity - … - object —
Define the directional dependency of this property. Isotropic means directionally independent. Orthotropic means directionally dependent.
- `type` string, required —
Define the directional dependency of this property. Isotropic means directionally independent. Orthotropic means directionally dependent.
Schema name: OrthotropicConductivity - `thermalConductivityX` SimulationDimensionalFunctionThermalConductivity - … - `thermalConductivityY` SimulationDimensionalFunctionThermalConductivity - … - `thermalConductivityZ` SimulationDimensionalFunctionThermalConductivity - … - `specificHeat` SimulationDimensionalFunctionSpecificHeat - `value` union - SimulationConstantFunction - … - SimulationExpressionFunction - … - SimulationPolynomialFunction - … - SimulationTableDefinedFunction - … - `unit` 'J/(kg·K)' | 'Btu/(lb·°F)', required - `topologicalReference` SimulationTopologicalReference - `entities` string[] - `sets` string[] - `builtInMaterial` string - `materialLibraryReference` SimulationMaterialLibraryReference - `materialGroupId` string - `materialId` string - `interpolationParameters` object - `initialConditions` SimulationSolidInitialConditions - `displacement` SimulationDimensionalVectorFunctionInitialConditionWithDomainsLength - `global` SimulationDimensionalVectorFunctionLength - `value` union - … - `unit` 'm' | 'in' | 'mm' | 'cm' | 'ft' | 'yd', required - `subdomains` SimulationSubdomainBasedDimensionalVectorFunctionInitialConditionLength[] - `name` string - `subdomainValue` SimulationDimensionalVectorFunctionLength - … - `topologicalReference` SimulationTopologicalReference - … - `velocity` SimulationDimensionalVectorFunctionInitialConditionWithDomainsSpeed - `global` SimulationDimensionalVectorFunctionSpeed - `value` union - … - `unit` 'm/s' | 'in/s' | 'm/min' | 'm/h' | 'mm/s' | 'mm/min' | 'mm/h' | 'cm/s' | 'cm/min' | 'cm/h' | 'km/h' | 'ft/s' | 'ft/min' | 'ft/h' | 'in/min' | 'in/h' | 'mph' | 'kn', required - `subdomains` SimulationSubdomainBasedDimensionalVectorFunctionInitialConditionSpeed[] - `name` string - `subdomainValue` SimulationDimensionalVectorFunctionSpeed - … - `topologicalReference` SimulationTopologicalReference - … - `acceleration` SimulationDimensionalVectorFunctionInitialConditionWithDomainsAcceleration - `global` SimulationDimensionalVectorFunctionAcceleration - `value` union - … - `unit` 'm/s²' | 'in/s²' | 'G', required - `subdomains` SimulationSubdomainBasedDimensionalVectorFunctionInitialConditionAcceleration[] - `name` string - `subdomainValue` SimulationDimensionalVectorFunctionAcceleration - … - `topologicalReference` SimulationTopologicalReference - … - `stress` SimulationStressInitialConditionDomains - `global` SimulationStressTensorPressure - `sigmaXX` union - … - `sigmaYY` union - … - `sigmaZZ` union - … - `sigmaYZ` union - … - `sigmaXZ` union - … - `sigmaXY` union - … - `unit` 'Pa' | 'lbf/in²' | 'hPa' | 'kPa' | 'MPa' | 'atm' | 'mbar' | 'bar' | 'mH2O' | 'mmH2O' | 'mmHg' | 'dyne/cm²' | 'inH2O' | 'ftH2O' | 'inHg' | 'psf', required - `subdomains` SimulationSubdomainStressInitialCondition[] - `name` string - `subdomainValue` SimulationStressTensorPressure - … - `topologicalReference` SimulationTopologicalReference - … - `temperature` SimulationDimensionalFunctionInitialConditionDomainsTemperature - `global` SimulationDimensionalFunctionTemperature - `value` union - … - `unit` '°C' | '°F' | 'K', required - `subdomains` SimulationSubdomainDimensionalFunctionInitialConditionTemperature[] - `name` string - `subdomainValue` SimulationDimensionalFunctionTemperature - … - `topologicalReference` SimulationTopologicalReference - … - `boundaryConditions` SimulationOneOfDynamicAnalysisBoundaryConditions[] - union - SimulationBoltPreloadBC — Bolt preload boundary condition helps to model pre-stressed bolts in a CAD geometry for structural analysis. Enter a preload force to be assigned to cylindrical faces representing the shank of the bolt.
Note:
These faces should be continuous and not be assigned to contact definitions.
Each bolt gets only one load, if multiple faces for the same bolt are assigned, they get ignored.
The applied load does not get distributed if multiple bolts are assigned.
Learn more. - `type` string, required — Bolt preload boundary condition helps to model pre-stressed bolts in a CAD geometry for structural analysis. Enter a preload force to be assigned to cylindrical faces representing the shank of the bolt.
Note:
These faces should be continuous and not be assigned to contact definitions.
Each bolt gets only one load, if multiple faces for the same bolt are assigned, they get ignored.
The applied load does not get distributed if multiple bolts are assigned.
Learn more. Schema name: BoltPreloadBC - `name` string - `preload` SimulationForcePreload - … - `topologicalReference` SimulationTopologicalReference - … - SimulationElasticSupportBC —
The elastic support constraint can be used to model an elastic foundation between the assigned surfaces and the rigid ground. Additionally it can be used to prevent rigid body motions in a nonlinear analysis. The constraint acts on tension and compression forces and all stiffness values are expressed in the global coordinate system.
Learn more.
- `type` string, required —
The elastic support constraint can be used to model an elastic foundation between the assigned surfaces and the rigid ground. Additionally it can be used to prevent rigid body motions in a nonlinear analysis. The constraint acts on tension and compression forces and all stiffness values are expressed in the global coordinate system.
Learn more.
Schema name: ElasticSupportBC - `name` string - `springStiffness` union —
The stiffness can either be assumed equal in all directions by selecting isotropic or it can depend on the force direction by selecting orthotropic. For an orthotropic stiffness the stiffness value along each global coordinate direction can be given independently.
- … - `topologicalReference` SimulationTopologicalReference - … - SimulationFixedSupportBC —
If a fixed support boundary condition is used, all degrees of freedom of the selected entities are fixed at zero. This constraint is often used to model a fixation to the ground or an undeformable part.
Learn more.
- `type` string, required —
If a fixed support boundary condition is used, all degrees of freedom of the selected entities are fixed at zero. This constraint is often used to model a fixation to the ground or an undeformable part.
Learn more.
Schema name: FixedSupportBC - `name` string - `topologicalReference` SimulationTopologicalReference - … - SimulationFixedValueBC — This is a boundary condition for the displacement vector variable. You can define prescribed values for the displacement of the assigned groups in every coordinate direction (x,y,z) or leave it unconstrained in order to let the entity move freely.

Important remarks:
Choose 0 as value in order to fix your selection.
Do not constrain entities in directions where a load boundary condition is applied.
Do not constrain entities with multiple Dirichlet boundary conditions in one direction (overconstrained).
Do not constrain slave entities of Contact Constraints as they are constrained by the master in that direction (overconstrained).
Learn more. - `type` string, required — This is a boundary condition for the displacement vector variable. You can define prescribed values for the displacement of the assigned groups in every coordinate direction (x,y,z) or leave it unconstrained in order to let the entity move freely.

Important remarks:
Choose 0 as value in order to fix your selection.
Do not constrain entities in directions where a load boundary condition is applied.
Do not constrain entities with multiple Dirichlet boundary conditions in one direction (overconstrained).
Do not constrain slave entities of Contact Constraints as they are constrained by the master in that direction (overconstrained).
Learn more. Schema name: FixedValueBC - `name` string - `displacement` SimulationDimensionalPartialVectorFunctionLength - … - `topologicalReference` SimulationTopologicalReference - … - SimulationPointMassBC —
Define a Point mass boundary condition in order to insert an additional mass on a specific location of the active model.
- `type` string, required —
Define a Point mass boundary condition in order to insert an additional mass on a specific location of the active model.
Schema name: PointMassBC - `name` string - `mass` SimulationDimensionalMass - … - `massMomentOfInertia` SimulationDimensionalVectorMomentOfInertia - … - `externalPoint` SimulationDimensionalVectorLength - … - `deformationBehavior` 'DEFORMABLE' | 'UNDEFORMABLE' —
Choose the deformation behavior of the entity which the point mass is connected to. If deformable is selected, the entity is allowed to deform, selecting undeformable leads to a rigid entity.
- `enableSearchRadius` boolean - `searchRadius` SimulationDimensionalLength - … - `topologicalReference` SimulationTopologicalReference - … - SimulationDistributedMassBC —
Define a Distributed mass boundary condition in order to insert an additional mass on a specific face of the active model.
- `type` string, required —
Define a Distributed mass boundary condition in order to insert an additional mass on a specific face of the active model.
Schema name: DistributedMassBC - `name` string - `massDefinition` union — Define how the distributed mass is specified: either as a total mass that will be distributed across the selected surface, or as an area density that represents mass per unit area. - … - `topologicalReference` SimulationTopologicalReference - … - SimulationRemoteDisplacementLoadBC — This boundary condition restrains the displacement of a face or edge relative to a specified remote point. Therefore the assignment is connected to the remote point with RBE3 (deformable) or MPC (undeformable) conditions and the defined constraints are applied to the remote point.

Important remarks:
As the assignments are connected to the remote point, additional constraints on these nodes may lead to overconstrained systems.
If the number of nodes of the assigment is large (>1000), it is recommended to use the MUMPS or PETSC solver.
This boundary condition is only valid for small rotations. For large rotations, please use Rotating motion boundary conditions.
Learn more. - `type` string, required — This boundary condition restrains the displacement of a face or edge relative to a specified remote point. Therefore the assignment is connected to the remote point with RBE3 (deformable) or MPC (undeformable) conditions and the defined constraints are applied to the remote point.

Important remarks:
As the assignments are connected to the remote point, additional constraints on these nodes may lead to overconstrained systems.
If the number of nodes of the assigment is large (>1000), it is recommended to use the MUMPS or PETSC solver.
This boundary condition is only valid for small rotations. For large rotations, please use Rotating motion boundary conditions.
Learn more. Schema name: RemoteDisplacementLoadBC - `name` string - `displacement` SimulationDimensionalPartialVectorFunctionLength - … - `rotation` SimulationDimensionalPartialVectorFunctionAngle - … - `externalPoint` SimulationDimensionalVectorLength - … - `deformationBehavior` 'DEFORMABLE' | 'UNDEFORMABLE' —
Choose the deformation behavior of the assigned entity. If deformable is selected, the entity is allowed to deform, selecting undeformable leads to a rigid entity.
- `enableSearchRadius` boolean - `searchRadius` SimulationDimensionalLength - … - `topologicalReference` SimulationTopologicalReference - … - SimulationRotatingMotionBC —
The rotating motion constraint applies a predefined rigid body rotation to the assigned entities. The rotation axis, the base point, and the rotation angle needs to be specified. Each component can be defined with a formula or table input.

Important remarks:
If a component of the rotation axis is input via formula or table, then ensure that the length of the axis vector is always positive.
If a continuous, transient rotation is required, then the rotation angle has to be given either as a formula or table value.
Learn more. - `type` string, required —
The rotating motion constraint applies a predefined rigid body rotation to the assigned entities. The rotation axis, the base point, and the rotation angle needs to be specified. Each component can be defined with a formula or table input.

Important remarks:
If a component of the rotation axis is input via formula or table, then ensure that the length of the axis vector is always positive.
If a continuous, transient rotation is required, then the rotation angle has to be given either as a formula or table value.
Learn more. Schema name: RotatingMotionBC - `name` string - `rotationOrigin` SimulationDimensionalVectorFunctionLength - … - `rotationAxis` SimulationDimensionalVectorFunctionLength - … - `omega` SimulationDimensionalFunctionAngle - … - `topologicalReference` SimulationTopologicalReference - … - SimulationSymmetryPlaneBC — This boundary condition restrains the displacement of a face in its normal direction in order to represent a symmetry plane of the structure. Use this boundary condition to reduce the model size significantly if the geometry and the loading conditions are symmetric.

Important remarks:
The solver uses linear relations between all three DOFs to constrian the normal movement, thus overcontraint conditions may appear if the edges of the selected faces are constrained by other displacement boundary conditions.
If the assigned faces are orthogonal to a global coordinate axes, it is recommended to directly specifiy the symmetry conditions with a Fixed value boundary condition.
Learn more. - `type` string, required — This boundary condition restrains the displacement of a face in its normal direction in order to represent a symmetry plane of the structure. Use this boundary condition to reduce the model size significantly if the geometry and the loading conditions are symmetric.

Important remarks:
The solver uses linear relations between all three DOFs to constrian the normal movement, thus overcontraint conditions may appear if the edges of the selected faces are constrained by other displacement boundary conditions.
If the assigned faces are orthogonal to a global coordinate axes, it is recommended to directly specifiy the symmetry conditions with a Fixed value boundary condition.
Learn more. Schema name: SymmetryPlaneBC - `name` string - `topologicalReference` SimulationTopologicalReference - … - SimulationCyclicSymmetryBC —
The cyclic symmetry constraint enables to model only a sector of a 360° cyclic periodic structure and reduces the computation time and memory consumption considerably. The user defines the center and axis of the cyclic symmetry as well as the sector angle. The master and slave surfaces define the cyclic periodicity boundaries.

Important remarks:
All DOFs of the slave nodes will be constrained, adding an additional constraint on those nodes may lead to an overconstrained system.
This is a linear constraint, so no large rotations or large deformations are allowed in the proximity of cyclic symmetry boundaries.
Learn more.
- `type` string, required —
The cyclic symmetry constraint enables to model only a sector of a 360° cyclic periodic structure and reduces the computation time and memory consumption considerably. The user defines the center and axis of the cyclic symmetry as well as the sector angle. The master and slave surfaces define the cyclic periodicity boundaries.

Important remarks:
All DOFs of the slave nodes will be constrained, adding an additional constraint on those nodes may lead to an overconstrained system.
This is a linear constraint, so no large rotations or large deformations are allowed in the proximity of cyclic symmetry boundaries.
Learn more.
Schema name: CyclicSymmetryBC - `name` string - `enableHeatTransfer` 'YES' | 'NO' | 'HEAT_TRANSFER_ONLY' —
Define if heat transfer should be allowed across the contact. If yes is chosen a perfectly bonded heat contact is assumed whereas if no is selected no heat transfer across the contact is allowed. Mechanical contact stays with both options active. With the selection of heat transfer only no mechanical contact is activated but only a bonded heat contact.
- `axisOrigin` SimulationDimensionalVectorLength - … - `axisDirection` SimulationDimensionalVectorLength - … - `sectorAngle` SimulationDimensionalAngle - … - `masterTopologicalReference` SimulationTopologicalReference - … - `slaveTopologicalReference` SimulationTopologicalReference - … - SimulationCentrifugalForceBC —
This is a centrifugal force boundary condition. Each volume element of the selection is loaded with a centrifugal force which is calculated depending on its volume, the density of the assigned material, its distance from the axis of rotation and the defined rotational velocity.
Learn more.
- `type` string, required —
This is a centrifugal force boundary condition. Each volume element of the selection is loaded with a centrifugal force which is calculated depending on its volume, the density of the assigned material, its distance from the axis of rotation and the defined rotational velocity.
Learn more.
Schema name: CentrifugalForceBC - `name` string - `rotation` SimulationAngularRotation - … - `topologicalReference` SimulationTopologicalReference - … - SimulationFollowerPressureBC — In contrast to ordinary pressure, the follower pressure boundary condition is applied normal to the surface of all face elements in the deformed state. This is a nonlinear boundary condition as the update of the geometry is required. In a linear analysis it becomes a simple pressure boundary condition.

The following conditions are taken into account:
The current deformed state of the surface.
Any changes in the direction of the normals of assigned entities.
Changes in the surface area of the assigned faces.
Learn more. - `type` string, required — In contrast to ordinary pressure, the follower pressure boundary condition is applied normal to the surface of all face elements in the deformed state. This is a nonlinear boundary condition as the update of the geometry is required. In a linear analysis it becomes a simple pressure boundary condition.

The following conditions are taken into account:
The current deformed state of the surface.
Any changes in the direction of the normals of assigned entities.
Changes in the surface area of the assigned faces.
Learn more. Schema name: FollowerPressureBC - `name` string - `pressure` SimulationDimensionalFunctionPressure - … - `topologicalReference` SimulationTopologicalReference - … - SimulationForceLoadBC —
This is a force boundary condition representing a distributed force on the selection. The total force is defined in the global coordinate system and each element of the assignment is loaded with a surface traction depending on the area of the element.
Learn more.
- `type` string, required —
This is a force boundary condition representing a distributed force on the selection. The total force is defined in the global coordinate system and each element of the assignment is loaded with a surface traction depending on the area of the element.
Learn more.
Schema name: ForceLoadBC - `name` string - `force` SimulationDimensionalVectorFunctionForce - … - `scaling` SimulationDimensionalFunctionDimensionless - … - `phaseAngle` SimulationDimensionalAngle - … - `topologicalReference` SimulationTopologicalReference - … - SimulationNodalLoadBC — This is a force boundary condition representing an equal point force on each node of the assignment. The total force applied on the assignment is calculated as the user defined forces times the number of nodes in the assignment.

Important remarks:
Currently, it only works on uploaded meshes
As the total load is depending on the number of nodes, and thus the mesh fineness, it is recommended only for loads on single nodes.
In most cases point loads are unphysical and distributed loads should be used instead.
- `type` string, required — This is a force boundary condition representing an equal point force on each node of the assignment. The total force applied on the assignment is calculated as the user defined forces times the number of nodes in the assignment.

Important remarks:
Currently, it only works on uploaded meshes
As the total load is depending on the number of nodes, and thus the mesh fineness, it is recommended only for loads on single nodes.
In most cases point loads are unphysical and distributed loads should be used instead.
Schema name: NodalLoadBC - `name` string - `force` SimulationDimensionalVectorFunctionForce - … - `scaling` SimulationDimensionalFunctionDimensionless - … - `phaseAngle` SimulationDimensionalAngle - … - `topologicalReference` SimulationTopologicalReference - … - SimulationPressureBC — This is a pressure boundary condition representing a distributed load on the selection. It is applied normal to the surface of all face elements.

Important remarks:
The applied total force depends on the surface area of the selection.
The normal direction of the faces is computed only in the undeformed state and not updated for large deformations.
For transient analyses you may define a time dependent value by uploading a table (csv-file).
Learn more. - `type` string, required — This is a pressure boundary condition representing a distributed load on the selection. It is applied normal to the surface of all face elements.

Important remarks:
The applied total force depends on the surface area of the selection.
The normal direction of the faces is computed only in the undeformed state and not updated for large deformations.
For transient analyses you may define a time dependent value by uploading a table (csv-file).
Learn more. Schema name: PressureBC - `name` string - `pressure` SimulationDimensionalFunctionPressure - … - `phaseAngle` SimulationDimensionalAngle - … - `topologicalReference` SimulationTopologicalReference - … - SimulationRemoteForceLoadBC — This is a remote force boundary condition where the load is applied on the assignment via a remote point. Therefore the assignment is connected to the remote point with RBE3 (deformable) or MPC (undeformable) conditions and the defined force is applied to the remote point.

Important remarks:
The total force will be distributed on the selection.
As the assignments are connected to the remote point, additional constraints on these nodes may lead to overconstrained systems.
If the number of nodes of the assignment is large (>1000), it is recommended to use the MUMPS or PETSC solver.
This boundary condition is only valid for small rotations.
Learn more. - `type` string, required — This is a remote force boundary condition where the load is applied on the assignment via a remote point. Therefore the assignment is connected to the remote point with RBE3 (deformable) or MPC (undeformable) conditions and the defined force is applied to the remote point.

Important remarks:
The total force will be distributed on the selection.
As the assignments are connected to the remote point, additional constraints on these nodes may lead to overconstrained systems.
If the number of nodes of the assignment is large (>1000), it is recommended to use the MUMPS or PETSC solver.
This boundary condition is only valid for small rotations.
Learn more. Schema name: RemoteForceLoadBC - `name` string - `force` SimulationDimensionalVectorFunctionForce - … - `moment` SimulationDimensionalVectorFunctionTorque - … - `scaling` SimulationDimensionalFunctionDimensionless - … - `phaseAngle` SimulationDimensionalAngle - … - `remotePoint` SimulationDimensionalVectorLength - … - `deformationBehavior` 'DEFORMABLE' | 'UNDEFORMABLE' —
Choose the deformation behavior of the assigned entity. If deformable is selected, the entitiy is allowed to deform without applying additional stiffness, selecting undeformable leads to a rigid entity.
- `enableSearchRadius` boolean - `searchRadius` SimulationDimensionalLength - … - `topologicalReference` SimulationTopologicalReference - … - SimulationSurfaceLoadBC — This is a surface load boundary condition representing a distributed load on the selection. It is applied as surface traction in the global coordinate system.

Important remarks:
The applied total force depends on the surface area of the selection
Learn more. - `type` string, required — This is a surface load boundary condition representing a distributed load on the selection. It is applied as surface traction in the global coordinate system.

Important remarks:
The applied total force depends on the surface area of the selection
Learn more. Schema name: SurfaceLoadBC - `name` string - `load` SimulationDimensionalVectorFunctionPressure - … - `scaling` SimulationDimensionalFunctionDimensionless - … - `phaseAngle` SimulationDimensionalAngle - … - `topologicalReference` SimulationTopologicalReference - … - SimulationVolumeLoadBC — This is a volume load boundary condition representing a distributed load on the selected volumes applied in the global coordinate system and each element of the assignment is loaded with a volume force depending on the volume of the element.

Important remarks:
The applied total force depends on the volume of the selection.
Learn more. - `type` string, required — This is a volume load boundary condition representing a distributed load on the selected volumes applied in the global coordinate system and each element of the assignment is loaded with a volume force depending on the volume of the element.

Important remarks:
The applied total force depends on the volume of the selection.
Learn more. Schema name: VolumeLoadBC - `name` string - `load` SimulationDimensionalVectorFunctionVolumeForce - … - `scaling` SimulationDimensionalFunctionDimensionless - … - `phaseAngle` SimulationDimensionalAngle - … - `topologicalReference` SimulationTopologicalReference - … - SimulationHingeConstraintBC — Replicate the behaviour of a freely rotating hinge fixed to the ground. Note that only a single face assignment is allowed. The assigned surface is constrained such that only rotational motion around the hinge axis is free. SimScale can automatically detect the axis of the hinge based on an assigned cylindrical surface, but the boundary condition also allows for a user-defined input. - `type` string, required — Replicate the behaviour of a freely rotating hinge fixed to the ground. Note that only a single face assignment is allowed. The assigned surface is constrained such that only rotational motion around the hinge axis is free. SimScale can automatically detect the axis of the hinge based on an assigned cylindrical surface, but the boundary condition also allows for a user-defined input. Schema name: HingeConstraintBC - `name` string - `axisDefinition` union - … - `topologicalReference` SimulationTopologicalReference - … - `numerics` SimulationSolidNumerics - `harmonicSolutionMethod` 'MODAL_BASED' | 'DIRECT' — Select the basis for the computation of the harmonic analysis. - `solver` union - object - `type` string, required — Schema name: MUMPSSolver - `advancedMumpsSettings` SimulationAdvancedMUMPSSettings - … - object - `type` string, required — Schema name: MultifrontalSolver - `renumberingMethod` 'MDA' | 'MD' — Choose a renumbering method for the solution process.
For large models around and above 50000 degrees of freedom you should consider using MDA. - `forceSymmetric` boolean — Choose if you want to enforce a symmetric matrix. - `precisionSingularityDetection` integer — Define the precision value for the detection of a singular matrix. Positive values enable the check, with 9 being a good starting point. Smaller values make the check more strict. This is an advanced option that should only be used to debug a model. - `stopIfSingular` boolean — Choose if the calculation should be stopped if the problem turns out to be singular. - `eliminateLagrangeMultipliers` boolean — This option makes it possible to eliminate the Lagrange Multipliers which are introduced by generalized boundary conditions like bonded contact, remote boundary conditions and symmetry conditions. If activated, this option removes the Lagrange Multipliers which leads to a reduction of the total number of unknowns and can increase the robustness of iterative solvers. - object - `type` string, required — Schema name: PETSCSolver - `convergenceThreshold` number — Set the threshold value for convergence detection for the relative convergence criteria. - `maxIterations` integer — Set the maximum number of iterations for the iterative solver. If set to 0 PETSC sets an estimate of the maximum number of iterations. - `advancedPetscSettings` SimulationAdvancedPETSCSettings - … - object - `type` string, required — Schema name: ChronosSolver - `convergenceThreshold` number — Select the convergence tolerance. Can be smaller than with PETSc, and has a big impact on the newton convergence. It is recommended to start with a smaller value in case of convergence problems e.g. 1e-8 - 1e-10. - `maxIterations` integer — Maximum number of iterations for Chronos. Should be 1000 for AMG (max 3000), and 5000 with FSAI (max 10000). - `nonConvergenceAction` 'STOP' | 'SWITCH_TO_DIRECT_SOLVER' — Choose what happens if the linear solution with Chronos fails. Either stop the simulation, or rerun it with a direct solver (MUMPS) - `advancedSettings` SimulationAdvancedChronosSettings - … - `solveModel` SimulationSolverModel - `eigenSolver` union - object - `type` string, required — Schema name: IRAMSorensen - `precSoren` number - `nmaxIterSoren` integer - `subspaceSettings` union —
Specify the subspace used by the eigensolver. This setting should only be changed if the errors during the solution procedure occur that recommend to change it. In general, the more frequencies are computed, the larger the subspace should be.

Automatic: The solver selects an appropriate subspace itself based on the model and other inputs.
Dimension: Directly specify the subspace dimension. This should be only done after checking the error log, which gives hints on selecting this setting.
Coefficient: Multiplier for setting the subspace dimension proportional to the number of computed frequencies
- … - object - `type` string, required — Schema name: Lanczos - `precOrtho` number - `nmaxIterOrtho` integer - `precLanczos` number - `maxIterQR` integer - `modeRigid` boolean - `subspaceSettings` union —
Specify the subspace used by the eigensolver. This setting should only be changed if the errors during the solution procedure occur that recommend to change it. In general, the more frequencies are computed, the larger the subspace should be.

Automatic: The solver selects an appropriate subspace itself based on the model and other inputs.
Dimension: Directly specify the subspace dimension. This should be only done after checking the error log, which gives hints on selecting this setting.
Coefficient: Multiplier for setting the subspace dimension proportional to the number of computed frequencies
- … - object - `type` string, required — Schema name: BatheWilson - `precBathe` number - `nmaxIterBathe` integer - `precJacobi` number - `maxIterJacobi` integer - `subspaceSettings` union —
Specify the subspace used by the eigensolver. This setting should only be changed if the errors during the solution procedure occur that recommend to change it. In general, the more frequencies are computed, the larger the subspace should be.

Automatic: The solver selects an appropriate subspace itself based on the model and other inputs.
Dimension: Directly specify the subspace dimension. This should be only done after checking the error log, which gives hints on selecting this setting.
Coefficient: Multiplier for setting the subspace dimension proportional to the number of computed frequencies
- … - object - `type` string, required — Schema name: QZ - `typeQZ` 'QZ_SIMPLE' | 'QZ_EQUI' | 'QZ_QR' - `calculateFrequency` SimulationCalculateFrequency - `precShift` number - `maxIterShift` integer - `thresholdFrequency` number - `eigenMode` SimulationEigenModeVerification - `threshold` number - `precisionShift` number - `enhancedAccuracy` boolean — Further increase the accuracy of the results by running two simulations. The results of the first one will be used as input for the second one to fine-tune the setup. - `modalBase` SimulationModalSolver - `solver` union —
Choose a linear equation system solver for your calculation:
Multfront is a direct solver of the multifrontal type. It is easy to set up and behaves well for most problems.
MUMPS is a general purpose direct solver of the multifrontal type. It provides a lot of parameter settings to allow the best fitting to your problems needs.
- SimulationMUMPSSolver - … - SimulationMultifrontalSolver - … - `solverModel` SimulationSolverModel - `eigenSolver` union - SimulationIRAMSorensen - … - SimulationLanczos - … - SimulationBatheWilson - … - SimulationQZ - … - `calculateFrequency` SimulationCalculateFrequency - `precShift` number - `maxIterShift` integer - `thresholdFrequency` number - `eigenMode` SimulationEigenModeVerification - `threshold` number - `precisionShift` number - `enhancedAccuracy` boolean — Further increase the accuracy of the results by running two simulations. The results of the first one will be used as input for the second one to fine-tune the setup. - `harmonicResponse` SimulationHarmonicResponse - `solver` SimulationMUMPSSolver - `type` string, required — Schema name: MUMPSSolver - `advancedMumpsSettings` SimulationAdvancedMUMPSSettings - … - `mechanicalTimeIntegrationType` union - object —
Choose the time integration scheme type

Important remarks:
Choose implicit if the problem is static or dynamic but not so complex. Implicit analysis takes more solution time but can solve the problem easily with larger timesteps. Therefore, it is always recommended to use implicit time integration scheme.
Choose explicit if the problem is only dynamic and highly complex. Explicit analysis takes less solution time but also needs more refined (small) timesteps to solve the problem. Therefore, in most of the cases it's not recommended due to convergence problems.
- `type` string, required —
Choose the time integration scheme type

Important remarks:
Choose implicit if the problem is static or dynamic but not so complex. Implicit analysis takes more solution time but can solve the problem easily with larger timesteps. Therefore, it is always recommended to use implicit time integration scheme.
Choose explicit if the problem is only dynamic and highly complex. Explicit analysis takes less solution time but also needs more refined (small) timesteps to solve the problem. Therefore, in most of the cases it's not recommended due to convergence problems.
Schema name: ImplicitTimeIntegrationType - `scheme` union - … - `schemeFormulation` 'DISPLACEMENT' —
Choose the primary variable for the time integration scheme.
- `massMatrixShift` number —
This parameter c_K allows the shifting of the mass matrix with the stiffness matrix multiplied by c_K: M^'=M + c_K*K. This makes it possible to strongly improve convergence in dynamics with implicit time scheme by imposing a cut-off frequency inversely proportional to the value of c_K (at the cost of a light distortion of all the eigen frequencies of the system).
- object —
Choose the time integration scheme type

Important remarks:
Choose implicit if the problem is static or dynamic but not so complex. Implicit analysis takes more solution time but can solve the problem easily with larger timesteps. Therefore, it is always recommended to use implicit time integration scheme.
Choose explicit if the problem is only dynamic and highly complex. Explicit analysis takes less solution time but also needs more refined (small) timesteps to solve the problem. Therefore, in most of the cases it's not recommended due to convergence problems.
- `type` string, required —
Choose the time integration scheme type

Important remarks:
Choose implicit if the problem is static or dynamic but not so complex. Implicit analysis takes more solution time but can solve the problem easily with larger timesteps. Therefore, it is always recommended to use implicit time integration scheme.
Choose explicit if the problem is only dynamic and highly complex. Explicit analysis takes less solution time but also needs more refined (small) timesteps to solve the problem. Therefore, in most of the cases it's not recommended due to convergence problems.
Schema name: ExplicitTimeIntegrationType - `scheme` union - … - `schemeFormulation` 'ACCELERATION' —
Choose the primary variable for the time integration scheme.
- `stopOnCFLCriterion` boolean —
If activated the simulation run is stopped when at some point the Courant-Friedrichs-Lewy (CFL) condition is violated.
- `massMatrixShift` number —
This parameter c_K allows the shifting of the mass matrix with the stiffness matrix multiplied by c_K: M^'=M + c_K*K. This makes it possible to strongly improve convergence in dynamics with implicit time scheme by imposing a cut-off frequency inversely proportional to the value of c_K (at the cost of a light distortion of all the eigen frequencies of the system).
- `mechanicalResolutionType` union - object —
Choose how the nonlinearities are solved. Currently for direct solvers only the Newton-Raphson method is available via the selection Newton. For iterative solvers also an inexact version of the Newton-Raphson method is available via the selection Newton-Krylov.
- `type` string, required —
Choose how the nonlinearities are solved. Currently for direct solvers only the Newton-Raphson method is available via the selection Newton. For iterative solvers also an inexact version of the Newton-Raphson method is available via the selection Newton-Krylov.
Schema name: NewtonResolutionType - `convergenceCriteria` union — Select the convergence criterion for the nonlinear solution method.
Important remarks:
When Absolute is selected, the convergence is reached if the maximum absolute residual of a given Newton iteration is lower than the defined tolerance.
If Relative is chosen, then the maximum relative residual i.e. the maximum absolute residual divided by external loads and support reactions, is checked during the Newton iteration. Please note that using the Relative criterion leads to a failed convergence if no external load is present (e.g. two far objects coming into contact). In this case, the Adaptive criterion should be used.
By selecting the Adaptive option, a combination of both Relative and Absolute criteria is used. That is, in each Newton iteration the Relative is used by default unless the external loads and support reactions have vanished, at which point we check the Absolute one instead.
- … - `predictionMatrix` 'TANGENT' | 'ELASTIC' —
Select which stiffnes matrix should be used in the prediction phase of the Newton method. A good choice leads to a good starting point for the first Newton iteration and thus a faster convergence.
- `jacobianMatrix` union - … - object —
Choose how the nonlinearities are solved. Currently for direct solvers only the Newton-Raphson method is available via the selection Newton. For iterative solvers also an inexact version of the Newton-Raphson method is available via the selection Newton-Krylov.
- `type` string, required —
Choose how the nonlinearities are solved. Currently for direct solvers only the Newton-Raphson method is available via the selection Newton. For iterative solvers also an inexact version of the Newton-Raphson method is available via the selection Newton-Krylov.
Schema name: NewtonKrylovResolutionType - `convergenceCriteria` union — Select the convergence criterion for the nonlinear solution method.
Important remarks:
When Absolute is selected, the convergence is reached if the maximum absolute residual of a given Newton iteration is lower than the defined tolerance.
If Relative is chosen, then the maximum relative residual i.e. the maximum absolute residual divided by external loads and support reactions, is checked during the Newton iteration. Please note that using the Relative criterion leads to a failed convergence if no external load is present (e.g. two far objects coming into contact). In this case, the Adaptive criterion should be used.
By selecting the Adaptive option, a combination of both Relative and Absolute criteria is used. That is, in each Newton iteration the Relative is used by default unless the external loads and support reactions have vanished, at which point we check the Absolute one instead.
- … - `predictionMatrix` 'TANGENT' | 'ELASTIC' —
Select which stiffnes matrix should be used in the prediction phase of the Newton method. A good choice leads to a good starting point for the first Newton iteration and thus a faster convergence.
- `jacobianMatrix` union - … - `mechanicalLineSearch` union - object —
Line search can be used to improve convergence for nonlinear calculations with the Newton method.
- `type` string, required —
Line search can be used to improve convergence for nonlinear calculations with the Newton method.
Schema name: FalseLineSearch - object —
Line search can be used to improve convergence for nonlinear calculations with the Newton method.
- `type` string, required —
Line search can be used to improve convergence for nonlinear calculations with the Newton method.
Schema name: TrueLineSearch - `method` 'SECANT' | 'MIXED' —
Choose the method of the line search algorithm. The Secant method is a simple one dimensional search algorithm. The mixed method is a more elaborate algorithm that uses variable bounds.
- `residual` number —
Set the residual for the line search convergence
- `maxIterations` integer —
Set the maximum number for line search iterations. Typically a sinlge-digit number should be sufficient.
- `thermalTimeIntegrationType` SimulationThetaMethodTimeIntegrationType —
Choose the time integration scheme type
- `type` string, required —
Choose the time integration scheme type
Schema name: ThetaMethodTimeIntegrationType - `theta` number — The parameter θ must be ranging between 0.0 (explicit method) and 1.0 (completely implicit method). The standard value of θ = 0.57 is chosen a little higher than θ = 0.5 which would lead to the Crank-Nicolson scheme of order 2. - `thermalResolutionType` union - object —
Choose how the nonlinearities are solved. Currently for direct solvers only the Newton-Raphson method is available via the selection Newton. For iterative solvers also an inexact version of the Newton-Raphson method is available via the selection Newton-Krylov.
- `type` string, required —
Choose how the nonlinearities are solved. Currently for direct solvers only the Newton-Raphson method is available via the selection Newton. For iterative solvers also an inexact version of the Newton-Raphson method is available via the selection Newton-Krylov.
Schema name: NewtonResolutionType - `convergenceCriteria` union — Select the convergence criterion for the nonlinear solution method.
Important remarks:
When Absolute is selected, the convergence is reached if the maximum absolute residual of a given Newton iteration is lower than the defined tolerance.
If Relative is chosen, then the maximum relative residual i.e. the maximum absolute residual divided by external loads and support reactions, is checked during the Newton iteration. Please note that using the Relative criterion leads to a failed convergence if no external load is present (e.g. two far objects coming into contact). In this case, the Adaptive criterion should be used.
By selecting the Adaptive option, a combination of both Relative and Absolute criteria is used. That is, in each Newton iteration the Relative is used by default unless the external loads and support reactions have vanished, at which point we check the Absolute one instead.
- … - `predictionMatrix` 'TANGENT' | 'ELASTIC' —
Select which stiffnes matrix should be used in the prediction phase of the Newton method. A good choice leads to a good starting point for the first Newton iteration and thus a faster convergence.
- `jacobianMatrix` union - … - object —
Choose how the nonlinearities are solved. Currently for direct solvers only the Newton-Raphson method is available via the selection Newton. For iterative solvers also an inexact version of the Newton-Raphson method is available via the selection Newton-Krylov.
- `type` string, required —
Choose how the nonlinearities are solved. Currently for direct solvers only the Newton-Raphson method is available via the selection Newton. For iterative solvers also an inexact version of the Newton-Raphson method is available via the selection Newton-Krylov.
Schema name: NewtonKrylovResolutionType - `convergenceCriteria` union — Select the convergence criterion for the nonlinear solution method.
Important remarks:
When Absolute is selected, the convergence is reached if the maximum absolute residual of a given Newton iteration is lower than the defined tolerance.
If Relative is chosen, then the maximum relative residual i.e. the maximum absolute residual divided by external loads and support reactions, is checked during the Newton iteration. Please note that using the Relative criterion leads to a failed convergence if no external load is present (e.g. two far objects coming into contact). In this case, the Adaptive criterion should be used.
By selecting the Adaptive option, a combination of both Relative and Absolute criteria is used. That is, in each Newton iteration the Relative is used by default unless the external loads and support reactions have vanished, at which point we check the Absolute one instead.
- … - `predictionMatrix` 'TANGENT' | 'ELASTIC' —
Select which stiffnes matrix should be used in the prediction phase of the Newton method. A good choice leads to a good starting point for the first Newton iteration and thus a faster convergence.
- `jacobianMatrix` union - … - `thermalLineSearch` union - object —
Line search can be used to improve convergence for nonlinear calculations with the Newton method.
- `type` string, required —
Line search can be used to improve convergence for nonlinear calculations with the Newton method.
Schema name: FalseLineSearch - object —
Line search can be used to improve convergence for nonlinear calculations with the Newton method.
- `type` string, required —
Line search can be used to improve convergence for nonlinear calculations with the Newton method.
Schema name: TrueLineSearch - `method` 'SECANT' | 'MIXED' —
Choose the method of the line search algorithm. The Secant method is a simple one dimensional search algorithm. The mixed method is a more elaborate algorithm that uses variable bounds.
- `residual` number —
Set the residual for the line search convergence
- `maxIterations` integer —
Set the maximum number for line search iterations. Typically a sinlge-digit number should be sufficient.
- `remotePointStiffnessMultiplier` number - `simulationControl` SimulationSolidSimulationControl - `timestepDefinition` union - object - `type` string, required — Schema name: AutoTimestepDefinition - `simulationInterval` SimulationDimensionalTime - … - `maximumTimestepLength` SimulationRestrictedDimensionalFunctionTime - … - `minimumTimestepLength` SimulationDimensionalTime - … - `maximumResidual` number - `retimingEvent` union - … - object - `type` string, required — Schema name: ManualTimestepDefinition - `simulationInterval` SimulationDimensionalTime - … - `timestepLength` SimulationRestrictedDimensionalFunctionTime - … - `pseudoTimeStepping` union - object - `type` string, required — Schema name: SingleStepPseudoTimeStepping - `staticTimesteps` SimulationDimensionalTime - … - object - `type` string, required — Schema name: SteppingListPseudoTimeStepping - `simulationIntervals` SimulationDimensionalTime - … - `timestepLength` SimulationRestrictedDimensionalFunctionTime - … - `autoLoadRamping` boolean — Loads and enforced motions will be ramped linearly over the simulation interval to aid solution convergence. Automatic ramping will only be applied if all boundary conditions (including gravity) are applied with constant values and if no creep formulation has been defined for the materials. - `writeControlDefinition` union - object —
Define how frequently intermediate results should be saved. With the selection of initial time steps only the user defined time steps are stored in the result and by selecting all computed time steps also intermediate results that were created by the automatic time stepping are saved. With the selection of write interval a specific write frequency can be chosen which reduces the result size. Finally using user defined time steps there can either be a constant time increment for result storage given or a table with varying time intervals analogous to the time step length definition.
- `type` string, required —
Define how frequently intermediate results should be saved. With the selection of initial time steps only the user defined time steps are stored in the result and by selecting all computed time steps also intermediate results that were created by the automatic time stepping are saved. With the selection of write interval a specific write frequency can be chosen which reduces the result size. Finally using user defined time steps there can either be a constant time increment for result storage given or a table with varying time intervals analogous to the time step length definition.
Schema name: WriteIntervalWriteControl - `writeInterval` integer —
Define the write frequency of the intermediate results to the result file. Selecting a write interval of 2 means that every second computed time step is saved in the final result database, independently if it is a pre-defined user time step or an intermediate one that was added during automatic time stepping.
- object —
Define how frequently intermediate results should be saved. With the selection of initial time steps only the user defined time steps are stored in the result and by selecting all computed time steps also intermediate results that were created by the automatic time stepping are saved. With the selection of write interval a specific write frequency can be chosen which reduces the result size. Finally using user defined time steps there can either be a constant time increment for result storage given or a table with varying time intervals analogous to the time step length definition.
- `type` string, required —
Define how frequently intermediate results should be saved. With the selection of initial time steps only the user defined time steps are stored in the result and by selecting all computed time steps also intermediate results that were created by the automatic time stepping are saved. With the selection of write interval a specific write frequency can be chosen which reduces the result size. Finally using user defined time steps there can either be a constant time increment for result storage given or a table with varying time intervals analogous to the time step length definition.
Schema name: AllComputedWriteControl - object —
Define how frequently intermediate results should be saved. With the selection of initial time steps only the user defined time steps are stored in the result and by selecting all computed time steps also intermediate results that were created by the automatic time stepping are saved. With the selection of write interval a specific write frequency can be chosen which reduces the result size. Finally using user defined time steps there can either be a constant time increment for result storage given or a table with varying time intervals analogous to the time step length definition.
- `type` string, required —
Define how frequently intermediate results should be saved. With the selection of initial time steps only the user defined time steps are stored in the result and by selecting all computed time steps also intermediate results that were created by the automatic time stepping are saved. With the selection of write interval a specific write frequency can be chosen which reduces the result size. Finally using user defined time steps there can either be a constant time increment for result storage given or a table with varying time intervals analogous to the time step length definition.
Schema name: InitialTimestepsWriteControl - object —
Define how frequently intermediate results should be saved. With the selection of initial time steps only the user defined time steps are stored in the result and by selecting all computed time steps also intermediate results that were created by the automatic time stepping are saved. With the selection of write interval a specific write frequency can be chosen which reduces the result size. Finally using user defined time steps there can either be a constant time increment for result storage given or a table with varying time intervals analogous to the time step length definition.
- `type` string, required —
Define how frequently intermediate results should be saved. With the selection of initial time steps only the user defined time steps are stored in the result and by selecting all computed time steps also intermediate results that were created by the automatic time stepping are saved. With the selection of write interval a specific write frequency can be chosen which reduces the result size. Finally using user defined time steps there can either be a constant time increment for result storage given or a table with varying time intervals analogous to the time step length definition.
Schema name: UserDefinedWriteControl - `writeIncrement` SimulationRestrictedDimensionalFunctionTime - … - `excitationFrequencies` union —
Set the frequencies for the harmonic excitation. Setting it to single frequency will only compute harmonic excitation on that frequency. To have harmonic excitations on multiple frequencies, please choose frequency list.
- object - `type` string, required — Schema name: SingleFrequency - `frequency` SimulationDimensionalFrequency - … - object - `type` string, required — Schema name: FrequencyList - `startFrequency` SimulationDimensionalFrequency - … - `endFrequency` SimulationDimensionalFrequency - … - `frequencyStepping` SimulationRestrictedDimensionalFunctionFrequency - … - `eigenfrequencyScope` union —
Select how you want to control natural frequencies to be computed:

First modes: The first Number of modes will be searched and computed, in the order of low to high frequency.
Frequency range: All the modes within the range of frequencies will be searched and computed. The frequency range is specified by a Start frequency and an End frequency.
Center frequency: Compute the Number of modes closest to the frequency defined by Center frequency.
- object - `type` string, required — Schema name: FirstMode - `numberOfModes` integer —
Define the maximum number of eigenfrequencies/eigenmodes, that should be calculated.
- object - `type` string, required — Schema name: FrequencyRange - `startFrequency` SimulationDimensionalFrequency - … - `endFrequency` SimulationDimensionalFrequency - … - `numberOfSubBands` integer - `parallelizationLevel` 'COMPLETE' | 'PARTIAL' - object - `type` string, required — Schema name: CenterFrequency - `centerFrequency` SimulationDimensionalFrequency - … - `numberOfModes` integer —
Define the maximum number of eigenfrequencies/eigenmodes, that should be calculated.
- `modalBase` SimulationModalBaseControl - `eigenfrequencyScope` union —
Select the method to build the modal base, by controlling the search of the natural frequencies:

Twice the maximum loading frequency: From zero to twice the maximum excitation frequency defined under Harmonic response.
First modes: The first Number of modes will be searched and computed in the order of low to high frequency.
Frequency range: All the modes within the specified frequency range will be searched and computed. The frequency range is defined by a Start frequency and an End frequency.
Center frequency: Compute the Number of modes closest to the frequency defined by the Center frequency.
- SimulationTwiceMaxLoadingFrequency - … - SimulationFirstMode - … - SimulationFrequencyRange - … - SimulationCenterFrequency - … - `harmonicResponse` SimulationHarmonicResponseControl - `excitationFrequencies` union —
Frequencies at which the harmonic loads are to be applied and results are to be computed. Define excitation frequencies using one of the following options:

Single frequency : Harmonic loads are applied at one frequency only.
Frequency list: Harmonic loads are applied across a range of frequencies with either a constant frequency stepping interval or a variable interval defined via a table.
Cluster around modes: Harmonic loads are applied at frequencies clustered around eigenfrequencies.
Cover spectrum: Harmonic loads are applied at frequencies clustered around and in between eigenfrequencies to fully capture the entire spectrum.
- SimulationSingleFrequency - … - SimulationFrequencyList - … - SimulationClusterAroundModes - … - SimulationCoverSpectrum - … - `processors` SimulationComputingCore - `numOfProcessors` -1 | 1 | 2 | 4 | 8 | 16 | 32 | 48 | 64 | 96 | 128 | 192 —
Selecting more processor cores will speed up the simulation process. Choosing a smaller computation instance will save core hours. Learn more.
- `numOfComputingProcessors` integer —
Set the number of processors which shall be used for the parallel computation.
- `domainDecomposition` union - SimulationAutomaticDomainDecomposition - … - SimulationCentralizedDomainDecomposition - … - SimulationElementGroupsDomainDecomposition - … - SimulationCustomDomainDecomposition - … - `numOfThreads` integer - `partitionMesh` boolean - `maxRunTime` SimulationDimensionalTime - `value` number - `unit` 's', required - `resultControl` SimulationSolidResultControl - `solutionFields` SimulationOneOfSolidResultControlSolutionFields[] — Each mode is normalized using its largest component of displacement. - union - SimulationContactResultControlItem - … - SimulationDisplacementResultControlItem - … - SimulationHarmonicDisplacementResultControlItem - … - SimulationNormalizedDisplacementResultControlItem - … - SimulationForceResultControlItem - … - SimulationStrainResultControlItem - … - SimulationStressResultControlItem - … - SimulationVelocityResultControlItem - … - SimulationHarmonicVelocityResultControlItem - … - SimulationAccelerationResultControlItem - … - SimulationHarmonicAccelerationResultControlItem - … - SimulationTemperatureResultControlItem - … - SimulationHeatFluxResultControlItem - … - SimulationERPDensityResultControlItem - … - `edgeCalculation` SimulationOneOfSolidResultControlEdgeCalculation[] - union - SimulationMinMaxFieldsCalculationResultControlItem - … - SimulationAverageFieldsCalculationResultControlItem - … - SimulationSumFieldsCalculationResultControlItem - … - `areaCalculation` SimulationOneOfSolidResultControlAreaCalculation[] - union - SimulationMinMaxFieldsCalculationResultControlItem - … - SimulationAverageFieldsCalculationResultControlItem - … - SimulationSumFieldsCalculationResultControlItem - … - SimulationHeatFlowCalculationResultControlItem - … - SimulationERPCalculationResultControlItem - … - `volumeCalculation` SimulationOneOfSolidResultControlVolumeCalculation[] - union - SimulationMinMaxFieldsCalculationResultControlItem - … - SimulationAverageFieldsCalculationResultControlItem - … - SimulationSumFieldsCalculationResultControlItem - … - `pointData` SimulationOneOfSolidResultControlPointData[] - union - SimulationTemporalResponseResultControlItem - … - SimulationHarmonicResponseResultControlItem - … - `meshOrder` 'FIRST' | 'SECOND' | 'NONE' - SimulationHeatTransfer - `type` string, required — Schema name: HeatTransfer - `timeDependency` union —
Steady-state: Steady-state simulations are time-independent, that is, the equations solved do not include time derivatives. If you are only interested in the converged solution, consider a steady-state simulation.
Transient: Transient simulations account for time-dependent effects, that is, the associated flow variables vary with respect to time.
- SimulationTransientTimeDependency - `type` string, required — Schema name: TransientTimeDependency - SimulationStationaryTimeDependency - `type` string, required — Schema name: StationaryTimeDependency - `nonLinearAnalysis` boolean —
Choose if your analysis should feature any kind of nonlinearity like physical contacts, nonlinear materials as hyperelasticity or plasticity or large rotations and large deformations, temperature dependant material properties or temperature dependant boundary conditions. For a linear analysis none of those nonlinearities are available.
- `connectionGroups` SimulationContact[] - `type` string, required — Schema name: Contact - `nodeMergingBonded` boolean —
Allow node merging for bonded contacts where possible to increase contact accuracy and solution efficiency. For contact pairs where nodes cannot be merged, linear relations will be used with the defined position tolerance.
- `connections` SimulationOneOfContactConnections[] - union - SimulationBondedContact - … - SimulationSlidingContact - … - `elementTechnology` SimulationSolidElementTechnology - `elementTechnology3D` SimulationElementTechnology - `definitionMethod` union - SimulationAutomaticElementDefinitionMethod - … - SimulationCustomElementDefinitionMethod - … - `model` SimulationSolidModel - `geometricBehavior` 'LINEAR' | 'NONLINEAR' - `magnitude` SimulationDimensionalFunctionAcceleration - `value` union - SimulationConstantFunction - … - SimulationExpressionFunction - … - SimulationPolynomialFunction - … - SimulationTableDefinedFunction - … - `unit` 'm/s²' | 'in/s²' | 'G', required - `e` SimulationDimensionalVectorLength - `value` SimulationDecimalVector - `x` number - `y` number - `z` number - `unit` 'm' | 'in' | 'mm' | 'cm' | 'ft' | 'yd', required - `materials` SimulationSolidMaterial[] - `name` string - `materialBehavior` union - object —
Choose the material behavior for your problem.

Important remarks:

Choose Linear elastic if the stress-strain relationship of your material is linear.
Choose Elasto-plastic if the stress-strain relationship of your material is non-linear after some point e.g. yielding point.
Choose Hyperelastic if your material responds elastically even at higher deformations.
- `type` string, required —
Choose the material behavior for your problem.

Important remarks:

Choose Linear elastic if the stress-strain relationship of your material is linear.
Choose Elasto-plastic if the stress-strain relationship of your material is non-linear after some point e.g. yielding point.
Choose Hyperelastic if your material responds elastically even at higher deformations.
Schema name: LinearElasticMaterialBehavior - `directionalDependency` union —
Choose the directional dependency for this property:
Isotropic material: all the material properties are the same in all directions
Orthotropic material: different material properties in different orthogonal directions (e.g. glass-reinforced plastic, or wood)
- … - `damping` union - … - `creepFormulation` union —
Define the Creep formulation. Three different formulations are available: Norton, Strain Hardening or Time Hardening.
They are based on the Power Law:
ε̇ = m*A*σⁿ*t^m-1
- … - object —
Choose the material behavior for your problem.

Important remarks:

Choose Linear elastic if the stress-strain relationship of your material is linear.
Choose Elasto-plastic if the stress-strain relationship of your material is non-linear after some point e.g. yielding point.
Choose Hyperelastic if your material responds elastically even at higher deformations.
- `type` string, required —
Choose the material behavior for your problem.

Important remarks:

Choose Linear elastic if the stress-strain relationship of your material is linear.
Choose Elasto-plastic if the stress-strain relationship of your material is non-linear after some point e.g. yielding point.
Choose Hyperelastic if your material responds elastically even at higher deformations.
Schema name: HyperElasticMaterialBehavior - `hyperElasticModel` union —
Choose the hyperelastic material model that should be used. All models derive the stress-strain relation from a strain energy function defined by the material model parameters.
- … - object —
Choose the material behavior for your problem.

Important remarks:

Choose Linear elastic if the stress-strain relationship of your material is linear.
Choose Elasto-plastic if the stress-strain relationship of your material is non-linear after some point e.g. yielding point.
Choose Hyperelastic if your material responds elastically even at higher deformations.
- `type` string, required —
Choose the material behavior for your problem.

Important remarks:

Choose Linear elastic if the stress-strain relationship of your material is linear.
Choose Elasto-plastic if the stress-strain relationship of your material is non-linear after some point e.g. yielding point.
Choose Hyperelastic if your material responds elastically even at higher deformations.
Schema name: PlasticMaterialBehavior - `elastoPlasticModel` union — Choose the Elasto-plastic model for your problem.

Important remarks:
Choose Bilinear if the material response is a combination of linear elastic and plastic behavior and is defined by the elastic modulus, yield strength, and, tangent modulus.
Choose Multilinear if the material response is a combination of linear elastic-plastic behavior and is defined by the elastic modulus, yield strength, and, multiple tangent moduli.
Choose Johnson-Cook if the material response includes strain hardening, strain rate hardening, and thermal softening effects, and is defined by parameters such as yield stress, hardening coefficient, hardening exponent, strain rate hardening coefficient, and thermal softening exponent.
Learn more - … - `density` SimulationDimensionalFunctionDensity - `value` union - SimulationConstantFunction - … - SimulationExpressionFunction - … - SimulationPolynomialFunction - … - SimulationTableDefinedFunction - … - `unit` 'kg/m³' | 'lb/in³' | 'g/mm³' | 'g/cm³' | 't/mm³' | 'lb/ft³', required - `expansion` SimulationIsotropicExpansion —
Define the directional dependency of this property. Isotropic means directionally independent.
- `type` string, required —
Define the directional dependency of this property. Isotropic means directionally independent.
Schema name: IsotropicExpansion - `expansionCoefficient` SimulationDimensionalFunctionThermalExpansionRate - `value` union - … - `unit` '1/K' | '1/°F', required - `referenceTemperature` SimulationDimensionalTemperature - `value` number - `unit` '°C' | '°F' | 'K', required - `conductivity` union - object —
Define the directional dependency of this property. Isotropic means directionally independent. Orthotropic means directionally dependent.
- `type` string, required —
Define the directional dependency of this property. Isotropic means directionally independent. Orthotropic means directionally dependent.
Schema name: IsotropicConductivity - `thermalConductivity` SimulationDimensionalFunctionThermalConductivity - … - `thermalConductivityFunction` SimulationDimensionalFunctionThermalConductivity - … - object —
Define the directional dependency of this property. Isotropic means directionally independent. Orthotropic means directionally dependent.
- `type` string, required —
Define the directional dependency of this property. Isotropic means directionally independent. Orthotropic means directionally dependent.
Schema name: OrthotropicConductivity - `thermalConductivityX` SimulationDimensionalFunctionThermalConductivity - … - `thermalConductivityY` SimulationDimensionalFunctionThermalConductivity - … - `thermalConductivityZ` SimulationDimensionalFunctionThermalConductivity - … - `specificHeat` SimulationDimensionalFunctionSpecificHeat - `value` union - SimulationConstantFunction - … - SimulationExpressionFunction - … - SimulationPolynomialFunction - … - SimulationTableDefinedFunction - … - `unit` 'J/(kg·K)' | 'Btu/(lb·°F)', required - `topologicalReference` SimulationTopologicalReference - `entities` string[] - `sets` string[] - `builtInMaterial` string - `materialLibraryReference` SimulationMaterialLibraryReference - `materialGroupId` string - `materialId` string - `interpolationParameters` object - `initialConditions` SimulationSolidInitialConditions - `displacement` SimulationDimensionalVectorFunctionInitialConditionWithDomainsLength - `global` SimulationDimensionalVectorFunctionLength - `value` union - … - `unit` 'm' | 'in' | 'mm' | 'cm' | 'ft' | 'yd', required - `subdomains` SimulationSubdomainBasedDimensionalVectorFunctionInitialConditionLength[] - `name` string - `subdomainValue` SimulationDimensionalVectorFunctionLength - … - `topologicalReference` SimulationTopologicalReference - … - `velocity` SimulationDimensionalVectorFunctionInitialConditionWithDomainsSpeed - `global` SimulationDimensionalVectorFunctionSpeed - `value` union - … - `unit` 'm/s' | 'in/s' | 'm/min' | 'm/h' | 'mm/s' | 'mm/min' | 'mm/h' | 'cm/s' | 'cm/min' | 'cm/h' | 'km/h' | 'ft/s' | 'ft/min' | 'ft/h' | 'in/min' | 'in/h' | 'mph' | 'kn', required - `subdomains` SimulationSubdomainBasedDimensionalVectorFunctionInitialConditionSpeed[] - `name` string - `subdomainValue` SimulationDimensionalVectorFunctionSpeed - … - `topologicalReference` SimulationTopologicalReference - … - `acceleration` SimulationDimensionalVectorFunctionInitialConditionWithDomainsAcceleration - `global` SimulationDimensionalVectorFunctionAcceleration - `value` union - … - `unit` 'm/s²' | 'in/s²' | 'G', required - `subdomains` SimulationSubdomainBasedDimensionalVectorFunctionInitialConditionAcceleration[] - `name` string - `subdomainValue` SimulationDimensionalVectorFunctionAcceleration - … - `topologicalReference` SimulationTopologicalReference - … - `stress` SimulationStressInitialConditionDomains - `global` SimulationStressTensorPressure - `sigmaXX` union - … - `sigmaYY` union - … - `sigmaZZ` union - … - `sigmaYZ` union - … - `sigmaXZ` union - … - `sigmaXY` union - … - `unit` 'Pa' | 'lbf/in²' | 'hPa' | 'kPa' | 'MPa' | 'atm' | 'mbar' | 'bar' | 'mH2O' | 'mmH2O' | 'mmHg' | 'dyne/cm²' | 'inH2O' | 'ftH2O' | 'inHg' | 'psf', required - `subdomains` SimulationSubdomainStressInitialCondition[] - `name` string - `subdomainValue` SimulationStressTensorPressure - … - `topologicalReference` SimulationTopologicalReference - … - `temperature` SimulationDimensionalFunctionInitialConditionDomainsTemperature - `global` SimulationDimensionalFunctionTemperature - `value` union - … - `unit` '°C' | '°F' | 'K', required - `subdomains` SimulationSubdomainDimensionalFunctionInitialConditionTemperature[] - `name` string - `subdomainValue` SimulationDimensionalFunctionTemperature - … - `topologicalReference` SimulationTopologicalReference - … - `boundaryConditions` SimulationOneOfHeatTransferBoundaryConditions[] - union - SimulationFixedTemperatureValueBC — This is a boundary condition for the temperature variable. It prescribes the given temperature value on all selected groups.

Important remarks:
Do not define a temperature and a heat flux boundary condition on the same group
Do not define the temperature on slave entities of Contact Constraints as they are constrained by the master temperature
You may define a parameter dependent (x,y,z,t) value by defining a formula or uploading a table (csv-file)
- `type` string, required — This is a boundary condition for the temperature variable. It prescribes the given temperature value on all selected groups.

Important remarks:
Do not define a temperature and a heat flux boundary condition on the same group
Do not define the temperature on slave entities of Contact Constraints as they are constrained by the master temperature
You may define a parameter dependent (x,y,z,t) value by defining a formula or uploading a table (csv-file)
Schema name: FixedTemperatureValueBC - `name` string - `temperatureValue` SimulationDimensionalFunctionTemperature - … - `topologicalReference` SimulationTopologicalReference - … - SimulationCyclicSymmetryBC —
The cyclic symmetry constraint enables to model only a sector of a 360° cyclic periodic structure and reduces the computation time and memory consumption considerably. The user defines the center and axis of the cyclic symmetry as well as the sector angle. The master and slave surfaces define the cyclic periodicity boundaries.

Important remarks:
All DOFs of the slave nodes will be constrained, adding an additional constraint on those nodes may lead to an overconstrained system.
This is a linear constraint, so no large rotations or large deformations are allowed in the proximity of cyclic symmetry boundaries.
Learn more.
- `type` string, required —
The cyclic symmetry constraint enables to model only a sector of a 360° cyclic periodic structure and reduces the computation time and memory consumption considerably. The user defines the center and axis of the cyclic symmetry as well as the sector angle. The master and slave surfaces define the cyclic periodicity boundaries.

Important remarks:
All DOFs of the slave nodes will be constrained, adding an additional constraint on those nodes may lead to an overconstrained system.
This is a linear constraint, so no large rotations or large deformations are allowed in the proximity of cyclic symmetry boundaries.
Learn more.
Schema name: CyclicSymmetryBC - `name` string - `enableHeatTransfer` 'YES' | 'NO' | 'HEAT_TRANSFER_ONLY' —
Define if heat transfer should be allowed across the contact. If yes is chosen a perfectly bonded heat contact is assumed whereas if no is selected no heat transfer across the contact is allowed. Mechanical contact stays with both options active. With the selection of heat transfer only no mechanical contact is activated but only a bonded heat contact.
- `axisOrigin` SimulationDimensionalVectorLength - … - `axisDirection` SimulationDimensionalVectorLength - … - `sectorAngle` SimulationDimensionalAngle - … - `masterTopologicalReference` SimulationTopologicalReference - … - `slaveTopologicalReference` SimulationTopologicalReference - … - SimulationSurfaceHeatFluxBC — Define the heatflux per unit area that enters the body through the assigned faces. Negative sign determines flux leaving the body. - `type` string, required — Define the heatflux per unit area that enters the body through the assigned faces. Negative sign determines flux leaving the body. Schema name: SurfaceHeatFluxBC - `name` string - `heatfluxValue` SimulationDimensionalFunctionHeatFlux - … - `topologicalReference` SimulationTopologicalReference - … - SimulationConvectiveHeatFluxBC — This is a heat flux boundary condition representing a convective heat flux on the selected face groups. It is defined by the reference temperature (surrounding temperature) and the convection coefficient.

Important remarks:
The convection coefficient is not only dependent on the material of the surrounding fluid but a property of the flow
You may define a parameter dependent (x,y,z,t) value by defining a formula or uploading a table (csv-file) for the reference temperature and the convection coefficient
- `type` string, required — This is a heat flux boundary condition representing a convective heat flux on the selected face groups. It is defined by the reference temperature (surrounding temperature) and the convection coefficient.

Important remarks:
The convection coefficient is not only dependent on the material of the surrounding fluid but a property of the flow
You may define a parameter dependent (x,y,z,t) value by defining a formula or uploading a table (csv-file) for the reference temperature and the convection coefficient
Schema name: ConvectiveHeatFluxBC - `name` string - `referenceTemperature` SimulationDimensionalFunctionTemperature - … - `heatTransferCoefficient` SimulationDimensionalFunctionThermalTransmittance - … - `topologicalReference` SimulationTopologicalReference - … - SimulationVolumeHeatFluxBC — This is a volume heat source boundary condition. It is applied to the volume elements in the selected volumes or volume groups.

Important remarks:
The total heat generated depends on the volume of the selection as the value is given as Watt per cubic meter.
For positive values heat is generated, for negative values the bc represents a heat sink.
You may define a parameter dependent (x,y,z,t) value by defining a formula or uploading a table (csv-file)
- `type` string, required — This is a volume heat source boundary condition. It is applied to the volume elements in the selected volumes or volume groups.

Important remarks:
The total heat generated depends on the volume of the selection as the value is given as Watt per cubic meter.
For positive values heat is generated, for negative values the bc represents a heat sink.
You may define a parameter dependent (x,y,z,t) value by defining a formula or uploading a table (csv-file)
Schema name: VolumeHeatFluxBC - `name` string - `heatfluxValue` SimulationDimensionalFunctionVolumetricPower - … - `topologicalReference` SimulationTopologicalReference - … - `numerics` SimulationSolidNumerics - `harmonicSolutionMethod` 'MODAL_BASED' | 'DIRECT' — Select the basis for the computation of the harmonic analysis. - `solver` union - object - `type` string, required — Schema name: MUMPSSolver - `advancedMumpsSettings` SimulationAdvancedMUMPSSettings - … - object - `type` string, required — Schema name: MultifrontalSolver - `renumberingMethod` 'MDA' | 'MD' — Choose a renumbering method for the solution process.
For large models around and above 50000 degrees of freedom you should consider using MDA. - `forceSymmetric` boolean — Choose if you want to enforce a symmetric matrix. - `precisionSingularityDetection` integer — Define the precision value for the detection of a singular matrix. Positive values enable the check, with 9 being a good starting point. Smaller values make the check more strict. This is an advanced option that should only be used to debug a model. - `stopIfSingular` boolean — Choose if the calculation should be stopped if the problem turns out to be singular. - `eliminateLagrangeMultipliers` boolean — This option makes it possible to eliminate the Lagrange Multipliers which are introduced by generalized boundary conditions like bonded contact, remote boundary conditions and symmetry conditions. If activated, this option removes the Lagrange Multipliers which leads to a reduction of the total number of unknowns and can increase the robustness of iterative solvers. - object - `type` string, required — Schema name: PETSCSolver - `convergenceThreshold` number — Set the threshold value for convergence detection for the relative convergence criteria. - `maxIterations` integer — Set the maximum number of iterations for the iterative solver. If set to 0 PETSC sets an estimate of the maximum number of iterations. - `advancedPetscSettings` SimulationAdvancedPETSCSettings - … - object - `type` string, required — Schema name: ChronosSolver - `convergenceThreshold` number — Select the convergence tolerance. Can be smaller than with PETSc, and has a big impact on the newton convergence. It is recommended to start with a smaller value in case of convergence problems e.g. 1e-8 - 1e-10. - `maxIterations` integer — Maximum number of iterations for Chronos. Should be 1000 for AMG (max 3000), and 5000 with FSAI (max 10000). - `nonConvergenceAction` 'STOP' | 'SWITCH_TO_DIRECT_SOLVER' — Choose what happens if the linear solution with Chronos fails. Either stop the simulation, or rerun it with a direct solver (MUMPS) - `advancedSettings` SimulationAdvancedChronosSettings - … - `solveModel` SimulationSolverModel - `eigenSolver` union - object - `type` string, required — Schema name: IRAMSorensen - `precSoren` number - `nmaxIterSoren` integer - `subspaceSettings` union —
Specify the subspace used by the eigensolver. This setting should only be changed if the errors during the solution procedure occur that recommend to change it. In general, the more frequencies are computed, the larger the subspace should be.

Automatic: The solver selects an appropriate subspace itself based on the model and other inputs.
Dimension: Directly specify the subspace dimension. This should be only done after checking the error log, which gives hints on selecting this setting.
Coefficient: Multiplier for setting the subspace dimension proportional to the number of computed frequencies
- … - object - `type` string, required — Schema name: Lanczos - `precOrtho` number - `nmaxIterOrtho` integer - `precLanczos` number - `maxIterQR` integer - `modeRigid` boolean - `subspaceSettings` union —
Specify the subspace used by the eigensolver. This setting should only be changed if the errors during the solution procedure occur that recommend to change it. In general, the more frequencies are computed, the larger the subspace should be.

Automatic: The solver selects an appropriate subspace itself based on the model and other inputs.
Dimension: Directly specify the subspace dimension. This should be only done after checking the error log, which gives hints on selecting this setting.
Coefficient: Multiplier for setting the subspace dimension proportional to the number of computed frequencies
- … - object - `type` string, required — Schema name: BatheWilson - `precBathe` number - `nmaxIterBathe` integer - `precJacobi` number - `maxIterJacobi` integer - `subspaceSettings` union —
Specify the subspace used by the eigensolver. This setting should only be changed if the errors during the solution procedure occur that recommend to change it. In general, the more frequencies are computed, the larger the subspace should be.

Automatic: The solver selects an appropriate subspace itself based on the model and other inputs.
Dimension: Directly specify the subspace dimension. This should be only done after checking the error log, which gives hints on selecting this setting.
Coefficient: Multiplier for setting the subspace dimension proportional to the number of computed frequencies
- … - object - `type` string, required — Schema name: QZ - `typeQZ` 'QZ_SIMPLE' | 'QZ_EQUI' | 'QZ_QR' - `calculateFrequency` SimulationCalculateFrequency - `precShift` number - `maxIterShift` integer - `thresholdFrequency` number - `eigenMode` SimulationEigenModeVerification - `threshold` number - `precisionShift` number - `enhancedAccuracy` boolean — Further increase the accuracy of the results by running two simulations. The results of the first one will be used as input for the second one to fine-tune the setup. - `modalBase` SimulationModalSolver - `solver` union —
Choose a linear equation system solver for your calculation:
Multfront is a direct solver of the multifrontal type. It is easy to set up and behaves well for most problems.
MUMPS is a general purpose direct solver of the multifrontal type. It provides a lot of parameter settings to allow the best fitting to your problems needs.
- SimulationMUMPSSolver - … - SimulationMultifrontalSolver - … - `solverModel` SimulationSolverModel - `eigenSolver` union - SimulationIRAMSorensen - … - SimulationLanczos - … - SimulationBatheWilson - … - SimulationQZ - … - … truncated; see the full OpenAPI document linked below ## Other responses - `404` — Not found. --- [API](https://skmtc.net/simscale/apis/simscale-api.md) · [All operations](https://skmtc.net/simscale/apis/simscale-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/simscale/simscale-api/revisions/53223abaceb7/schema)