- file_namename of the file in which the time sequence is read
C++ Type:FileName
Unit:(no unit assumed)
Controllable:No
Description:name of the file in which the time sequence is read
CSVTimeSequenceStepper
This time stepper derives from TimeSequenceStepperBase and provides the sequence of time values from a CSV file or similarly delimited text file. A DelimitedFileReader is used to read the CSV file.
The file is always read in columns. The column can either be accessed by name (using the "column_name" parameter, provided that the CSV file has a header containing the names of the different columns) or by index (using the "column_index" parameter, with 0 the index of the first column).
See Failed solves for information on the behavior of this time stepper for failed time steps.
Input Parameters
- column_indexindex of the column which contains the time sequence
C++ Type:unsigned int
Unit:(no unit assumed)
Controllable:No
Description:index of the column which contains the time sequence
- column_nametimename of the column which contains the time sequence
Default:time
C++ Type:std::string
Unit:(no unit assumed)
Controllable:No
Description:name of the column which contains the time sequence
- cutback_factor_at_failure0.5Factor to apply to timestep if a time step fails to converge.
Default:0.5
C++ Type:double
Unit:(no unit assumed)
Controllable:No
Description:Factor to apply to timestep if a time step fails to converge.
- delimiter,delimiter used to parse the file
Default:,
C++ Type:std::string
Unit:(no unit assumed)
Controllable:No
Description:delimiter used to parse the file
- headerFalseindicates whether the file contains a header with the column names
Default:False
C++ Type:bool
Unit:(no unit assumed)
Controllable:No
Description:indicates whether the file contains a header with the column names
- reset_dtFalseUse when restarting a calculation to force a change in dt.
Default:False
C++ Type:bool
Unit:(no unit assumed)
Controllable:No
Description:Use when restarting a calculation to force a change in dt.
- use_last_dt_after_last_tFalseIf true, uses the final time step size for times after the last time in the sequence, instead of taking a single step directly to the simulation end time
Default:False
C++ Type:bool
Unit:(no unit assumed)
Controllable:No
Description:If true, uses the final time step size for times after the last time in the sequence, instead of taking a single step directly to the simulation end time
Optional Parameters
- control_tagsAdds user-defined labels for accessing object parameters via control logic.
C++ Type:std::vector<std::string>
Unit:(no unit assumed)
Controllable:No
Description:Adds user-defined labels for accessing object parameters via control logic.
- enableTruewhether or not to enable the time stepper
Default:True
C++ Type:bool
Unit:(no unit assumed)
Controllable:Yes
Description:whether or not to enable the time stepper