Class MPMLava

Lava on an MPMSolver whose materials include lava: the thermal step once per frame after the solver's substeps (three compute passes: scatter mass, heat and the surface glow into a grid; per node, which also writes the MPMLava.field texture; gather, cool and conduct), and the drawing, a screen-space surface (as for fluids): the particles near the surface are splatted as spheres into a depth buffer, which a bilateral blur smooths into one surface; a full-screen pass over the scene reconstructs its normals and shades it as basalt (sun GGX, sky or environment light) with a blackbody glow from the field's skin temperature (from how long the surface has been open, lavaSkin; Wien-scaled, so skin below ~1000 K is black by day and dull red at night), cracks glowing at the melt's bulk temperature, and ropy folds across the surface flow where the skin is dark. Hide the solver's own object, add this one, and call MPMLava.render before rendering.

Example

const mpm = new MPMSolver(renderer, { materials: { lava: LAVA_PRESETS.pahoehoe.material }, height })
const lava = new MPMLava(mpm, LAVA_PRESETS.pahoehoe.lava)
mpm.object.visible = false
scene.add(lava.object)
lava.emit({ center: vent, size: [0.4, 0.2, 0.4], velocity: [1, 0, 0] })
renderer.setAnimationLoop(() => {
  renderer.compute(lava.prepare(1 / 60))
  lava.lighting.fromScene(scene)
  lava.render(renderer, camera)
  renderer.render(scene, camera)
})

Index

Constructors

constructor

new MPMLava(
    solver: MPMSolver,
    __namedParameters?: {
        material?: string;
        render?: {
            clasts?: number;
            cracks?: number;
            crackSize?: number;
            crackWidth?: number;
            crust?: string;
            intensity?: number;
            iterations?: number;
            radius?: number;
            resolution?: number;
            ropeLength?: number;
            ropes?: number;
            roughness?: number;
            smoothing?: number;
        };
    } & {
        envMap?: Texture<unknown, TextureEventMap>
        | null;
        lighting?: ParticleLighting;
    },
): MPMLava
Lava on solver (whose materials must include options.material, default lava). lighting is shared with other systems if given; envMap (e.g. scene.environment) lights the surface instead of the sky colour of lighting.
Parameters
- solver: MPMSolver
- __namedParameters: {
      material?: string;
      render?: {
          clasts?: number;
          cracks?: number;
          crackSize?: number;
          crackWidth?: number;
          crust?: string;
          intensity?: number;
          iterations?: number;
          radius?: number;
          resolution?: number;
          ropeLength?: number;
          ropes?: number;
          roughness?: number;
          smoothing?: number;
      };
  } & {
      envMap?: Texture<unknown, TextureEventMap>
      | null;
      lighting?: ParticleLighting;
  } = {}
  - Optionalmaterial?: string
    
    Name of the solver material that is lava (compiled into the solver).
  - Optionalrender?: {
        clasts?: number;
        cracks?: number;
        crackSize?: number;
        crackWidth?: number;
        crust?: string;
        intensity?: number;
        iterations?: number;
        radius?: number;
        resolution?: number;
        ropeLength?: number;
        ropes?: number;
        roughness?: number;
        smoothing?: number;
    }
    
    The screen-space surface: particle spheres → depth → bilateral smoothing → normals, shaded with the lava field.
    
    Optionalclasts?: number
    
    Clinker: each crack cell is a clast tilted at random up to this much (0 a continuous skin, 1 rubble).
    
    Optionalcracks?: number
    
    Glow of the crust's crack network, 0…1: cooling-joint cells of crackSize whose edges, crackWidth wide, glow at the melt temperature under the crust (dark where the lava below has cooled too), and of crust cracks opening in the flow.
    
    OptionalcrackSize?: number
    
    Crack cell size, metres (pāhoehoe crust plates ~0.3 m, ʻaʻā clinker ~0.1 m).
    
    OptionalcrackWidth?: number
    
    Crack width, metres.
    
    Optionalcrust?: string
    
    Basalt albedo, #rrggbb (sRGB; ~0.05 linear).
    
    Optionalintensity?: number
    
    Emission scale (1: against a noon sun of intensity 3, 1400 K lava has radiance LAVA_GLOW_1400).
    
    Optionaliterations?: number
    
    Smoothing passes (each a horizontal and a vertical blur), 0…4.
    
    Optionalradius?: number
    
    Sphere radius of a particle, in particle spacings (Δx / 2). About 1.3 makes neighbours overlap into one surface.
    
    Optionalresolution?: number
    
    Resolution of the offscreen passes relative to the drawing buffer (0.25…1).
    
    OptionalropeLength?: number
    
    Rope spacing, metres.
    
    Optionalropes?: number
    
    Ropy folds of the cooled skin (pāhoehoe), 0…1: ridges across the surface flow, where the skin has gone dark.
    
    Optionalroughness?: number
    
    Crust roughness: glassy pāhoehoe skin ~0.5, clinkery ʻaʻā ~0.9.
    
    Optionalsmoothing?: number
    
    Depth smoothing radius, in sphere radii: large for smooth pāhoehoe skin, small to keep ʻaʻā clinker lumpy.
  - OptionalenvMap?: Texture<unknown, TextureEventMap> | null
  - Optionallighting?: ParticleLighting
