Fluid Variable

Introduction

TBA

Property Grid

General

Template

Definition

Custom

Time Average Uniform

Time Average Exp

Data Type

Definition

Scalar

Vector

Calc Type

Definition

Cell

Particles

Compute for Output Only

Definition

On

Off

Initial Scalar

Calculation

Custom Variable UDF

depends on UDF expression | This UDF defines the custom property to be calculated in each voxel. One output must be defined within the UDF: a floating-point variable named {cv}, where {cv} is the dynamic name of the custom fluid variable. This variable can be used in other local UDFs. This is a voxel-based local UDF, calculated on a voxel-by-voxel basis using the local UDF properties.

Download Sample File: Custom Fluid Variable

Display Name, Unit

Display Name Override

Display Unit Override


Legacy Text:

These objects contain a UDF that evaluates over the entire fluid domain. They are used to create custom fields based on common input variables.

Date Type
  • Scalar: each cell value contains a single floating point value

  • Vector: each cell value contains a 3 component vector

Calc Type
  • Cell: UDF takes as input only the cell variables

  • Particle Set: Choose a particle set and apply a reduction on the particle values to create a single cell value. Each cell performs this reduction on particles within the cell

Particle Set

Choose the particle set to perform reductions on

Reduction Type

Apply reduction calculation on particles (Min/Max/Sum/Mean)

Compute For output only

Enable to only evaluate this for output purposes

Initial Scalar

Initial value at t=0

Code

UDF evaluated at all cell locations