amrex/doxygen/AMReX__AsyncOut_8H_source.html

#ifndef AMREX_ASYNCOUT_H_

#define AMREX_ASYNCOUT_H_

#include <AMReX_Config.H>


#include <functional>


namespace amrex::AsyncOut {


struct WriteInfo {

    int ifile;

    int ispot;

    int nspots;

};


void Initialize ();

void Finalize ();


bool UseAsyncOut ();


WriteInfo GetWriteInfo (int rank);


void Submit (std::function<void()>&& a_f);

void Submit (std::function<void()> const& a_f);


void Finish ();


void Wait ();

void Notify ();


}


#endif

amrex::AsyncOut::Finalize
void Finalize()
Tear down resources owned by the asynchronous output subsystem.
Definition AMReX_AsyncOut.cpp:58

amrex::AsyncOut::GetWriteInfo
WriteInfo GetWriteInfo(int rank)
Compute this rank's write slot information for multi-file output.
Definition AMReX_AsyncOut.cpp:72

amrex::AsyncOut::Wait
void Wait()
Called inside a submitted user job function to wait for this rank's turn to access the file.
Definition AMReX_AsyncOut.cpp:112

amrex::AsyncOut::Notify
void Notify()
Called inside a submitted user job function to notify the next rank sharing the file that it may proc...
Definition AMReX_AsyncOut.cpp:127

amrex::AsyncOut::Submit
void Submit(std::function< void()> &&a_f)
Submit a job functor to the asynchronous writer thread.
Definition AMReX_AsyncOut.cpp:95

amrex::AsyncOut::Initialize
void Initialize()
Initialize the asynchronous output infrastructure.
Definition AMReX_AsyncOut.cpp:23

amrex::AsyncOut::UseAsyncOut
bool UseAsyncOut()
Query whether asynchronous output is enabled at runtime.
Definition AMReX_AsyncOut.cpp:70

amrex::AsyncOut::Finish
void Finish()
Block until all submitted asynchronous jobs have completed.
Definition AMReX_AsyncOut.cpp:105

amrex::AsyncOut
Definition AMReX_AsyncOut.cpp:9

amrex::AsyncOut::WriteInfo
Slot assignment metadata for ranks sharing an output file.
Definition AMReX_AsyncOut.H:19

amrex::AsyncOut::WriteInfo::nspots
int nspots
Definition AMReX_AsyncOut.H:22

amrex::AsyncOut::WriteInfo::ifile
int ifile
Definition AMReX_AsyncOut.H:20

amrex::AsyncOut::WriteInfo::ispot
int ispot
Definition AMReX_AsyncOut.H:21