sim::EvaluateAtTime

Returns the geometry from a simulation at a specified time.

On this page	Inputs Outputs
Since	20.0

Performs any necessary simulation timesteps if the engine does not already have cached simulation data for the requested time.

Similar to a DOP network, if the simulation parameters are changed, this marks the simulation as out of date and resimulates the current frame. Returning to the first simulation frame (a simtime of 0) also causes resimulation if the parameters were modified.

Inputs ¶


                engine:
                    SimEngine

The simulation engine.


                simtime:
                    Float

The simulation time at which to evaluate the output geometry. Note that this is not a global time and is relative to the simulation’s start time.


                forceresetsim:
                    Bool

If set to True, forces the simulation to be reset. This causes all timesteps from the start time to the simtime to be solved.


                autoresimframe:
                    Bool

If set to True, resimulates the specified simulation frame if it has not been resimulated since the last parameter change (also clears any subsequently cached frames). This allows you to quickly preview the behavior of a parameter change on earlier frames without resetting the entire simulation, done by simply rewinding to an earlier frame and playing forward. For expensive simulations, however, this additional resimulation may be undesirable.

If set to False, parameter changes only resimulate the current frame, so any earlier frames will return their original cached results.


                disableresimframe:
                    Bool

If set to True, parameter changes do not cause any cached frames to be resimulated. Only future frames are simulated with the new parameters. This can be used for “timeless” simulations where the internal simulation time is always advancing and previously cached frames do not need to be resimulated.

If set to False, parameter changes can resimulate cached frames based on autoresimframe.


                parms:
                    Dict

A dictionary containing custom parameters for the engine’s presimulation step graph. Changes to this input mark the simulation as out of date.


                datapath:
                    String

The name of the geometry subdata to evaluate. This may contain slashes to refer to nested subdata.

Outputs ¶


                geo:
                    Geometry

The geometry from the datapath. This is empty if the subdata is not a geometry type.

Inputs ¶

Outputs ¶

APEX nodes