PSCF v1.3
Util::MpiFileIo Class Reference

Identifies whether this processor may do file I/O. More...

#include <MpiFileIo.h>

Inheritance diagram for Util::MpiFileIo:
Util::ParamComponent Util::Begin Util::Blank Util::End Util::ParamComposite Util::Parameter Pscf::MixtureTmpl< Polymer, Solvent > Pscf::MixtureTmpl< Polymer< D >, Solvent< D > > Pscf::Prdc::DomainReal< D, FFT< D >, WaveList< D >, FieldIo< D > > Pscf::SweepTmpl< DArray< System::WField > > Pscf::SweepTmpl< BasisFieldState< D > > Util::Manager< Analyzer< D > > Util::Manager< McMove< D > > Pscf::EnvironmentBase Pscf::FieldGeneratorBase Pscf::FloryHuggins::Mixture Pscf::FloryHuggins::Molecule Pscf::Interaction Pscf::MixtureTmpl< PT, ST > Pscf::Prdc::DomainReal< D, FFT, WLT, FIT > Pscf::R1d::Domain Pscf::R1d::Iterator Pscf::R1d::System Pscf::Rpc::Analyzer< D > Pscf::Rpc::BdStep< D > Pscf::Rpc::Compressor< D > Pscf::Rpc::Iterator< D > Pscf::Rpc::McMove< D > Pscf::Rpc::Perturbation< D > Pscf::Rpc::Ramp< D > Pscf::Rpc::Simulator< D > Pscf::Rpc::System< D > Pscf::Rpg::Analyzer< D > Pscf::Rpg::BdStep< D > Pscf::Rpg::Compressor< D > Pscf::Rpg::IntraCorrelation< D > Pscf::Rpg::Iterator< D > Pscf::Rpg::McMove< D > Pscf::Rpg::Perturbation< D > Pscf::Rpg::Ramp< D > Pscf::Rpg::Simulator< D > Pscf::Rpg::System< D > Pscf::Species Pscf::SweepTmpl< State > Util::AutoCorr< Data, Product > Util::AutoCorrArray< Data, Product > Util::AutoCorrelation< Data, Product > Util::Average Util::Distribution Util::FileMaster Util::IntDistribution Util::Manager< Data > Util::MeanSqDispArray< Data > Util::Random Util::SymmTensorAverage Util::TensorAverage Util::ArrayParam< Type > Util::MatrixParam< Type > Util::ScalarParam< Type >

Public Member Functions

 MpiFileIo ()
 Constructor.
 MpiFileIo (const MpiFileIo &other)
 Copy constructor.
bool isIoProcessor () const
 Can this processor do file I/O ?

Detailed Description

Identifies whether this processor may do file I/O.

The return value of isIoProcessor() indicates whether this processor can read and write to file. If the the class is compiled with UTIL_MPI not defined, then isIoProcessor() always returns true. If the class is compiled with UTIL_MPI defined, then this method returns true if either: (1) A communicator has been set and this processor has rank 0 within that communicator, or (2) No communicator has been set.

When compiled with UTIL_MPI defined, an MpiFileIo object has a pointer to an MPI communiciator, and provides methods to set and unset (nullify) the associated communicator.

Definition at line 35 of file MpiFileIo.h.

Constructor & Destructor Documentation

◆ MpiFileIo() [1/2]

Util::MpiFileIo::MpiFileIo ( )

Constructor.

Definition at line 18 of file MpiFileIo.cpp.

Referenced by MpiFileIo(), Util::ParamComponent::ParamComponent(), and Util::ParamComponent::ParamComponent().

◆ MpiFileIo() [2/2]

Util::MpiFileIo::MpiFileIo ( const MpiFileIo & other)

Copy constructor.

Definition at line 28 of file MpiFileIo.cpp.

References MpiFileIo().

Member Function Documentation

◆ isIoProcessor()


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