Time


Functions

double TecUtilSolutionTimeGetCurrent (void)
  Returns the current solution time for the current frame.
double TecUtilSolutionTimeGetMin (void)
  Returns the minimum solution time for the current frame.
double TecUtilSolutionTimeGetMax (void)
  Returns the maximum solution time for the current frame.
SetValueReturnCode_e TecUtilSolutionTimeSetCurrent (double NewSolutionTime)
  Sets the current solution time for the current frame.


Function Documentation

double TecUtilSolutionTimeGetCurrent ( void   ) 

Returns the current solution time for the current frame.

This function is Thread Safe.

Since:
12.1.1.8018
Returns:
Current solution time for the current frame.
Precondition:
Must have one or more frames.
Fortran Syntax:
    REAL*8 FUNCTION TecUtilSolutionTimeGetCurrent();

Python Syntax:

  Results = TecUtil.SolutionTimeGetCurrent()

  Output:
    Results[0]    ReturnVal            double

See also:
TecUtilSolutionTimeSetCurrent(), TecUtilSolutionTimeGetMin(), TecUtilSolutionTimeGetMax(), and TecUtilZoneGetSolutionTime().

double TecUtilSolutionTimeGetMax ( void   ) 

Returns the maximum solution time for the current frame.

This function is Thread Safe.

Returns:
Maximum solution time for the current frame.
Precondition:
Must have one or more frames.
Fortran Syntax:
    REAL*8 FUNCTION TecUtilSolutionTimeGetMax();

Python Syntax:

  Results = TecUtil.SolutionTimeGetMax()

  Output:
    Results[0]    ReturnVal            double

See also:
TecUtilSolutionTimeSetCurrent(), TecUtilSolutionTimeGetCurrent(), TecUtilSolutionTimeGetMin(), and TecUtilZoneGetSolutionTime().

double TecUtilSolutionTimeGetMin ( void   ) 

Returns the minimum solution time for the current frame.

This function is Thread Safe.

Since:
12.1.1.8018
Returns:
Minimum solution time for the current frame.
Precondition:
Must have one or more frames.
Fortran Syntax:
    REAL*8 FUNCTION TecUtilSolutionTimeGetMin();

Python Syntax:

  Results = TecUtil.SolutionTimeGetMin()

  Output:
    Results[0]    ReturnVal            double

See also:
TecUtilSolutionTimeSetCurrent(), TecUtilSolutionTimeGetCurrent(), TecUtilSolutionTimeGetMax(), and TecUtilZoneGetSolutionTime().

SetValueReturnCode_e TecUtilSolutionTimeSetCurrent ( double  NewSolutionTime  ) 

Sets the current solution time for the current frame.

Parameters:
NewSolutionTime Value of the new solution time for the current frame.
Returns:
The setvalue return code (of type SetValueReturnCode_e).
Fortran Syntax:
    INTEGER*4 FUNCTION TecUtilSolutionTimeSetCurrent(NewSolutionTime)
    REAL*8 NewSolutionTime

Python Syntax:

  Results = TecUtil.SolutionTimeSetCurrent(NewSolutionTime)

  Input:
                  NewSolutionTime      double
  Output:
    Results[0]    ReturnVal            SetValueReturnCode_e  (defined in TecVals.py)

See also:
TecUtilSolutionTimeGetCurrent()


Generated on Tue Mar 12 02:24:44 2013 for Tecplot by  doxygen 1.5.5