View & accessibility
Thumbnails
Motion
Bforartists
5.1
Editors

Volume

Volume nodes: Read, Sample, Write, Operations, Primitives.

10
 min read
Up to date for 
5.1
draft

Read

Add menu - Volume - Read

Add menu - Volume - Read
Add menu - Volume - Read

Here you find nodes to modify the volume.

Get Grid Names

Get Grid Names

Lists the names of all grids stored in a volume. Use it to see what a volume contains, for example before you pick a grid with Get Named Grid.

Inputs

Volume

The volume to list the grid names of.

Outputs

Names

A list of the names of all grids in the volume, sorted alphabetically. If the geometry has no volume, the list is empty.

Get Named Grid

Get Named Grid

Get volume grid from a volume geometry with the specified name

Inputs

EntryWhat it does
VolumeThe input volume.
NameThe name of the grid.
RemoveRemoves the grid from the volume after retreive.

Properties

Data Type
Data Type

The type of data stored in the grid. It determines both, the expected data type of the Grid output, and how it can be used in subsequent nodes.

Output

EntryWhat it does
VolumeThe output grid.
GridThe extracted grid.

Grid Info

Grid Info

Retreive informations about a grid.

Inputs

Grid

Standard geometry input.

Properties

Data type
Data type

The data type to retreive.

Output

EntryWhat it does
TransformTransform from grid index space to object space.
Background ValueDefault value outside of grid voxels.

Voxel Index

Voxel Index

Retreive the integer coordinates of the voxel that the field is evaluated on.

Outputs

EntryWhat it does
X / Y / ZVector 3 output of the voxel.
Tile subpanelIs Tile: True when the field is evaluated on a tile. · Extend X / Y / Z: Number of voxels in the corresponding direction. Or 1 if the field is evaluated at a voxel.

Sample

Add menu - Volume

Add menu - Volume
Add menu - Volume

Here you find nodes to modify the volume.

Sample Grid

Sample Grid

Retreive values from the specified volume grid.

Inputs

EntryWhat it does
GridThe input grid
PositionThe position field.
Interpolation
Interpolation

How to interpolate the values between neighbouring voxels.

Input

Data Type
Data Type

Which data type to calculate.

Output

Value

The output value.

Sample Grid Index

Sample Grid Index

Retreive values from the specified volume grid.

Inputs

EntryWhat it does
GridThe input grid
PositionThe position field.
Interpolation
Interpolation

How to interpolate the values between neighbouring voxels.

Input

Data Type
Data Type

Which data type to calculate.

Output

Value

The output value.

Advect Grid

Advect Grid

Move grid values through a velocity field using numerical integration. Supports multiple intetgration schemes for different accuracy and performance trade-offs.

Inputs

EntryWhat it does
GridThe input grid.
VelocityThe velocity.
PositionThe position field.
Time stepTime step for advection in seconds.
Integration scheme
Integration scheme

Numerical integration method for advection.

Limiter
Limiter

Limiting strategy to prevent numerical artifacts.

Output

Grid

The output grid.

Grid Curl

Grid Curl

Calculate the magnitude and direction of ciruclation of a directional vector grid.

EntryWhat it does
InputsGrid: The input grid.
OutputCurl: The output grid.

Grid Divergence

Grid Divergence

Calculate the flow into and out of each point of a directional vector grid.

EntryWhat it does
InputsGrid: The input grid.
OutputDivergence: The output grid.

Grid Gradient

Grid Gradient

Calculate the direction and magnitude of the change in values of a scalar grid.

EntryWhat it does
InputsGrid: The input grid.
OutputGradient: The output grid.

Grid Laplacian

Grid Laplacian

Compute the divergence of the gradient of the input grid.

EntryWhat it does
InputsGrid: The input grid.
OutputLaplacian: The output grid.

Grid Solve Poisson

Grid Solve Poisson

Solves the Poisson equation for a scalar grid. It computes a grid whose Laplacian is the input grid. Use the boundary settings to say what happens at the edge of the active voxels.

The solver works on grids with the same voxel size in all directions. If the voxel size is not uniform, the node shows a warning.

Inputs
Grid

The scalar grid on the right-hand side of the equation.

Max Iterations

The most steps the solver may take. The default is 100. The value can be 1 to 10000.

Error Threshold

The solver stops when the error is below this value. The default is 0.001.

Threshold Mode

How the error threshold is measured.

  • Relative: the error is measured relative to the largest absolute value of the input grid. This is the default.
  • Absolute: the error is measured as an absolute value in the units of the solution.
Boundary

What happens at the boundary between active and inactive voxels.

  • Fixed: you set the value of the solution for the voxels just outside the active ones. This is the default.
  • Gradient: you set the gradient of the solution at the boundary.
  • Mixed: you set both and blend between them with Boundary Factor.
Boundary Value

The value of the solution at the boundary. It is a field, so it can change from voxel to voxel. It is only shown for Fixed and Mixed.

Boundary Gradient

The gradient of the solution at the boundary. It is a field. It is only shown for Gradient and Mixed.

Boundary Factor

How much of the gradient is used instead of the value, from 0 to 1. At 0 the value is used, at 1 the gradient. It is a field. It is only shown for Mixed.

Outputs
Solution

The grid that solves the equation.

Success

True if the solver reached the error threshold.

Iterations

How many steps the solver took.

Absolute Error

The absolute error of the solution at the end.

Relative Error

The relative error of the solution at the end.

Debug Boundary Value

A panel with three outputs that is closed by default. This one is the grid of boundary values the solver used. It is only shown for Fixed and Mixed.

Debug Boundary Gradient

The grid of boundary gradients the solver used. It is only shown for Gradient and Mixed.

Debug Boundary Factor

The grid of boundary factors the solver used. It is only shown for Mixed.

Write

Add menu - Volume

Add menu - Volume
Add menu - Volume

Here you find nodes to modify the volume.

Grid Background

Grid Background

Set the background value used for inactive voxels and tiles.

Inputs

EntryWhat it does
GridStandard geometry input.
BackgroundVolume density per voxel. Higher values makes it more dense.

Properties

Data Type
Data Type

What data type to calculate.

Output

Grid

The grid output.

Set Grid Transform

Set Grid Transform

Set the transform for the grid from index space into object space.

Inputs

EntryWhat it does
GridStandard geometry input.
TransformThe input transform.

Properties

Data Type
Data Type

What data type to calculate.

Output

EntryWhat it does
Is ValidIf the new transform is successfully applied and working.
GridThe grid output.

Store Named Grid

Store Named Grid

Set the transform for the grid from index space into object space.

Inputs

EntryWhat it does
VolumeThe volume input.
NameThe name
GridStandard geometry input.

Properties

Data Type
Data Type

What data type to calculate.

Output

Volume Geometry

The volume geometry to add to.

Operations

Add menu - Volume - Operations

Add menu - Volume - Operations
Add menu - Volume - Operations

Here you find nodes to modify the volume.

Grid to Mesh

Grid to Mesh

Generate a mesh on the surface of a volume grid.

EntryWhat it does
InputsGrid: Standard grid input. · Threshold: Values larger than the threshold are inside the generated mesh. · Adaptivity: The input radius
OutputMesh: The generated mesh.

Volume to Mesh

Volume to Mesh

The Volume to Mesh node generates a mesh on the “surface” of a volume. The surface is defined by a threshold value. All voxels with a larger value than the threshold are considered to be outside.

Note that currently this node only works on volumes generated using geometry nodes.

Inputs

Volume

Standard geometry input.

Resolution
Resolution

Base the voxel resolution at the gridsize, the amount or the size of the point cloud.

EntryWhat it does
ThresholdThe voxel amount to use.
AdaptivityThe input radius.

Output

