mirror of
https://develop.openfoam.com/Development/openfoam.git
synced 2025-11-28 03:28:01 +00:00
486 lines
9.4 KiB
C
486 lines
9.4 KiB
C
/*---------------------------------------------------------------------------*\
|
|
========= |
|
|
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
|
\\ / O peration |
|
|
\\ / A nd | www.openfoam.com
|
|
\\/ M anipulation |
|
|
-------------------------------------------------------------------------------
|
|
Copyright (C) 2011-2016 OpenFOAM Foundation
|
|
Copyright (C) 2018-2022 OpenCFD Ltd.
|
|
-------------------------------------------------------------------------------
|
|
License
|
|
This file is part of OpenFOAM.
|
|
|
|
OpenFOAM is free software: you can redistribute it and/or modify it
|
|
under the terms of the GNU General Public License as published by
|
|
the Free Software Foundation, either version 3 of the License, or
|
|
(at your option) any later version.
|
|
|
|
OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
|
|
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
|
|
FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
|
|
for more details.
|
|
|
|
You should have received a copy of the GNU General Public License
|
|
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
\*---------------------------------------------------------------------------*/
|
|
|
|
#include "ListOps.H"
|
|
#include "labelRange.H"
|
|
|
|
// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
|
|
|
|
inline Foam::globalIndex::globalIndex
|
|
(
|
|
const labelUList& listOffsets
|
|
)
|
|
{
|
|
if (listOffsets.size() > 1)
|
|
{
|
|
offsets_ = listOffsets;
|
|
}
|
|
}
|
|
|
|
|
|
inline Foam::globalIndex::globalIndex
|
|
(
|
|
labelList&& listOffsets
|
|
)
|
|
{
|
|
if (listOffsets.size() > 1)
|
|
{
|
|
offsets_.transfer(listOffsets);
|
|
}
|
|
else
|
|
{
|
|
listOffsets.clear();
|
|
}
|
|
}
|
|
|
|
|
|
inline Foam::globalIndex::globalIndex
|
|
(
|
|
const labelUList& offsetsOrSizes,
|
|
enum globalIndex::accessType accType
|
|
)
|
|
{
|
|
if (accType == accessType::SIZES)
|
|
{
|
|
reset(offsetsOrSizes);
|
|
}
|
|
else if (offsetsOrSizes.size() > 1)
|
|
{
|
|
// accessType::OFFSETS
|
|
offsets_ = offsetsOrSizes;
|
|
}
|
|
}
|
|
|
|
|
|
inline Foam::globalIndex::globalIndex(const label localSize)
|
|
{
|
|
reset(localSize);
|
|
}
|
|
|
|
|
|
inline Foam::globalIndex::globalIndex
|
|
(
|
|
const label localSize,
|
|
const globalIndex::gatherOnly,
|
|
const label comm
|
|
)
|
|
{
|
|
// Gather sizes (one-sided)
|
|
reset(UPstream::listGatherValues(localSize, comm));
|
|
}
|
|
|
|
|
|
inline Foam::globalIndex::globalIndex
|
|
(
|
|
const label localSize,
|
|
const globalIndex::gatherNone,
|
|
const label /* comm (ignored) */
|
|
)
|
|
:
|
|
offsets_(2)
|
|
{
|
|
offsets_[0] = 0;
|
|
offsets_[1] = localSize;
|
|
}
|
|
|
|
|
|
inline Foam::globalIndex::globalIndex
|
|
(
|
|
const label localSize,
|
|
const int tag,
|
|
const label comm,
|
|
const bool parallel
|
|
)
|
|
{
|
|
reset(localSize, tag, comm, parallel);
|
|
}
|
|
|
|
|
|
// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
|
|
|
|
inline bool Foam::globalIndex::empty() const
|
|
{
|
|
return offsets_.empty() || offsets_.last() == 0;
|
|
}
|
|
|
|
|
|
inline Foam::label Foam::globalIndex::totalSize() const
|
|
{
|
|
const label len = (offsets_.size() - 1);
|
|
return (len < 1) ? static_cast<label>(0) : offsets_[len];
|
|
}
|
|
|
|
|
|
inline Foam::label Foam::globalIndex::size() const
|
|
{
|
|
return totalSize();
|
|
}
|
|
|
|
|
|
inline Foam::label Foam::globalIndex::nProcs() const noexcept
|
|
{
|
|
const label len = (offsets_.size() - 1);
|
|
return (len < 1) ? static_cast<label>(0) : len;
|
|
}
|
|
|
|
|
|
inline Foam::labelRange Foam::globalIndex::allProcs() const noexcept
|
|
{
|
|
// Proc 0 -> nProcs
|
|
const label len = (offsets_.size() - 1);
|
|
return (len < 1) ? labelRange() : labelRange(0, len);
|
|
}
|
|
|
|
|
|
inline Foam::labelRange Foam::globalIndex::subProcs() const noexcept
|
|
{
|
|
// Proc 1 -> nProcs
|
|
const label len = (offsets_.size() - 2);
|
|
return (len < 1) ? labelRange() : labelRange(1, len);
|
|
}
|
|
|
|
|
|
inline const Foam::labelList& Foam::globalIndex::offsets() const noexcept
|
|
{
|
|
return offsets_;
|
|
}
|
|
|
|
|
|
inline Foam::labelList& Foam::globalIndex::offsets() noexcept
|
|
{
|
|
return offsets_;
|
|
}
|
|
|
|
|
|
inline const Foam::labelUList Foam::globalIndex::localStarts() const
|
|
{
|
|
const label len = (offsets_.size() - 1);
|
|
|
|
if (len < 1) return labelUList::null();
|
|
|
|
return labelList::subList(offsets_, len);
|
|
}
|
|
|
|
|
|
inline Foam::label Foam::globalIndex::localStart(const label proci) const
|
|
{
|
|
return offsets_[proci];
|
|
}
|
|
|
|
|
|
inline Foam::label Foam::globalIndex::localStart() const
|
|
{
|
|
return localStart(Pstream::myProcNo());
|
|
}
|
|
|
|
|
|
inline Foam::label Foam::globalIndex::localSize(const label proci) const
|
|
{
|
|
return offsets_[proci+1] - offsets_[proci];
|
|
}
|
|
|
|
|
|
inline Foam::label Foam::globalIndex::localSize() const
|
|
{
|
|
return localSize(Pstream::myProcNo());
|
|
}
|
|
|
|
|
|
inline Foam::label Foam::globalIndex::maxSize() const
|
|
{
|
|
// Use out-of-range proci to avoid excluding any processor
|
|
return maxNonLocalSize(-1);
|
|
}
|
|
|
|
|
|
inline Foam::label Foam::globalIndex::maxNonLocalSize() const
|
|
{
|
|
return maxNonLocalSize(Pstream::myProcNo());
|
|
}
|
|
|
|
|
|
inline Foam::labelRange Foam::globalIndex::range(const label proci) const
|
|
{
|
|
return labelRange(offsets_[proci], offsets_[proci+1] - offsets_[proci]);
|
|
}
|
|
|
|
|
|
inline Foam::labelRange Foam::globalIndex::range() const
|
|
{
|
|
return range(Pstream::myProcNo());
|
|
}
|
|
|
|
|
|
inline bool Foam::globalIndex::isLocal(const label proci, const label i) const
|
|
{
|
|
return i >= offsets_[proci] && i < offsets_[proci+1];
|
|
}
|
|
|
|
|
|
inline bool Foam::globalIndex::isLocal(const label i) const
|
|
{
|
|
return isLocal(Pstream::myProcNo(), i);
|
|
}
|
|
|
|
|
|
inline Foam::label Foam::globalIndex::toGlobal
|
|
(
|
|
const label proci,
|
|
const label i
|
|
) const
|
|
{
|
|
return i + offsets_[proci];
|
|
}
|
|
|
|
|
|
inline Foam::label Foam::globalIndex::toGlobal(const label i) const
|
|
{
|
|
return toGlobal(Pstream::myProcNo(), i);
|
|
}
|
|
|
|
|
|
inline Foam::labelList Foam::globalIndex::toGlobal
|
|
(
|
|
const label proci,
|
|
const labelUList& labels
|
|
) const
|
|
{
|
|
labelList result(labels);
|
|
inplaceToGlobal(proci, result);
|
|
|
|
return result;
|
|
}
|
|
|
|
|
|
inline Foam::labelList Foam::globalIndex::toGlobal
|
|
(
|
|
const labelUList& labels
|
|
) const
|
|
{
|
|
return toGlobal(Pstream::myProcNo(), labels);
|
|
}
|
|
|
|
|
|
inline void Foam::globalIndex::inplaceToGlobal
|
|
(
|
|
const label proci,
|
|
labelList& labels
|
|
) const
|
|
{
|
|
const label off = offsets_[proci];
|
|
|
|
for (label& val : labels)
|
|
{
|
|
val += off;
|
|
}
|
|
}
|
|
|
|
|
|
inline void Foam::globalIndex::inplaceToGlobal(labelList& labels) const
|
|
{
|
|
inplaceToGlobal(Pstream::myProcNo(), labels);
|
|
}
|
|
|
|
|
|
inline Foam::label
|
|
Foam::globalIndex::toLocal(const label proci, const label i) const
|
|
{
|
|
const label locali = i - offsets_[proci];
|
|
|
|
if (locali < 0 || i >= offsets_[proci+1])
|
|
{
|
|
FatalErrorInFunction
|
|
<< "Global " << i << " does not belong on processor "
|
|
<< proci << nl << "Offsets:" << offsets_
|
|
<< abort(FatalError);
|
|
}
|
|
return locali;
|
|
}
|
|
|
|
|
|
inline Foam::label Foam::globalIndex::toLocal(const label i) const
|
|
{
|
|
return toLocal(Pstream::myProcNo(), i);
|
|
}
|
|
|
|
|
|
inline Foam::label Foam::globalIndex::whichProcID(const label i) const
|
|
{
|
|
if (i < 0 || i >= totalSize())
|
|
{
|
|
FatalErrorInFunction
|
|
<< "Global " << i << " does not belong on any processor."
|
|
<< " Offsets:" << offsets_
|
|
<< abort(FatalError);
|
|
}
|
|
|
|
return findLower(offsets_, i+1);
|
|
}
|
|
|
|
|
|
// * * * * * * * * * * * * * * * * Iterators * * * * * * * * * * * * * * * * //
|
|
|
|
inline Foam::globalIndex::const_iterator::
|
|
const_iterator
|
|
(
|
|
const globalIndex* globalIdx,
|
|
const label i
|
|
) noexcept
|
|
:
|
|
parent_(globalIdx),
|
|
proci_(i)
|
|
{}
|
|
|
|
|
|
inline Foam::label Foam::globalIndex::const_iterator::
|
|
proci() const noexcept
|
|
{
|
|
return proci_;
|
|
}
|
|
|
|
|
|
inline Foam::label Foam::globalIndex::const_iterator::
|
|
start() const
|
|
{
|
|
return (*parent_).localStart(proci_);
|
|
}
|
|
|
|
|
|
inline Foam::label Foam::globalIndex::const_iterator::
|
|
size() const
|
|
{
|
|
return (*parent_).localSize(proci_);
|
|
}
|
|
|
|
|
|
inline Foam::labelRange Foam::globalIndex::const_iterator::
|
|
range() const
|
|
{
|
|
return (*parent_).range(proci_);
|
|
}
|
|
|
|
|
|
inline Foam::labelRange Foam::globalIndex::const_iterator::
|
|
operator*() const
|
|
{
|
|
return this->range();
|
|
}
|
|
|
|
|
|
inline Foam::globalIndex::const_iterator&
|
|
Foam::globalIndex::const_iterator::
|
|
operator++()
|
|
{
|
|
++proci_;
|
|
return *this;
|
|
}
|
|
|
|
|
|
inline Foam::globalIndex::const_iterator
|
|
Foam::globalIndex::const_iterator::
|
|
operator++(int)
|
|
{
|
|
const_iterator old(*this);
|
|
++proci_;
|
|
return old;
|
|
}
|
|
|
|
|
|
inline Foam::globalIndex::const_iterator&
|
|
Foam::globalIndex::const_iterator::
|
|
operator--()
|
|
{
|
|
--proci_;
|
|
return *this;
|
|
}
|
|
|
|
|
|
inline Foam::globalIndex::const_iterator
|
|
Foam::globalIndex::const_iterator::
|
|
operator--(int)
|
|
{
|
|
const_iterator old(*this);
|
|
--proci_;
|
|
return old;
|
|
}
|
|
|
|
|
|
inline bool
|
|
Foam::globalIndex::const_iterator::
|
|
operator==
|
|
(
|
|
const const_iterator& iter
|
|
) const noexcept
|
|
{
|
|
return (proci_ == iter.proci_);
|
|
}
|
|
|
|
|
|
inline bool
|
|
Foam::globalIndex::const_iterator::
|
|
operator!=
|
|
(
|
|
const const_iterator& iter
|
|
) const noexcept
|
|
{
|
|
return (proci_ != iter.proci_);
|
|
}
|
|
|
|
|
|
// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
|
|
|
|
inline Foam::globalIndex::const_iterator
|
|
Foam::globalIndex::cbegin() const noexcept
|
|
{
|
|
return const_iterator(this);
|
|
}
|
|
|
|
|
|
inline const Foam::globalIndex::const_iterator
|
|
Foam::globalIndex::cend() const noexcept
|
|
{
|
|
return const_iterator(this, this->nProcs());
|
|
}
|
|
|
|
|
|
inline Foam::globalIndex::const_iterator
|
|
Foam::globalIndex::begin() const noexcept
|
|
{
|
|
return const_iterator(this);
|
|
}
|
|
|
|
|
|
inline const Foam::globalIndex::const_iterator
|
|
Foam::globalIndex::end() const noexcept
|
|
{
|
|
return const_iterator(this, this->nProcs());
|
|
}
|
|
|
|
|
|
// ************************************************************************* //
|