View source for Nvidia Flow Emitter COMP

{{Summary
	|opFamily=COMP
	|opType=flowEmitterCOMP
	|opLabel=Nvidia Flow Emitter
	|opClass=flowEmitterCOMP_Class
	|opFilter=False
	|opLicense=Non-Commercial
	|short=The Nvidia Flow COMP is the fuel emitter for the Flow simulation and can be placed anywhere in the 3D scene. This operator only works with '''Nvidia GPUs'''.
	|long=NVIDIA Flow is a volumetric fluid based simulation of a burning gas system. The user controls the 3 main factors of temperature, fuel, and smoke to create fire and smoke simulations. 

The Nvidia Flow COMP is the fuel emitter for the Flow simulation and can be placed anywhere in the 3D scene. This operator only works with '''Nvidia GPUs'''. 

See also [[Nvidia Flow TOP]], [[Nvidia Flow]].}}
{{ParameterPage
	|opFamily=COMP
	|pageName=Emitter
	|pageSummary=
	|items={{Parameter
	|opFamily=COMP
	|opType=flowEmitterCOMP
	|parLabel=Active
	|parName=active
	|parType=toggle
	|parReadOnly=False
	|parOrder=0
	|parSummary=Turns the emitter On or Off.
	|parItems=}}
{{Parameter
	|opFamily=COMP
	|opType=flowEmitterCOMP
	|parLabel=Mode
	|parName=mode
	|parType=dropmenu
	|parReadOnly=False
	|parOrder=1
	|parSummary=Select Emitter or Collider mode.
	|parItems={{ParameterItem
	|opFamily=COMP
	|parName=mode
	|itemLabel=Emitter
	|itemName=emitter
	|itemSummary=Emitter will act as a fuel emitter for the system injecting a specific amount of fluw into the simulation each step.
    }}<!--
-->{{ParameterItem
	|opFamily=COMP
	|parName=mode
	|itemLabel=Collider
	|itemName=collider
	|itemSummary=Collider will act as a rigid object which the combustion simulation will collide with.
    }}
}}
{{Parameter
	|opFamily=COMP
	|opType=flowEmitterCOMP
	|parLabel=Type
	|parName=type
	|parType=dropmenu
	|parReadOnly=False
	|parOrder=2
	|parSummary=Select the shape type used for the emitter.
	|parItems={{ParameterItem
	|opFamily=COMP
	|parName=type
	|itemLabel=Sphere
	|itemName=sphere
	|itemSummary=Creates a sphere emitter, dimensions controlled by the Radius parameter below.
    }}<!--
-->{{ParameterItem
	|opFamily=COMP
	|parName=type
	|itemLabel=Box
	|itemName=box
	|itemSummary=Creates a box emitter, dimensions controlled by the Size parameter below.
    }}<!--
-->{{ParameterItem
	|opFamily=COMP
	|parName=type
	|itemLabel=Capsule
	|itemName=capsule
	|itemSummary=Create a capsule emitter, like a tube with cap ends. The dimensions are controlled by the Radius and Length parameters below.
    }}<!--
-->{{ParameterItem
	|opFamily=COMP
	|parName=type
	|itemLabel=Shape TOP
	|itemName=shapeop
	|itemSummary=Uses the TOP specified in the Shape TOP parameter below to create an emitter in the shape of the image. 
    }}<!--
-->{{ParameterItem
	|opFamily=COMP
	|parName=type
	|itemLabel=Shape SOP
	|itemName=sop
	|itemSummary=Uses the SOP specified in the Shape OP parameter below to create an emitter withg the shape of the SOP's geometry.
    }}
}}
{{Parameter
	|opFamily=COMP
	|opType=flowEmitterCOMP
	|parLabel=Size
	|parName=size
	|parType=float
	|parReadOnly=False
	|parOrder=3
	|parSummary=Controls the dimensions of the emitter when using Box or Shape TOP types.
	|parItems={{ParameterItem
	|opFamily=COMP
	|parName=size
	|itemLabel=X
	|itemName=sizex
	|itemSummary=Scale in x.
    }}<!--
-->{{ParameterItem
	|opFamily=COMP
	|parName=size
	|itemLabel=Y
	|itemName=sizey
	|itemSummary=Scale in y.}}<!--
-->{{ParameterItem
	|opFamily=COMP
	|parName=size
	|itemLabel=Z
	|itemName=sizez
	|itemSummary=Scale in z.}}
}}
{{Parameter
	|opFamily=COMP
	|opType=flowEmitterCOMP
	|parLabel=Radius
	|parName=radius
	|parType=float
	|parReadOnly=False
	|parOrder=4
	|parSummary=Controls the radius of the emitter when using the Sphere or Capsule types.
	|parItems=}}
{{Parameter
	|opFamily=COMP
	|opType=flowEmitterCOMP
	|parLabel=Length
	|parName=length
	|parType=float
	|parReadOnly=False
	|parOrder=5
	|parSummary=Control the length of the emitter when using the Capsule type.
	|parItems=}}
{{Parameter
	|opFamily=COMP
	|opType=flowEmitterCOMP
	|parLabel=Shape TOP
	|parName=shapeop
	|parType=string
	|parReadOnly=False
	|parOrder=6
	|parSummary=Specify the TOP or SOP to use as an emitter when Type parameter is set to Shape TOP / Shape SOP respectively.
	|parItems=}}
{{Parameter
	|opFamily=COMP
	|opType=flowEmitterCOMP
	|parLabel=Shape Channel
	|parName=shapechannel
	|parType=dropmenu
	|parReadOnly=False
	|parOrder=6
	|parSummary=Allows use of different channels to determine the shape of the emitter created when using Shape TOP.
	|parItems=}}
{{Parameter
	|opFamily=COMP
	|opType=flowEmitterCOMP
	|parLabel=Shape Threshold
	|parName=shapethreshold
	|parType=float
	|parReadOnly=False
	|parOrder=6
	|parSummary=Pixels greater than or equal to the threshold value are used for emission, pixels below the threshold value are ignored.
	|parItems=}}
{{Parameter
	|opFamily=COMP
	|opType=flowEmitterCOMP
	|parLabel=Center of Mass
	|parName=centerofmass
	|parType=float
	|parReadOnly=False
	|parOrder=7
	|parSummary=Specifies the center of mass of the emitter.
	|parItems={{ParameterItem
	|opFamily=COMP
	|parName=centerofmass
	|itemLabel=X
	|itemName=centerofmassx
	|itemSummary=}}<!--
-->{{ParameterItem
	|opFamily=COMP
	|parName=centerofmass
	|itemLabel=Y
	|itemName=centerofmassy
	|itemSummary=}}<!--
-->{{ParameterItem
	|opFamily=COMP
	|parName=centerofmass
	|itemLabel=Z
	|itemName=centerofmassz
	|itemSummary=}}
}}
{{Parameter
	|opFamily=COMP
	|opType=flowEmitterCOMP
	|parLabel=Inner Width
	|parName=innerwidth
	|parType=float
	|parReadOnly=False
	|parOrder=8
	|parSummary=The shape of the emitter sets the surface shape, and the Inner Width adds to the emitter by filling in the shape from the surface inwards. The default setting of 1.0 effectively fills in the shape like a solid.
	|parItems=}}
{{Parameter
	|opFamily=COMP
	|opType=flowEmitterCOMP
	|parLabel=Outer Width
	|parName=outerwidth
	|parType=float
	|parReadOnly=False
	|parOrder=9
	|parSummary=The shape of the emitter set the surface shape, and the Outer Width adds to the emitter by extending the shape outwards from the surface.
	|parItems=}}
    
[[image:ShapeWidths.png|700px]]    

'''Figure1''': Left-side Inner Width = 1.0, Center uses narrow width for both, Right-side Outer Width = 1.0
    
{{Parameter
	|opFamily=COMP
	|opType=flowEmitterCOMP
	|parLabel=Linear Velocity
	|parName=linearvel
	|parType=float
	|parReadOnly=False
	|parOrder=10
	|parSummary=Target linear velocity of the fuel added to the system.
	|parItems={{ParameterItem
	|opFamily=COMP
	|parName=linearvel
	|itemLabel=X
	|itemName=linearvelx
	|itemSummary=Linear velocity in x.}}<!--
-->{{ParameterItem
	|opFamily=COMP
	|parName=linearvel
	|itemLabel=Y
	|itemName=linearvely
	|itemSummary=Linear velocity in y.}}<!--
-->{{ParameterItem
	|opFamily=COMP
	|parName=linearvel
	|itemLabel=Z
	|itemName=linearvelz
	|itemSummary=Linear velocity in z.}}
}}
{{Parameter
	|opFamily=COMP
	|opType=flowEmitterCOMP
	|parLabel=Angular Velocity
	|parName=angularvel
	|parType=float
	|parReadOnly=False
	|parOrder=11
	|parSummary=Target angular velocity of the fuel added to the system. Think of this as 'rotational velocity.
	|parItems={{ParameterItem
	|opFamily=COMP
	|parName=angularvel
	|itemLabel=X
	|itemName=angularvelx
	|itemSummary=Angular velocity in x.}}<!--
-->{{ParameterItem
	|opFamily=COMP
	|parName=angularvel
	|itemLabel=Y
	|itemName=angularvely
	|itemSummary=Angular velocity in y.}}<!--
-->{{ParameterItem
	|opFamily=COMP
	|parName=angularvel
	|itemLabel=Z
	|itemName=angularvelz
	|itemSummary=Angular velocity in z.}}
}}
{{Parameter
	|opFamily=COMP
	|opType=flowEmitterCOMP
	|parLabel=Velocity Correction Rate
	|parName=velcorrate
	|parType=float
	|parReadOnly=False
	|parOrder=12
	|parSummary=Rate at which the the system gets to the target velocity. Each simulation block has its own velocity level, the emitter tries to change any blocks it overlaps with to match its emitter value. The correction rate is how strongly it tries to change the value to this target value, for example if 0 the emiitter won't do anything, when a small value like 0-1 the emitter will gently influence the simulation, when a high value like 10-100 it will force the value.
	|parItems={{ParameterItem
	|opFamily=COMP
	|parName=velcorrate
	|itemLabel=X
	|itemName=velcorratex
	|itemSummary=}}<!--
-->{{ParameterItem
	|opFamily=COMP
	|parName=velcorrate
	|itemLabel=Y
	|itemName=velcorratey
	|itemSummary=}}<!--
-->{{ParameterItem
	|opFamily=COMP
	|parName=velcorrate
	|itemLabel=Z
	|itemName=velcorratez
	|itemSummary=}}
}}
{{Parameter
	|opFamily=COMP
	|opType=flowEmitterCOMP
	|parLabel=Smoke
	|parName=smoke
	|parType=float
	|parReadOnly=False
	|parOrder=13
	|parSummary=Amount of smoke produced per unit of fuel in the system. 
	|parItems=}}
{{Parameter
	|opFamily=COMP
	|opType=flowEmitterCOMP
	|parLabel=Smoke Correction Rate
	|parName=smokecorrate
	|parType=float
	|parReadOnly=False
	|parOrder=14
	|parSummary=Rate at which the the system gets to the target smoke level. Each simulation block has its own smoke level, the emitter tries to change any blocks it overlaps with to match its emitter value. The correction rate is how strongly it tries to change the value to this target value, for example if 0 the emiitter won't do anything, when a small value like 0-1 the emitter will gently influence the simulation, when a high value like 10-100 it will force the value.
	|parItems=}}
{{Parameter
	|opFamily=COMP
	|opType=flowEmitterCOMP
	|parLabel=Temp
	|parName=temp
	|parType=float
	|parReadOnly=False
	|parOrder=15
	|parSummary=Temperature of the system. Note a temperature value of 0 will not ignite the simlulation, a minimum temperature is required for the simulation to burn.
	|parItems=}}
{{Parameter
	|opFamily=COMP
	|opType=flowEmitterCOMP
	|parLabel=Temp Correction Rate
	|parName=tempcorrate
	|parType=float
	|parReadOnly=False
	|parOrder=16
	|parSummary=Rate at which the the system gets to the target temperature level. Each simulation block has its own temperature level, the emitter tries to change any blocks it overlaps with to match its emitter value. The correction rate is how strongly it tries to change the value to this target value, for example if 0 the emiitter won't do anything, when a small value like 0-1 the emitter will gently influence the simulation, when a high value like 10-100 it will force the value.
	|parItems=}}
{{Parameter
	|opFamily=COMP
	|opType=flowEmitterCOMP
	|parLabel=Fuel
	|parName=fuel
	|parType=float
	|parReadOnly=False
	|parOrder=17
	|parSummary=Amount of fuel added to the system per simulation step. The fuel is treated as gaseous and is converted into temperature (and a certain density) when combustion is taking place.
	|parItems=}}
{{Parameter
	|opFamily=COMP
	|opType=flowEmitterCOMP
	|parLabel=Fuel Correction Rate
	|parName=fuelcorrate
	|parType=float
	|parReadOnly=False
	|parOrder=18
	|parSummary=Rate at which the the system gets to the target fuel level. Each simulation block has its own fuel level, the emitter tries to change any blocks it overlaps with to match its emitter value. The correction rate is how strongly it tries to change the value to this target value, for example if 0 the emiitter won't do anything, when a small value like 0-1 the emitter will gently influence the simulation, when a high value like 10-100 it will force the value.
	|parItems=}}
{{Parameter
	|opFamily=COMP
	|opType=flowEmitterCOMP
	|parLabel=Fuel Release Temp
	|parName=fuelreleasetemp
	|parType=float
	|parReadOnly=False
	|parOrder=19
	|parSummary=THe temperature required in the system to trigger addition Fuel Release set in the parameter below.
	|parItems=}}
{{Parameter
	|opFamily=COMP
	|opType=flowEmitterCOMP
	|parLabel=Fuel Release
	|parName=fuelrelease
	|parType=float
	|parReadOnly=False
	|parOrder=20
	|parSummary=An additional amount of fuel is released into the system when the Fuel Release Temperature threshold set above is met. TIP: This can help simulate solid fuels where heat must be applied for a gaseous fuel to be released.
	|parItems=}}
{{Parameter
	|opFamily=COMP
	|opType=flowEmitterCOMP
	|parLabel=Alloc Scale
	|parName=allocscale
	|parType=float
	|parReadOnly=False
	|parOrder=21
	|parSummary=The emitter allocates 'blocks' to contain the simulation. This parameter controls this where 0.0 turns off emitter allocation, 1.0 is default, and values greater than 1.0 can help pre-allocate which can be useful when the direction of the simulation is difficult to predict.

The effect of this parameter can be visualized by turning 'Show Blocks' parameter On in the [[Nvidia Flow TOP]].
	|parItems=}}
{{Parameter
	|opFamily=COMP
	|opType=flowEmitterCOMP
	|parLabel=Alloc Predict
	|parName=allocpredict
	|parType=float
	|parReadOnly=False
	|parOrder=22
	|parSummary=Controls the emitter's direction block allocation prediction, used for pre-allocation of blocks for fast emitters.
    
The effect of this parameter can be visualized by turning 'Show Blocks' parameter On in the [[Nvidia Flow TOP]].
	|parItems=}}
}}
{{ParameterPage
	|opFamily=COMP
	|pageName=Material
	|pageSummary=
	|items={{Parameter
	|opFamily=COMP
	|opType=flowEmitterCOMP
	|parLabel=Color
	|parName=color
	|parType=rgb
	|parReadOnly=False
	|parOrder=0
	|parSummary=The base color of the combustion.
	|parItems={{ParameterItem
	|opFamily=COMP
	|parName=color
	|itemLabel=Red
	|itemName=colorr
	|itemSummary=}}<!--
-->{{ParameterItem
	|opFamily=COMP
	|parName=color
	|itemLabel=Green
	|itemName=colorg
	|itemSummary=}}<!--
-->{{ParameterItem
	|opFamily=COMP
	|parName=color
	|itemLabel=Blue
	|itemName=colorb
	|itemSummary=}}<!--
-->{{ParameterItem
	|opFamily=COMP
	|parName=color
	|itemLabel=Alpha
	|itemName=colora
	|itemSummary=}}
}}
{{Parameter
	|opFamily=COMP
	|opType=flowEmitterCOMP
	|parLabel=Color Ramp
	|parName=colorramp
	|parType=chopref
	|parReadOnly=False
	|parOrder=1
	|parSummary=This color ramp will be multiplied with the Color Parameter above. The left-side of the color ramp is used for the cooler temperatures in the system ie. further away from center of combustion and where it turns to smoke. The right-side of the ramp colors the higher temperatures.
	|parItems=}}
{{Parameter
	|opFamily=COMP
	|opType=flowEmitterCOMP
	|parLabel=Alpha Scale
	|parName=alphascale
	|parType=float
	|parReadOnly=False
	|parOrder=2
	|parSummary=Alpha calculations (determined by Alpha Bias and Alpha Masks below) are multiplied by this value for a final Alpha value.
	|parItems=}}
{{Parameter
	|opFamily=COMP
	|opType=flowEmitterCOMP
	|parLabel=Alpha Bias
	|parName=alphabias
	|parType=float
	|parReadOnly=False
	|parOrder=3
	|parSummary=This value is added to alpha before final alpha values are calculated using the Alpha Mask parameters below.
	|parItems=}}
{{Parameter
	|opFamily=COMP
	|opType=flowEmitterCOMP
	|parLabel=Intensity Bias
	|parName=intensitybias
	|parType=float
	|parReadOnly=False
	|parOrder=4
	|parSummary=A mulitplier for the color contribution. Useful to use with the Additive Factor parameter below.
	|parItems=}}
{{Parameter
	|opFamily=COMP
	|opType=flowEmitterCOMP
	|parLabel=Additive Factor
	|parName=additivefactor
	|parType=float
	|parReadOnly=False
	|parOrder=5
	|parSummary=Controls an additive effect in the rendering ie. transparency is added together giving hotspots and brighter color where there is more gas burning.
	|parItems=}}
    
Flow simulation color has 3 independant parts: color, alpha, and intensity which are based on the burn, smoke, temperature and fuel levels. The masks below control how much each value influences the color.

The final color value is calculated using ((Burn * Burn Mask) + (Smoke * Smoke Mask) + (Temp * Temp Mask) + (Fuel * Fuel Mask)) 
Intensity brightens the respective Color and Alpha like a multiplier.

{{Parameter
	|opFamily=COMP
	|opType=flowEmitterCOMP
	|parLabel=Burn Color Mask
	|parName=burncolormask
	|parType=float
	|parReadOnly=False
	|parOrder=6
	|parSummary=Controls the color contribution of the ignition point of the fuel in the system. The value determines which position in the Color Ramp to use for Burn color.
	|parItems=}}
{{Parameter
	|opFamily=COMP
	|opType=flowEmitterCOMP
	|parLabel=Smoke Color Mask
	|parName=smokecolormask
	|parType=float
	|parReadOnly=False
	|parOrder=7
	|parSummary=Controls the color contribution of the smoke in the system. The value determines which position in the Color Ramp to use for Smoke color.
	|parItems=}}
{{Parameter
	|opFamily=COMP
	|opType=flowEmitterCOMP
	|parLabel=Temp Color Mask
	|parName=tempcolormask
	|parType=float
	|parReadOnly=False
	|parOrder=8
	|parSummary=Controls the color contribution of the temperature in the system. Note: Fuel is converted to Temperature when combustion is active. The value determines which position in the Color Ramp to use for Temp color.
	|parItems=}}
{{Parameter
	|opFamily=COMP
	|opType=flowEmitterCOMP
	|parLabel=Fuel Color Mask
	|parName=fuelcolormask
	|parType=float
	|parReadOnly=False
	|parOrder=9
	|parSummary=Controls the color contribution of the fuel in the system before it is burned. The value determines which position in the Color Ramp to use for Fuel color.
	|parItems=}}
{{Parameter
	|opFamily=COMP
	|opType=flowEmitterCOMP
	|parLabel=Burn Alpha Mask
	|parName=burnalphamask
	|parType=float
	|parReadOnly=False
	|parOrder=10
	|parSummary=Controls the transparency of the Burn Color above. 
	|parItems=}}
{{Parameter
	|opFamily=COMP
	|opType=flowEmitterCOMP
	|parLabel=Smoke Alpha Mask
	|parName=smokealphamask
	|parType=float
	|parReadOnly=False
	|parOrder=11
	|parSummary=Controls the transparency of the Smoke Color above.
	|parItems=}}
{{Parameter
	|opFamily=COMP
	|opType=flowEmitterCOMP
	|parLabel=Temp Alpha Mask
	|parName=tempalphamask
	|parType=float
	|parReadOnly=False
	|parOrder=12
	|parSummary=Controls the transparency of the Temp Color above.
	|parItems=}}
{{Parameter
	|opFamily=COMP
	|opType=flowEmitterCOMP
	|parLabel=Fuel Alpha Mask
	|parName=fuelalphamask
	|parType=float
	|parReadOnly=False
	|parOrder=13
	|parSummary=Controls the transparency of the Fuel Color above.
	|parItems=}}
{{Parameter
	|opFamily=COMP
	|opType=flowEmitterCOMP
	|parLabel=Burn Intensity Mask
	|parName=burnintensitymask
	|parType=float
	|parReadOnly=False
	|parOrder=14
	|parSummary=Controls the intensity of the Burn Color above. This value is a multiplier and accepts values greater than 1.0.
	|parItems=}}
{{Parameter
	|opFamily=COMP
	|opType=flowEmitterCOMP
	|parLabel=Smoke Intensity Mask
	|parName=smokeintensitymask
	|parType=float
	|parReadOnly=False
	|parOrder=15
	|parSummary=Controls the intensity of the Smoke Color above. This value is a multiplier and accepts values greater than 1.0.
	|parItems=}}
{{Parameter
	|opFamily=COMP
	|opType=flowEmitterCOMP
	|parLabel=Temp Intensity Mask
	|parName=tempintensitymask
	|parType=float
	|parReadOnly=False
	|parOrder=16
	|parSummary=Controls the intensity of the Temp Color above. This value is a multiplier and accepts values greater than 1.0.
	|parItems=}}
{{Parameter
	|opFamily=COMP
	|opType=flowEmitterCOMP
	|parLabel=Fuel Intensity Mask
	|parName=fuelintensitymask
	|parType=float
	|parReadOnly=False
	|parOrder=17
	|parSummary=Controls the intensity of the Fuel Color above. This value is a multiplier and accepts values greater than 1.0.
	|parItems=}}
}}
{{:COMP Xform Page}}
{{:COMP Pre-Xform Page}}
{{:COMP Instance Page}}
{{:COMP Instance 2 Page}}
{{:COMP Render Page}}
{{:COMP Extensions Page}}
{{:COMP Generator Common Page}}
{{History}}
{{NavBox
	|Category=COMPs}}
{{#invoke:Category
	|list
	|COMPs}}