|
|
Arcane
4.1.12.0
User documentation
|
|
|
|
Arcane
4.1.12.0
User documentation
|
Class managing a history of values. More...
#include <arcane/core/ITimeHistoryMng.h>
Public Member Functions | |
| virtual | ~ITimeHistoryMng ()=default |
| Frees resources. | |
| virtual void | addValue (const String &name, Real value, bool end_time=true, bool is_local=false)=0 |
| Adds the value value to the history name. | |
| virtual void | addValue (const String &name, Int32 value, bool end_time=true, bool is_local=false)=0 |
| Adds the value value to the history name. | |
| virtual void | addValue (const String &name, Int64 value, bool end_time=true, bool is_local=false)=0 |
| virtual void | addValue (const String &name, RealConstArrayView value, bool end_time=true, bool is_local=false)=0 |
| Adds the value value to the history name. | |
| virtual void | addValue (const String &name, Int32ConstArrayView value, bool end_time=true, bool is_local=false)=0 |
| Adds the value value to the history name. | |
| virtual void | addValue (const String &name, Int64ConstArrayView value, bool end_time=true, bool is_local=false)=0 |
| virtual void | timeHistoryBegin ()=0 |
| virtual void | timeHistoryEnd ()=0 |
| virtual void | timeHistoryInit ()=0 |
| virtual void | timeHistoryStartInit ()=0 |
| virtual void | timeHistoryContinueInit ()=0 |
| virtual void | timeHistoryRestore ()=0 |
| virtual ARCANE_DEPRECATED void | addCurveWriter (ITimeHistoryCurveWriter *writer) |
| Adds a writer. | |
| virtual ARCANE_DEPRECATED void | removeCurveWriter (ITimeHistoryCurveWriter *writer) |
| Removes a writer. | |
| virtual void | addCurveWriter (ITimeHistoryCurveWriter2 *writer)=0 |
| Adds a writer. | |
| virtual void | removeCurveWriter (ITimeHistoryCurveWriter2 *writer)=0 |
| Removes a writer. | |
| virtual void | removeCurveWriter (const String &name)=0 |
| Removes the writer with name name. | |
| virtual void | dumpHistory (bool is_verbose)=0 |
| virtual void | dumpCurves (ITimeHistoryCurveWriter2 *writer)=0 |
| Uses the writer writer to output all curves. | |
| virtual bool | active () const =0 |
| Indicates the activation status. | |
| virtual void | setActive (bool is_active)=0 |
| Sets the activation status. | |
| virtual void | applyTransformation (ITimeHistoryTransformer *v)=0 |
| Applies the transformation v to all curves. | |
| virtual bool | isDumpActive () const =0 |
| Indicates the output activation status. | |
| virtual void | setDumpActive (bool is_active)=0 |
| Sets the output activation status. | |
| virtual bool | isShrinkActive () const =0 |
| Returns a boolean indicating if the history is compressed. | |
| virtual void | setShrinkActive (bool is_active)=0 |
| Sets the boolean indicating if the history is compressed. | |
| virtual ITimeHistoryMngInternal * | _internalApi () |
| Internal Arcane API. | |
Class managing a history of values.
The history manager manages the history of a set of values over time.
The history is based on iterations (VariablesCommon::globalIteration()). For each iteration, it is possible to save a value using the addValue() methods. It is not mandatory to have a value for every iteration. When several addValue() calls are made for the same history at the same iteration, only the last value is taken into account.
Each history is associated with a name, which is the name of the file where the list of values will be saved.
Only the instance associated with the subdomain where parallelMng()->isMasterIO() is true saves the values. For others, calls to addValue() have no effect.
Values are only saved if active() is true. It is possible to change the activation status by calling isActive().
In debug mode, all histories are saved at every time step. In normal execution, this set is saved every n iterations, n being given by the dataset option <module-main/time-history-iteration-step>. In any case, an output is performed at the end of the execution.
The format of these files depends on the implementation.
Definition at line 129 of file ITimeHistoryMng.h.
|
inlinevirtual |
|
pure virtual |
Indicates the activation status.
The addValue() functions are only considered if the instance is active. Otherwise, calls to addValue() are ignored.
|
inlinevirtual |
|
pure virtual |
Adds the value value to the history name.
The value is that at the end time of the iteration if end_time is true, at the beginning otherwise. the boolean is_local indicates whether the curve is specific to the process or not, in order to be able to write curves even by non io_master procs when the ARCANE_ENABLE_NON_IO_MASTER_CURVES variable is set.
|
pure virtual |
Adds the value value to the history name.
The number of elements of value must be constant over time. The value is that at the end time of the iteration if end_time is true, at the beginning otherwise. the boolean is_local indicates whether the curve is specific to the process or not, in order to be able to write curves even by non io_master procs when the ARCANE_ENABLE_NON_IO_MASTER_CURVES variable is set.
|
pure virtual |
Adds the value value to the history name.
The value is that at the end time of the iteration if end_time is true, at the beginning otherwise. the boolean is_local indicates whether the curve is specific to the process or not, in order to be able to write curves even by non io_master procs when the ARCANE_ENABLE_NON_IO_MASTER_CURVES variable is set.
|
pure virtual |
Adds the value value to the history name.
The number of elements of value must be constant over time. The value is that at the end time of the iteration if end_time is true, at the beginning otherwise. the boolean is_local indicates whether the curve is specific to the process or not, in order to be able to write curves even by non io_master procs when the ARCANE_ENABLE_NON_IO_MASTER_CURVES variable is set.
|
pure virtual |
Adds the value value to the history name.
The value is that at the end time of the iteration if end_time is true, at the beginning otherwise. the boolean is_local indicates whether the curve is specific to the process or not, in order to be able to write curves even by non io_master procs when the ARCANE_ENABLE_NON_IO_MASTER_CURVES variable is set.
Referenced by Arcane::ModuleMaster::dumpStandardCurves().
|
pure virtual |
Adds the value value to the history name.
The number of elements of value must be constant over time. The value is that at the end time of the iteration if end_time is true, at the beginning otherwise. the boolean is_local indicates whether the curve is specific to the process or not, in order to be able to write curves even by non io_master procs when the ARCANE_ENABLE_NON_IO_MASTER_CURVES variable is set.
|
pure virtual |
Uses the writer writer to output all curves.
The output path is the current directory.
|
pure virtual |
Indicates the output activation status.
The dumpHistory() function is inactive if isDumpActive() is false.
|
inlinevirtual |
|
pure virtual |
Sets the activation status.
1.16.1