Returns MPMLava
- Defined in particles/src/mpm-lava.ts:492

Properties

`Readonly`field

field: Storage3DTexture

Per grid node (texel), written by the thermal step: x lava fill φ, y mean temperature (K), and the glow of the surface particles (skin, or bulk where a crust crack opens) premultiplied: z Σ fill·T_glow (K), w their fill. The drawing divides z/w after trilinear filtering, so the glow is as continuous as the surface.

`Readonly`lighting

lighting: ParticleLighting

Sun and sky light for the surface (fill it with lighting.fromScene(scene)).

`Readonly`materialIndex

materialIndex: number

Index of the lava material in the solver.

`Readonly`object

object: Mesh

Add this to your scene: the full-screen surface pass (drawn after the opaque scene, it reads its depth).

options

options: LavaOptions

Resolved drawing options.

`Readonly`solver

solver: MPMSolver

The solver it runs on.

`Readonly`uniforms

uniforms: {
    clasts: UniformNode<"float", number>;
    cracks: UniformNode<"float", number>;
    crackSize: UniformNode<"float", number>;
    crackWidth: UniformNode<"float", number>;
    crust: UniformNode<"color", Color>;
    direction: UniformNode<"vec2", Vector2>;
    dt: UniformNode<"float", number>;
    environmentIntensity: UniformNode<"float", number>;
    gateCount: UniformNode<"int", number>;
    gateFill: UniformNode<"float", number>;
    gateFirst: UniformNode<"int", number>;
    intensity: UniformNode<"float", number>;
    origin: UniformNode<"vec3", Vector3>;
    projection: UniformNode<"vec2", Vector2>;
    radius: UniformNode<"float", number>;
    right: UniformNode<"vec3", Vector3>;
    ropeLength: UniformNode<"float", number>;
    ropes: UniformNode<"float", number>;
    roughness: UniformNode<"float", number>;
    smoothing: UniformNode<"float", number>;
    texel: UniformNode<"vec2", Vector2>;
    up: UniformNode<"vec3", Vector3>;
} = ...

Shader uniforms.

Type Declaration

clasts: UniformNode<"float", number>

Clast tilt.
cracks: UniformNode<"float", number>

Crack glow.
crackSize: UniformNode<"float", number>

Crack cell size, metres.
crackWidth: UniformNode<"float", number>

Crack width, metres.
crust: UniformNode<"color", Color>

Crust albedo (linear).
direction: UniformNode<"vec2", Vector2>

Blur direction.
dt: UniformNode<"float", number>

Simulated seconds since the last thermal step.
environmentIntensity: UniformNode<"float", number>

Environment light scale (the scene's environmentIntensity).
gateCount: UniformNode<"int", number>

How many.
gateFill: UniformNode<"float", number>

Most lava fill a new particle may land in.
gateFirst: UniformNode<"int", number>

First ring slot of the particles MPMLava.emit added since the last step.
intensity: UniformNode<"float", number>

Emission scale.
origin: UniformNode<"vec3", Vector3>

Solver origin, world.
projection: UniformNode<"vec2", Vector2>

Projection [0][0] and [1][1].
radius: UniformNode<"float", number>

Sphere radius, metres.
right: UniformNode<"vec3", Vector3>

Camera right, world.
ropeLength: UniformNode<"float", number>

Rope spacing, metres.
ropes: UniformNode<"float", number>

Rope amplitude.
roughness: UniformNode<"float", number>

Crust roughness.
smoothing: UniformNode<"float", number>

Smoothing radius, metres.
texel: UniformNode<"vec2", Vector2>

One texel of the offscreen passes.
up: UniformNode<"vec3", Vector3>

Camera up, world.

Methods

dispose

dispose(): void
Frees the GPU passes, targets and meshes (not the solver).

Returns void
- Defined in particles/src/mpm-lava.ts:641

emit

emit(spec: MPMEmit, maxFill?: number): number
Adds lava (an MPMEmit block, by default this material at its eruption temperature) through a vent that only fills free space: before the next step, new particles that land where the lava fill φ (from the last thermal step) is above maxFill are removed. MPM reads density from each particle's own deformation, so a particle born inside lava would add mass without pressure, and a vent pouring faster than the flow carries lava away would pack it ever denser. Returns how many were added (before the gate).
Parameters
- spec: MPMEmit
- maxFill: number = 0.7
Returns number
- Defined in particles/src/mpm-lava.ts:551

prepare

prepare(dt: number): ComputeNode[]
The solver's passes for dt and then the thermal step, for one renderer.compute(...).
Parameters
- dt: number
Returns ComputeNode[]
- Defined in particles/src/mpm-lava.ts:566

render

render(renderer: Renderer, camera: Camera): this
Draws the offscreen surface passes for camera (each frame, before rendering the scene that holds object).
Parameters
- renderer: Renderer
- camera: Camera
Returns this
- Defined in particles/src/mpm-lava.ts:594

set

set(
    input: {
        material?: string;
        render?: {
            clasts?: number;
            cracks?: number;
            crackSize?: number;
            crackWidth?: number;
            crust?: string;
            intensity?: number;
            iterations?: number;
            radius?: number;
            resolution?: number;
            ropeLength?: number;
            ropes?: number;
            roughness?: number;
            smoothing?: number;
        };
    },
): this
Merges input into the drawing options (material is fixed at construction).
Parameters
- input: {
      material?: string;
      render?: {
          clasts?: number;
          cracks?: number;
          crackSize?: number;
          crackWidth?: number;
          crust?: string;
          intensity?: number;
          iterations?: number;
          radius?: number;
          resolution?: number;
          ropeLength?: number;
          ropes?: number;
          roughness?: number;
          smoothing?: number;
      };
  }
  - Optionalmaterial?: string
    
    Name of the solver material that is lava (compiled into the solver).
  - Optionalrender?: {
        clasts?: number;
        cracks?: number;
        crackSize?: number;
        crackWidth?: number;
        crust?: string;
        intensity?: number;
        iterations?: number;
        radius?: number;
        resolution?: number;
        ropeLength?: number;
        ropes?: number;
        roughness?: number;
        smoothing?: number;
    }
    
    The screen-space surface: particle spheres → depth → bilateral smoothing → normals, shaded with the lava field.
    
    Optionalclasts?: number
    
    Clinker: each crack cell is a clast tilted at random up to this much (0 a continuous skin, 1 rubble).
    
    Optionalcracks?: number
    
    Glow of the crust's crack network, 0…1: cooling-joint cells of crackSize whose edges, crackWidth wide, glow at the melt temperature under the crust (dark where the lava below has cooled too), and of crust cracks opening in the flow.
    
    OptionalcrackSize?: number
    
    Crack cell size, metres (pāhoehoe crust plates ~0.3 m, ʻaʻā clinker ~0.1 m).
    
    OptionalcrackWidth?: number
    
    Crack width, metres.
    
    Optionalcrust?: string
    
    Basalt albedo, #rrggbb (sRGB; ~0.05 linear).
    
    Optionalintensity?: number
    
    Emission scale (1: against a noon sun of intensity 3, 1400 K lava has radiance LAVA_GLOW_1400).
    
    Optionaliterations?: number
    
    Smoothing passes (each a horizontal and a vertical blur), 0…4.
    
    Optionalradius?: number
    
    Sphere radius of a particle, in particle spacings (Δx / 2). About 1.3 makes neighbours overlap into one surface.
    
    Optionalresolution?: number
    
    Resolution of the offscreen passes relative to the drawing buffer (0.25…1).
    
    OptionalropeLength?: number
    
    Rope spacing, metres.
    
    Optionalropes?: number
    
    Ropy folds of the cooled skin (pāhoehoe), 0…1: ridges across the surface flow, where the skin has gone dark.
    
    Optionalroughness?: number
    
    Crust roughness: glassy pāhoehoe skin ~0.5, clinkery ʻaʻā ~0.9.
    
    Optionalsmoothing?: number
    
    Depth smoothing radius, in sphere radii: large for smooth pāhoehoe skin, small to keep ʻaʻā clinker lumpy.
Returns this
- Defined in particles/src/mpm-lava.ts:537

setEnvironment

setEnvironment(envMap: Texture<unknown, TextureEventMap> | null): this
Replaces the environment that lights the surface (null: the sky colour of lighting). Rebuilds the surface pass.
Parameters
- envMap: Texture<unknown, TextureEventMap> | null
Returns this
- Defined in particles/src/mpm-lava.ts:585

Class MPMLava

Example

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optionalmaterial?: string

Optionalrender?: { clasts?: number; cracks?: number; crackSize?: number; crackWidth?: number; crust?: string; intensity?: number; iterations?: number; radius?: number; resolution?: number; ropeLength?: number; ropes?: number; roughness?: number; smoothing?: number;}

Optionalclasts?: number

Optionalcracks?: number

OptionalcrackSize?: number

OptionalcrackWidth?: number

Optionalcrust?: string

Optionalintensity?: number

Optionaliterations?: number

Optionalradius?: number

Optionalresolution?: number

OptionalropeLength?: number

Optionalropes?: number

Optionalroughness?: number

Optionalsmoothing?: number

OptionalenvMap?: Texture<unknown, TextureEventMap> | null

Optionallighting?: ParticleLighting

Returns MPMLava

Properties

Readonlyfield

Readonlylighting

ReadonlymaterialIndex

Readonlyobject

options

Readonlysolver

Readonlyuniforms

Type Declaration

clasts: UniformNode<"float", number>

cracks: UniformNode<"float", number>

crackSize: UniformNode<"float", number>

crackWidth: UniformNode<"float", number>

crust: UniformNode<"color", Color>

direction: UniformNode<"vec2", Vector2>

dt: UniformNode<"float", number>

environmentIntensity: UniformNode<"float", number>

gateCount: UniformNode<"int", number>

gateFill: UniformNode<"float", number>

gateFirst: UniformNode<"int", number>

intensity: UniformNode<"float", number>

origin: UniformNode<"vec3", Vector3>

projection: UniformNode<"vec2", Vector2>

radius: UniformNode<"float", number>

right: UniformNode<"vec3", Vector3>

ropeLength: UniformNode<"float", number>

ropes: UniformNode<"float", number>

roughness: UniformNode<"float", number>

smoothing: UniformNode<"float", number>

texel: UniformNode<"vec2", Vector2>

up: UniformNode<"vec3", Vector3>

Methods

dispose

Returns void

emit

Parameters

Returns number

prepare

Parameters

Returns ComputeNode[]

render

Parameters

Returns this

set

Parameters

Optionalmaterial?: string

Optionalrender?: { clasts?: number; cracks?: number; crackSize?: number; crackWidth?: number; crust?: string; intensity?: number; iterations?: number; radius?: number; resolution?: number; ropeLength?: number; ropes?: number; roughness?: number; smoothing?: number;}

Optionalclasts?: number

Optionalcracks?: number

OptionalcrackSize?: number

OptionalcrackWidth?: number

Optionalcrust?: string

Optionalintensity?: number

`Optional`material?: string

`Optional`render?: {
clasts?: number;
cracks?: number;
crackSize?: number;
crackWidth?: number;
crust?: string;
intensity?: number;
iterations?: number;
radius?: number;
resolution?: number;
ropeLength?: number;
ropes?: number;
roughness?: number;
smoothing?: number;
}

`Optional`clasts?: number

`Optional`cracks?: number

`Optional`crackSize?: number

`Optional`crackWidth?: number

`Optional`crust?: string

`Optional`intensity?: number

`Optional`iterations?: number

`Optional`radius?: number

`Optional`resolution?: number

`Optional`ropeLength?: number

`Optional`ropes?: number

`Optional`roughness?: number

`Optional`smoothing?: number

`Optional`envMap?: Texture<unknown, TextureEventMap> | null

`Optional`lighting?: ParticleLighting

`Readonly`field

`Readonly`lighting

`Readonly`materialIndex

`Readonly`object

`Readonly`solver

`Readonly`uniforms

`Optional`material?: string

`Optional`render?: {
clasts?: number;
cracks?: number;
crackSize?: number;
crackWidth?: number;
crust?: string;
intensity?: number;
iterations?: number;
radius?: number;
resolution?: number;
ropeLength?: number;
ropes?: number;
roughness?: number;
smoothing?: number;
}

`Optional`clasts?: number

`Optional`cracks?: number

`Optional`crackSize?: number

`Optional`crackWidth?: number

`Optional`crust?: string

`Optional`intensity?: number

`Optional`iterations?: number

`Optional`radius?: number

`Optional`resolution?: number

`Optional`ropeLength?: number

`Optional`ropes?: number

`Optional`roughness?: number

`Optional`smoothing?: number