File size: 7,794 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 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 | /*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2011-2026 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::subCycle
Description
Perform a subCycleTime on a field or list of fields.
\*---------------------------------------------------------------------------*/
#ifndef subCycle_H
#define subCycle_H
#include "subCycleTime.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
/*---------------------------------------------------------------------------*\
Class subCycleField Declaration
\*---------------------------------------------------------------------------*/
template<class GeometricField>
class subCycleField
{
// Private Data
//- Reference to the field being sub-cycled
GeometricField& gf_;
//- Reference to the field old-time field being sub-cycled
// Needed to avoid calls to oldTime() which may cause
// unexpected updates of the old-time field
GeometricField& gf0_;
//- Copy of the "real" old-time value of the field
tmp<GeometricField> gf_0_;
public:
//- Type of the field
typedef GeometricField FieldsType;
// Constructors
//- Construct from field and number of sub-cycles
subCycleField
(
GeometricField& gf,
const label nSubCycles
)
:
gf_(gf),
gf0_(gf.oldTimeRef())
{
if (nSubCycles > 1)
{
gf_0_ = GeometricField::New(gf0_.name() + "_", gf0_);
}
}
//- Destructor
~subCycleField()
{
if (gf_0_.valid())
{
// Reset the old-time field
gf0_ = gf_0_;
// Correct the time index of the field
// to correspond to the global time
gf_.setTimeIndex(time().timeIndex());
gf0_.setTimeIndex(time().timeIndex());
}
}
//- Access to time
const Time& time() const
{
return gf_.time();
}
//- Correct the time index of the field to correspond to
// the sub-cycling time.
//
// The time index is incremented to protect the old-time value from
// being updated at the beginning of the time-loop in the case of
// outer iteration
void updateTimeIndex()
{
gf_.setTimeIndex(time().timeIndex() + 1);
gf0_.setTimeIndex(time().timeIndex() + 1);
}
};
/*---------------------------------------------------------------------------*\
Class subCycleFields Declaration
\*---------------------------------------------------------------------------*/
template<class GeometricField>
class subCycleFields
{
// Private Data
//- List of pointers to the fields being sub-cycled
UPtrList<GeometricField> gfs_;
//- List of pointers to the fields old-time field being sub-cycled
// Needed to avoid calls to oldTime() which may cause
// unexpected updates of the old-time field
UPtrList<GeometricField> gf0s_;
//- Copy of the "real" old-time value of the fields
PtrList<GeometricField> gf_0s_;
public:
//- Type of the list of fields
typedef UPtrList<GeometricField> FieldsType;
// Constructors
//- Construct from field list and number of sub-cycles
subCycleFields
(
UPtrList<GeometricField>& gfs,
const label nSubCycles
)
:
gfs_(gfs),
gf0s_(gfs.size())
{
if (nSubCycles > 1)
{
gf_0s_.setSize(gfs.size());
forAll(gfs_, i)
{
gf0s_.set(i, &gfs_[i].oldTimeRef());
gf_0s_.set
(
i,
new volScalarField
(
gf0s_[i].name() + "_",
gf0s_[i]
)
);
}
}
}
//- Destructor
~subCycleFields()
{
if (gf_0s_.size())
{
forAll(gfs_, i)
{
// Reset the old-time fields
gf0s_[i] = gf_0s_[i];
// Correct the time index of the fields
// to correspond to the global time
gfs_[i].setTimeIndex(time().timeIndex());
gf0s_[i].setTimeIndex(time().timeIndex());
}
}
}
//- Access to time
const Time& time() const
{
return gfs_[0].time();
}
//- Correct the time index of the fields to correspond to
// the sub-cycling time.
//
// The time index is incremented to protect the old-time value from
// being updated at the beginning of the time-loop in the case of
// outer iteration
void updateTimeIndex()
{
forAll(gfs_, i)
{
gfs_[i].setTimeIndex(time().timeIndex() + 1);
gf0s_[i].setTimeIndex(time().timeIndex() + 1);
}
}
};
/*---------------------------------------------------------------------------* \
Class subCycle Declaration
\*---------------------------------------------------------------------------*/
template
<
class GeometricField,
template<class> class SubCycleField = subCycleField
>
class subCycle
:
public SubCycleField<GeometricField>,
public subCycleTime
{
public:
// Constructors
//- Construct field and number of sub-cycles
subCycle
(
typename SubCycleField<GeometricField>::FieldsType& gf,
const label nSubCycles
)
:
SubCycleField<GeometricField>(gf, nSubCycles),
subCycleTime(const_cast<Time&>(this->time()), nSubCycles)
{
if (nSubCycles > 1)
{
// Update the field time index to correspond
// to the sub-cycle time
this->updateTimeIndex();
}
}
//- Disallow default bitwise copy construction
subCycle(const subCycle<GeometricField>&) = delete;
//- Destructor
// End the subCycleTime, which restores the time state
~subCycle()
{
endSubCycle();
}
// Member Operators
//- Disallow default bitwise assignment
void operator=(const subCycle<GeometricField>&) = delete;
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //
|