UPstream Class Reference

Inter-processor communications stream. More...

Inheritance diagram for UPstream:
Collaboration diagram for UPstream:

Classes

class  commsStruct
 Structure for communicating between processors. More...
 
class  communicator
 Helper class for allocating/freeing communicators. More...
 
class  listEq
 combineReduce operator for lists. Used for counting. More...
 

Public Types

enum  commsTypes { blocking, scheduled, nonBlocking }
 Types of communications. More...
 

Public Member Functions

 ClassName ("UPstream")
 
 UPstream (const commsTypes commsType)
 Construct given optional buffer size. More...
 
commsTypes commsType () const
 Get the communications type of the stream. More...
 
commsTypes commsType (const commsTypes ct)
 Set the communications type of the stream. More...
 

Static Public Member Functions

static label allocateCommunicator (const label parent, const labelList &subRanks, const bool doPstream=true)
 Allocate a new communicator. More...
 
static void freeCommunicator (const label communicator, const bool doPstream=true)
 Free a previously allocated communicator. More...
 
static void freeCommunicators (const bool doPstream)
 Free all communicators. More...
 
static int baseProcNo (const label myComm, const int procID)
 Return physical processor number (i.e. processor number in. More...
 
static label procNo (const label comm, const int baseProcID)
 Return processor number in communicator (given physical processor. More...
 
static label procNo (const label myComm, const label currentComm, const int currentProcID)
 Return processor number in communicator (given processor number. More...
 
static void addValidParOptions (HashTable< string > &validParOptions)
 Add the valid option this type of communications library. More...
 
static bool init (int &argc, char **&argv, const bool needsThread)
 Initialisation function called from main. More...
 
static label nRequests ()
 Get number of outstanding requests. More...
 
static void resetRequests (const label sz)
 Truncate number of outstanding requests. More...
 
static void waitRequests (const label start=0)
 Wait until all requests (from start onwards) have finished. More...
 
static void waitRequest (const label i)
 Wait until request i has finished. More...
 
static bool finishedRequest (const label i)
 Non-blocking comms: has request i finished? More...
 
static int allocateTag (const char *)
 
static int allocateTag (const word &)
 
static void freeTag (const char *, const int tag)
 
static void freeTag (const word &, const int tag)
 
static bool & parRun ()
 Is this a parallel run? More...
 
static bool haveThreads ()
 Have support for threads. More...
 
static label nProcs (const label communicator=0)
 Number of processes in parallel run. More...
 
static int masterNo ()
 Process index of the master. More...
 
static bool master (const label communicator=0)
 Am I the master process. More...
 
static int myProcNo (const label communicator=0)
 Number of this process (starting from masterNo() = 0) More...
 
static label parent (const label communicator)
 
static List< int > & procID (label communicator)
 Process ID of given process index. More...
 
static int firstSlave ()
 Process index of first slave. More...
 
static int lastSlave (const label communicator=0)
 Process index of last slave. More...
 
static const List< commsStruct > & linearCommunication (const label communicator=0)
 Communication schedule for linear all-to-master (proc 0) More...
 
static const List< commsStruct > & treeCommunication (const label communicator=0)
 Communication schedule for tree all-to-master (proc 0) More...
 
static int & msgType ()
 Message tag of standard messages. More...
 
static void exit (int errnum=1)
 Exit program. More...
 
static void abort ()
 Abort program. More...
 
static void allToAll (const labelUList &sendData, labelUList &recvData, const label communicator=0)
 Exchange label with all processors (in the communicator). More...
 
static void allToAll (const char *sendData, const UList< int > &sendSizes, const UList< int > &sendOffsets, char *recvData, const UList< int > &recvSizes, const UList< int > &recvOffsets, const label communicator=0)
 Exchange data with all processors (in the communicator) More...
 
static void gather (const char *sendData, int sendSize, char *recvData, const UList< int > &recvSizes, const UList< int > &recvOffsets, const label communicator=0)
 Receive data from all processors on the master. More...
 
static void scatter (const char *sendData, const UList< int > &sendSizes, const UList< int > &sendOffsets, char *recvData, int recvSize, const label communicator=0)
 Send data to all processors from the root of the communicator. More...
 

Static Public Attributes

static const NamedEnum< commsTypes, 3 > commsTypeNames
 
static bool floatTransfer
 Should compact transfer be used in which floats replace doubles. More...
 
static int nProcsSimpleSum
 Number of processors at which the sum algorithm changes from linear. More...
 
static commsTypes defaultCommsType
 Default commsType. More...
 
static int nPollProcInterfaces
 Number of polling cycles in processor updates. More...
 
static label worldComm
 Default communicator (all processors) More...
 
static label warnComm
 Debugging: warn for use of any communicator differing from warnComm. More...
 

Protected Attributes

commsTypes commsType_
 Communications type of this stream. More...
 

Detailed Description

Inter-processor communications stream.

Source files

Definition at line 58 of file UPstream.H.

Member Enumeration Documentation

◆ commsTypes

enum commsTypes
strong

Types of communications.

Enumerator
blocking 
scheduled 
nonBlocking 

Definition at line 64 of file UPstream.H.

Constructor & Destructor Documentation

◆ UPstream()

UPstream ( const commsTypes  commsType)
inline

Construct given optional buffer size.

Definition at line 287 of file UPstream.H.

References UPstream::allocateCommunicator(), UPstream::freeCommunicator(), UPstream::freeCommunicators(), and UPstream::parent().

Here is the call graph for this function:

Member Function Documentation

◆ ClassName()

ClassName ( "UPstream"  )

◆ allocateCommunicator()

Foam::label allocateCommunicator ( const label  parent,
const labelList subRanks,
const bool  doPstream = true 
)
static

◆ freeCommunicator()

◆ freeCommunicators()

void freeCommunicators ( const bool  doPstream)
static

Free all communicators.

Definition at line 346 of file UPstream.C.

References forAll.

Referenced by UPstream::UPstream().

Here is the caller graph for this function:

◆ baseProcNo()

int baseProcNo ( const label  myComm,
const int  procID 
)
static

Return physical processor number (i.e. processor number in.

worldComm) given communicator and procssor

Definition at line 358 of file UPstream.C.

References UPstream::parent(), and UPstream::procID().

Referenced by UPstream::communicator::operator label(), and UPstream::procNo().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ procNo() [1/2]

Foam::label procNo ( const label  comm,
const int  baseProcID 
)
static

Return processor number in communicator (given physical processor.

number) (= reverse of baseProcNo)

Definition at line 374 of file UPstream.C.

References Foam::findIndex().

Referenced by UPstream::communicator::operator label().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ procNo() [2/2]

Foam::label procNo ( const label  myComm,
const label  currentComm,
const int  currentProcID 
)
static

Return processor number in communicator (given processor number.

and communicator)

Definition at line 392 of file UPstream.C.

References UPstream::baseProcNo(), UPstream::defaultCommsType, UPstream::floatTransfer, dictionary::lookup(), UPstream::nProcsSimpleSum, Foam::debug::optimisationSwitch(), Foam::debug::optimisationSwitches(), registerOptSwitch(), and serialComm.

Here is the call graph for this function:

◆ addValidParOptions()

void addValidParOptions ( HashTable< string > &  validParOptions)
static

Add the valid option this type of communications library.

adds/requires on the command line

Definition at line 31 of file UPstream.C.

Referenced by argList::initValidTables::initValidTables(), and UPstream::communicator::operator label().

Here is the caller graph for this function:

◆ init()

bool init ( int &  argc,
char **&  argv,
const bool  needsThread 
)
static

Initialisation function called from main.

Spawns slave processes and initialises inter-communication

Definition at line 35 of file UPstream.C.

References Foam::exit(), Foam::FatalError, FatalErrorInFunction, and Foam::nl.

Referenced by UPstream::communicator::operator label(), and ParRunControl::runPar().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ nRequests()

◆ resetRequests()

void resetRequests ( const label  sz)
static

Truncate number of outstanding requests.

Definition at line 143 of file UPstream.C.

Referenced by UPstream::allToAll(), and UPstream::communicator::operator label().

Here is the caller graph for this function:

◆ waitRequests()

void waitRequests ( const label  start = 0)
static

◆ waitRequest()

void waitRequest ( const label  i)
static

Wait until request i has finished.

Definition at line 151 of file UPstream.C.

Referenced by UPstream::allToAll(), UPstream::communicator::operator label(), processorFvPatchField< Type >::updateInterfaceMatrix(), and processorGAMGInterfaceField::updateInterfaceMatrix().

Here is the caller graph for this function:

◆ finishedRequest()

bool finishedRequest ( const label  i)
static

Non-blocking comms: has request i finished?

Definition at line 155 of file UPstream.C.

References NotImplemented.

Referenced by UPstream::allToAll(), and UPstream::communicator::operator label().

Here is the caller graph for this function:

◆ allocateTag() [1/2]

int allocateTag ( const char *  s)
static

Definition at line 826 of file UPstream.C.

References Foam::endl(), Foam::PstreamGlobals::freedTags_, Foam::PstreamGlobals::nTags_, Foam::Pout, and DynamicList< T, SizeInc, SizeMult, SizeDiv >::remove().

Referenced by UPstream::communicator::operator label().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ allocateTag() [2/2]

int allocateTag ( const word s)
static

◆ freeTag() [1/2]

void freeTag ( const char *  s,
const int  tag 
)
static

Definition at line 884 of file UPstream.C.

References DynamicList< T, SizeInc, SizeMult, SizeDiv >::append(), Foam::endl(), Foam::PstreamGlobals::freedTags_, and Foam::Pout.

Referenced by UPstream::communicator::operator label().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ freeTag() [2/2]

void freeTag ( const word s,
const int  tag 
)
static

Definition at line 900 of file UPstream.C.

References DynamicList< T, SizeInc, SizeMult, SizeDiv >::append(), Foam::endl(), Foam::PstreamGlobals::freedTags_, and Foam::Pout.

Here is the call graph for this function:

◆ parRun()

static bool& parRun ( )
inlinestatic

Is this a parallel run?

Definition at line 399 of file UPstream.H.

Referenced by error::abort(), IOerror::abort(), snappyLayerDriver::addLayers(), unwatchedIOdictionary::addWatch(), regIOobject::addWatch(), UPstream::allToAll(), meshRefinement::balance(), writeFile::baseFileDir(), boundBox::boundBox(), processorCyclicPolyPatch::calcGeometry(), processorPolyPatch::calcGeometry(), FaceCellWave< Type, TrackingData >::cellToFace(), polyBoundaryMesh::checkParallelSync(), CloudFunctionObject< CloudType >::CloudFunctionObject(), mapDistributeBase::compact(), cyclicAMIPointPatch::coupled(), processorFvPatch::coupled(), processorPointPatchField< Type >::coupled(), processorCyclicPointPatchField< Type >::coupled(), processorFvsPatchField< Type >::coupled(), processorCyclicFvsPatchField< Type >::coupled(), cyclicAMIFvPatch::coupled(), processorFvPatchField< Type >::coupled(), processorPolyPatch::coupled(), simpleGeomDecomp::decompose(), decompositionMethod::decompose(), conformalVoronoiMesh::decomposition(), processorFvPatch::delta(), fvMeshDistribute::distribute(), refinementHistory::distribute(), distributedTriSurfaceMesh::distributedTriSurfaceMesh(), snappyLayerDriver::doLayers(), snappyRefineDriver::doRefine(), PointEdgeWave< Type, TrackingData >::edgeToPoint(), GeometricField< Type, PatchField, GeoMesh >::Boundary::evaluate(), Foam::evaluateConstraintTypes(), error::exit(), IOerror::exit(), sampledSurfaces::expire(), polyMesh::findCell(), distributedTriSurfaceMesh::findNearest(), masterUncollatedFileOperation::findTimes(), Pstream::gather(), Pstream::gatherList(), distributedTriSurfaceMesh::getField(), distributedTriSurfaceMesh::getNormal(), distributedTriSurfaceMesh::getRegion(), GAMGProcAgglomeration::globalCellCells(), InflationInjection< CloudType >::InflationInjection(), processorPolyPatch::initGeometry(), processorPolyPatch::initOrder(), processorPolyPatch::initUpdateMesh(), collatedFileOperation::isMasterRank(), PointEdgeWave< Type, TrackingData >::iterate(), FaceCellWave< Type, TrackingData >::iterate(), masterUncollatedFileOperation::localObjectPath(), fileOperation::lookupProcessorsPath(), LUscalarMatrix::LUscalarMatrix(), patchMeanVelocityForce::magUbarAve(), processorFvPatch::makeWeights(), NamedEnum< directionType, 3 >::names(), polyBoundaryMesh::neighbourEdges(), masterUncollatedFileOperation::NewIFstream(), minEqOp< labelPair >::operator()(), messageStream::operator()(), processorPolyPatch::order(), InflationInjection< CloudType >::parcelsToInject(), powerLawLopesdaCostaZone::powerLawLopesdaCostaZone(), probes::prepare(), collatedFileOperation::processorsDir(), sampledSurfaces::read(), uncollatedFileOperation::read(), masterUncollatedFileOperation::read(), Time::readModifiedObjects(), masterUncollatedFileOperation::readObjects(), masterUncollatedFileOperation::readStream(), sampledSets::sampledSets(), sampledSurfaces::sampledSurfaces(), Pstream::scatter(), Pstream::scatterList(), Time::setControls(), fvMeshSubset::setLargeCellSubset(), syncTools::syncEdgeMap(), syncTools::syncEdgePositions(), syncTools::syncPointMap(), externalCoupledTemperatureMixedFvPatchScalarField::transferData(), sampledSurfaces::update(), processorPolyPatch::updateMesh(), fileOperation::updateStates(), streamLine::write(), meshToMeshMethod::writeConnectivity(), fieldMinMax::writeFileHeader(), collatedFileOperation::writeObject(), and masterOFstream::~masterOFstream().

◆ haveThreads()

static bool haveThreads ( )
inlinestatic

Have support for threads.

Definition at line 405 of file UPstream.H.

Referenced by UPstream::listEq::operator()(), and OFstreamCollator::write().

Here is the caller graph for this function:

◆ nProcs()

static label nProcs ( const label  communicator = 0)
inlinestatic

Number of processes in parallel run.

Definition at line 411 of file UPstream.H.

References List< T >::size().

Referenced by surfaceZonesInfo::addCellZonesToMesh(), surfaceZonesInfo::addFaceZonesToMesh(), masterCoarsestGAMGProcAgglomeration::agglomerate(), eagerGAMGProcAgglomeration::agglomerate(), manualGAMGProcAgglomeration::agglomerate(), procFacesGAMGProcAgglomeration::agglomerate(), UPstream::allToAll(), meshRefinement::balanceAndRefine(), mapDistributeBase::calcCompactAddressing(), decomposedBlockData::calcNumProcs(), meshRefinement::checkCoupledFaceZones(), polyBoundaryMesh::checkParallelSync(), collatedFileOperation::collatedFileOperation(), mappedPatchBase::collectSamples(), fieldValue::combineFields(), Foam::combineReduce(), mapDistributeBase::compact(), GAMGAgglomeration::continueAgglomerating(), fvMeshDistribute::countCells(), simpleGeomDecomp::decompose(), fvMeshDistribute::distribute(), refinementHistory::distribute(), distributedTriSurfaceMesh::distribute(), distributedTriSurfaceMesh::distributedTriSurfaceMesh(), mapDistributeBase::exchangeAddressing(), extendedUpwindCellToFaceStencil::extendedUpwindCellToFaceStencil(), distributedTriSurfaceMesh::findNearest(), Pstream::gather(), decomposedBlockData::gather(), Pstream::gatherList(), decomposedBlockData::gatherSlaveData(), globalIndex::globalIndex(), hostCollatedFileOperation::hostCollatedFileOperation(), UPstream::lastSlave(), LUscalarMatrix::LUscalarMatrix(), mapDistributeBase::mapDistributeBase(), NamedEnum< directionType, 3 >::names(), masterUncollatedFileOperation::NewIFstream(), minEqOp< labelPair >::operator()(), lessProcPatches::operator()(), UPstream::listEq::operator()(), InflationInjection< CloudType >::parcelsToInject(), argList::parse(), AMIInterpolation::patchMagSf(), powerLawLopesdaCostaZone::powerLawLopesdaCostaZone(), fvMeshDistribute::printCoupleInfo(), mapDistributeBase::printLayout(), collatedFileOperation::processorsDir(), uncollatedFileOperation::read(), masterUncollatedFileOperation::read(), decomposedBlockData::readBlocks(), masterUncollatedFileOperation::readHeader(), masterUncollatedFileOperation::readStream(), mapDistributeBase::receive(), Foam::reduce(), meshRefinement::refineAndBalance(), meshRefinement::refineCandidates(), Foam::returnReduce(), Pstream::scatter(), Pstream::scatterList(), mapDistributeBase::schedule(), mapDistributeBase::send(), Time::setControls(), fvMeshSubset::setLargeCellSubset(), ParSortableList< Type >::sort(), externalCoupledTemperatureMixedFvPatchScalarField::transferData(), globalMeshData::updateMesh(), streamLine::write(), decomposedBlockData::writeBlocks(), and masterOFstream::~masterOFstream().

Here is the call graph for this function:

◆ masterNo()

◆ master()

static bool master ( const label  communicator = 0)
inlinestatic

Am I the master process.

Definition at line 423 of file UPstream.H.

References UPstream::masterNo().

Referenced by effectivenessHeatExchangerSource::addSup(), regIOobject::addWatch(), masterUncollatedFileOperation::addWatch(), UPstream::allToAll(), mappedPatchBase::calcMapping(), decomposedBlockData::calcNumProcs(), viewFactor::calculate(), argList::check(), polyBoundaryMesh::checkParallelSync(), argList::checkRootCase(), Foam::chMod(), collatedFileOperation::collatedFileOperation(), fieldValue::combineFields(), commSchedule::commSchedule(), Foam::cp(), logFiles::createFiles(), simpleGeomDecomp::decompose(), masterUncollatedFileOperation::dirPath(), Foam::exists(), logFiles::file(), masterUncollatedFileOperation::filePath(), logFiles::files(), Foam::fileSize(), probes::findElements(), masterUncollatedFileOperation::findInstance(), masterUncollatedFileOperation::findTimes(), masterUncollatedFileOperation::findWatch(), decomposedBlockData::gather(), decomposedBlockData::gatherSlaveData(), masterUncollatedFileOperation::getFile(), masterUncollatedFileOperation::getState(), Random::globalScalar01(), Foam::highResLastModified(), hostCollatedFileOperation::hostCollatedFileOperation(), Foam::isDir(), Foam::isFile(), collatedFileOperation::isMasterRank(), jobInfo::jobInfo(), Foam::lastModified(), Foam::ln(), LUscalarMatrix::LUscalarMatrix(), messageStream::masterStream(), Foam::mkDir(), Foam::mode(), Foam::mv(), Foam::mvBak(), NamedEnum< directionType, 3 >::names(), masterUncollatedFileOperation::NewIFstream(), fileOperation::nProcs(), isNotEqOp< T >::operator()(), minEqOp< labelPair >::operator()(), ListPlusEqOp< T, Size >::operator()(), messageStream::operator()(), InflationInjection< CloudType >::parcelsToInject(), argList::parse(), porosityModel::porosityModel(), probes::prepare(), decomposedBlockData::read(), sampledSurfaces::read(), uncollatedFileOperation::read(), sampledSets::read(), masterUncollatedFileOperation::read(), decomposedBlockData::readBlocks(), baseIOdictionary::readData(), Foam::readDir(), masterUncollatedFileOperation::readHeader(), masterUncollatedFileOperation::readObjects(), masterUncollatedFileOperation::readStream(), masterUncollatedFileOperation::removeWatch(), logFiles::resetName(), logFiles::resetNames(), Foam::rm(), Foam::rmDir(), mapDistributeBase::schedule(), masterUncollatedFileOperation::setUnmodified(), globalMeshData::sharedPoints(), jobInfo::signalEnd(), rigidBodyMeshMotionSolver::solve(), rigidBodyMeshMotion::solve(), rigidBodyMotion::solve(), ParSortableList< Type >::sort(), syncTools::syncEdgeMap(), syncTools::syncPointMap(), externalCoupledTemperatureMixedFvPatchScalarField::transferData(), IOobject::typeHeaderOk(), sampledSurfaces::update(), sixDoFRigidBodyMotion::update(), fileMonitor::updateStates(), masterUncollatedFileOperation::updateStates(), solution::upgradeSolverDict(), OFstreamCollator::waitAll(), jobInfo::write(), time::write(), residuals::write(), rigidBodyState::write(), turbulenceIntensity::write(), yPlus::write(), cloudInfo::write(), sixDoFRigidBodyState::write(), wallHeatFlux::write(), wallShearStress::write(), histogram::write(), OFstreamCollator::write(), fieldValueDelta::write(), wallHeatTransferCoeff::write(), fieldMinMax::write(), sampledSurfaces::write(), forceCoeffs::write(), sampledSets::write(), regionSizeDistribution::write(), streamLine::write(), volFieldValue::write(), forces::write(), surfaceFieldValue::write(), decomposedBlockData::writeBlocks(), decomposedBlockData::writeData(), time::writeFileHeader(), residuals::writeFileHeader(), decomposedBlockData::writeObject(), collatedFileOperation::writeObject(), jobInfo::~jobInfo(), and masterOFstream::~masterOFstream().

Here is the call graph for this function:

◆ myProcNo()

static int myProcNo ( const label  communicator = 0)
inlinestatic

Number of this process (starting from masterNo() = 0)

Definition at line 429 of file UPstream.H.

Referenced by surfaceZonesInfo::addCellZonesToMesh(), surfaceZonesInfo::addFaceZonesToMesh(), GAMGProcAgglomeration::agglomerate(), masterCoarsestGAMGProcAgglomeration::agglomerate(), eagerGAMGProcAgglomeration::agglomerate(), manualGAMGProcAgglomeration::agglomerate(), mapDistributeBase::calcCompactAddressing(), viewFactor::calculate(), GAMGAgglomeration::calculateRegionMaster(), meshRefinement::checkCoupledFaceZones(), polyBoundaryMesh::checkParallelSync(), collatedFileOperation::collatedFileOperation(), mappedPatchBase::collectSamples(), fieldValue::combineFields(), mapDistributeBase::compact(), noDecomp::decompose(), fvMeshDistribute::distribute(), distributedTriSurfaceMesh::distribute(), distributedTriSurfaceMesh::distributedTriSurfaceMesh(), mapDistributeBase::exchangeAddressing(), processorField::execute(), InjectionModel< CloudType >::findCellAtPosition(), probes::findElements(), patchProbes::findElements(), distributedTriSurfaceMesh::findNearest(), mappedPatchBase::findSamples(), Pstream::gather(), lduPrimitiveMesh::gather(), Pstream::gatherList(), decomposedBlockData::gatherSlaveData(), GAMGProcAgglomeration::globalCellCells(), globalIndex::globalIndex(), hostCollatedFileOperation::hostCollatedFileOperation(), globalIndex::isLocal(), lduPrimitiveMesh::lduPrimitiveMesh(), masterUncollatedFileOperation::localObjectPath(), globalIndex::localSize(), meshToMesh::mapAndOpTgtToSrc(), mapDistribute::mapDistribute(), mapDistributeBase::mapDistributeBase(), conformalVoronoiMesh::maxSurfaceProtrusion(), meshRefinement::mergeBaffles(), NamedEnum< directionType, 3 >::names(), masterUncollatedFileOperation::NewIFstream(), regionSplit::nLocalRegions(), minEqOp< labelPair >::operator()(), ListPlusEqOp< T, Size >::operator()(), lessProcPatches::operator()(), InflationInjection< CloudType >::parcelsToInject(), argList::parse(), AMIInterpolation::patchMagSf(), powerLawLopesdaCostaZone::powerLawLopesdaCostaZone(), UOPstream::print(), fvMeshDistribute::printCoupleInfo(), mapDistributeBase::printLayout(), backgroundMeshDecomposition::procBounds(), uncollatedFileOperation::read(), masterUncollatedFileOperation::read(), masterUncollatedFileOperation::readHeader(), masterUncollatedFileOperation::readStream(), indexedVertex< Gt, Vb >::referred(), Pstream::scatter(), Pstream::scatterList(), mapDistributeBase::schedule(), Time::setControls(), fvMeshSubset::setLargeCellSubset(), patchInjectionBase::setPositionAndCell(), ParSortableList< Type >::sort(), ThermoSurfaceFilm< CloudType >::splashInteraction(), masterUncollatedFileOperation::subRanks(), refinementHistory::subset(), globalIndex::toGlobal(), globalIndex::toLocal(), externalCoupledTemperatureMixedFvPatchScalarField::transferData(), patchInjectionBase::updateMesh(), meshToMeshMethod::writeConnectivity(), AMIInterpolation::writeFaceConnectivity(), extendedCellToFaceStencil::writeStencilStats(), and masterOFstream::~masterOFstream().

◆ parent()

static label parent ( const label  communicator)
inlinestatic

Definition at line 434 of file UPstream.H.

Referenced by UPstream::baseProcNo(), and UPstream::UPstream().

Here is the caller graph for this function:

◆ procID()

static List<int>& procID ( label  communicator)
inlinestatic

Process ID of given process index.

Definition at line 440 of file UPstream.H.

Referenced by UPstream::baseProcNo(), UPstream::listEq::operator()(), and collatedFileOperation::processorsDir().

Here is the caller graph for this function:

◆ firstSlave()

static int firstSlave ( )
inlinestatic

Process index of first slave.

Definition at line 446 of file UPstream.H.

Referenced by LUscalarMatrix::LUscalarMatrix(), minEqOp< labelPair >::operator()(), argList::parse(), mapDistributeBase::schedule(), globalMeshData::sharedPoints(), syncTools::syncEdgeMap(), and syncTools::syncPointMap().

Here is the caller graph for this function:

◆ lastSlave()

static int lastSlave ( const label  communicator = 0)
inlinestatic

Process index of last slave.

Definition at line 452 of file UPstream.H.

References UPstream::linearCommunication(), and UPstream::nProcs().

Referenced by LUscalarMatrix::LUscalarMatrix(), minEqOp< labelPair >::operator()(), argList::parse(), mapDistributeBase::schedule(), globalMeshData::sharedPoints(), syncTools::syncEdgeMap(), and syncTools::syncPointMap().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ linearCommunication()

static const List<commsStruct>& linearCommunication ( const label  communicator = 0)
inlinestatic

Communication schedule for linear all-to-master (proc 0)

Definition at line 459 of file UPstream.H.

References UPstream::treeCommunication().

Referenced by Foam::combineReduce(), Pstream::gather(), Pstream::gatherList(), UPstream::lastSlave(), uncollatedFileOperation::read(), masterUncollatedFileOperation::read(), Foam::reduce(), Foam::returnReduce(), Pstream::scatter(), and Pstream::scatterList().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ treeCommunication()

static const List<commsStruct>& treeCommunication ( const label  communicator = 0)
inlinestatic

Communication schedule for tree all-to-master (proc 0)

Definition at line 468 of file UPstream.H.

Referenced by Foam::combineReduce(), Pstream::gather(), Pstream::gatherList(), UPstream::linearCommunication(), uncollatedFileOperation::read(), masterUncollatedFileOperation::read(), Foam::reduce(), Foam::returnReduce(), Pstream::scatter(), and Pstream::scatterList().

Here is the caller graph for this function:

◆ msgType()

static int& msgType ( )
inlinestatic

Message tag of standard messages.

Definition at line 476 of file UPstream.H.

Referenced by decompositionMethod::calcCellCells(), masterUncollatedFileOperation::chMod(), extendedCentredCellToFaceStencil::compact(), extendedCentredFaceToCellStencil::compact(), extendedCentredCellToCellStencil::compact(), mapDistributeBase::constructHasFlip(), masterUncollatedFileOperation::cp(), masterUncollatedFileOperation::dirPath(), masterUncollatedFileOperation::exists(), masterUncollatedFileOperation::filePath(), masterUncollatedFileOperation::fileSize(), masterUncollatedFileOperation::findInstance(), UOPstream::flags(), UIPstream::flags(), globalIndex::gather(), lduPrimitiveMesh::gather(), Foam::gAverage(), GAMGProcAgglomeration::globalCellCells(), globalIndex::globalIndex(), Foam::gSumCmptProd(), Foam::gSumProd(), masterUncollatedFileOperation::highResLastModified(), regionModel::interRegionAMI(), masterUncollatedFileOperation::isDir(), masterUncollatedFileOperation::isFile(), masterUncollatedFileOperation::lastModified(), lduPrimitiveMesh::lduPrimitiveMesh(), masterUncollatedFileOperation::ln(), LUscalarMatrix::LUscalarMatrix(), mappedPatchFieldBase< Type >::mappedField(), masterUncollatedFileOperation::mkDir(), masterUncollatedFileOperation::mode(), masterUncollatedFileOperation::mv(), masterUncollatedFileOperation::mvBak(), masterUncollatedFileOperation::NewIFstream(), fileOperation::nProcs(), mapDistribute::transformPosition::operator()(), Pstream::Pstream(), uncollatedFileOperation::read(), masterUncollatedFileOperation::read(), decomposedBlockData::readBlocks(), masterUncollatedFileOperation::readDir(), masterUncollatedFileOperation::readHeader(), masterUncollatedFileOperation::readStream(), Foam::reduce(), fvMatrix< Type >::relax(), masterUncollatedFileOperation::rm(), masterUncollatedFileOperation::rmDir(), mapDistributeBase::schedule(), processorFvPatch::tag(), processorCyclicPolyPatch::tag(), processorPolyPatch::tag(), externalCoupledTemperatureMixedFvPatchScalarField::transferData(), mapDistribute::transformStart(), masterUncollatedFileOperation::type(), mappedVelocityFluxFixedValueFvPatchField::updateCoeffs(), mappedFlowRateFvPatchVectorField::updateCoeffs(), filmPyrolysisTemperatureCoupledFvPatchScalarField::updateCoeffs(), filmPyrolysisVelocityCoupledFvPatchVectorField::updateCoeffs(), wideBandDiffusiveRadiationMixedFvPatchScalarField::updateCoeffs(), MarshakRadiationFvPatchScalarField::updateCoeffs(), MarshakRadiationFixedTemperatureFvPatchScalarField::updateCoeffs(), greyDiffusiveRadiationMixedFvPatchScalarField::updateCoeffs(), alphatFilmWallFunctionFvPatchScalarField::updateCoeffs(), turbulentTemperatureCoupledBaffleMixedFvPatchScalarField::updateCoeffs(), turbulentTemperatureRadCoupledMixedFvPatchScalarField::updateCoeffs(), thermalBaffle1DFvPatchScalarField< solidType >::updateCoeffs(), globalMeshData::updateMesh(), OFstreamCollator::write(), decomposedBlockData::writeBlocks(), and decomposedBlockData::writeData().

◆ commsType() [1/2]

commsTypes commsType ( ) const
inline

Get the communications type of the stream.

Definition at line 483 of file UPstream.H.

References UPstream::commsType_.

◆ commsType() [2/2]

commsTypes commsType ( const commsTypes  ct)
inline

Set the communications type of the stream.

Definition at line 489 of file UPstream.H.

References UPstream::abort(), UPstream::allToAll(), UPstream::commsType_, UPstream::exit(), UPstream::gather(), Foam::operator<<(), and UPstream::scatter().

Here is the call graph for this function:

◆ exit()

void exit ( int  errnum = 1)
static

Exit program.

Definition at line 46 of file UPstream.C.

References NotImplemented.

Referenced by UPstream::commsType(), error::exit(), IOerror::exit(), ParRunControl::runPar(), and ParRunControl::~ParRunControl().

Here is the caller graph for this function:

◆ abort()

void abort ( )
static

Abort program.

Definition at line 52 of file UPstream.C.

References NotImplemented.

Referenced by error::abort(), IOerror::abort(), and UPstream::commsType().

Here is the caller graph for this function:

◆ allToAll() [1/2]

void allToAll ( const labelUList sendData,
labelUList recvData,
const label  communicator = 0 
)
static

Exchange label with all processors (in the communicator).

sendData[proci] is the label to send to proci. After return recvData contains the data from the other processors.

Definition at line 85 of file UPstream.C.

References UList< T >::deepCopy(), and UPstream::gather().

Referenced by UPstream::commsType(), and Foam::reduce().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ allToAll() [2/2]

void allToAll ( const char *  sendData,
const UList< int > &  sendSizes,
const UList< int > &  sendOffsets,
char *  recvData,
const UList< int > &  recvSizes,
const UList< int > &  recvOffsets,
const label  communicator = 0 
)
static

◆ gather()

void gather ( const char *  sendData,
int  sendSize,
char *  recvData,
const UList< int > &  recvSizes,
const UList< int > &  recvOffsets,
const label  communicator = 0 
)
static

Receive data from all processors on the master.

Definition at line 96 of file UPstream.C.

References UPstream::scatter().

Referenced by UPstream::allToAll(), UPstream::commsType(), decomposedBlockData::gather(), and decomposedBlockData::gatherSlaveData().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ scatter()

void scatter ( const char *  sendData,
const UList< int > &  sendSizes,
const UList< int > &  sendOffsets,
char *  recvData,
int  recvSize,
const label  communicator = 0 
)
static

Send data to all processors from the root of the communicator.

Definition at line 111 of file UPstream.C.

Referenced by UPstream::allToAll(), decomposedBlockData::calcNumProcs(), UPstream::commsType(), and UPstream::gather().

Here is the caller graph for this function:

Member Data Documentation

◆ commsTypeNames

◆ commsType_

commsTypes commsType_
protected

Communications type of this stream.

Definition at line 252 of file UPstream.H.

Referenced by UPstream::commsType(), and UOPstream::~UOPstream().

◆ floatTransfer

bool floatTransfer
static

Should compact transfer be used in which floats replace doubles.

reducing the bandwidth requirement at the expense of some loss in accuracy

Definition at line 265 of file UPstream.H.

Referenced by processorFvPatchField< Type >::initInterfaceMatrixUpdate(), processorGAMGInterfaceField::initInterfaceMatrixUpdate(), argList::parse(), UPstream::procNo(), processorFvPatchField< Type >::updateInterfaceMatrix(), and processorGAMGInterfaceField::updateInterfaceMatrix().

◆ nProcsSimpleSum

int nProcsSimpleSum
static

◆ defaultCommsType

◆ nPollProcInterfaces

int nPollProcInterfaces
static

Number of polling cycles in processor updates.

Definition at line 275 of file UPstream.H.

Referenced by argList::parse(), and addcommsTypeToOpt::writeData().

◆ worldComm

◆ warnComm

Foam::label warnComm
static

Debugging: warn for use of any communicator differing from warnComm.

Definition at line 281 of file UPstream.H.

Referenced by messageStream::masterStream(), Foam::reduce(), and addcommsTypeToOpt::writeData().


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