Skip to content

Game.Simulation.Flow.FluidFlowSolverState

Assembly: Assembly-CSharp.dll
Namespace: Game.Simulation.Flow

Type: struct

Base: System.ValueType

Summary:
Lightweight value type used to track the state of the fluid flow solver. Contains a completion flag and a version counter used by the solver to track progression or changes between solver steps.


Fields

  • public bool m_Complete
    Indicates whether the solver has completed its current work/pass. Typical usage is to check this flag to determine if further processing is required for the current simulation step.

  • public int m_CurrentVersion
    Integer version/token for the solver's current iteration or configuration. Can be used to detect when the solver state has been updated (e.g., to avoid reprocessing samples or to coordinate between systems that drive the solver).

Properties

  • None. This struct exposes its data as public fields rather than properties.

Constructors

  • public FluidFlowSolverState()
    Default parameterless constructor provided by the runtime for structs. Fields default to m_Complete = false and m_CurrentVersion = 0. You can also initialize fields explicitly after construction.

Methods

  • None. This type is a plain data container without behavior.

Usage Example

// Initialize default state
var solverState = new Game.Simulation.Flow.FluidFlowSolverState();

// Mark the solver as started for a given version
solverState.m_CurrentVersion = 42;
solverState.m_Complete = false;

// Later, when the solver finishes its pass
solverState.m_Complete = true;

// Example check in a simulation loop
if (!solverState.m_Complete || solverState.m_CurrentVersion != expectedVersion)
{
    // run or re-run fluid flow solver
}