Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Returned Engines are not passed by reference. #2520

Merged
merged 1 commit into from
Dec 23, 2020
Merged

Returned Engines are not passed by reference. #2520

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions docs/user_guide/source/components/io.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -203,24 +203,24 @@ The available modes are ``adios2::Mode::Read``, ``adios2::Mode::Write``, ``adios

/** Signatures */
/** Provide a new MPI communicator other than from ADIOS->IO->Engine */
adios2::Engine &adios2::IO::Open( const std::string &name,
const adios2::Mode mode,
MPI_Comm mpiComm );
adios2::Engine adios2::IO::Open(const std::string &name,
const adios2::Mode mode,
MPI_Comm mpiComm );

/** Reuse the MPI communicator from ADIOS->IO->Engine \n or non-MPI serial mode */
adios2::Engine &adios2::IO::Open(const std::string &name,
const adios2::Mode mode);
adios2::Engine adios2::IO::Open(const std::string &name,
const adios2::Mode mode);


/** Examples */

/** Engine derived class, spawned to start Write operations */
adios2::Engine& bpWriter = io.Open("myVector.bp", adios2::Mode::Write);
adios2::Engine bpWriter = io.Open("myVector.bp", adios2::Mode::Write);

/** Engine derived class, spawned to start Read operations on rank 0 */
if( rank == 0 )
{
adios2::Engine& bpReader = io.Open("myVector.bp",
adios2::Engine bpReader = io.Open("myVector.bp",
adios2::Mode::Read,
MPI_COMM_SELF);
}
Expand Down