Shamrock 2025.10.0
Astrophysical Code
Loading...
Searching...
No Matches
Classes | Public Member Functions | List of all members
AsciiSplitDump Class Reference

A class to dump a simulation state into ASCII files. More...

#include <shamrock/include/shamrock/io/AsciiSplitDump.hpp>

Public Member Functions

PatchDump & get_file (u64 id)
 Get a reference to a file.
 
 AsciiSplitDump (std::string fileprefix)
 Constructor.
 
void create_id (u64 id)
 Create a new file for the given patch.
 

Detailed Description

A class to dump a simulation state into ASCII files.

Todo:
add example of usage

Definition at line 32 of file AsciiSplitDump.hpp.

Constructor & Destructor Documentation

◆ AsciiSplitDump()

AsciiSplitDump::AsciiSplitDump ( std::string  fileprefix)
inlineexplicit

Constructor.

Parameters
fileprefixthe file prefix (without the patch id)

Definition at line 129 of file AsciiSplitDump.hpp.

Member Function Documentation

◆ create_id()

void AsciiSplitDump::create_id ( u64  id)
inline

Create a new file for the given patch.

Parameters
idthe patch id

Definition at line 136 of file AsciiSplitDump.hpp.

+ Here is the call graph for this function:

◆ get_file()

PatchDump & AsciiSplitDump::get_file ( u64  id)
inline

Get a reference to a file.

Parameters
idthe patch id
Returns
a reference to the file associated with the patch

Definition at line 122 of file AsciiSplitDump.hpp.

+ Here is the call graph for this function:

The documentation for this class was generated from the following file: