Skip to content

Commit

Permalink
Add documentation for readXML of MPICheckpointWriter
Browse files Browse the repository at this point in the history
Signed-off-by: Christoph Niethammer <[email protected]>
  • Loading branch information
cniethammer committed Dec 23, 2024
1 parent aef0537 commit a1d1b34
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions src/io/MPICheckpointWriter.h
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,20 @@ class MPICheckpointWriter : public PluginBase {
, std::string datarep=std::string(""));
//~MPICheckpointWriter() {};

/** @brief Read in XML configuration for MPICheckpointWriter and all its included objects.
*
* The following xml object structure is handled by this method:
* \code{.xml}
<outputplugin name="MPICheckpointWriter">
<writefrequency>INTEGER</writefrequency> <!-- Frequency in which the output is written; Default: 1 -->
<outputprefix>STRING</outputprefix> <!-- Prefix of the output file; Default: "mardyn" -->
<incremental>BOOL</incremental> <!-- Checkpoint files will get individual numbers; Default: false -->
<appendTimestamp>BOOL</appendTimestamp> <!-- Append timestamp to checkpoint files; Default: false -->
<datarep>STRING</datarep> <!-- MPI I/O output representation to use, valid values are "native", "internal", "external32"; Default: "" -->
<mpi_info><!-- see MPI_Info_object class documentation --></mpi_info> <!-- MPI infos to be used for MPI file I/O writing the checkpoint files -->
</outputplugin>
\endcode
*/
void readXML(XMLfileUnits& xmlconfig);

void init(ParticleContainer *particleContainer,
Expand Down

0 comments on commit a1d1b34

Please sign in to comment.