Skip to content

Commit

Permalink
Merge pull request #2520 from ornladios/NAThompson-patch-1
Browse files Browse the repository at this point in the history
Returned Engines are not passed by reference.
  • Loading branch information
NAThompson authored Dec 23, 2020
2 parents 0555d8b + c818fb3 commit 951afa1
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions docs/user_guide/source/components/io.rst
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

0 comments on commit 951afa1

Please sign in to comment.