Progress

Simulation progress to output file.

Collaboration diagram for Progress:

Writes the current time progression of fhsim to a file. The time progression is given as percent, rounded to two decimals. The file is rewritten only when that value changes, at most every half second of wall time, and once more at the end with the last value. If the end time is infinity, the output progression will always be zero.

Example configuration excerpt

<Lib
LibName      = "fhsim_base"
SimObject    = "Sink/Progress"
Name         = "p"
/>

Input Ports

This SimObject does not contain any inputs.

Output Ports

This SimObject does not contain any outputs.

Configuration parameters

Name	Width	Description
OutputFile	1	The file where the output will be written. Default: fhsim_progress

Initial conditions

This SimObject does not contain any initial conditions.

Full example file

<Contents>
  <OBJECTS>
    
    <Lib
        LibName="base" 
        SimObject="Sink/Progress"  
        Name="P" 
    />
    
  </OBJECTS>
  
  <INTERCONNECTIONS>
  </INTERCONNECTIONS>
        
  <INITIALIZATION>
  </INITIALIZATION>
 
  <SIMULATION>
    <Timing TStart="0" TEnd="99"/>
    <Integrator Method="RK45_i" NumCores="1" LogStates="1" UseRSSNorm="0">
      <StepControl Step="0.1" StepMax="0.002" StepMin="0.00000001" AbsTol="1e-3" RelTol="1e-3"/>
    </Integrator>
  </SIMULATION>
  <OBSERVERS>
    <FileOutput TOutput="0,100" Select="objects:all"/>
  </OBSERVERS>
</Contents>

This SimObject is referred to as Sink/Progress