Save simulation state and particle coordinates to disk. More...
#include <analysis.h>
Inheritance diagram for Faunus::analysis::SaveState:
Collaboration diagram for Faunus::analysis::SaveState:
Public Member Functions | |
| SaveState (json j, const Space &spc) | |
| void | setWriteFunction (const Space &spc) |
 Public Member Functions inherited from Faunus::analysis::Analysis | |
| void | to_json (json &j) const |
| JSON report w. statistics, output etc. | |
| void | from_json (const json &j) |
| configure from json object | |
| void | to_disk () |
| Save data to disk (if defined) More... | |
| void | sample () |
| Increase step count and sample. More... | |
| int | getNumberOfSteps () const |
| Number of steps. | |
| Analysis (const Space &spc, std::string_view name) | |
| Analysis (const Space &spc, std::string_view name, int sample_interval, int number_of_skipped_steps) | |
Additional Inherited Members | |
| Public Attributes inherited from Faunus::analysis::Analysis | |
| const std::string | name |
| descriptive name | |
| std::string | cite |
| url, doi etc. describing the analysis | |
| Protected Attributes inherited from Faunus::analysis::Analysis | |
| const Space & | spc |
| Instance of Space to analyse. | |
| int | sample_interval = 0 |
| Steps in between each sample point (do not modify) | |
| int | number_of_samples = 0 |
| counter for number of samples | |
Detailed Description
Save simulation state and particle coordinates to disk.
Using a variety of formats (pqr, gro, xyz, aam, state) this stores the simulation state to disk. The most complete format is .state which stores information about groups, particle positions, random number state etc.
- if sample interval = -1, analysis is run only once at the simulation end.
- if sample interval >= 0, analysis is performed as every nstep.
- if
use_numbered_files= true (default) files are labelled with the step count
The documentation for this class was generated from the following files:
- src/analysis.h
- src/analysis.cpp
