Materials

Materials

new Materials(unit_system, model)

Creates an instance of the SkyCiv Materials class.

Parameters:
Name Type Description
unit_system 'metric' | 'imperial'

The unit system which the default materials should follow.
model Object

Param only used for the model class. Disregard this parameter if using the Materials class separately.
Source:

Extends

Methods

(static) add(material, unit_system)

Add a default material to the model.

Parameters:
Name Type Description
material "Structural Steel" | "Aluminium" | "Carbon Fibre Reinforced Plastic" | "Concrete" | "Concrete High Strength" | "Oakwood" | "Glass"

The material name.
unit_system "metric" | "imperial"

Units system for the default materials.
Source:

(static) addCustom(name, density, elasticity_modulus, poissons_ratio, yield_strength, ultimate_strength, _class)

Create a custom material with the next available ID.

Parameters:
Name Type Description
name string

The name of the material.
density number

The density of the material.
elasticity_modulus number

The Modulus of Elasticity of the material.
poissons_ratio number

The Poisson's Ratio for the material.
yield_strength number

The Yield strength of the material.
ultimate_strength number

The Ultimate strength the material.
_class "steel" | "aluminium" | "masonry" | "concrete" | "wood" | "other"

The type of material.
Source: