Dye Regions

Used for fluid motion tracking.

In a simulation, dye regions can be defined with the same or different colors. As a fluid particle (without respect to its phase definition/density) passes through a dye region it is assigned that regions defined color (integer, scalar property which is then output in the particle data). The use of dye regions eliminates the need of using multiple FLUID phase definitions to track the fluid flow from a specific location.
  • Dye regions can only be spherical in shape.
  • If a particle passes through multiple dye regions, it will adopt the color of the last dye region through which it passed.


        dyeregion_clr           1                           
        dyeregion_cntr          "0.0 0.1 0.2"               
        dyeregion_rad           0.1                         
        dyeregion_radodx        2.5                         
        dyeregion_tstart        0.0                         
        dyeregion_tend          1.0                         


Command Contents SI Unit Example
dyeregion_clr Color assigned to the dye region.  
dyeregion_cntr Center coordinates of the dye region sphere.  
dyeregion_rad Radius of the dye region sphere. [m]
dyeregion_radodx Radius of the dye region sphere as a function of dx, for example, when specified 3.0, implies 3.0*dx.
Note: If both dyeregion_rad and dyeregion_radodx are present, the latter takes precedence.
dyeregion_tstart Start time of dye injection.  
dyeregion_tend End time of dye injection.