File size: 5,083 Bytes
5a600cf | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 | /*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2023-2025 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
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/>.
Class
Foam::MultiRegionRefs
Description
Class to wrap a UPtrList of of region-associated objects (meshes, solvers,
domainDecompositions, ...). Access will return a wrapped reference and will
set the Info prefix to the region name. The prefix will remain until the
wrapped reference goes out of scope.
\*---------------------------------------------------------------------------*/
#ifndef MultiRegionRefs_H
#define MultiRegionRefs_H
#include "IOstreams.H"
#include "regionName.H"
#include "UPtrList.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
template<class Region>
class MultiRegionRefs;
/*---------------------------------------------------------------------------*\
Class RegionRef Declaration
\*---------------------------------------------------------------------------*/
template<class Region>
class RegionRef
{
private:
// Private Data
//- The multi-region container
const MultiRegionRefs<Region>& mrr_;
//- Previous prefix to restore on destruction
const word previousPrefix_;
//- The region index
label regioni_;
//- Reference to the region object
Region& region_;
public:
// Constructors
//- Construct form components
template<class NonConstRegion>
RegionRef
(
const MultiRegionRefs<NonConstRegion>& mrr,
const word& previousPrefix,
const label regioni,
Region& region
);
//- Disallow copy construct
RegionRef(const RegionRef& rp) = delete;
//- Move construct
RegionRef(RegionRef&& rp);
//- Destructor
~RegionRef();
// Member operators
//- Cast to reference
operator Region&() const;
//- Obtain the reference
Region& operator()() const;
};
/*---------------------------------------------------------------------------*\
Class MultiRegionRefs Declaration
\*---------------------------------------------------------------------------*/
template<class Region>
class MultiRegionRefs
{
// Private Data
//- List of region pointers
UPtrList<Region>& regions_;
//- Previous prefix to restore on destruction
const word previousPrefix_;
//- Table to facilitate access by name
HashTable<label, word> indices_;
// Private Member Functions
//- Are we prefixing?
bool prefixes() const;
//- Width of the write prefix
string::size_type prefixWidth() const;
public:
// Friendship
//- Declare friendship with region-reference class
friend class RegionRef<Region>;
//- Declare friendship with const-region-reference class
friend class RegionRef<const Region>;
// Constructors
//- Construct from a list of region pointers
MultiRegionRefs(UPtrList<Region>& regions);
//- Destructor
~MultiRegionRefs();
// Member Functions
//- Return the size
label size() const;
// Member Operators
//- Const-access a region
RegionRef<const Region> operator[](const label regioni) const;
//- Access a region
RegionRef<Region> operator[](const label regioni);
//- Const-access a region
RegionRef<const Region> operator[](const word& regionName) const;
//- Access a region
RegionRef<Region> operator[](const word& regionName);
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#ifdef NoRepository
#include "MultiRegionRefs.C"
#endif
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //
|