Mesh

The generated mesh.

SDF Grid Boolean

SDF Grid Boolean

Bool multiple sdf grids with each other.

EntryWhat it does
InputsGrid 1: The first input grid. · Grid 2: The second input grid
PropertiesOperation: The bool method.
OutputGrid: The generated grid.

SDF Grid Fillet

SDF Grid Fillet

Round off concave internal corners in a signed distance field. Only affects areas with negataive principal curvature. This creates smoother transitions between surfaces.

EntryWhat it does
InputsGrid: The input grid. · Iterations: How often to run the algorithm.
OutputGrid: The generated grid.

SDF Grid Laplacian

SDF Grid Laplacian

Apply laplacian flow smoothing to a signed distance field.

EntryWhat it does
InputsGrid: The input grid. · Iterations: How often to run the algorithm.
OutputGrid: The generated grid.

SDF Grid Mean

SDF Grid Mean

Apply lmean (box) filter smoothing to a signed distance field. Fast separable averaging filter for general smoothing of the distance field.

EntryWhat it does
InputsGrid: The input grid. · Width: Filter kernel radius in voxel. · Iterations: How often to run the algorithm.
OutputGrid: The generated grid.

SDF Grid Mean

SDF Grid Mean

Apply mean filter smoothing to a signed distance field. Evolves the surface based on its mean curvature. This smooths high curvature regions more than flat areas.

EntryWhat it does
InputsGrid: The input grid. · Iterations: How often to run the algorithm.
OutputGrid: The generated grid.

SDF Grid Median

SDF Grid Median

Apply median filter smoothing to a signed distance field. Reduces nioise while preserving sharp features and edges in the distance field.

EntryWhat it does
InputsGrid: The input grid. · Width: Filter kernel radius in voxel. · Iterations: How often to run the algorithm.
OutputGrid: The generated grid.

SDF Grid Offset

SDF Grid Offset

Offset a signed distance field surface by a world space distance. It dilates or erodes while maintaining the signed distance property.

EntryWhat it does
InputsGrid: The input grid. · Distance: Object space distance to offset the sdf surface.
OutputGrid: The generated grid.

Field to Grid

Field to Grid

Create new grids by evaulating new values on an existing volume grid topology.

Inputs

EntryWhat it does
TopologyThe input topology.
Properties—
Data Type
Data Type

The data type to evaluate.

Output

Grid

The generated grid.

Prune Grid

Prune Grid

Create new grids by evaulating new values on an existing volume grid topology.

Inputs

Grid

The input grid.

Mode
Mode

How to progress the state.

EntryWhat it does
InactiveTurn inactive voxels and tiels into inactive background tiles.
ThresholdTurn regioons where all voxels have the same value and active state into inactive background tiles. You will see a threshold slider.
SDFReplace inactive tiles with inactive nodes.
Properties
Data Type
Data Type

The data type to evaluate.

Output

Grid

The generated grid.

Prune Grid

Prune Grid

Create new grids by evaulating new values on an existing volume grid topology.

Inputs

EntryWhat it does
GridThe input grid.
Properties—
Data Type
Data Type

The data type to evaluate.

Output

Grid

The generated grid.

Primitives

Add menu - Volume - Primitives

Add menu - Volume - Primitives
Add menu - Volume - Primitives

Here you find nodes to modify the volume.

Volume Cube

Volume Cube

The Volume Cube node generates a voxel based volume cube primitive that can be used for volume conversion to mesh in conjunction with the Volume to Mesh node.

Inputs

EntryWhat it does
GeometryStandard geometry input.
DensityVolume density per voxel. Higher values makes it more dense.
BackgroundValue per voxel outside the cube domain.
Min:Minimum boundary of the volume cube. Max: Maximum boundary of the volume cube. Resolution X Number of volume voxules in the X axis. Resolution Y Number of volume voxules in the Y axis. Resolution Z Number of volume voxules in the Z axis.